117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242

defwebsocket(self,path:Annotated[str,Doc("""            WebSocket path.            """),],name:Annotated[str|None,Doc("""            A name for the WebSocket. Only used internally.            """),]=None,*,dependencies:Annotated[Sequence[params.Depends]|None,Doc("""            A list of dependencies (using `Depends()`) to be used for this            WebSocket.            Read more about it in the            [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).            """),]=None,)->Callable[[DecoratedCallable],DecoratedCallable]:"""    Decorate a WebSocket function.    Read more about it in the    [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).    **Example**    ## Example    ```python    from fastapi import APIRouter, FastAPI, WebSocket    app = FastAPI()    router = APIRouter()    @router.websocket("/ws")    async def websocket_endpoint(websocket: WebSocket):        await websocket.accept()        while True:            data = await websocket.receive_text()            await websocket.send_text(f"Message text was: {data}")    app.include_router(router)    ```    """defdecorator(func:DecoratedCallable)->DecoratedCallable:self.add_api_websocket_route(path,func,name=name,dependencies=dependencies)returnfuncreturndecorator

1253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499

definclude_router(self,router:Annotated["APIRouter",Doc("The `APIRouter` to include.")],*,prefix:Annotated[str,Doc("An optional path prefix for the router.")]="",tags:Annotated[list[str|Enum]|None,Doc("""            A list of tags to be applied to all the *path operations* in this            router.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).            """),]=None,dependencies:Annotated[Sequence[params.Depends]|None,Doc("""            A list of dependencies (using `Depends()`) to be applied to all the            *path operations* in this router.            Read more about it in the            [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).            """),]=None,default_response_class:Annotated[type[Response],Doc("""            The default response class to be used.            Read more in the            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).            """),]=Default(JSONResponse),responses:Annotated[dict[int|str,dict[str,Any]]|None,Doc("""            Additional responses to be shown in OpenAPI.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).            And in the            [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).            """),]=None,callbacks:Annotated[list[BaseRoute]|None,Doc("""            OpenAPI callbacks that should apply to all *path operations* in this            router.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).            """),]=None,deprecated:Annotated[bool|None,Doc("""            Mark all *path operations* in this router as deprecated.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).            """),]=None,include_in_schema:Annotated[bool,Doc("""            Include (or not) all the *path operations* in this router in the            generated OpenAPI schema.            This affects the generated OpenAPI (e.g. visible at `/docs`).            """),]=True,generate_unique_id_function:Annotated[Callable[[APIRoute],str],Doc("""            Customize the function used to generate unique IDs for the *path            operations* shown in the generated OpenAPI.            This is particularly useful when automatically generating clients or            SDKs for your API.            Read more about it in the            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).            """),]=Default(generate_unique_id),)->None:"""    Include another `APIRouter` in the same current `APIRouter`.    Read more about it in the    [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).    ## Example    ```python    from fastapi import APIRouter, FastAPI    app = FastAPI()    internal_router = APIRouter()    users_router = APIRouter()    @users_router.get("/users/")    def read_users():        return [{"name": "Rick"}, {"name": "Morty"}]    internal_router.include_router(users_router)    app.include_router(internal_router)    ```    """assertselfisnotrouter,("Cannot include the same APIRouter instance into itself. ""Did you mean to include a different router?")ifprefix:assertprefix.startswith("/"),"A path prefix must start with '/'"assertnotprefix.endswith("/"),("A path prefix must not end with '/', as the routes will start with '/'")else:forrinrouter.routes:path=getattr(r,"path")# noqa: B009name=getattr(r,"name","unknown")ifpathisnotNoneandnotpath:raiseFastAPIError(f"Prefix and path cannot be both empty (path operation:{name})")ifresponsesisNone:responses={}forrouteinrouter.routes:ifisinstance(route,APIRoute):combined_responses={**responses,**route.responses}use_response_class=get_value_or_default(route.response_class,router.default_response_class,default_response_class,self.default_response_class,)current_tags=[]iftags:current_tags.extend(tags)ifroute.tags:current_tags.extend(route.tags)current_dependencies:list[params.Depends]=[]ifdependencies:current_dependencies.extend(dependencies)ifroute.dependencies:current_dependencies.extend(route.dependencies)current_callbacks=[]ifcallbacks:current_callbacks.extend(callbacks)ifroute.callbacks:current_callbacks.extend(route.callbacks)current_generate_unique_id=get_value_or_default(route.generate_unique_id_function,router.generate_unique_id_function,generate_unique_id_function,self.generate_unique_id_function,)self.add_api_route(prefix+route.path,route.endpoint,response_model=route.response_model,status_code=route.status_code,tags=current_tags,dependencies=current_dependencies,summary=route.summary,description=route.description,response_description=route.response_description,responses=combined_responses,deprecated=route.deprecatedordeprecatedorself.deprecated,methods=route.methods,operation_id=route.operation_id,response_model_include=route.response_model_include,response_model_exclude=route.response_model_exclude,response_model_by_alias=route.response_model_by_alias,response_model_exclude_unset=route.response_model_exclude_unset,response_model_exclude_defaults=route.response_model_exclude_defaults,response_model_exclude_none=route.response_model_exclude_none,include_in_schema=route.include_in_schemaandself.include_in_schemaandinclude_in_schema,response_class=use_response_class,name=route.name,route_class_override=type(route),callbacks=current_callbacks,openapi_extra=route.openapi_extra,generate_unique_id_function=current_generate_unique_id,)elifisinstance(route,routing.Route):methods=list(route.methodsor[])self.add_route(prefix+route.path,route.endpoint,methods=methods,include_in_schema=route.include_in_schema,name=route.name,)elifisinstance(route,APIWebSocketRoute):current_dependencies=[]ifdependencies:current_dependencies.extend(dependencies)ifroute.dependencies:current_dependencies.extend(route.dependencies)self.add_api_websocket_route(prefix+route.path,route.endpoint,dependencies=current_dependencies,name=route.name,)elifisinstance(route,routing.WebSocketRoute):self.add_websocket_route(prefix+route.path,route.endpoint,name=route.name)forhandlerinrouter.on_startup:self.add_event_handler("startup",handler)forhandlerinrouter.on_shutdown:self.add_event_handler("shutdown",handler)self.lifespan_context=_merge_lifespan_context(self.lifespan_context,router.lifespan_context,)

1501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876

defget(self,path:Annotated[str,Doc("""            The URL path to be used for this *path operation*.            For example, in `http://example.com/items`, the path is `/items`.            """),],*,response_model:Annotated[Any,Doc("""            The type to use for the response.            It could be any valid Pydantic *field* type. So, it doesn't have to            be a Pydantic model, it could be other things, like a `list`, `dict`,            etc.            It will be used for:            * Documentation: the generated OpenAPI (and the UI at `/docs`) will                show it as the response (JSON Schema).            * Serialization: you could return an arbitrary object and the                `response_model` would be used to serialize that object into the                corresponding JSON.            * Filtering: the JSON sent to the client will only contain the data                (fields) defined in the `response_model`. If you returned an object                that contains an attribute `password` but the `response_model` does                not include that field, the JSON sent to the client would not have                that `password`.            * Validation: whatever you return will be serialized with the                `response_model`, converting any data as necessary to generate the                corresponding JSON. But if the data in the object returned is not                valid, that would mean a violation of the contract with the client,                so it's an error from the API developer. So, FastAPI will raise an                error and return a 500 error code (Internal Server Error).            Read more about it in the            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).            """),]=Default(None),status_code:Annotated[int|None,Doc("""            The default status code to be used for the response.            You could override the status code by returning a response directly.            Read more about it in the            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).            """),]=None,tags:Annotated[list[str|Enum]|None,Doc("""            A list of tags to be applied to the *path operation*.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).            """),]=None,dependencies:Annotated[Sequence[params.Depends]|None,Doc("""            A list of dependencies (using `Depends()`) to be applied to the            *path operation*.            Read more about it in the            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).            """),]=None,summary:Annotated[str|None,Doc("""            A summary for the *path operation*.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).            """),]=None,description:Annotated[str|None,Doc("""            A description for the *path operation*.            If not provided, it will be extracted automatically from the docstring            of the *path operation function*.            It can contain Markdown.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).            """),]=None,response_description:Annotated[str,Doc("""            The description for the default response.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            """),]="Successful Response",responses:Annotated[dict[int|str,dict[str,Any]]|None,Doc("""            Additional responses that could be returned by this *path operation*.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            """),]=None,deprecated:Annotated[bool|None,Doc("""            Mark this *path operation* as deprecated.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            """),]=None,operation_id:Annotated[str|None,Doc("""            Custom operation ID to be used by this *path operation*.            By default, it is generated automatically.            If you provide a custom operation ID, you need to make sure it is            unique for the whole API.            You can customize the            operation ID generation with the parameter            `generate_unique_id_function` in the `FastAPI` class.            Read more about it in the            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).            """),]=None,response_model_include:Annotated[IncEx|None,Doc("""            Configuration passed to Pydantic to include only certain fields in the            response data.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).            """),]=None,response_model_exclude:Annotated[IncEx|None,Doc("""            Configuration passed to Pydantic to exclude certain fields in the            response data.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).            """),]=None,response_model_by_alias:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response model            should be serialized by alias when an alias is used.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).            """),]=True,response_model_exclude_unset:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response data            should have all the fields, including the ones that were not set and            have their default values. This is different from            `response_model_exclude_defaults` in that if the fields are set,            they will be included in the response, even if the value is the same            as the default.            When `True`, default values are omitted from the response.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).            """),]=False,response_model_exclude_defaults:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response data            should have all the fields, including the ones that have the same value            as the default. This is different from `response_model_exclude_unset`            in that if the fields are set but contain the same default values,            they will be excluded from the response.            When `True`, default values are omitted from the response.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).            """),]=False,response_model_exclude_none:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response data should            exclude fields set to `None`.            This is much simpler (less smart) than `response_model_exclude_unset`            and `response_model_exclude_defaults`. You probably want to use one of            those two instead of this one, as those allow returning `None` values            when it makes sense.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).            """),]=False,include_in_schema:Annotated[bool,Doc("""            Include this *path operation* in the generated OpenAPI schema.            This affects the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).            """),]=True,response_class:Annotated[type[Response],Doc("""            Response class to be used for this *path operation*.            This will not be used if you return a response directly.            Read more about it in the            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).            """),]=Default(JSONResponse),name:Annotated[str|None,Doc("""            Name for this *path operation*. Only used internally.            """),]=None,callbacks:Annotated[list[BaseRoute]|None,Doc("""            List of *path operations* that will be used as OpenAPI callbacks.            This is only for OpenAPI documentation, the callbacks won't be used            directly.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).            """),]=None,openapi_extra:Annotated[dict[str,Any]|None,Doc("""            Extra metadata to be included in the OpenAPI schema for this *path            operation*.            Read more about it in the            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).            """),]=None,generate_unique_id_function:Annotated[Callable[[APIRoute],str],Doc("""            Customize the function used to generate unique IDs for the *path            operations* shown in the generated OpenAPI.            This is particularly useful when automatically generating clients or            SDKs for your API.            Read more about it in the            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).            """),]=Default(generate_unique_id),)->Callable[[DecoratedCallable],DecoratedCallable]:"""    Add a *path operation* using an HTTP GET operation.    ## Example    ```python    from fastapi import APIRouter, FastAPI    app = FastAPI()    router = APIRouter()    @router.get("/items/")    def read_items():        return [{"name": "Empanada"}, {"name": "Arepa"}]    app.include_router(router)    ```    """returnself.api_route(path=path,response_model=response_model,status_code=status_code,tags=tags,dependencies=dependencies,summary=summary,description=description,response_description=response_description,responses=responses,deprecated=deprecated,methods=["GET"],operation_id=operation_id,response_model_include=response_model_include,response_model_exclude=response_model_exclude,response_model_by_alias=response_model_by_alias,response_model_exclude_unset=response_model_exclude_unset,response_model_exclude_defaults=response_model_exclude_defaults,response_model_exclude_none=response_model_exclude_none,include_in_schema=include_in_schema,response_class=response_class,name=name,callbacks=callbacks,openapi_extra=openapi_extra,generate_unique_id_function=generate_unique_id_function,)

187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258

defput(self,path:Annotated[str,Doc("""            The URL path to be used for this *path operation*.            For example, in `http://example.com/items`, the path is `/items`.            """),],*,response_model:Annotated[Any,Doc("""            The type to use for the response.            It could be any valid Pydantic *field* type. So, it doesn't have to            be a Pydantic model, it could be other things, like a `list`, `dict`,            etc.            It will be used for:            * Documentation: the generated OpenAPI (and the UI at `/docs`) will                show it as the response (JSON Schema).            * Serialization: you could return an arbitrary object and the                `response_model` would be used to serialize that object into the                corresponding JSON.            * Filtering: the JSON sent to the client will only contain the data                (fields) defined in the `response_model`. If you returned an object                that contains an attribute `password` but the `response_model` does                not include that field, the JSON sent to the client would not have                that `password`.            * Validation: whatever you return will be serialized with the                `response_model`, converting any data as necessary to generate the                corresponding JSON. But if the data in the object returned is not                valid, that would mean a violation of the contract with the client,                so it's an error from the API developer. So, FastAPI will raise an                error and return a 500 error code (Internal Server Error).            Read more about it in the            [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).            """),]=Default(None),status_code:Annotated[int|None,Doc("""            The default status code to be used for the response.            You could override the status code by returning a response directly.            Read more about it in the            [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).            """),]=None,tags:Annotated[list[str|Enum]|None,Doc("""            A list of tags to be applied to the *path operation*.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).            """),]=None,dependencies:Annotated[Sequence[params.Depends]|None,Doc("""            A list of dependencies (using `Depends()`) to be applied to the            *path operation*.            Read more about it in the            [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).            """),]=None,summary:Annotated[str|None,Doc("""            A summary for the *path operation*.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).            """),]=None,description:Annotated[str|None,Doc("""            A description for the *path operation*.            If not provided, it will be extracted automatically from the docstring            of the *path operation function*.            It can contain Markdown.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).            """),]=None,response_description:Annotated[str,Doc("""            The description for the default response.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            """),]="Successful Response",responses:Annotated[dict[int|str,dict[str,Any]]|None,Doc("""            Additional responses that could be returned by this *path operation*.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            """),]=None,deprecated:Annotated[bool|None,Doc("""            Mark this *path operation* as deprecated.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            """),]=None,operation_id:Annotated[str|None,Doc("""            Custom operation ID to be used by this *path operation*.            By default, it is generated automatically.            If you provide a custom operation ID, you need to make sure it is            unique for the whole API.            You can customize the            operation ID generation with the parameter            `generate_unique_id_function` in the `FastAPI` class.            Read more about it in the            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).            """),]=None,response_model_include:Annotated[IncEx|None,Doc("""            Configuration passed to Pydantic to include only certain fields in the            response data.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).            """),]=None,response_model_exclude:Annotated[IncEx|None,Doc("""            Configuration passed to Pydantic to exclude certain fields in the            response data.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).            """),]=None,response_model_by_alias:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response model            should be serialized by alias when an alias is used.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).            """),]=True,response_model_exclude_unset:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response data            should have all the fields, including the ones that were not set and            have their default values. This is different from            `response_model_exclude_defaults` in that if the fields are set,            they will be included in the response, even if the value is the same            as the default.            When `True`, default values are omitted from the response.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).            """),]=False,response_model_exclude_defaults:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response data            should have all the fields, including the ones that have the same value            as the default. This is different from `response_model_exclude_unset`            in that if the fields are set but contain the same default values,            they will be excluded from the response.            When `True`, default values are omitted from the response.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).            """),]=False,response_model_exclude_none:Annotated[bool,Doc("""            Configuration passed to Pydantic to define if the response data should            exclude fields set to `None`.            This is much simpler (less smart) than `response_model_exclude_unset`            and `response_model_exclude_defaults`. You probably want to use one of            those two instead of this one, as those allow returning `None` values            when it makes sense.            Read more about it in the            [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).            """),]=False,include_in_schema:Annotated[bool,Doc("""            Include this *path operation* in the generated OpenAPI schema.            This affects the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-parameters-from-openapi).            """),]=True,response_class:Annotated[type[Response],Doc("""            Response class to be used for this *path operation*.            This will not be used if you return a response directly.            Read more about it in the            [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).            """),]=Default(JSONResponse),name:Annotated[str|None,Doc("""            Name for this *path operation*. Only used internally.            """),]=None,callbacks:Annotated[list[BaseRoute]|None,Doc("""            List of *path operations* that will be used as OpenAPI callbacks.            This is only for OpenAPI documentation, the callbacks won't be used            directly.            It will be added to the generated OpenAPI (e.g. visible at `/docs`).            Read more about it in the            [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).            """),]=None,openapi_extra:Annotated[dict[str,Any]|None,Doc("""            Extra metadata to be included in the OpenAPI schema for this *path            operation*.            Read more about it in the            [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).            """),]=None,generate_unique_id_function:Annotated[Callable[[APIRoute],str],Doc("""            Customize the function used to generate unique IDs for the *path            operations* shown in the generated OpenAPI.            This is particularly useful when automatically generating clients or            SDKs for your API.            Read more about it in the            [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).            """),]=Default(generate_unique_id),)->Callable[[DecoratedCallable],DecoratedCallable]:"""    Add a *path operation* using an HTTP PUT operation.    ## Example    ```python    from fastapi import APIRouter, FastAPI    from pydantic import BaseModel    class Item(BaseModel):        name: str        description: str | None = None    app = FastAPI()    router = APIRouter()    @router.put("/items/{item_id}")    def replace_item(item_id: str, item: Item):        return {"message": "Item replaced", "id": item_id}    app.include_router(router)    ```    """returnself.api_route(path=path,response_model=response_model,status_code=status_code,tags=tags,dependencies=dependencies,summary=summary,description=description,response_description=response_description,responses=responses,deprecated=deprecated,methods=["PUT"],operation_id=operation_id,response_model_include=response_model_include,response_model_exclude=response_model_exclude,response_model_by_alias=response_model_by_alias,response_model_exclude_unset=response_model_exclude_unset,response_model_exclude_defaults=response_model_exclude_defaults,response_model_exclude_none=response_model_exclude_none,include_in_schema=include_in_schema,response_class=response_class,name=name,callbacks=callbacks,openapi_extra=openapi_extra,generate_unique_id_function=generate_unique_id_function,)