Callable[[DecoratedCallable], DecoratedCallable]:\n2921: \"\"\"\n2922: Add a *path operation* using an HTTP DELETE operation.\n2923: \n2924: ## Example\n2925: \n2926: ```python\n2927: from fastapi import FastAPI\n2928: \n2929: app = FastAPI()\n2930: \n2931: @app.delete(\"/items/{item_id}\")\n2932: def delete_item(item_id: str):\n2933: return {\"message\": \"Item deleted\"}\n2934: ```\n2935: \"\"\"\n2936: return self.router.delete(\n2937: path,\n2938: response_model=response_model,\n2939: status_code=status_code,\n2940: tags=tags,\n2941: dependencies=dependencies,\n2942: summary=summary,\n2943: description=description,\n2944: response_description=response_description,\n2945: responses=responses,\n2946: deprecated=deprecated,\n2947: operation_id=operation_id,\n2948: response_model_include=response_model_include,\n2949: response_model_exclude=response_model_exclude,\n2950: response_model_by_alias=response_model_by_alias,\n2951: response_model_exclude_unset=response_model_exclude_unset,\n2952: response_model_exclude_defaults=response_model_exclude_defaults,\n2953: response_model_exclude_none=response_model_exclude_none,\n2954: include_in_schema=include_in_schema,\n2955: response_class=response_class,\n2956: name=name,\n2957: callbacks=callbacks,\n2958: openapi_extra=openapi_extra,\n2959: generate_unique_id_function=generate_unique_id_function,\n2960: )\n2961: \n2962: def options(\n2963: self,\n2964: path: Annotated[\n2965: str,\n2966: Doc(\n2967: \"\"\"\n2968: The URL path to be used for this *path operation*.\n2969: \n2970: For example, in `http://example.com/items`, the path is `/items`.\n2971: \"\"\"\n2972: ),\n2973: ],\n2974: *,\n2975: response_model: Annotated[\n2976: Any,\n2977: Doc(\n2978: \"\"\"\n2979: The type to use for the response.\n2980: \n2981: It could be any valid Pydantic *field* type. So, it doesn't have to\n2982: be a Pydantic model, it could be other things, like a `list`, `dict`,\n2983: etc.\n2984: \n2985: It will be used for:\n2986: \n2987: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n2988: show it as the response (JSON Schema).\n2989: * Serialization: you could return an arbitrary object and the\n2990: `response_model` would be used to serialize that object into the\n2991: corresponding JSON.\n2992: * Filtering: the JSON sent to the client will only contain the data\n2993: (fields) defined in the `response_model`. If you returned an object\n2994: that contains an attribute `password` but the `response_model` does\n2995: not include that field, the JSON sent to the client would not have\n2996: that `password`.\n2997: * Validation: whatever you return will be serialized with the\n2998: `response_model`, converting any data as necessary to generate the\n2999: corresponding JSON. But if the data in the object returned is not\n3000: valid, that would mean a violation of the contract with the client,\n3001: so it's an error from the API developer. So, FastAPI will raise an\n3002: error and return a 500 error code (Internal Server Error).\n3003: \n3004: Read more about it in the\n3005: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n3006: \"\"\"\n3007: ),\n3008: ] = Default(None),\n3009: status_code: Annotated[\n3010: Optional[int],\n3011: Doc(\n3012: \"\"\"\n3013: The default status code to be used for the response.\n3014: \n3015: You could override the status code by returning a response directly.\n3016: \n3017: Read more about it in the\n3018: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n3019: \"\"\"\n3020: ),\n3021: ] = None,\n3022: tags: Annotated[\n3023: Optional[List[Union[str, Enum]]],\n3024: Doc(\n3025: \"\"\"\n3026: A list of tags to be applied to the *path operation*.\n3027: \n3028: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3029: \n3030: Read more about it in the\n3031: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n3032: \"\"\"\n3033: ),\n3034: ] = None,\n3035: dependencies: Annotated[\n3036: Optional[Sequence[Depends]],\n3037: Doc(\n3038: \"\"\"\n3039: A list of dependencies (using `Depends()`) to be applied to the\n3040: *path operation*.\n3041: \n3042: Read more about it in the\n3043: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n3044: \"\"\"\n3045: ),\n3046: ] = None,\n3047: summary: Annotated[\n3048: Optional[str],\n3049: Doc(\n3050: \"\"\"\n3051: A summary for the *path operation*.\n3052: \n3053: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3054: \n3055: Read more about it in the\n3056: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3057: \"\"\"\n3058: ),\n3059: ] = None,\n3060: description: Annotated[\n3061: Optional[str],\n3062: Doc(\n3063: \"\"\"\n3064: A description for the *path operation*.\n3065: \n3066: If not provided, it will be extracted automatically from the docstring\n3067: of the *path operation function*.\n3068: \n3069: It can contain Markdown.\n3070: \n3071: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3072: \n3073: Read more about it in the\n3074: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3075: \"\"\"\n3076: ),\n3077: ] = None,\n3078: response_description: Annotated[\n3079: str,\n3080: Doc(\n3081: \"\"\"\n3082: The description for the default response.\n3083: \n3084: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3085: \"\"\"\n3086: ),\n3087: ] = \"Successful Response\",\n3088: responses: Annotated[\n3089: Optional[Dict[Union[int, str], Dict[str, Any]]],\n3090: Doc(\n3091: \"\"\"\n3092: Additional responses that could be returned by this *path operation*.\n3093: \n3094: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3095: \"\"\"\n3096: ),\n3097: ] = None,\n3098: deprecated: Annotated[\n3099: Optional[bool],\n3100: Doc(\n3101: \"\"\"\n3102: Mark this *path operation* as deprecated.\n3103: \n3104: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3105: \"\"\"\n3106: ),\n3107: ] = None,\n3108: operation_id: Annotated[\n3109: Optional[str],\n3110: Doc(\n3111: \"\"\"\n3112: Custom operation ID to be used by this *path operation*.\n3113: \n3114: By default, it is generated automatically.\n3115: \n3116: If you provide a custom operation ID, you need to make sure it is\n3117: unique for the whole API.\n3118: \n3119: You can customize the\n3120: operation ID generation with the parameter\n3121: `generate_unique_id_function` in the `FastAPI` class.\n3122: \n3123: Read more about it in the\n3124: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3125: \"\"\"\n3126: ),\n3127: ] = None,\n3128: response_model_include: Annotated[\n3129: Optional[IncEx],\n3130: Doc(\n3131: \"\"\"\n3132: Configuration passed to Pydantic to include only certain fields in the\n3133: response data.\n3134: \n3135: Read more about it in the\n3136: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3137: \"\"\"\n3138: ),\n3139: ] = None,\n3140: response_model_exclude: Annotated[\n3141: Optional[IncEx],\n3142: Doc(\n3143: \"\"\"\n3144: Configuration passed to Pydantic to exclude certain fields in the\n3145: response data.\n3146: \n3147: Read more about it in the\n3148: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3149: \"\"\"\n3150: ),\n3151: ] = None,\n3152: response_model_by_alias: Annotated[\n3153: bool,\n3154: Doc(\n3155: \"\"\"\n3156: Configuration passed to Pydantic to define if the response model\n3157: should be serialized by alias when an alias is used.\n3158: \n3159: Read more about it in the\n3160: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3161: \"\"\"\n3162: ),\n3163: ] = True,\n3164: response_model_exclude_unset: Annotated[\n3165: bool,\n3166: Doc(\n3167: \"\"\"\n3168: Configuration passed to Pydantic to define if the response data\n3169: should have all the fields, including the ones that were not set and\n3170: have their default values. This is different from\n3171: `response_model_exclude_defaults` in that if the fields are set,\n3172: they will be included in the response, even if the value is the same\n3173: as the default.\n3174: \n3175: When `True`, default values are omitted from the response.\n3176: \n3177: Read more about it in the\n3178: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3179: \"\"\"\n3180: ),\n3181: ] = False,\n3182: response_model_exclude_defaults: Annotated[\n3183: bool,\n3184: Doc(\n3185: \"\"\"\n3186: Configuration passed to Pydantic to define if the response data\n3187: should have all the fields, including the ones that have the same value\n3188: as the default. This is different from `response_model_exclude_unset`\n3189: in that if the fields are set but contain the same default values,\n3190: they will be excluded from the response.\n3191: \n3192: When `True`, default values are omitted from the response.\n3193: \n3194: Read more about it in the\n3195: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3196: \"\"\"\n3197: ),\n3198: ] = False,\n3199: response_model_exclude_none: Annotated[\n3200: bool,\n3201: Doc(\n3202: \"\"\"\n3203: Configuration passed to Pydantic to define if the response data should\n3204: exclude fields set to `None`.\n3205: \n3206: This is much simpler (less smart) than `response_model_exclude_unset`\n3207: and `response_model_exclude_defaults`. You probably want to use one of\n3208: those two instead of this one, as those allow returning `None` values\n3209: when it makes sense.\n3210: \n3211: Read more about it in the\n3212: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n3213: \"\"\"\n3214: ),\n3215: ] = False,\n3216: include_in_schema: Annotated[\n3217: bool,\n3218: Doc(\n3219: \"\"\"\n3220: Include this *path operation* in the generated OpenAPI schema.\n3221: \n3222: This affects the generated OpenAPI (e.g. visible at `/docs`).\n3223: \n3224: Read more about it in the\n3225: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n3226: \"\"\"\n3227: ),\n3228: ] = True,\n3229: response_class: Annotated[\n3230: Type[Response],\n3231: Doc(\n3232: \"\"\"\n3233: Response class to be used for this *path operation*.\n3234: \n3235: This will not be used if you return a response directly.\n3236: \n3237: Read more about it in the\n3238: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n3239: \"\"\"\n3240: ),\n3241: ] = Default(JSONResponse),\n3242: name: Annotated[\n3243: Optional[str],\n3244: Doc(\n3245: \"\"\"\n3246: Name for this *path operation*. Only used internally.\n3247: \"\"\"\n3248: ),\n3249: ] = None,\n3250: callbacks: Annotated[\n3251: Optional[List[BaseRoute]],\n3252: Doc(\n3253: \"\"\"\n3254: List of *path operations* that will be used as OpenAPI callbacks.\n3255: \n3256: This is only for OpenAPI documentation, the callbacks won't be used\n3257: directly.\n3258: \n3259: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3260: \n3261: Read more about it in the\n3262: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n3263: \"\"\"\n3264: ),\n3265: ] = None,\n3266: openapi_extra: Annotated[\n3267: Optional[Dict[str, Any]],\n3268: Doc(\n3269: \"\"\"\n3270: Extra metadata to be included in the OpenAPI schema for this *path\n3271: operation*.\n3272: \n3273: Read more about it in the\n3274: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n3275: \"\"\"\n3276: ),\n3277: ] = None,\n3278: generate_unique_id_function: Annotated[\n3279: Callable[[routing.APIRoute], str],\n3280: Doc(\n3281: \"\"\"\n3282: Customize the function used to generate unique IDs for the *path\n3283: operations* shown in the generated OpenAPI.\n3284: \n3285: This is particularly useful when automatically generating clients or\n3286: SDKs for your API.\n3287: \n3288: Read more about it in the\n3289: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3290: \"\"\"\n3291: ),\n3292: ] = Default(generate_unique_id),\n3293: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n3294: \"\"\"\n3295: Add a *path operation* using an HTTP OPTIONS operation.\n3296: \n3297: ## Example\n3298: \n3299: ```python\n3300: from fastapi import FastAPI\n3301: \n3302: app = FastAPI()\n3303: \n3304: @app.options(\"/items/\")\n3305: def get_item_options():\n3306: return {\"additions\": [\"Aji\", \"Guacamole\"]}\n3307: ```\n3308: \"\"\"\n3309: return self.router.options(\n3310: path,\n3311: response_model=response_model,\n3312: status_code=status_code,\n3313: tags=tags,\n3314: dependencies=dependencies,\n3315: summary=summary,\n3316: description=description,\n3317: response_description=response_description,\n3318: responses=responses,\n3319: deprecated=deprecated,\n3320: operation_id=operation_id,\n3321: response_model_include=response_model_include,\n3322: response_model_exclude=response_model_exclude,\n3323: response_model_by_alias=response_model_by_alias,\n3324: response_model_exclude_unset=response_model_exclude_unset,\n3325: response_model_exclude_defaults=response_model_exclude_defaults,\n3326: response_model_exclude_none=response_model_exclude_none,\n3327: include_in_schema=include_in_schema,\n3328: response_class=response_class,\n3329: name=name,\n3330: callbacks=callbacks,\n3331: openapi_extra=openapi_extra,\n3332: generate_unique_id_function=generate_unique_id_function,\n3333: )\n3334: \n3335: def head(\n3336: self,\n3337: path: Annotated[\n3338: str,\n3339: Doc(\n3340: \"\"\"\n3341: The URL path to be used for this *path operation*.\n3342: \n3343: For example, in `http://example.com/items`, the path is `/items`.\n3344: \"\"\"\n3345: ),\n3346: ],\n3347: *,\n3348: response_model: Annotated[\n3349: Any,\n3350: Doc(\n3351: \"\"\"\n3352: The type to use for the response.\n3353: \n3354: It could be any valid Pydantic *field* type. So, it doesn't have to\n3355: be a Pydantic model, it could be other things, like a `list`, `dict`,\n3356: etc.\n3357: \n3358: It will be used for:\n3359: \n3360: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n3361: show it as the response (JSON Schema).\n3362: * Serialization: you could return an arbitrary object and the\n3363: `response_model` would be used to serialize that object into the\n3364: corresponding JSON.\n3365: * Filtering: the JSON sent to the client will only contain the data\n3366: (fields) defined in the `response_model`. If you returned an object\n3367: that contains an attribute `password` but the `response_model` does\n3368: not include that field, the JSON sent to the client would not have\n3369: that `password`.\n3370: * Validation: whatever you return will be serialized with the\n3371: `response_model`, converting any data as necessary to generate the\n3372: corresponding JSON. But if the data in the object returned is not\n3373: valid, that would mean a violation of the contract with the client,\n3374: so it's an error from the API developer. So, FastAPI will raise an\n3375: error and return a 500 error code (Internal Server Error).\n3376: \n3377: Read more about it in the\n3378: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n3379: \"\"\"\n3380: ),\n3381: ] = Default(None),\n3382: status_code: Annotated[\n3383: Optional[int],\n3384: Doc(\n3385: \"\"\"\n3386: The default status code to be used for the response.\n3387: \n3388: You could override the status code by returning a response directly.\n3389: \n3390: Read more about it in the\n3391: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n3392: \"\"\"\n3393: ),\n3394: ] = None,\n3395: tags: Annotated[\n3396: Optional[List[Union[str, Enum]]],\n3397: Doc(\n3398: \"\"\"\n3399: A list of tags to be applied to the *path operation*.\n3400: \n3401: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3402: \n3403: Read more about it in the\n3404: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n3405: \"\"\"\n3406: ),\n3407: ] = None,\n3408: dependencies: Annotated[\n3409: Optional[Sequence[Depends]],\n3410: Doc(\n3411: \"\"\"\n3412: A list of dependencies (using `Depends()`) to be applied to the\n3413: *path operation*.\n3414: \n3415: Read more about it in the\n3416: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n3417: \"\"\"\n3418: ),\n3419: ] = None,\n3420: summary: Annotated[\n3421: Optional[str],\n3422: Doc(\n3423: \"\"\"\n3424: A summary for the *path operation*.\n3425: \n3426: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3427: \n3428: Read more about it in the\n3429: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3430: \"\"\"\n3431: ),\n3432: ] = None,\n3433: description: Annotated[\n3434: Optional[str],\n3435: Doc(\n3436: \"\"\"\n3437: A description for the *path operation*.\n3438: \n3439: If not provided, it will be extracted automatically from the docstring\n3440: of the *path operation function*.\n3441: \n3442: It can contain Markdown.\n3443: \n3444: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3445: \n3446: Read more about it in the\n3447: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3448: \"\"\"\n3449: ),\n3450: ] = None,\n3451: response_description: Annotated[\n3452: str,\n3453: Doc(\n3454: \"\"\"\n3455: The description for the default response.\n3456: \n3457: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3458: \"\"\"\n3459: ),\n3460: ] = \"Successful Response\",\n3461: responses: Annotated[\n3462: Optional[Dict[Union[int, str], Dict[str, Any]]],\n3463: Doc(\n3464: \"\"\"\n3465: Additional responses that could be returned by this *path operation*.\n3466: \n3467: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3468: \"\"\"\n3469: ),\n3470: ] = None,\n3471: deprecated: Annotated[\n3472: Optional[bool],\n3473: Doc(\n3474: \"\"\"\n3475: Mark this *path operation* as deprecated.\n3476: \n3477: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3478: \"\"\"\n3479: ),\n3480: ] = None,\n3481: operation_id: Annotated[\n3482: Optional[str],\n3483: Doc(\n3484: \"\"\"\n3485: Custom operation ID to be used by this *path operation*.\n3486: \n3487: By default, it is generated automatically.\n3488: \n3489: If you provide a custom operation ID, you need to make sure it is\n3490: unique for the whole API.\n3491: \n3492: You can customize the\n3493: operation ID generation with the parameter\n3494: `generate_unique_id_function` in the `FastAPI` class.\n3495: \n3496: Read more about it in the\n3497: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3498: \"\"\"\n3499: ),\n3500: ] = None,\n3501: response_model_include: Annotated[\n3502: Optional[IncEx],\n3503: Doc(\n3504: \"\"\"\n3505: Configuration passed to Pydantic to include only certain fields in the\n3506: response data.\n3507: \n3508: Read more about it in the\n3509: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3510: \"\"\"\n3511: ),\n3512: ] = None,\n3513: response_model_exclude: Annotated[\n3514: Optional[IncEx],\n3515: Doc(\n3516: \"\"\"\n3517: Configuration passed to Pydantic to exclude certain fields in the\n3518: response data.\n3519: \n3520: Read more about it in the\n3521: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3522: \"\"\"\n3523: ),\n3524: ] = None,\n3525: response_model_by_alias: Annotated[\n3526: bool,\n3527: Doc(\n3528: \"\"\"\n3529: Configuration passed to Pydantic to define if the response model\n3530: should be serialized by alias when an alias is used.\n3531: \n3532: Read more about it in the\n3533: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3534: \"\"\"\n3535: ),\n3536: ] = True,\n3537: response_model_exclude_unset: Annotated[\n3538: bool,\n3539: Doc(\n3540: \"\"\"\n3541: Configuration passed to Pydantic to define if the response data\n3542: should have all the fields, including the ones that were not set and\n3543: have their default values. This is different from\n3544: `response_model_exclude_defaults` in that if the fields are set,\n3545: they will be included in the response, even if the value is the same\n3546: as the default.\n3547: \n3548: When `True`, default values are omitted from the response.\n3549: \n3550: Read more about it in the\n3551: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3552: \"\"\"\n3553: ),\n3554: ] = False,\n3555: response_model_exclude_defaults: Annotated[\n3556: bool,\n3557: Doc(\n3558: \"\"\"\n3559: Configuration passed to Pydantic to define if the response data\n3560: should have all the fields, including the ones that have the same value\n3561: as the default. This is different from `response_model_exclude_unset`\n3562: in that if the fields are set but contain the same default values,\n3563: they will be excluded from the response.\n3564: \n3565: When `True`, default values are omitted from the response.\n3566: \n3567: Read more about it in the\n3568: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3569: \"\"\"\n3570: ),\n3571: ] = False,\n3572: response_model_exclude_none: Annotated[\n3573: bool,\n3574: Doc(\n3575: \"\"\"\n3576: Configuration passed to Pydantic to define if the response data should\n3577: exclude fields set to `None`.\n3578: \n3579: This is much simpler (less smart) than `response_model_exclude_unset`\n3580: and `response_model_exclude_defaults`. You probably want to use one of\n3581: those two instead of this one, as those allow returning `None` values\n3582: when it makes sense.\n3583: \n3584: Read more about it in the\n3585: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n3586: \"\"\"\n3587: ),\n3588: ] = False,\n3589: include_in_schema: Annotated[\n3590: bool,\n3591: Doc(\n3592: \"\"\"\n3593: Include this *path operation* in the generated OpenAPI schema.\n3594: \n3595: This affects the generated OpenAPI (e.g. visible at `/docs`).\n3596: \n3597: Read more about it in the\n3598: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n3599: \"\"\"\n3600: ),\n3601: ] = True,\n3602: response_class: Annotated[\n3603: Type[Response],\n3604: Doc(\n3605: \"\"\"\n3606: Response class to be used for this *path operation*.\n3607: \n3608: This will not be used if you return a response directly.\n3609: \n3610: Read more about it in the\n3611: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n3612: \"\"\"\n3613: ),\n3614: ] = Default(JSONResponse),\n3615: name: Annotated[\n3616: Optional[str],\n3617: Doc(\n3618: \"\"\"\n3619: Name for this *path operation*. Only used internally.\n3620: \"\"\"\n3621: ),\n3622: ] = None,\n3623: callbacks: Annotated[\n3624: Optional[List[BaseRoute]],\n3625: Doc(\n3626: \"\"\"\n3627: List of *path operations* that will be used as OpenAPI callbacks.\n3628: \n3629: This is only for OpenAPI documentation, the callbacks won't be used\n3630: directly.\n3631: \n3632: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3633: \n3634: Read more about it in the\n3635: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n3636: \"\"\"\n3637: ),\n3638: ] = None,\n3639: openapi_extra: Annotated[\n3640: Optional[Dict[str, Any]],\n3641: Doc(\n3642: \"\"\"\n3643: Extra metadata to be included in the OpenAPI schema for this *path\n3644: operation*.\n3645: \n3646: Read more about it in the\n3647: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n3648: \"\"\"\n3649: ),\n3650: ] = None,\n3651: generate_unique_id_function: Annotated[\n3652: Callable[[routing.APIRoute], str],\n3653: Doc(\n3654: \"\"\"\n3655: Customize the function used to generate unique IDs for the *path\n3656: operations* shown in the generated OpenAPI.\n3657: \n3658: This is particularly useful when automatically generating clients or\n3659: SDKs for your API.\n3660: \n3661: Read more about it in the\n3662: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3663: \"\"\"\n3664: ),\n3665: ] = Default(generate_unique_id),\n3666: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n3667: \"\"\"\n3668: Add a *path operation* using an HTTP HEAD operation.\n3669: \n3670: ## Example\n3671: \n3672: ```python\n3673: from fastapi import FastAPI, Response\n3674: \n3675: app = FastAPI()\n3676: \n3677: @app.head(\"/items/\", status_code=204)\n3678: def get_items_headers(response: Response):\n3679: response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n3680: ```\n3681: \"\"\"\n3682: return self.router.head(\n3683: path,\n3684: response_model=response_model,\n3685: status_code=status_code,\n3686: tags=tags,\n3687: dependencies=dependencies,\n3688: summary=summary,\n3689: description=description,\n3690: response_description=response_description,\n3691: responses=responses,\n3692: deprecated=deprecated,\n3693: operation_id=operation_id,\n3694: response_model_include=response_model_include,\n3695: response_model_exclude=response_model_exclude,\n3696: response_model_by_alias=response_model_by_alias,\n3697: response_model_exclude_unset=response_model_exclude_unset,\n3698: response_model_exclude_defaults=response_model_exclude_defaults,\n3699: response_model_exclude_none=response_model_exclude_none,\n3700: include_in_schema=include_in_schema,\n3701: response_class=response_class,\n3702: name=name,\n3703: callbacks=callbacks,\n3704: openapi_extra=openapi_extra,\n3705: generate_unique_id_function=generate_unique_id_function,\n3706: )\n3707: \n3708: def patch(\n3709: self,\n3710: path: Annotated[\n3711: str,\n3712: Doc(\n3713: \"\"\"\n3714: The URL path to be used for this *path operation*.\n3715: \n3716: For example, in `http://example.com/items`, the path is `/items`.\n3717: \"\"\"\n3718: ),\n3719: ],\n3720: *,\n3721: response_model: Annotated[\n3722: Any,\n3723: Doc(\n3724: \"\"\"\n3725: The type to use for the response.\n3726: \n3727: It could be any valid Pydantic *field* type. So, it doesn't have to\n3728: be a Pydantic model, it could be other things, like a `list`, `dict`,\n3729: etc.\n3730: \n3731: It will be used for:\n3732: \n3733: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n3734: show it as the response (JSON Schema).\n3735: * Serialization: you could return an arbitrary object and the\n3736: `response_model` would be used to serialize that object into the\n3737: corresponding JSON.\n3738: * Filtering: the JSON sent to the client will only contain the data\n3739: (fields) defined in the `response_model`. If you returned an object\n3740: that contains an attribute `password` but the `response_model` does\n3741: not include that field, the JSON sent to the client would not have\n3742: that `password`.\n3743: * Validation: whatever you return will be serialized with the\n3744: `response_model`, converting any data as necessary to generate the\n3745: corresponding JSON. But if the data in the object returned is not\n3746: valid, that would mean a violation of the contract with the client,\n3747: so it's an error from the API developer. So, FastAPI will raise an\n3748: error and return a 500 error code (Internal Server Error).\n3749: \n3750: Read more about it in the\n3751: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n3752: \"\"\"\n3753: ),\n3754: ] = Default(None),\n3755: status_code: Annotated[\n3756: Optional[int],\n3757: Doc(\n3758: \"\"\"\n3759: The default status code to be used for the response.\n3760: \n3761: You could override the status code by returning a response directly.\n3762: \n3763: Read more about it in the\n3764: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n3765: \"\"\"\n3766: ),\n3767: ] = None,\n3768: tags: Annotated[\n3769: Optional[List[Union[str, Enum]]],\n3770: Doc(\n3771: \"\"\"\n3772: A list of tags to be applied to the *path operation*.\n3773: \n3774: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3775: \n3776: Read more about it in the\n3777: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n3778: \"\"\"\n3779: ),\n3780: ] = None,\n3781: dependencies: Annotated[\n3782: Optional[Sequence[Depends]],\n3783: Doc(\n3784: \"\"\"\n3785: A list of dependencies (using `Depends()`) to be applied to the\n3786: *path operation*.\n3787: \n3788: Read more about it in the\n3789: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n3790: \"\"\"\n3791: ),\n3792: ] = None,\n3793: summary: Annotated[\n3794: Optional[str],\n3795: Doc(\n3796: \"\"\"\n3797: A summary for the *path operation*.\n3798: \n3799: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3800: \n3801: Read more about it in the\n3802: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3803: \"\"\"\n3804: ),\n3805: ] = None,\n3806: description: Annotated[\n3807: Optional[str],\n3808: Doc(\n3809: \"\"\"\n3810: A description for the *path operation*.\n3811: \n3812: If not provided, it will be extracted automatically from the docstring\n3813: of the *path operation function*.\n3814: \n3815: It can contain Markdown.\n3816: \n3817: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3818: \n3819: Read more about it in the\n3820: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3821: \"\"\"\n3822: ),\n3823: ] = None,\n3824: response_description: Annotated[\n3825: str,\n3826: Doc(\n3827: \"\"\"\n3828: The description for the default response.\n3829: \n3830: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3831: \"\"\"\n3832: ),\n3833: ] = \"Successful Response\",\n3834: responses: Annotated[\n3835: Optional[Dict[Union[int, str], Dict[str, Any]]],\n3836: Doc(\n3837: \"\"\"\n3838: Additional responses that could be returned by this *path operation*.\n3839: \n3840: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3841: \"\"\"\n3842: ),\n3843: ] = None,\n3844: deprecated: Annotated[\n3845: Optional[bool],\n3846: Doc(\n3847: \"\"\"\n3848: Mark this *path operation* as deprecated.\n3849: \n3850: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3851: \"\"\"\n3852: ),\n3853: ] = None,\n3854: operation_id: Annotated[\n3855: Optional[str],\n3856: Doc(\n3857: \"\"\"\n3858: Custom operation ID to be used by this *path operation*.\n3859: \n3860: By default, it is generated automatically.\n3861: \n3862: If you provide a custom operation ID, you need to make sure it is\n3863: unique for the whole API.\n3864: \n3865: You can customize the\n3866: operation ID generation with the parameter\n3867: `generate_unique_id_function` in the `FastAPI` class.\n3868: \n3869: Read more about it in the\n3870: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3871: \"\"\"\n3872: ),\n3873: ] = None,\n3874: response_model_include: Annotated[\n3875: Optional[IncEx],\n3876: Doc(\n3877: \"\"\"\n3878: Configuration passed to Pydantic to include only certain fields in the\n3879: response data.\n3880: \n3881: Read more about it in the\n3882: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3883: \"\"\"\n3884: ),\n3885: ] = None,\n3886: response_model_exclude: Annotated[\n3887: Optional[IncEx],\n3888: Doc(\n3889: \"\"\"\n3890: Configuration passed to Pydantic to exclude certain fields in the\n3891: response data.\n3892: \n3893: Read more about it in the\n3894: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3895: \"\"\"\n3896: ),\n3897: ] = None,\n3898: response_model_by_alias: Annotated[\n3899: bool,\n3900: Doc(\n3901: \"\"\"\n3902: Configuration passed to Pydantic to define if the response model\n3903: should be serialized by alias when an alias is used.\n3904: \n3905: Read more about it in the\n3906: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3907: \"\"\"\n3908: ),\n3909: ] = True,\n3910: response_model_exclude_unset: Annotated[\n3911: bool,\n3912: Doc(\n3913: \"\"\"\n3914: Configuration passed to Pydantic to define if the response data\n3915: should have all the fields, including the ones that were not set and\n3916: have their default values. This is different from\n3917: `response_model_exclude_defaults` in that if the fields are set,\n3918: they will be included in the response, even if the value is the same\n3919: as the default.\n3920: \n3921: When `True`, default values are omitted from the response.\n3922: \n3923: Read more about it in the\n3924: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3925: \"\"\"\n3926: ),\n3927: ] = False,\n3928: response_model_exclude_defaults: Annotated[\n3929: bool,\n3930: Doc(\n3931: \"\"\"\n3932: Configuration passed to Pydantic to define if the response data\n3933: should have all the fields, including the ones that have the same value\n3934: as the default. This is different from `response_model_exclude_unset`\n3935: in that if the fields are set but contain the same default values,\n3936: they will be excluded from the response.\n3937: \n3938: When `True`, default values are omitted from the response.\n3939: \n3940: Read more about it in the\n3941: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3942: \"\"\"\n3943: ),\n3944: ] = False,\n3945: response_model_exclude_none: Annotated[\n3946: bool,\n3947: Doc(\n3948: \"\"\"\n3949: Configuration passed to Pydantic to define if the response data should\n3950: exclude fields set to `None`.\n3951: \n3952: This is much simpler (less smart) than `response_model_exclude_unset`\n3953: and `response_model_exclude_defaults`. You probably want to use one of\n3954: those two instead of this one, as those allow returning `None` values\n3955: when it makes sense.\n3956: \n3957: Read more about it in the\n3958: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n3959: \"\"\"\n3960: ),\n3961: ] = False,\n3962: include_in_schema: Annotated[\n3963: bool,\n3964: Doc(\n3965: \"\"\"\n3966: Include this *path operation* in the generated OpenAPI schema.\n3967: \n3968: This affects the generated OpenAPI (e.g. visible at `/docs`).\n3969: \n3970: Read more about it in the\n3971: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n3972: \"\"\"\n3973: ),\n3974: ] = True,\n3975: response_class: Annotated[\n3976: Type[Response],\n3977: Doc(\n3978: \"\"\"\n3979: Response class to be used for this *path operation*.\n3980: \n3981: This will not be used if you return a response directly.\n3982: \n3983: Read more about it in the\n3984: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n3985: \"\"\"\n3986: ),\n3987: ] = Default(JSONResponse),\n3988: name: Annotated[\n3989: Optional[str],\n3990: Doc(\n3991: \"\"\"\n3992: Name for this *path operation*. Only used internally.\n3993: \"\"\"\n3994: ),\n3995: ] = None,\n3996: callbacks: Annotated[\n3997: Optional[List[BaseRoute]],\n3998: Doc(\n3999: \"\"\"\n4000: List of *path operations* that will be used as OpenAPI callbacks.\n4001: \n4002: This is only for OpenAPI documentation, the callbacks won't be used\n4003: directly.\n4004: \n4005: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4006: \n4007: Read more about it in the\n4008: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n4009: \"\"\"\n4010: ),\n4011: ] = None,\n4012: openapi_extra: Annotated[\n4013: Optional[Dict[str, Any]],\n4014: Doc(\n4015: \"\"\"\n4016: Extra metadata to be included in the OpenAPI schema for this *path\n4017: operation*.\n4018: \n4019: Read more about it in the\n4020: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n4021: \"\"\"\n4022: ),\n4023: ] = None,\n4024: generate_unique_id_function: Annotated[\n4025: Callable[[routing.APIRoute], str],\n4026: Doc(\n4027: \"\"\"\n4028: Customize the function used to generate unique IDs for the *path\n4029: operations* shown in the generated OpenAPI.\n4030: \n4031: This is particularly useful when automatically generating clients or\n4032: SDKs for your API.\n4033: \n4034: Read more about it in the\n4035: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n4036: \"\"\"\n4037: ),\n4038: ] = Default(generate_unique_id),\n4039: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4040: \"\"\"\n4041: Add a *path operation* using an HTTP PATCH operation.\n4042: \n4043: ## Example\n4044: \n4045: ```python\n4046: from fastapi import FastAPI\n4047: from pydantic import BaseModel\n4048: \n4049: class Item(BaseModel):\n4050: name: str\n4051: description: str | None = None\n4052: \n4053: app = FastAPI()\n4054: \n4055: @app.patch(\"/items/\")\n4056: def update_item(item: Item):\n4057: return {\"message\": \"Item updated in place\"}\n4058: ```\n4059: \"\"\"\n4060: return self.router.patch(\n4061: path,\n4062: response_model=response_model,\n4063: status_code=status_code,\n4064: tags=tags,\n4065: dependencies=dependencies,\n4066: summary=summary,\n4067: description=description,\n4068: response_description=response_description,\n4069: responses=responses,\n4070: deprecated=deprecated,\n4071: operation_id=operation_id,\n4072: response_model_include=response_model_include,\n4073: response_model_exclude=response_model_exclude,\n4074: response_model_by_alias=response_model_by_alias,\n4075: response_model_exclude_unset=response_model_exclude_unset,\n4076: response_model_exclude_defaults=response_model_exclude_defaults,\n4077: response_model_exclude_none=response_model_exclude_none,\n4078: include_in_schema=include_in_schema,\n4079: response_class=response_class,\n4080: name=name,\n4081: callbacks=callbacks,\n4082: openapi_extra=openapi_extra,\n4083: generate_unique_id_function=generate_unique_id_function,\n4084: )\n4085: \n4086: def trace(\n4087: self,\n4088: path: Annotated[\n4089: str,\n4090: Doc(\n4091: \"\"\"\n4092: The URL path to be used for this *path operation*.\n4093: \n4094: For example, in `http://example.com/items`, the path is `/items`.\n4095: \"\"\"\n4096: ),\n4097: ],\n4098: *,\n4099: response_model: Annotated[\n4100: Any,\n4101: Doc(\n4102: \"\"\"\n4103: The type to use for the response.\n4104: \n4105: It could be any valid Pydantic *field* type. So, it doesn't have to\n4106: be a Pydantic model, it could be other things, like a `list`, `dict`,\n4107: etc.\n4108: \n4109: It will be used for:\n4110: \n4111: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n4112: show it as the response (JSON Schema).\n4113: * Serialization: you could return an arbitrary object and the\n4114: `response_model` would be used to serialize that object into the\n4115: corresponding JSON.\n4116: * Filtering: the JSON sent to the client will only contain the data\n4117: (fields) defined in the `response_model`. If you returned an object\n4118: that contains an attribute `password` but the `response_model` does\n4119: not include that field, the JSON sent to the client would not have\n4120: that `password`.\n4121: * Validation: whatever you return will be serialized with the\n4122: `response_model`, converting any data as necessary to generate the\n4123: corresponding JSON. But if the data in the object returned is not\n4124: valid, that would mean a violation of the contract with the client,\n4125: so it's an error from the API developer. So, FastAPI will raise an\n4126: error and return a 500 error code (Internal Server Error).\n4127: \n4128: Read more about it in the\n4129: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n4130: \"\"\"\n4131: ),\n4132: ] = Default(None),\n4133: status_code: Annotated[\n4134: Optional[int],\n4135: Doc(\n4136: \"\"\"\n4137: The default status code to be used for the response.\n4138: \n4139: You could override the status code by returning a response directly.\n4140: \n4141: Read more about it in the\n4142: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n4143: \"\"\"\n4144: ),\n4145: ] = None,\n4146: tags: Annotated[\n4147: Optional[List[Union[str, Enum]]],\n4148: Doc(\n4149: \"\"\"\n4150: A list of tags to be applied to the *path operation*.\n4151: \n4152: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4153: \n4154: Read more about it in the\n4155: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n4156: \"\"\"\n4157: ),\n4158: ] = None,\n4159: dependencies: Annotated[\n4160: Optional[Sequence[Depends]],\n4161: Doc(\n4162: \"\"\"\n4163: A list of dependencies (using `Depends()`) to be applied to the\n4164: *path operation*.\n4165: \n4166: Read more about it in the\n4167: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n4168: \"\"\"\n4169: ),\n4170: ] = None,\n4171: summary: Annotated[\n4172: Optional[str],\n4173: Doc(\n4174: \"\"\"\n4175: A summary for the *path operation*.\n4176: \n4177: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4178: \n4179: Read more about it in the\n4180: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n4181: \"\"\"\n4182: ),\n4183: ] = None,\n4184: description: Annotated[\n4185: Optional[str],\n4186: Doc(\n4187: \"\"\"\n4188: A description for the *path operation*.\n4189: \n4190: If not provided, it will be extracted automatically from the docstring\n4191: of the *path operation function*.\n4192: \n4193: It can contain Markdown.\n4194: \n4195: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4196: \n4197: Read more about it in the\n4198: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n4199: \"\"\"\n4200: ),\n4201: ] = None,\n4202: response_description: Annotated[\n4203: str,\n4204: Doc(\n4205: \"\"\"\n4206: The description for the default response.\n4207: \n4208: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4209: \"\"\"\n4210: ),\n4211: ] = \"Successful Response\",\n4212: responses: Annotated[\n4213: Optional[Dict[Union[int, str], Dict[str, Any]]],\n4214: Doc(\n4215: \"\"\"\n4216: Additional responses that could be returned by this *path operation*.\n4217: \n4218: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4219: \"\"\"\n4220: ),\n4221: ] = None,\n4222: deprecated: Annotated[\n4223: Optional[bool],\n4224: Doc(\n4225: \"\"\"\n4226: Mark this *path operation* as deprecated.\n4227: \n4228: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4229: \"\"\"\n4230: ),\n4231: ] = None,\n4232: operation_id: Annotated[\n4233: Optional[str],\n4234: Doc(\n4235: \"\"\"\n4236: Custom operation ID to be used by this *path operation*.\n4237: \n4238: By default, it is generated automatically.\n4239: \n4240: If you provide a custom operation ID, you need to make sure it is\n4241: unique for the whole API.\n4242: \n4243: You can customize the\n4244: operation ID generation with the parameter\n4245: `generate_unique_id_function` in the `FastAPI` class.\n4246: \n4247: Read more about it in the\n4248: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n4249: \"\"\"\n4250: ),\n4251: ] = None,\n4252: response_model_include: Annotated[\n4253: Optional[IncEx],\n4254: Doc(\n4255: \"\"\"\n4256: Configuration passed to Pydantic to include only certain fields in the\n4257: response data.\n4258: \n4259: Read more about it in the\n4260: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n4261: \"\"\"\n4262: ),\n4263: ] = None,\n4264: response_model_exclude: Annotated[\n4265: Optional[IncEx],\n4266: Doc(\n4267: \"\"\"\n4268: Configuration passed to Pydantic to exclude certain fields in the\n4269: response data.\n4270: \n4271: Read more about it in the\n4272: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n4273: \"\"\"\n4274: ),\n4275: ] = None,\n4276: response_model_by_alias: Annotated[\n4277: bool,\n4278: Doc(\n4279: \"\"\"\n4280: Configuration passed to Pydantic to define if the response model\n4281: should be serialized by alias when an alias is used.\n4282: \n4283: Read more about it in the\n4284: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n4285: \"\"\"\n4286: ),\n4287: ] = True,\n4288: response_model_exclude_unset: Annotated[\n4289: bool,\n4290: Doc(\n4291: \"\"\"\n4292: Configuration passed to Pydantic to define if the response data\n4293: should have all the fields, including the ones that were not set and\n4294: have their default values. This is different from\n4295: `response_model_exclude_defaults` in that if the fields are set,\n4296: they will be included in the response, even if the value is the same\n4297: as the default.\n4298: \n4299: When `True`, default values are omitted from the response.\n4300: \n4301: Read more about it in the\n4302: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n4303: \"\"\"\n4304: ),\n4305: ] = False,\n4306: response_model_exclude_defaults: Annotated[\n4307: bool,\n4308: Doc(\n4309: \"\"\"\n4310: Configuration passed to Pydantic to define if the response data\n4311: should have all the fields, including the ones that have the same value\n4312: as the default. This is different from `response_model_exclude_unset`\n4313: in that if the fields are set but contain the same default values,\n4314: they will be excluded from the response.\n4315: \n4316: When `True`, default values are omitted from the response.\n4317: \n4318: Read more about it in the\n4319: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n4320: \"\"\"\n4321: ),\n4322: ] = False,\n4323: response_model_exclude_none: Annotated[\n4324: bool,\n4325: Doc(\n4326: \"\"\"\n4327: Configuration passed to Pydantic to define if the response data should\n4328: exclude fields set to `None`.\n4329: \n4330: This is much simpler (less smart) than `response_model_exclude_unset`\n4331: and `response_model_exclude_defaults`. You probably want to use one of\n4332: those two instead of this one, as those allow returning `None` values\n4333: when it makes sense.\n4334: \n4335: Read more about it in the\n4336: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n4337: \"\"\"\n4338: ),\n4339: ] = False,\n4340: include_in_schema: Annotated[\n4341: bool,\n4342: Doc(\n4343: \"\"\"\n4344: Include this *path operation* in the generated OpenAPI schema.\n4345: \n4346: This affects the generated OpenAPI (e.g. visible at `/docs`).\n4347: \n4348: Read more about it in the\n4349: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n4350: \"\"\"\n4351: ),\n4352: ] = True,\n4353: response_class: Annotated[\n4354: Type[Response],\n4355: Doc(\n4356: \"\"\"\n4357: Response class to be used for this *path operation*.\n4358: \n4359: This will not be used if you return a response directly.\n4360: \n4361: Read more about it in the\n4362: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n4363: \"\"\"\n4364: ),\n4365: ] = Default(JSONResponse),\n4366: name: Annotated[\n4367: Optional[str],\n4368: Doc(\n4369: \"\"\"\n4370: Name for this *path operation*. Only used internally.\n4371: \"\"\"\n4372: ),\n4373: ] = None,\n4374: callbacks: Annotated[\n4375: Optional[List[BaseRoute]],\n4376: Doc(\n4377: \"\"\"\n4378: List of *path operations* that will be used as OpenAPI callbacks.\n4379: \n4380: This is only for OpenAPI documentation, the callbacks won't be used\n4381: directly.\n4382: \n4383: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4384: \n4385: Read more about it in the\n4386: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n4387: \"\"\"\n4388: ),\n4389: ] = None,\n4390: openapi_extra: Annotated[\n4391: Optional[Dict[str, Any]],\n4392: Doc(\n4393: \"\"\"\n4394: Extra metadata to be included in the OpenAPI schema for this *path\n4395: operation*.\n4396: \n4397: Read more about it in the\n4398: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n4399: \"\"\"\n4400: ),\n4401: ] = None,\n4402: generate_unique_id_function: Annotated[\n4403: Callable[[routing.APIRoute], str],\n4404: Doc(\n4405: \"\"\"\n4406: Customize the function used to generate unique IDs for the *path\n4407: operations* shown in the generated OpenAPI.\n4408: \n4409: This is particularly useful when automatically generating clients or\n4410: SDKs for your API.\n4411: \n4412: Read more about it in the\n4413: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n4414: \"\"\"\n4415: ),\n4416: ] = Default(generate_unique_id),\n4417: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4418: \"\"\"\n4419: Add a *path operation* using an HTTP TRACE operation.\n4420: \n4421: ## Example\n4422: \n4423: ```python\n4424: from fastapi import FastAPI\n4425: \n4426: app = FastAPI()\n4427: \n4428: @app.put(\"/items/{item_id}\")\n4429: def trace_item(item_id: str):\n4430: return None\n4431: ```\n4432: \"\"\"\n4433: return self.router.trace(\n4434: path,\n4435: response_model=response_model,\n4436: status_code=status_code,\n4437: tags=tags,\n4438: dependencies=dependencies,\n4439: summary=summary,\n4440: description=description,\n4441: response_description=response_description,\n4442: responses=responses,\n4443: deprecated=deprecated,\n4444: operation_id=operation_id,\n4445: response_model_include=response_model_include,\n4446: response_model_exclude=response_model_exclude,\n4447: response_model_by_alias=response_model_by_alias,\n4448: response_model_exclude_unset=response_model_exclude_unset,\n4449: response_model_exclude_defaults=response_model_exclude_defaults,\n4450: response_model_exclude_none=response_model_exclude_none,\n4451: include_in_schema=include_in_schema,\n4452: response_class=response_class,\n4453: name=name,\n4454: callbacks=callbacks,\n4455: openapi_extra=openapi_extra,\n4456: generate_unique_id_function=generate_unique_id_function,\n4457: )\n4458: \n4459: def websocket_route(\n4460: self, path: str, name: Union[str, None] = None\n4461: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4462: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n4463: self.router.add_websocket_route(path, func, name=name)\n4464: return func\n4465: \n4466: return decorator\n4467: \n4468: @deprecated(\n4469: \"\"\"\n4470: on_event is deprecated, use lifespan event handlers instead.\n4471: \n4472: Read more about it in the\n4473: [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n4474: \"\"\"\n4475: )\n4476: def on_event(\n4477: self,\n4478: event_type: Annotated[\n4479: str,\n4480: Doc(\n4481: \"\"\"\n4482: The type of event. `startup` or `shutdown`.\n4483: \"\"\"\n4484: ),\n4485: ],\n4486: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4487: \"\"\"\n4488: Add an event handler for the application.\n4489: \n4490: `on_event` is deprecated, use `lifespan` event handlers instead.\n4491: \n4492: Read more about it in the\n4493: [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n4494: \"\"\"\n4495: return self.router.on_event(event_type)\n4496: \n4497: def middleware(\n4498: self,\n4499: middleware_type: Annotated[\n4500: str,\n4501: Doc(\n4502: \"\"\"\n4503: The type of middleware. Currently only supports `http`.\n4504: \"\"\"\n4505: ),\n4506: ],\n4507: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4508: \"\"\"\n4509: Add a middleware to the application.\n4510: \n4511: Read more about it in the\n4512: [FastAPI docs for Middleware](https://fastapi.tiangolo.com/tutorial/middleware/).\n4513: \n4514: ## Example\n4515: \n4516: ```python\n4517: import time\n4518: \n4519: from fastapi import FastAPI, Request\n4520: \n4521: app = FastAPI()\n4522: \n4523: \n4524: @app.middleware(\"http\")\n4525: async def add_process_time_header(request: Request, call_next):\n4526: start_time = time.time()\n4527: response = await call_next(request)\n4528: process_time = time.time() - start_time\n4529: response.headers[\"X-Process-Time\"] = str(process_time)\n4530: return response\n4531: ```\n4532: \"\"\"\n4533: \n4534: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n4535: self.add_middleware(BaseHTTPMiddleware, dispatch=func)\n4536: return func\n4537: \n4538: return decorator\n4539: \n4540: def exception_handler(\n4541: self,\n4542: exc_class_or_status_code: Annotated[\n4543: Union[int, Type[Exception]],\n4544: Doc(\n4545: \"\"\"\n4546: The Exception class this would handle, or a status code.\n4547: \"\"\"\n4548: ),\n4549: ],\n4550: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4551: \"\"\"\n4552: Add an exception handler to the app.\n4553: \n4554: Read more about it in the\n4555: [FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/).\n4556: \n4557: ## Example\n4558: \n4559: ```python\n4560: from fastapi import FastAPI, Request\n4561: from fastapi.responses import JSONResponse\n4562: \n4563: \n4564: class UnicornException(Exception):\n4565: def __init__(self, name: str):\n4566: self.name = name\n4567: \n4568: \n4569: app = FastAPI()\n4570: \n4571: \n4572: @app.exception_handler(UnicornException)\n4573: async def unicorn_exception_handler(request: Request, exc: UnicornException):\n4574: return JSONResponse(\n4575: status_code=418,\n4576: content={\"message\": f\"Oops! {exc.name} did something. There goes a rainbow...\"},\n4577: )\n4578: ```\n4579: \"\"\"\n4580: \n4581: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n4582: self.add_exception_handler(exc_class_or_status_code, func)\n4583: return func\n4584: \n4585: return decorator\n4586: \n\nfastapi/routing.py: \n\n1: import asyncio\n2: import dataclasses\n3: import email.message\n4: import inspect\n5: import json\n6: from contextlib import AsyncExitStack, asynccontextmanager\n7: from enum import Enum, IntEnum\n8: from typing import (\n9: Any,\n10: AsyncIterator,\n11: Callable,\n12: Coroutine,\n13: Dict,\n14: List,\n15: Mapping,\n16: Optional,\n17: Sequence,\n18: Set,\n19: Tuple,\n20: Type,\n21: Union,\n22: )\n23: \n24: from fastapi import params\n25: from fastapi._compat import (\n26: ModelField,\n27: Undefined,\n28: _get_model_config,\n29: _model_dump,\n30: _normalize_errors,\n31: lenient_issubclass,\n32: )\n33: from fastapi.datastructures import Default, DefaultPlaceholder\n34: from fastapi.dependencies.models import Dependant\n35: from fastapi.dependencies.utils import (\n36: _should_embed_body_fields,\n37: get_body_field,\n38: get_dependant,\n39: get_flat_dependant,\n40: get_parameterless_sub_dependant,\n41: get_typed_return_annotation,\n42: solve_dependencies,\n43: )\n44: from fastapi.encoders import jsonable_encoder\n45: from fastapi.exceptions import (\n46: FastAPIError,\n47: RequestValidationError,\n48: ResponseValidationError,\n49: WebSocketRequestValidationError,\n50: )\n51: from fastapi.types import DecoratedCallable, IncEx\n52: from fastapi.utils import (\n53: create_cloned_field,\n54: create_model_field,\n55: generate_unique_id,\n56: get_value_or_default,\n57: is_body_allowed_for_status_code,\n58: )\n59: from pydantic import BaseModel\n60: from starlette import routing\n61: from starlette.concurrency import run_in_threadpool\n62: from starlette.exceptions import HTTPException\n63: from starlette.requests import Request\n64: from starlette.responses import JSONResponse, Response\n65: from starlette.routing import (\n66: BaseRoute,\n67: Match,\n68: compile_path,\n69: get_name,\n70: request_response,\n71: websocket_session,\n72: )\n73: from starlette.routing import Mount as Mount # noqa\n74: from starlette.types import AppType, ASGIApp, Lifespan, Scope\n75: from starlette.websockets import WebSocket\n76: from typing_extensions import Annotated, Doc, deprecated\n77: \n78: \n79: def _prepare_response_content(\n80: res: Any,\n81: *,\n82: exclude_unset: bool,\n83: exclude_defaults: bool = False,\n84: exclude_none: bool = False,\n85: ) -> Any:\n86: if isinstance(res, BaseModel):\n87: read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n88: if read_with_orm_mode:\n89: # Let from_orm extract the data from this model instead of converting\n90: # it now to a dict.\n91: # Otherwise, there's no way to extract lazy data that requires attribute\n92: # access instead of dict iteration, e.g. lazy relationships.\n93: return res\n94: return _model_dump(\n95: res,\n96: by_alias=True,\n97: exclude_unset=exclude_unset,\n98: exclude_defaults=exclude_defaults,\n99: exclude_none=exclude_none,\n100: )\n101: elif isinstance(res, list):\n102: return [\n103: _prepare_response_content(\n104: item,\n105: exclude_unset=exclude_unset,\n106: exclude_defaults=exclude_defaults,\n107: exclude_none=exclude_none,\n108: )\n109: for item in res\n110: ]\n111: elif isinstance(res, dict):\n112: return {\n113: k: _prepare_response_content(\n114: v,\n115: exclude_unset=exclude_unset,\n116: exclude_defaults=exclude_defaults,\n117: exclude_none=exclude_none,\n118: )\n119: for k, v in res.items()\n120: }\n121: elif dataclasses.is_dataclass(res):\n122: return dataclasses.asdict(res)\n123: return res\n124: \n125: \n126: def _merge_lifespan_context(\n127: original_context: Lifespan[Any], nested_context: Lifespan[Any]\n128: ) -> Lifespan[Any]:\n129: @asynccontextmanager\n130: async def merged_lifespan(\n131: app: AppType,\n132: ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n133: async with original_context(app) as maybe_original_state:\n134: async with nested_context(app) as maybe_nested_state:\n135: if maybe_nested_state is None and maybe_original_state is None:\n136: yield None # old ASGI compatibility\n137: else:\n138: yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n139: \n140: return merged_lifespan # type: ignore[return-value]\n141: \n142: \n143: async def serialize_response(\n144: *,\n145: field: Optional[ModelField] = None,\n146: response_content: Any,\n147: include: Optional[IncEx] = None,\n148: exclude: Optional[IncEx] = None,\n149: by_alias: bool = True,\n150: exclude_unset: bool = False,\n151: exclude_defaults: bool = False,\n152: exclude_none: bool = False,\n153: is_coroutine: bool = True,\n154: ) -> Any:\n155: if field:\n156: errors = []\n157: if not hasattr(field, \"serialize\"):\n158: # pydantic v1\n159: response_content = _prepare_response_content(\n160: response_content,\n161: exclude_unset=exclude_unset,\n162: exclude_defaults=exclude_defaults,\n163: exclude_none=exclude_none,\n164: )\n165: if is_coroutine:\n166: value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n167: else:\n168: value, errors_ = await run_in_threadpool(\n169: field.validate, response_content, {}, loc=(\"response\",)\n170: )\n171: if isinstance(errors_, list):\n172: errors.extend(errors_)\n173: elif errors_:\n174: errors.append(errors_)\n175: if errors:\n176: raise ResponseValidationError(\n177: errors=_normalize_errors(errors), body=response_content\n178: )\n179: \n180: if hasattr(field, \"serialize\"):\n181: return field.serialize(\n182: value,\n183: include=include,\n184: exclude=exclude,\n185: by_alias=by_alias,\n186: exclude_unset=exclude_unset,\n187: exclude_defaults=exclude_defaults,\n188: exclude_none=exclude_none,\n189: )\n190: \n191: return jsonable_encoder(\n192: value,\n193: include=include,\n194: exclude=exclude,\n195: by_alias=by_alias,\n196: exclude_unset=exclude_unset,\n197: exclude_defaults=exclude_defaults,\n198: exclude_none=exclude_none,\n199: )\n200: else:\n201: return jsonable_encoder(response_content)\n202: \n203: \n204: async def run_endpoint_function(\n205: *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n206: ) -> Any:\n207: # Only called by get_request_handler. Has been split into its own function to\n208: # facilitate profiling endpoints, since inner functions are harder to profile.\n209: assert dependant.call is not None, \"dependant.call must be a function\"\n210: \n211: if is_coroutine:\n212: return await dependant.call(**values)\n213: else:\n214: return await run_in_threadpool(dependant.call, **values)\n215: \n216: \n217: def get_request_handler(\n218: dependant: Dependant,\n219: body_field: Optional[ModelField] = None,\n220: status_code: Optional[int] = None,\n221: response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n222: response_field: Optional[ModelField] = None,\n223: response_model_include: Optional[IncEx] = None,\n224: response_model_exclude: Optional[IncEx] = None,\n225: response_model_by_alias: bool = True,\n226: response_model_exclude_unset: bool = False,\n227: response_model_exclude_defaults: bool = False,\n228: response_model_exclude_none: bool = False,\n229: dependency_overrides_provider: Optional[Any] = None,\n230: embed_body_fields: bool = False,\n231: ) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n232: assert dependant.call is not None, \"dependant.call must be a function\"\n233: is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n234: is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n235: if isinstance(response_class, DefaultPlaceholder):\n236: actual_response_class: Type[Response] = response_class.value\n237: else:\n238: actual_response_class = response_class\n239: \n240: async def app(request: Request) -> Response:\n241: response: Union[Response, None] = None\n242: async with AsyncExitStack() as file_stack:\n243: try:\n244: body: Any = None\n245: if body_field:\n246: if is_body_form:\n247: body = await request.form()\n248: file_stack.push_async_callback(body.close)\n249: else:\n250: body_bytes = await request.body()\n251: if body_bytes:\n252: json_body: Any = Undefined\n253: content_type_value = request.headers.get(\"content-type\")\n254: if not content_type_value:\n255: json_body = await request.json()\n256: else:\n257: message = email.message.Message()\n258: message[\"content-type\"] = content_type_value\n259: if message.get_content_maintype() == \"application\":\n260: subtype = message.get_content_subtype()\n261: if subtype == \"json\" or subtype.endswith(\"+json\"):\n262: json_body = await request.json()\n263: if json_body != Undefined:\n264: body = json_body\n265: else:\n266: body = body_bytes\n267: except json.JSONDecodeError as e:\n268: validation_error = RequestValidationError(\n269: [\n270: {\n271: \"type\": \"json_invalid\",\n272: \"loc\": (\"body\", e.pos),\n273: \"msg\": \"JSON decode error\",\n274: \"input\": {},\n275: \"ctx\": {\"error\": e.msg},\n276: }\n277: ],\n278: body=e.doc,\n279: )\n280: raise validation_error from e\n281: except HTTPException:\n282: # If a middleware raises an HTTPException, it should be raised again\n283: raise\n284: except Exception as e:\n285: http_error = HTTPException(\n286: status_code=400, detail=\"There was an error parsing the body\"\n287: )\n288: raise http_error from e\n289: errors: List[Any] = []\n290: async with AsyncExitStack() as async_exit_stack:\n291: solved_result = await solve_dependencies(\n292: request=request,\n293: dependant=dependant,\n294: body=body,\n295: dependency_overrides_provider=dependency_overrides_provider,\n296: async_exit_stack=async_exit_stack,\n297: embed_body_fields=embed_body_fields,\n298: )\n299: errors = solved_result.errors\n300: if not errors:\n301: raw_response = await run_endpoint_function(\n302: dependant=dependant,\n303: values=solved_result.values,\n304: is_coroutine=is_coroutine,\n305: )\n306: if isinstance(raw_response, Response):\n307: if raw_response.background is None:\n308: raw_response.background = solved_result.background_tasks\n309: response = raw_response\n310: else:\n311: response_args: Dict[str, Any] = {\n312: \"background\": solved_result.background_tasks\n313: }\n314: # If status_code was set, use it, otherwise use the default from the\n315: # response class, in the case of redirect it's 307\n316: current_status_code = (\n317: status_code\n318: if status_code\n319: else solved_result.response.status_code\n320: )\n321: if current_status_code is not None:\n322: response_args[\"status_code\"] = current_status_code\n323: if solved_result.response.status_code:\n324: response_args[\"status_code\"] = (\n325: solved_result.response.status_code\n326: )\n327: content = await serialize_response(\n328: field=response_field,\n329: response_content=raw_response,\n330: include=response_model_include,\n331: exclude=response_model_exclude,\n332: by_alias=response_model_by_alias,\n333: exclude_unset=response_model_exclude_unset,\n334: exclude_defaults=response_model_exclude_defaults,\n335: exclude_none=response_model_exclude_none,\n336: is_coroutine=is_coroutine,\n337: )\n338: response = actual_response_class(content, **response_args)\n339: if not is_body_allowed_for_status_code(response.status_code):\n340: response.body = b\"\"\n341: response.headers.raw.extend(solved_result.response.headers.raw)\n342: if errors:\n343: validation_error = RequestValidationError(\n344: _normalize_errors(errors), body=body\n345: )\n346: raise validation_error\n347: if response is None:\n348: raise FastAPIError(\n349: \"No response object was returned. There's a high chance that the \"\n350: \"application code is raising an exception and a dependency with yield \"\n351: \"has a block with a bare except, or a block with except Exception, \"\n352: \"and is not raising the exception again. Read more about it in the \"\n353: \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n354: )\n355: return response\n356: \n357: return app\n358: \n359: \n360: def get_websocket_app(\n361: dependant: Dependant,\n362: dependency_overrides_provider: Optional[Any] = None,\n363: embed_body_fields: bool = False,\n364: ) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n365: async def app(websocket: WebSocket) -> None:\n366: async with AsyncExitStack() as async_exit_stack:\n367: # TODO: remove this scope later, after a few releases\n368: # This scope fastapi_astack is no longer used by FastAPI, kept for\n369: # compatibility, just in case\n370: websocket.scope[\"fastapi_astack\"] = async_exit_stack\n371: solved_result = await solve_dependencies(\n372: request=websocket,\n373: dependant=dependant,\n374: dependency_overrides_provider=dependency_overrides_provider,\n375: async_exit_stack=async_exit_stack,\n376: embed_body_fields=embed_body_fields,\n377: )\n378: if solved_result.errors:\n379: raise WebSocketRequestValidationError(\n380: _normalize_errors(solved_result.errors)\n381: )\n382: assert dependant.call is not None, \"dependant.call must be a function\"\n383: await dependant.call(**solved_result.values)\n384: \n385: return app\n386: \n387: \n388: class APIWebSocketRoute(routing.WebSocketRoute):\n389: def __init__(\n390: self,\n391: path: str,\n392: endpoint: Callable[..., Any],\n393: *,\n394: name: Optional[str] = None,\n395: dependencies: Optional[Sequence[params.Depends]] = None,\n396: dependency_overrides_provider: Optional[Any] = None,\n397: ) -> None:\n398: self.path = path\n399: self.endpoint = endpoint\n400: self.name = get_name(endpoint) if name is None else name\n401: self.dependencies = list(dependencies or [])\n402: self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n403: self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n404: for depends in self.dependencies[::-1]:\n405: self.dependant.dependencies.insert(\n406: 0,\n407: get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n408: )\n409: self._flat_dependant = get_flat_dependant(self.dependant)\n410: self._embed_body_fields = _should_embed_body_fields(\n411: self._flat_dependant.body_params\n412: )\n413: self.app = websocket_session(\n414: get_websocket_app(\n415: dependant=self.dependant,\n416: dependency_overrides_provider=dependency_overrides_provider,\n417: embed_body_fields=self._embed_body_fields,\n418: )\n419: )\n420: \n421: def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n422: match, child_scope = super().matches(scope)\n423: if match != Match.NONE:\n424: child_scope[\"route\"] = self\n425: return match, child_scope\n426: \n427: \n428: class APIRoute(routing.Route):\n429: def __init__(\n430: self,\n431: path: str,\n432: endpoint: Callable[..., Any],\n433: *,\n434: response_model: Any = Default(None),\n435: status_code: Optional[int] = None,\n436: tags: Optional[List[Union[str, Enum]]] = None,\n437: dependencies: Optional[Sequence[params.Depends]] = None,\n438: summary: Optional[str] = None,\n439: description: Optional[str] = None,\n440: response_description: str = \"Successful Response\",\n441: responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n442: deprecated: Optional[bool] = None,\n443: name: Optional[str] = None,\n444: methods: Optional[Union[Set[str], List[str]]] = None,\n445: operation_id: Optional[str] = None,\n446: response_model_include: Optional[IncEx] = None,\n447: response_model_exclude: Optional[IncEx] = None,\n448: response_model_by_alias: bool = True,\n449: response_model_exclude_unset: bool = False,\n450: response_model_exclude_defaults: bool = False,\n451: response_model_exclude_none: bool = False,\n452: include_in_schema: bool = True,\n453: response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n454: JSONResponse\n455: ),\n456: dependency_overrides_provider: Optional[Any] = None,\n457: callbacks: Optional[List[BaseRoute]] = None,\n458: openapi_extra: Optional[Dict[str, Any]] = None,\n459: generate_unique_id_function: Union[\n460: Callable[[\"APIRoute\"], str], DefaultPlaceholder\n461: ] = Default(generate_unique_id),\n462: ) -> None:\n463: self.path = path\n464: self.endpoint = endpoint\n465: if isinstance(response_model, DefaultPlaceholder):\n466: return_annotation = get_typed_return_annotation(endpoint)\n467: if lenient_issubclass(return_annotation, Response):\n468: response_model = None\n469: else:\n470: response_model = return_annotation\n471: self.response_model = response_model\n472: self.summary = summary\n473: self.response_description = response_description\n474: self.deprecated = deprecated\n475: self.operation_id = operation_id\n476: self.response_model_include = response_model_include\n477: self.response_model_exclude = response_model_exclude\n478: self.response_model_by_alias = response_model_by_alias\n479: self.response_model_exclude_unset = response_model_exclude_unset\n480: self.response_model_exclude_defaults = response_model_exclude_defaults\n481: self.response_model_exclude_none = response_model_exclude_none\n482: self.include_in_schema = include_in_schema\n483: self.response_class = response_class\n484: self.dependency_overrides_provider = dependency_overrides_provider\n485: self.callbacks = callbacks\n486: self.openapi_extra = openapi_extra\n487: self.generate_unique_id_function = generate_unique_id_function\n488: self.tags = tags or []\n489: self.responses = responses or {}\n490: self.name = get_name(endpoint) if name is None else name\n491: self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n492: if methods is None:\n493: methods = [\"GET\"]\n494: self.methods: Set[str] = {method.upper() for method in methods}\n495: if isinstance(generate_unique_id_function, DefaultPlaceholder):\n496: current_generate_unique_id: Callable[[APIRoute], str] = (\n497: generate_unique_id_function.value\n498: )\n499: else:\n500: current_generate_unique_id = generate_unique_id_function\n501: self.unique_id = self.operation_id or current_generate_unique_id(self)\n502: # normalize enums e.g. http.HTTPStatus\n503: if isinstance(status_code, IntEnum):\n504: status_code = int(status_code)\n505: self.status_code = status_code\n506: if self.response_model:\n507: assert is_body_allowed_for_status_code(status_code), (\n508: f\"Status code {status_code} must not have a response body\"\n509: )\n510: response_name = \"Response_\" + self.unique_id\n511: self.response_field = create_model_field(\n512: name=response_name,\n513: type_=self.response_model,\n514: mode=\"serialization\",\n515: )\n516: # Create a clone of the field, so that a Pydantic submodel is not returned\n517: # as is just because it's an instance of a subclass of a more limited class\n518: # e.g. UserInDB (containing hashed_password) could be a subclass of User\n519: # that doesn't have the hashed_password. But because it's a subclass, it\n520: # would pass the validation and be returned as is.\n521: # By being a new field, no inheritance will be passed as is. A new model\n522: # will always be created.\n523: # TODO: remove when deprecating Pydantic v1\n524: self.secure_cloned_response_field: Optional[ModelField] = (\n525: create_cloned_field(self.response_field)\n526: )\n527: else:\n528: self.response_field = None # type: ignore\n529: self.secure_cloned_response_field = None\n530: self.dependencies = list(dependencies or [])\n531: self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n532: # if a \"form feed\" character (page break) is found in the description text,\n533: # truncate description text to the content preceding the first \"form feed\"\n534: self.description = self.description.split(\"\\f\")[0].strip()\n535: response_fields = {}\n536: for additional_status_code, response in self.responses.items():\n537: assert isinstance(response, dict), \"An additional response must be a dict\"\n538: model = response.get(\"model\")\n539: if model:\n540: assert is_body_allowed_for_status_code(additional_status_code), (\n541: f\"Status code {additional_status_code} must not have a response body\"\n542: )\n543: response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n544: response_field = create_model_field(\n545: name=response_name, type_=model, mode=\"serialization\"\n546: )\n547: response_fields[additional_status_code] = response_field\n548: if response_fields:\n549: self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n550: else:\n551: self.response_fields = {}\n552: \n553: assert callable(endpoint), \"An endpoint must be a callable\"\n554: self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n555: for depends in self.dependencies[::-1]:\n556: self.dependant.dependencies.insert(\n557: 0,\n558: get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n559: )\n560: self._flat_dependant = get_flat_dependant(self.dependant)\n561: self._embed_body_fields = _should_embed_body_fields(\n562: self._flat_dependant.body_params\n563: )\n564: self.body_field = get_body_field(\n565: flat_dependant=self._flat_dependant,\n566: name=self.unique_id,\n567: embed_body_fields=self._embed_body_fields,\n568: )\n569: self.app = request_response(self.get_route_handler())\n570: \n571: def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n572: return get_request_handler(\n573: dependant=self.dependant,\n574: body_field=self.body_field,\n575: status_code=self.status_code,\n576: response_class=self.response_class,\n577: response_field=self.secure_cloned_response_field,\n578: response_model_include=self.response_model_include,\n579: response_model_exclude=self.response_model_exclude,\n580: response_model_by_alias=self.response_model_by_alias,\n581: response_model_exclude_unset=self.response_model_exclude_unset,\n582: response_model_exclude_defaults=self.response_model_exclude_defaults,\n583: response_model_exclude_none=self.response_model_exclude_none,\n584: dependency_overrides_provider=self.dependency_overrides_provider,\n585: embed_body_fields=self._embed_body_fields,\n586: )\n587: \n588: def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n589: match, child_scope = super().matches(scope)\n590: if match != Match.NONE:\n591: child_scope[\"route\"] = self\n592: return match, child_scope\n593: \n594: \n595: class APIRouter(routing.Router):\n596: \"\"\"\n597: `APIRouter` class, used to group *path operations*, for example to structure\n598: an app in multiple files. It would then be included in the `FastAPI` app, or\n599: in another `APIRouter` (ultimately included in the app).\n600: \n601: Read more about it in the\n602: [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n603: \n604: ## Example\n605: \n606: ```python\n607: from fastapi import APIRouter, FastAPI\n608: \n609: app = FastAPI()\n610: router = APIRouter()\n611: \n612: \n613: @router.get(\"/users/\", tags=[\"users\"])\n614: async def read_users():\n615: return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n616: \n617: \n618: app.include_router(router)\n619: ```\n620: \"\"\"\n621: \n622: def __init__(\n623: self,\n624: *,\n625: prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n626: tags: Annotated[\n627: Optional[List[Union[str, Enum]]],\n628: Doc(\n629: \"\"\"\n630: A list of tags to be applied to all the *path operations* in this\n631: router.\n632: \n633: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n634: \n635: Read more about it in the\n636: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n637: \"\"\"\n638: ),\n639: ] = None,\n640: dependencies: Annotated[\n641: Optional[Sequence[params.Depends]],\n642: Doc(\n643: \"\"\"\n644: A list of dependencies (using `Depends()`) to be applied to all the\n645: *path operations* in this router.\n646: \n647: Read more about it in the\n648: [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).\n649: \"\"\"\n650: ),\n651: ] = None,\n652: default_response_class: Annotated[\n653: Type[Response],\n654: Doc(\n655: \"\"\"\n656: The default response class to be used.\n657: \n658: Read more in the\n659: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n660: \"\"\"\n661: ),\n662: ] = Default(JSONResponse),\n663: responses: Annotated[\n664: Optional[Dict[Union[int, str], Dict[str, Any]]],\n665: Doc(\n666: \"\"\"\n667: Additional responses to be shown in OpenAPI.\n668: \n669: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n670: \n671: Read more about it in the\n672: [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n673: \n674: And in the\n675: [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n676: \"\"\"\n677: ),\n678: ] = None,\n679: callbacks: Annotated[\n680: Optional[List[BaseRoute]],\n681: Doc(\n682: \"\"\"\n683: OpenAPI callbacks that should apply to all *path operations* in this\n684: router.\n685: \n686: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n687: \n688: Read more about it in the\n689: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n690: \"\"\"\n691: ),\n692: ] = None,\n693: routes: Annotated[\n694: Optional[List[BaseRoute]],\n695: Doc(\n696: \"\"\"\n697: **Note**: you probably shouldn't use this parameter, it is inherited\n698: from Starlette and supported for compatibility.\n699: \n700: ---\n701: \n702: A list of routes to serve incoming HTTP and WebSocket requests.\n703: \"\"\"\n704: ),\n705: deprecated(\n706: \"\"\"\n707: You normally wouldn't use this parameter with FastAPI, it is inherited\n708: from Starlette and supported for compatibility.\n709: \n710: In FastAPI, you normally would use the *path operation methods*,\n711: like `router.get()`, `router.post()`, etc.\n712: \"\"\"\n713: ),\n714: ] = None,\n715: redirect_slashes: Annotated[\n716: bool,\n717: Doc(\n718: \"\"\"\n719: Whether to detect and redirect slashes in URLs when the client doesn't\n720: use the same format.\n721: \"\"\"\n722: ),\n723: ] = True,\n724: default: Annotated[\n725: Optional[ASGIApp],\n726: Doc(\n727: \"\"\"\n728: Default function handler for this router. Used to handle\n729: 404 Not Found errors.\n730: \"\"\"\n731: ),\n732: ] = None,\n733: dependency_overrides_provider: Annotated[\n734: Optional[Any],\n735: Doc(\n736: \"\"\"\n737: Only used internally by FastAPI to handle dependency overrides.\n738: \n739: You shouldn't need to use it. It normally points to the `FastAPI` app\n740: object.\n741: \"\"\"\n742: ),\n743: ] = None,\n744: route_class: Annotated[\n745: Type[APIRoute],\n746: Doc(\n747: \"\"\"\n748: Custom route (*path operation*) class to be used by this router.\n749: \n750: Read more about it in the\n751: [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n752: \"\"\"\n753: ),\n754: ] = APIRoute,\n755: on_startup: Annotated[\n756: Optional[Sequence[Callable[[], Any]]],\n757: Doc(\n758: \"\"\"\n759: A list of startup event handler functions.\n760: \n761: You should instead use the `lifespan` handlers.\n762: \n763: Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n764: \"\"\"\n765: ),\n766: ] = None,\n767: on_shutdown: Annotated[\n768: Optional[Sequence[Callable[[], Any]]],\n769: Doc(\n770: \"\"\"\n771: A list of shutdown event handler functions.\n772: \n773: You should instead use the `lifespan` handlers.\n774: \n775: Read more in the\n776: [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n777: \"\"\"\n778: ),\n779: ] = None,\n780: # the generic to Lifespan[AppType] is the type of the top level application\n781: # which the router cannot know statically, so we use typing.Any\n782: lifespan: Annotated[\n783: Optional[Lifespan[Any]],\n784: Doc(\n785: \"\"\"\n786: A `Lifespan` context manager handler. This replaces `startup` and\n787: `shutdown` functions with a single context manager.\n788: \n789: Read more in the\n790: [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n791: \"\"\"\n792: ),\n793: ] = None,\n794: deprecated: Annotated[\n795: Optional[bool],\n796: Doc(\n797: \"\"\"\n798: Mark all *path operations* in this router as deprecated.\n799: \n800: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n801: \n802: Read more about it in the\n803: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n804: \"\"\"\n805: ),\n806: ] = None,\n807: include_in_schema: Annotated[\n808: bool,\n809: Doc(\n810: \"\"\"\n811: To include (or not) all the *path operations* in this router in the\n812: generated OpenAPI.\n813: \n814: This affects the generated OpenAPI (e.g. visible at `/docs`).\n815: \n816: Read more about it in the\n817: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n818: \"\"\"\n819: ),\n820: ] = True,\n821: generate_unique_id_function: Annotated[\n822: Callable[[APIRoute], str],\n823: Doc(\n824: \"\"\"\n825: Customize the function used to generate unique IDs for the *path\n826: operations* shown in the generated OpenAPI.\n827: \n828: This is particularly useful when automatically generating clients or\n829: SDKs for your API.\n830: \n831: Read more about it in the\n832: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n833: \"\"\"\n834: ),\n835: ] = Default(generate_unique_id),\n836: ) -> None:\n837: super().__init__(\n838: routes=routes,\n839: redirect_slashes=redirect_slashes,\n840: default=default,\n841: on_startup=on_startup,\n842: on_shutdown=on_shutdown,\n843: lifespan=lifespan,\n844: )\n845: if prefix:\n846: assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n847: assert not prefix.endswith(\"/\"), (\n848: \"A path prefix must not end with '/', as the routes will start with '/'\"\n849: )\n850: self.prefix = prefix\n851: self.tags: List[Union[str, Enum]] = tags or []\n852: self.dependencies = list(dependencies or [])\n853: self.deprecated = deprecated\n854: self.include_in_schema = include_in_schema\n855: self.responses = responses or {}\n856: self.callbacks = callbacks or []\n857: self.dependency_overrides_provider = dependency_overrides_provider\n858: self.route_class = route_class\n859: self.default_response_class = default_response_class\n860: self.generate_unique_id_function = generate_unique_id_function\n861: \n862: def route(\n863: self,\n864: path: str,\n865: methods: Optional[List[str]] = None,\n866: name: Optional[str] = None,\n867: include_in_schema: bool = True,\n868: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n869: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n870: self.add_route(\n871: path,\n872: func,\n873: methods=methods,\n874: name=name,\n875: include_in_schema=include_in_schema,\n876: )\n877: return func\n878: \n879: return decorator\n880: \n881: def add_api_route(\n882: self,\n883: path: str,\n884: endpoint: Callable[..., Any],\n885: *,\n886: response_model: Any = Default(None),\n887: status_code: Optional[int] = None,\n888: tags: Optional[List[Union[str, Enum]]] = None,\n889: dependencies: Optional[Sequence[params.Depends]] = None,\n890: summary: Optional[str] = None,\n891: description: Optional[str] = None,\n892: response_description: str = \"Successful Response\",\n893: responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n894: deprecated: Optional[bool] = None,\n895: methods: Optional[Union[Set[str], List[str]]] = None,\n896: operation_id: Optional[str] = None,\n897: response_model_include: Optional[IncEx] = None,\n898: response_model_exclude: Optional[IncEx] = None,\n899: response_model_by_alias: bool = True,\n900: response_model_exclude_unset: bool = False,\n901: response_model_exclude_defaults: bool = False,\n902: response_model_exclude_none: bool = False,\n903: include_in_schema: bool = True,\n904: response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n905: JSONResponse\n906: ),\n907: name: Optional[str] = None,\n908: route_class_override: Optional[Type[APIRoute]] = None,\n909: callbacks: Optional[List[BaseRoute]] = None,\n910: openapi_extra: Optional[Dict[str, Any]] = None,\n911: generate_unique_id_function: Union[\n912: Callable[[APIRoute], str], DefaultPlaceholder\n913: ] = Default(generate_unique_id),\n914: ) -> None:\n915: route_class = route_class_override or self.route_class\n916: responses = responses or {}\n917: combined_responses = {**self.responses, **responses}\n918: current_response_class = get_value_or_default(\n919: response_class, self.default_response_class\n920: )\n921: current_tags = self.tags.copy()\n922: if tags:\n923: current_tags.extend(tags)\n924: current_dependencies = self.dependencies.copy()\n925: if dependencies:\n926: current_dependencies.extend(dependencies)\n927: current_callbacks = self.callbacks.copy()\n928: if callbacks:\n929: current_callbacks.extend(callbacks)\n930: current_generate_unique_id = get_value_or_default(\n931: generate_unique_id_function, self.generate_unique_id_function\n932: )\n933: route = route_class(\n934: self.prefix + path,\n935: endpoint=endpoint,\n936: response_model=response_model,\n937: status_code=status_code,\n938: tags=current_tags,\n939: dependencies=current_dependencies,\n940: summary=summary,\n941: description=description,\n942: response_description=response_description,\n943: responses=combined_responses,\n944: deprecated=deprecated or self.deprecated,\n945: methods=methods,\n946: operation_id=operation_id,\n947: response_model_include=response_model_include,\n948: response_model_exclude=response_model_exclude,\n949: response_model_by_alias=response_model_by_alias,\n950: response_model_exclude_unset=response_model_exclude_unset,\n951: response_model_exclude_defaults=response_model_exclude_defaults,\n952: response_model_exclude_none=response_model_exclude_none,\n953: include_in_schema=include_in_schema and self.include_in_schema,\n954: response_class=current_response_class,\n955: name=name,\n956: dependency_overrides_provider=self.dependency_overrides_provider,\n957: callbacks=current_callbacks,\n958: openapi_extra=openapi_extra,\n959: generate_unique_id_function=current_generate_unique_id,\n960: )\n961: self.routes.append(route)\n962: \n963: def api_route(\n964: self,\n965: path: str,\n966: *,\n967: response_model: Any = Default(None),\n968: status_code: Optional[int] = None,\n969: tags: Optional[List[Union[str, Enum]]] = None,\n970: dependencies: Optional[Sequence[params.Depends]] = None,\n971: summary: Optional[str] = None,\n972: description: Optional[str] = None,\n973: response_description: str = \"Successful Response\",\n974: responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n975: deprecated: Optional[bool] = None,\n976: methods: Optional[List[str]] = None,\n977: operation_id: Optional[str] = None,\n978: response_model_include: Optional[IncEx] = None,\n979: response_model_exclude: Optional[IncEx] = None,\n980: response_model_by_alias: bool = True,\n981: response_model_exclude_unset: bool = False,\n982: response_model_exclude_defaults: bool = False,\n983: response_model_exclude_none: bool = False,\n984: include_in_schema: bool = True,\n985: response_class: Type[Response] = Default(JSONResponse),\n986: name: Optional[str] = None,\n987: callbacks: Optional[List[BaseRoute]] = None,\n988: openapi_extra: Optional[Dict[str, Any]] = None,\n989: generate_unique_id_function: Callable[[APIRoute], str] = Default(\n990: generate_unique_id\n991: ),\n992: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n993: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n994: self.add_api_route(\n995: path,\n996: func,\n997: response_model=response_model,\n998: status_code=status_code,\n999: tags=tags,\n1000: dependencies=dependencies,\n1001: summary=summary,\n1002: description=description,\n1003: response_description=response_description,\n1004: responses=responses,\n1005: deprecated=deprecated,\n1006: methods=methods,\n1007: operation_id=operation_id,\n1008: response_model_include=response_model_include,\n1009: response_model_exclude=response_model_exclude,\n1010: response_model_by_alias=response_model_by_alias,\n1011: response_model_exclude_unset=response_model_exclude_unset,\n1012: response_model_exclude_defaults=response_model_exclude_defaults,\n1013: response_model_exclude_none=response_model_exclude_none,\n1014: include_in_schema=include_in_schema,\n1015: response_class=response_class,\n1016: name=name,\n1017: callbacks=callbacks,\n1018: openapi_extra=openapi_extra,\n1019: generate_unique_id_function=generate_unique_id_function,\n1020: )\n1021: return func\n1022: \n1023: return decorator\n1024: \n1025: def add_api_websocket_route(\n1026: self,\n1027: path: str,\n1028: endpoint: Callable[..., Any],\n1029: name: Optional[str] = None,\n1030: *,\n1031: dependencies: Optional[Sequence[params.Depends]] = None,\n1032: ) -> None:\n1033: current_dependencies = self.dependencies.copy()\n1034: if dependencies:\n1035: current_dependencies.extend(dependencies)\n1036: \n1037: route = APIWebSocketRoute(\n1038: self.prefix + path,\n1039: endpoint=endpoint,\n1040: name=name,\n1041: dependencies=current_dependencies,\n1042: dependency_overrides_provider=self.dependency_overrides_provider,\n1043: )\n1044: self.routes.append(route)\n1045: \n1046: def websocket(\n1047: self,\n1048: path: Annotated[\n1049: str,\n1050: Doc(\n1051: \"\"\"\n1052: WebSocket path.\n1053: \"\"\"\n1054: ),\n1055: ],\n1056: name: Annotated[\n1057: Optional[str],\n1058: Doc(\n1059: \"\"\"\n1060: A name for the WebSocket. Only used internally.\n1061: \"\"\"\n1062: ),\n1063: ] = None,\n1064: *,\n1065: dependencies: Annotated[\n1066: Optional[Sequence[params.Depends]],\n1067: Doc(\n1068: \"\"\"\n1069: A list of dependencies (using `Depends()`) to be used for this\n1070: WebSocket.\n1071: \n1072: Read more about it in the\n1073: [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n1074: \"\"\"\n1075: ),\n1076: ] = None,\n1077: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n1078: \"\"\"\n1079: Decorate a WebSocket function.\n1080: \n1081: Read more about it in the\n1082: [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n1083: \n1084: **Example**\n1085: \n1086: ## Example\n1087: \n1088: ```python\n1089: from fastapi import APIRouter, FastAPI, WebSocket\n1090: \n1091: app = FastAPI()\n1092: router = APIRouter()\n1093: \n1094: @router.websocket(\"/ws\")\n1095: async def websocket_endpoint(websocket: WebSocket):\n1096: await websocket.accept()\n1097: while True:\n1098: data = await websocket.receive_text()\n1099: await websocket.send_text(f\"Message text was: {data}\")\n1100: \n1101: app.include_router(router)\n1102: ```\n1103: \"\"\"\n1104: \n1105: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n1106: self.add_api_websocket_route(\n1107: path, func, name=name, dependencies=dependencies\n1108: )\n1109: return func\n1110: \n1111: return decorator\n1112: \n1113: def websocket_route(\n1114: self, path: str, name: Union[str, None] = None\n1115: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n1116: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n1117: self.add_websocket_route(path, func, name=name)\n1118: return func\n1119: \n1120: return decorator\n1121: \n1122: def include_router(\n1123: self,\n1124: router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n1125: *,\n1126: prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n1127: tags: Annotated[\n1128: Optional[List[Union[str, Enum]]],\n1129: Doc(\n1130: \"\"\"\n1131: A list of tags to be applied to all the *path operations* in this\n1132: router.\n1133: \n1134: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1135: \n1136: Read more about it in the\n1137: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n1138: \"\"\"\n1139: ),\n1140: ] = None,\n1141: dependencies: Annotated[\n1142: Optional[Sequence[params.Depends]],\n1143: Doc(\n1144: \"\"\"\n1145: A list of dependencies (using `Depends()`) to be applied to all the\n1146: *path operations* in this router.\n1147: \n1148: Read more about it in the\n1149: [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).\n1150: \"\"\"\n1151: ),\n1152: ] = None,\n1153: default_response_class: Annotated[\n1154: Type[Response],\n1155: Doc(\n1156: \"\"\"\n1157: The default response class to be used.\n1158: \n1159: Read more in the\n1160: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n1161: \"\"\"\n1162: ),\n1163: ] = Default(JSONResponse),\n1164: responses: Annotated[\n1165: Optional[Dict[Union[int, str], Dict[str, Any]]],\n1166: Doc(\n1167: \"\"\"\n1168: Additional responses to be shown in OpenAPI.\n1169: \n1170: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1171: \n1172: Read more about it in the\n1173: [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n1174: \n1175: And in the\n1176: [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n1177: \"\"\"\n1178: ),\n1179: ] = None,\n1180: callbacks: Annotated[\n1181: Optional[List[BaseRoute]],\n1182: Doc(\n1183: \"\"\"\n1184: OpenAPI callbacks that should apply to all *path operations* in this\n1185: router.\n1186: \n1187: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1188: \n1189: Read more about it in the\n1190: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n1191: \"\"\"\n1192: ),\n1193: ] = None,\n1194: deprecated: Annotated[\n1195: Optional[bool],\n1196: Doc(\n1197: \"\"\"\n1198: Mark all *path operations* in this router as deprecated.\n1199: \n1200: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1201: \n1202: Read more about it in the\n1203: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n1204: \"\"\"\n1205: ),\n1206: ] = None,\n1207: include_in_schema: Annotated[\n1208: bool,\n1209: Doc(\n1210: \"\"\"\n1211: Include (or not) all the *path operations* in this router in the\n1212: generated OpenAPI schema.\n1213: \n1214: This affects the generated OpenAPI (e.g. visible at `/docs`).\n1215: \"\"\"\n1216: ),\n1217: ] = True,\n1218: generate_unique_id_function: Annotated[\n1219: Callable[[APIRoute], str],\n1220: Doc(\n1221: \"\"\"\n1222: Customize the function used to generate unique IDs for the *path\n1223: operations* shown in the generated OpenAPI.\n1224: \n1225: This is particularly useful when automatically generating clients or\n1226: SDKs for your API.\n1227: \n1228: Read more about it in the\n1229: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n1230: \"\"\"\n1231: ),\n1232: ] = Default(generate_unique_id),\n1233: ) -> None:\n1234: \"\"\"\n1235: Include another `APIRouter` in the same current `APIRouter`.\n1236: \n1237: Read more about it in the\n1238: [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n1239: \n1240: ## Example\n1241: \n1242: ```python\n1243: from fastapi import APIRouter, FastAPI\n1244: \n1245: app = FastAPI()\n1246: internal_router = APIRouter()\n1247: users_router = APIRouter()\n1248: \n1249: @users_router.get(\"/users/\")\n1250: def read_users():\n1251: return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n1252: \n1253: internal_router.include_router(users_router)\n1254: app.include_router(internal_router)\n1255: ```\n1256: \"\"\"\n1257: if prefix:\n1258: assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n1259: assert not prefix.endswith(\"/\"), (\n1260: \"A path prefix must not end with '/', as the routes will start with '/'\"\n1261: )\n1262: else:\n1263: for r in router.routes:\n1264: path = getattr(r, \"path\") # noqa: B009\n1265: name = getattr(r, \"name\", \"unknown\")\n1266: if path is not None and not path:\n1267: raise FastAPIError(\n1268: f\"Prefix and path cannot be both empty (path operation: {name})\"\n1269: )\n1270: if responses is None:\n1271: responses = {}\n1272: for route in router.routes:\n1273: if isinstance(route, APIRoute):\n1274: combined_responses = {**responses, **route.responses}\n1275: use_response_class = get_value_or_default(\n1276: route.response_class,\n1277: router.default_response_class,\n1278: default_response_class,\n1279: self.default_response_class,\n1280: )\n1281: current_tags = []\n1282: if tags:\n1283: current_tags.extend(tags)\n1284: if route.tags:\n1285: current_tags.extend(route.tags)\n1286: current_dependencies: List[params.Depends] = []\n1287: if dependencies:\n1288: current_dependencies.extend(dependencies)\n1289: if route.dependencies:\n1290: current_dependencies.extend(route.dependencies)\n1291: current_callbacks = []\n1292: if callbacks:\n1293: current_callbacks.extend(callbacks)\n1294: if route.callbacks:\n1295: current_callbacks.extend(route.callbacks)\n1296: current_generate_unique_id = get_value_or_default(\n1297: route.generate_unique_id_function,\n1298: router.generate_unique_id_function,\n1299: generate_unique_id_function,\n1300: self.generate_unique_id_function,\n1301: )\n1302: self.add_api_route(\n1303: prefix + route.path,\n1304: route.endpoint,\n1305: response_model=route.response_model,\n1306: status_code=route.status_code,\n1307: tags=current_tags,\n1308: dependencies=current_dependencies,\n1309: summary=route.summary,\n1310: description=route.description,\n1311: response_description=route.response_description,\n1312: responses=combined_responses,\n1313: deprecated=route.deprecated or deprecated or self.deprecated,\n1314: methods=route.methods,\n1315: operation_id=route.operation_id,\n1316: response_model_include=route.response_model_include,\n1317: response_model_exclude=route.response_model_exclude,\n1318: response_model_by_alias=route.response_model_by_alias,\n1319: response_model_exclude_unset=route.response_model_exclude_unset,\n1320: response_model_exclude_defaults=route.response_model_exclude_defaults,\n1321: response_model_exclude_none=route.response_model_exclude_none,\n1322: include_in_schema=route.include_in_schema\n1323: and self.include_in_schema\n1324: and include_in_schema,\n1325: response_class=use_response_class,\n1326: name=route.name,\n1327: route_class_override=type(route),\n1328: callbacks=current_callbacks,\n1329: openapi_extra=route.openapi_extra,\n1330: generate_unique_id_function=current_generate_unique_id,\n1331: )\n1332: elif isinstance(route, routing.Route):\n1333: methods = list(route.methods or [])\n1334: self.add_route(\n1335: prefix + route.path,\n1336: route.endpoint,\n1337: methods=methods,\n1338: include_in_schema=route.include_in_schema,\n1339: name=route.name,\n1340: )\n1341: elif isinstance(route, APIWebSocketRoute):\n1342: current_dependencies = []\n1343: if dependencies:\n1344: current_dependencies.extend(dependencies)\n1345: if route.dependencies:\n1346: current_dependencies.extend(route.dependencies)\n1347: self.add_api_websocket_route(\n1348: prefix + route.path,\n1349: route.endpoint,\n1350: dependencies=current_dependencies,\n1351: name=route.name,\n1352: )\n1353: elif isinstance(route, routing.WebSocketRoute):\n1354: self.add_websocket_route(\n1355: prefix + route.path, route.endpoint, name=route.name\n1356: )\n1357: for handler in router.on_startup:\n1358: self.add_event_handler(\"startup\", handler)\n1359: for handler in router.on_shutdown:\n1360: self.add_event_handler(\"shutdown\", handler)\n1361: self.lifespan_context = _merge_lifespan_context(\n1362: self.lifespan_context,\n1363: router.lifespan_context,\n1364: )\n1365: \n1366: def get(\n1367: self,\n1368: path: Annotated[\n1369: str,\n1370: Doc(\n1371: \"\"\"\n1372: The URL path to be used for this *path operation*.\n1373: \n1374: For example, in `http://example.com/items`, the path is `/items`.\n1375: \"\"\"\n1376: ),\n1377: ],\n1378: *,\n1379: response_model: Annotated[\n1380: Any,\n1381: Doc(\n1382: \"\"\"\n1383: The type to use for the response.\n1384: \n1385: It could be any valid Pydantic *field* type. So, it doesn't have to\n1386: be a Pydantic model, it could be other things, like a `list`, `dict`,\n1387: etc.\n1388: \n1389: It will be used for:\n1390: \n1391: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n1392: show it as the response (JSON Schema).\n1393: * Serialization: you could return an arbitrary object and the\n1394: `response_model` would be used to serialize that object into the\n1395: corresponding JSON.\n1396: * Filtering: the JSON sent to the client will only contain the data\n1397: (fields) defined in the `response_model`. If you returned an object\n1398: that contains an attribute `password` but the `response_model` does\n1399: not include that field, the JSON sent to the client would not have\n1400: that `password`.\n1401: * Validation: whatever you return will be serialized with the\n1402: `response_model`, converting any data as necessary to generate the\n1403: corresponding JSON. But if the data in the object returned is not\n1404: valid, that would mean a violation of the contract with the client,\n1405: so it's an error from the API developer. So, FastAPI will raise an\n1406: error and return a 500 error code (Internal Server Error).\n1407: \n1408: Read more about it in the\n1409: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n1410: \"\"\"\n1411: ),\n1412: ] = Default(None),\n1413: status_code: Annotated[\n1414: Optional[int],\n1415: Doc(\n1416: \"\"\"\n1417: The default status code to be used for the response.\n1418: \n1419: You could override the status code by returning a response directly.\n1420: \n1421: Read more about it in the\n1422: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n1423: \"\"\"\n1424: ),\n1425: ] = None,\n1426: tags: Annotated[\n1427: Optional[List[Union[str, Enum]]],\n1428: Doc(\n1429: \"\"\"\n1430: A list of tags to be applied to the *path operation*.\n1431: \n1432: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1433: \n1434: Read more about it in the\n1435: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n1436: \"\"\"\n1437: ),\n1438: ] = None,\n1439: dependencies: Annotated[\n1440: Optional[Sequence[params.Depends]],\n1441: Doc(\n1442: \"\"\"\n1443: A list of dependencies (using `Depends()`) to be applied to the\n1444: *path operation*.\n1445: \n1446: Read more about it in the\n1447: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n1448: \"\"\"\n1449: ),\n1450: ] = None,\n1451: summary: Annotated[\n1452: Optional[str],\n1453: Doc(\n1454: \"\"\"\n1455: A summary for the *path operation*.\n1456: \n1457: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1458: \n1459: Read more about it in the\n1460: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n1461: \"\"\"\n1462: ),\n1463: ] = None,\n1464: description: Annotated[\n1465: Optional[str],\n1466: Doc(\n1467: \"\"\"\n1468: A description for the *path operation*.\n1469: \n1470: If not provided, it will be extracted automatically from the docstring\n1471: of the *path operation function*.\n1472: \n1473: It can contain Markdown.\n1474: \n1475: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1476: \n1477: Read more about it in the\n1478: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n1479: \"\"\"\n1480: ),\n1481: ] = None,\n1482: response_description: Annotated[\n1483: str,\n1484: Doc(\n1485: \"\"\"\n1486: The description for the default response.\n1487: \n1488: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1489: \"\"\"\n1490: ),\n1491: ] = \"Successful Response\",\n1492: responses: Annotated[\n1493: Optional[Dict[Union[int, str], Dict[str, Any]]],\n1494: Doc(\n1495: \"\"\"\n1496: Additional responses that could be returned by this *path operation*.\n1497: \n1498: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1499: \"\"\"\n1500: ),\n1501: ] = None,\n1502: deprecated: Annotated[\n1503: Optional[bool],\n1504: Doc(\n1505: \"\"\"\n1506: Mark this *path operation* as deprecated.\n1507: \n1508: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1509: \"\"\"\n1510: ),\n1511: ] = None,\n1512: operation_id: Annotated[\n1513: Optional[str],\n1514: Doc(\n1515: \"\"\"\n1516: Custom operation ID to be used by this *path operation*.\n1517: \n1518: By default, it is generated automatically.\n1519: \n1520: If you provide a custom operation ID, you need to make sure it is\n1521: unique for the whole API.\n1522: \n1523: You can customize the\n1524: operation ID generation with the parameter\n1525: `generate_unique_id_function` in the `FastAPI` class.\n1526: \n1527: Read more about it in the\n1528: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n1529: \"\"\"\n1530: ),\n1531: ] = None,\n1532: response_model_include: Annotated[\n1533: Optional[IncEx],\n1534: Doc(\n1535: \"\"\"\n1536: Configuration passed to Pydantic to include only certain fields in the\n1537: response data.\n1538: \n1539: Read more about it in the\n1540: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n1541: \"\"\"\n1542: ),\n1543: ] = None,\n1544: response_model_exclude: Annotated[\n1545: Optional[IncEx],\n1546: Doc(\n1547: \"\"\"\n1548: Configuration passed to Pydantic to exclude certain fields in the\n1549: response data.\n1550: \n1551: Read more about it in the\n1552: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n1553: \"\"\"\n1554: ),\n1555: ] = None,\n1556: response_model_by_alias: Annotated[\n1557: bool,\n1558: Doc(\n1559: \"\"\"\n1560: Configuration passed to Pydantic to define if the response model\n1561: should be serialized by alias when an alias is used.\n1562: \n1563: Read more about it in the\n1564: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n1565: \"\"\"\n1566: ),\n1567: ] = True,\n1568: response_model_exclude_unset: Annotated[\n1569: bool,\n1570: Doc(\n1571: \"\"\"\n1572: Configuration passed to Pydantic to define if the response data\n1573: should have all the fields, including the ones that were not set and\n1574: have their default values. This is different from\n1575: `response_model_exclude_defaults` in that if the fields are set,\n1576: they will be included in the response, even if the value is the same\n1577: as the default.\n1578: \n1579: When `True`, default values are omitted from the response.\n1580: \n1581: Read more about it in the\n1582: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n1583: \"\"\"\n1584: ),\n1585: ] = False,\n1586: response_model_exclude_defaults: Annotated[\n1587: bool,\n1588: Doc(\n1589: \"\"\"\n1590: Configuration passed to Pydantic to define if the response data\n1591: should have all the fields, including the ones that have the same value\n1592: as the default. This is different from `response_model_exclude_unset`\n1593: in that if the fields are set but contain the same default values,\n1594: they will be excluded from the response.\n1595: \n1596: When `True`, default values are omitted from the response.\n1597: \n1598: Read more about it in the\n1599: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n1600: \"\"\"\n1601: ),\n1602: ] = False,\n1603: response_model_exclude_none: Annotated[\n1604: bool,\n1605: Doc(\n1606: \"\"\"\n1607: Configuration passed to Pydantic to define if the response data should\n1608: exclude fields set to `None`.\n1609: \n1610: This is much simpler (less smart) than `response_model_exclude_unset`\n1611: and `response_model_exclude_defaults`. You probably want to use one of\n1612: those two instead of this one, as those allow returning `None` values\n1613: when it makes sense.\n1614: \n1615: Read more about it in the\n1616: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n1617: \"\"\"\n1618: ),\n1619: ] = False,\n1620: include_in_schema: Annotated[\n1621: bool,\n1622: Doc(\n1623: \"\"\"\n1624: Include this *path operation* in the generated OpenAPI schema.\n1625: \n1626: This affects the generated OpenAPI (e.g. visible at `/docs`).\n1627: \n1628: Read more about it in the\n1629: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n1630: \"\"\"\n1631: ),\n1632: ] = True,\n1633: response_class: Annotated[\n1634: Type[Response],\n1635: Doc(\n1636: \"\"\"\n1637: Response class to be used for this *path operation*.\n1638: \n1639: This will not be used if you return a response directly.\n1640: \n1641: Read more about it in the\n1642: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n1643: \"\"\"\n1644: ),\n1645: ] = Default(JSONResponse),\n1646: name: Annotated[\n1647: Optional[str],\n1648: Doc(\n1649: \"\"\"\n1650: Name for this *path operation*. Only used internally.\n1651: \"\"\"\n1652: ),\n1653: ] = None,\n1654: callbacks: Annotated[\n1655: Optional[List[BaseRoute]],\n1656: Doc(\n1657: \"\"\"\n1658: List of *path operations* that will be used as OpenAPI callbacks.\n1659: \n1660: This is only for OpenAPI documentation, the callbacks won't be used\n1661: directly.\n1662: \n1663: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1664: \n1665: Read more about it in the\n1666: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n1667: \"\"\"\n1668: ),\n1669: ] = None,\n1670: openapi_extra: Annotated[\n1671: Optional[Dict[str, Any]],\n1672: Doc(\n1673: \"\"\"\n1674: Extra metadata to be included in the OpenAPI schema for this *path\n1675: operation*.\n1676: \n1677: Read more about it in the\n1678: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n1679: \"\"\"\n1680: ),\n1681: ] = None,\n1682: generate_unique_id_function: Annotated[\n1683: Callable[[APIRoute], str],\n1684: Doc(\n1685: \"\"\"\n1686: Customize the function used to generate unique IDs for the *path\n1687: operations* shown in the generated OpenAPI.\n1688: \n1689: This is particularly useful when automatically generating clients or\n1690: SDKs for your API.\n1691: \n1692: Read more about it in the\n1693: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n1694: \"\"\"\n1695: ),\n1696: ] = Default(generate_unique_id),\n1697: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n1698: \"\"\"\n1699: Add a *path operation* using an HTTP GET operation.\n1700: \n1701: ## Example\n1702: \n1703: ```python\n1704: from fastapi import APIRouter, FastAPI\n1705: \n1706: app = FastAPI()\n1707: router = APIRouter()\n1708: \n1709: @router.get(\"/items/\")\n1710: def read_items():\n1711: return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n1712: \n1713: app.include_router(router)\n1714: ```\n1715: \"\"\"\n1716: return self.api_route(\n1717: path=path,\n1718: response_model=response_model,\n1719: status_code=status_code,\n1720: tags=tags,\n1721: dependencies=dependencies,\n1722: summary=summary,\n1723: description=description,\n1724: response_description=response_description,\n1725: responses=responses,\n1726: deprecated=deprecated,\n1727: methods=[\"GET\"],\n1728: operation_id=operation_id,\n1729: response_model_include=response_model_include,\n1730: response_model_exclude=response_model_exclude,\n1731: response_model_by_alias=response_model_by_alias,\n1732: response_model_exclude_unset=response_model_exclude_unset,\n1733: response_model_exclude_defaults=response_model_exclude_defaults,\n1734: response_model_exclude_none=response_model_exclude_none,\n1735: include_in_schema=include_in_schema,\n1736: response_class=response_class,\n1737: name=name,\n1738: callbacks=callbacks,\n1739: openapi_extra=openapi_extra,\n1740: generate_unique_id_function=generate_unique_id_function,\n1741: )\n1742: \n1743: def put(\n1744: self,\n1745: path: Annotated[\n1746: str,\n1747: Doc(\n1748: \"\"\"\n1749: The URL path to be used for this *path operation*.\n1750: \n1751: For example, in `http://example.com/items`, the path is `/items`.\n1752: \"\"\"\n1753: ),\n1754: ],\n1755: *,\n1756: response_model: Annotated[\n1757: Any,\n1758: Doc(\n1759: \"\"\"\n1760: The type to use for the response.\n1761: \n1762: It could be any valid Pydantic *field* type. So, it doesn't have to\n1763: be a Pydantic model, it could be other things, like a `list`, `dict`,\n1764: etc.\n1765: \n1766: It will be used for:\n1767: \n1768: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n1769: show it as the response (JSON Schema).\n1770: * Serialization: you could return an arbitrary object and the\n1771: `response_model` would be used to serialize that object into the\n1772: corresponding JSON.\n1773: * Filtering: the JSON sent to the client will only contain the data\n1774: (fields) defined in the `response_model`. If you returned an object\n1775: that contains an attribute `password` but the `response_model` does\n1776: not include that field, the JSON sent to the client would not have\n1777: that `password`.\n1778: * Validation: whatever you return will be serialized with the\n1779: `response_model`, converting any data as necessary to generate the\n1780: corresponding JSON. But if the data in the object returned is not\n1781: valid, that would mean a violation of the contract with the client,\n1782: so it's an error from the API developer. So, FastAPI will raise an\n1783: error and return a 500 error code (Internal Server Error).\n1784: \n1785: Read more about it in the\n1786: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n1787: \"\"\"\n1788: ),\n1789: ] = Default(None),\n1790: status_code: Annotated[\n1791: Optional[int],\n1792: Doc(\n1793: \"\"\"\n1794: The default status code to be used for the response.\n1795: \n1796: You could override the status code by returning a response directly.\n1797: \n1798: Read more about it in the\n1799: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n1800: \"\"\"\n1801: ),\n1802: ] = None,\n1803: tags: Annotated[\n1804: Optional[List[Union[str, Enum]]],\n1805: Doc(\n1806: \"\"\"\n1807: A list of tags to be applied to the *path operation*.\n1808: \n1809: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1810: \n1811: Read more about it in the\n1812: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n1813: \"\"\"\n1814: ),\n1815: ] = None,\n1816: dependencies: Annotated[\n1817: Optional[Sequence[params.Depends]],\n1818: Doc(\n1819: \"\"\"\n1820: A list of dependencies (using `Depends()`) to be applied to the\n1821: *path operation*.\n1822: \n1823: Read more about it in the\n1824: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n1825: \"\"\"\n1826: ),\n1827: ] = None,\n1828: summary: Annotated[\n1829: Optional[str],\n1830: Doc(\n1831: \"\"\"\n1832: A summary for the *path operation*.\n1833: \n1834: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1835: \n1836: Read more about it in the\n1837: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n1838: \"\"\"\n1839: ),\n1840: ] = None,\n1841: description: Annotated[\n1842: Optional[str],\n1843: Doc(\n1844: \"\"\"\n1845: A description for the *path operation*.\n1846: \n1847: If not provided, it will be extracted automatically from the docstring\n1848: of the *path operation function*.\n1849: \n1850: It can contain Markdown.\n1851: \n1852: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1853: \n1854: Read more about it in the\n1855: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n1856: \"\"\"\n1857: ),\n1858: ] = None,\n1859: response_description: Annotated[\n1860: str,\n1861: Doc(\n1862: \"\"\"\n1863: The description for the default response.\n1864: \n1865: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1866: \"\"\"\n1867: ),\n1868: ] = \"Successful Response\",\n1869: responses: Annotated[\n1870: Optional[Dict[Union[int, str], Dict[str, Any]]],\n1871: Doc(\n1872: \"\"\"\n1873: Additional responses that could be returned by this *path operation*.\n1874: \n1875: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1876: \"\"\"\n1877: ),\n1878: ] = None,\n1879: deprecated: Annotated[\n1880: Optional[bool],\n1881: Doc(\n1882: \"\"\"\n1883: Mark this *path operation* as deprecated.\n1884: \n1885: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n1886: \"\"\"\n1887: ),\n1888: ] = None,\n1889: operation_id: Annotated[\n1890: Optional[str],\n1891: Doc(\n1892: \"\"\"\n1893: Custom operation ID to be used by this *path operation*.\n1894: \n1895: By default, it is generated automatically.\n1896: \n1897: If you provide a custom operation ID, you need to make sure it is\n1898: unique for the whole API.\n1899: \n1900: You can customize the\n1901: operation ID generation with the parameter\n1902: `generate_unique_id_function` in the `FastAPI` class.\n1903: \n1904: Read more about it in the\n1905: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n1906: \"\"\"\n1907: ),\n1908: ] = None,\n1909: response_model_include: Annotated[\n1910: Optional[IncEx],\n1911: Doc(\n1912: \"\"\"\n1913: Configuration passed to Pydantic to include only certain fields in the\n1914: response data.\n1915: \n1916: Read more about it in the\n1917: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n1918: \"\"\"\n1919: ),\n1920: ] = None,\n1921: response_model_exclude: Annotated[\n1922: Optional[IncEx],\n1923: Doc(\n1924: \"\"\"\n1925: Configuration passed to Pydantic to exclude certain fields in the\n1926: response data.\n1927: \n1928: Read more about it in the\n1929: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n1930: \"\"\"\n1931: ),\n1932: ] = None,\n1933: response_model_by_alias: Annotated[\n1934: bool,\n1935: Doc(\n1936: \"\"\"\n1937: Configuration passed to Pydantic to define if the response model\n1938: should be serialized by alias when an alias is used.\n1939: \n1940: Read more about it in the\n1941: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n1942: \"\"\"\n1943: ),\n1944: ] = True,\n1945: response_model_exclude_unset: Annotated[\n1946: bool,\n1947: Doc(\n1948: \"\"\"\n1949: Configuration passed to Pydantic to define if the response data\n1950: should have all the fields, including the ones that were not set and\n1951: have their default values. This is different from\n1952: `response_model_exclude_defaults` in that if the fields are set,\n1953: they will be included in the response, even if the value is the same\n1954: as the default.\n1955: \n1956: When `True`, default values are omitted from the response.\n1957: \n1958: Read more about it in the\n1959: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n1960: \"\"\"\n1961: ),\n1962: ] = False,\n1963: response_model_exclude_defaults: Annotated[\n1964: bool,\n1965: Doc(\n1966: \"\"\"\n1967: Configuration passed to Pydantic to define if the response data\n1968: should have all the fields, including the ones that have the same value\n1969: as the default. This is different from `response_model_exclude_unset`\n1970: in that if the fields are set but contain the same default values,\n1971: they will be excluded from the response.\n1972: \n1973: When `True`, default values are omitted from the response.\n1974: \n1975: Read more about it in the\n1976: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n1977: \"\"\"\n1978: ),\n1979: ] = False,\n1980: response_model_exclude_none: Annotated[\n1981: bool,\n1982: Doc(\n1983: \"\"\"\n1984: Configuration passed to Pydantic to define if the response data should\n1985: exclude fields set to `None`.\n1986: \n1987: This is much simpler (less smart) than `response_model_exclude_unset`\n1988: and `response_model_exclude_defaults`. You probably want to use one of\n1989: those two instead of this one, as those allow returning `None` values\n1990: when it makes sense.\n1991: \n1992: Read more about it in the\n1993: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n1994: \"\"\"\n1995: ),\n1996: ] = False,\n1997: include_in_schema: Annotated[\n1998: bool,\n1999: Doc(\n2000: \"\"\"\n2001: Include this *path operation* in the generated OpenAPI schema.\n2002: \n2003: This affects the generated OpenAPI (e.g. visible at `/docs`).\n2004: \n2005: Read more about it in the\n2006: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n2007: \"\"\"\n2008: ),\n2009: ] = True,\n2010: response_class: Annotated[\n2011: Type[Response],\n2012: Doc(\n2013: \"\"\"\n2014: Response class to be used for this *path operation*.\n2015: \n2016: This will not be used if you return a response directly.\n2017: \n2018: Read more about it in the\n2019: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n2020: \"\"\"\n2021: ),\n2022: ] = Default(JSONResponse),\n2023: name: Annotated[\n2024: Optional[str],\n2025: Doc(\n2026: \"\"\"\n2027: Name for this *path operation*. Only used internally.\n2028: \"\"\"\n2029: ),\n2030: ] = None,\n2031: callbacks: Annotated[\n2032: Optional[List[BaseRoute]],\n2033: Doc(\n2034: \"\"\"\n2035: List of *path operations* that will be used as OpenAPI callbacks.\n2036: \n2037: This is only for OpenAPI documentation, the callbacks won't be used\n2038: directly.\n2039: \n2040: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2041: \n2042: Read more about it in the\n2043: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n2044: \"\"\"\n2045: ),\n2046: ] = None,\n2047: openapi_extra: Annotated[\n2048: Optional[Dict[str, Any]],\n2049: Doc(\n2050: \"\"\"\n2051: Extra metadata to be included in the OpenAPI schema for this *path\n2052: operation*.\n2053: \n2054: Read more about it in the\n2055: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n2056: \"\"\"\n2057: ),\n2058: ] = None,\n2059: generate_unique_id_function: Annotated[\n2060: Callable[[APIRoute], str],\n2061: Doc(\n2062: \"\"\"\n2063: Customize the function used to generate unique IDs for the *path\n2064: operations* shown in the generated OpenAPI.\n2065: \n2066: This is particularly useful when automatically generating clients or\n2067: SDKs for your API.\n2068: \n2069: Read more about it in the\n2070: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n2071: \"\"\"\n2072: ),\n2073: ] = Default(generate_unique_id),\n2074: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n2075: \"\"\"\n2076: Add a *path operation* using an HTTP PUT operation.\n2077: \n2078: ## Example\n2079: \n2080: ```python\n2081: from fastapi import APIRouter, FastAPI\n2082: from pydantic import BaseModel\n2083: \n2084: class Item(BaseModel):\n2085: name: str\n2086: description: str | None = None\n2087: \n2088: app = FastAPI()\n2089: router = APIRouter()\n2090: \n2091: @router.put(\"/items/{item_id}\")\n2092: def replace_item(item_id: str, item: Item):\n2093: return {\"message\": \"Item replaced\", \"id\": item_id}\n2094: \n2095: app.include_router(router)\n2096: ```\n2097: \"\"\"\n2098: return self.api_route(\n2099: path=path,\n2100: response_model=response_model,\n2101: status_code=status_code,\n2102: tags=tags,\n2103: dependencies=dependencies,\n2104: summary=summary,\n2105: description=description,\n2106: response_description=response_description,\n2107: responses=responses,\n2108: deprecated=deprecated,\n2109: methods=[\"PUT\"],\n2110: operation_id=operation_id,\n2111: response_model_include=response_model_include,\n2112: response_model_exclude=response_model_exclude,\n2113: response_model_by_alias=response_model_by_alias,\n2114: response_model_exclude_unset=response_model_exclude_unset,\n2115: response_model_exclude_defaults=response_model_exclude_defaults,\n2116: response_model_exclude_none=response_model_exclude_none,\n2117: include_in_schema=include_in_schema,\n2118: response_class=response_class,\n2119: name=name,\n2120: callbacks=callbacks,\n2121: openapi_extra=openapi_extra,\n2122: generate_unique_id_function=generate_unique_id_function,\n2123: )\n2124: \n2125: def post(\n2126: self,\n2127: path: Annotated[\n2128: str,\n2129: Doc(\n2130: \"\"\"\n2131: The URL path to be used for this *path operation*.\n2132: \n2133: For example, in `http://example.com/items`, the path is `/items`.\n2134: \"\"\"\n2135: ),\n2136: ],\n2137: *,\n2138: response_model: Annotated[\n2139: Any,\n2140: Doc(\n2141: \"\"\"\n2142: The type to use for the response.\n2143: \n2144: It could be any valid Pydantic *field* type. So, it doesn't have to\n2145: be a Pydantic model, it could be other things, like a `list`, `dict`,\n2146: etc.\n2147: \n2148: It will be used for:\n2149: \n2150: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n2151: show it as the response (JSON Schema).\n2152: * Serialization: you could return an arbitrary object and the\n2153: `response_model` would be used to serialize that object into the\n2154: corresponding JSON.\n2155: * Filtering: the JSON sent to the client will only contain the data\n2156: (fields) defined in the `response_model`. If you returned an object\n2157: that contains an attribute `password` but the `response_model` does\n2158: not include that field, the JSON sent to the client would not have\n2159: that `password`.\n2160: * Validation: whatever you return will be serialized with the\n2161: `response_model`, converting any data as necessary to generate the\n2162: corresponding JSON. But if the data in the object returned is not\n2163: valid, that would mean a violation of the contract with the client,\n2164: so it's an error from the API developer. So, FastAPI will raise an\n2165: error and return a 500 error code (Internal Server Error).\n2166: \n2167: Read more about it in the\n2168: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n2169: \"\"\"\n2170: ),\n2171: ] = Default(None),\n2172: status_code: Annotated[\n2173: Optional[int],\n2174: Doc(\n2175: \"\"\"\n2176: The default status code to be used for the response.\n2177: \n2178: You could override the status code by returning a response directly.\n2179: \n2180: Read more about it in the\n2181: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n2182: \"\"\"\n2183: ),\n2184: ] = None,\n2185: tags: Annotated[\n2186: Optional[List[Union[str, Enum]]],\n2187: Doc(\n2188: \"\"\"\n2189: A list of tags to be applied to the *path operation*.\n2190: \n2191: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2192: \n2193: Read more about it in the\n2194: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n2195: \"\"\"\n2196: ),\n2197: ] = None,\n2198: dependencies: Annotated[\n2199: Optional[Sequence[params.Depends]],\n2200: Doc(\n2201: \"\"\"\n2202: A list of dependencies (using `Depends()`) to be applied to the\n2203: *path operation*.\n2204: \n2205: Read more about it in the\n2206: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n2207: \"\"\"\n2208: ),\n2209: ] = None,\n2210: summary: Annotated[\n2211: Optional[str],\n2212: Doc(\n2213: \"\"\"\n2214: A summary for the *path operation*.\n2215: \n2216: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2217: \n2218: Read more about it in the\n2219: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n2220: \"\"\"\n2221: ),\n2222: ] = None,\n2223: description: Annotated[\n2224: Optional[str],\n2225: Doc(\n2226: \"\"\"\n2227: A description for the *path operation*.\n2228: \n2229: If not provided, it will be extracted automatically from the docstring\n2230: of the *path operation function*.\n2231: \n2232: It can contain Markdown.\n2233: \n2234: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2235: \n2236: Read more about it in the\n2237: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n2238: \"\"\"\n2239: ),\n2240: ] = None,\n2241: response_description: Annotated[\n2242: str,\n2243: Doc(\n2244: \"\"\"\n2245: The description for the default response.\n2246: \n2247: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2248: \"\"\"\n2249: ),\n2250: ] = \"Successful Response\",\n2251: responses: Annotated[\n2252: Optional[Dict[Union[int, str], Dict[str, Any]]],\n2253: Doc(\n2254: \"\"\"\n2255: Additional responses that could be returned by this *path operation*.\n2256: \n2257: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2258: \"\"\"\n2259: ),\n2260: ] = None,\n2261: deprecated: Annotated[\n2262: Optional[bool],\n2263: Doc(\n2264: \"\"\"\n2265: Mark this *path operation* as deprecated.\n2266: \n2267: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2268: \"\"\"\n2269: ),\n2270: ] = None,\n2271: operation_id: Annotated[\n2272: Optional[str],\n2273: Doc(\n2274: \"\"\"\n2275: Custom operation ID to be used by this *path operation*.\n2276: \n2277: By default, it is generated automatically.\n2278: \n2279: If you provide a custom operation ID, you need to make sure it is\n2280: unique for the whole API.\n2281: \n2282: You can customize the\n2283: operation ID generation with the parameter\n2284: `generate_unique_id_function` in the `FastAPI` class.\n2285: \n2286: Read more about it in the\n2287: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n2288: \"\"\"\n2289: ),\n2290: ] = None,\n2291: response_model_include: Annotated[\n2292: Optional[IncEx],\n2293: Doc(\n2294: \"\"\"\n2295: Configuration passed to Pydantic to include only certain fields in the\n2296: response data.\n2297: \n2298: Read more about it in the\n2299: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n2300: \"\"\"\n2301: ),\n2302: ] = None,\n2303: response_model_exclude: Annotated[\n2304: Optional[IncEx],\n2305: Doc(\n2306: \"\"\"\n2307: Configuration passed to Pydantic to exclude certain fields in the\n2308: response data.\n2309: \n2310: Read more about it in the\n2311: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n2312: \"\"\"\n2313: ),\n2314: ] = None,\n2315: response_model_by_alias: Annotated[\n2316: bool,\n2317: Doc(\n2318: \"\"\"\n2319: Configuration passed to Pydantic to define if the response model\n2320: should be serialized by alias when an alias is used.\n2321: \n2322: Read more about it in the\n2323: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n2324: \"\"\"\n2325: ),\n2326: ] = True,\n2327: response_model_exclude_unset: Annotated[\n2328: bool,\n2329: Doc(\n2330: \"\"\"\n2331: Configuration passed to Pydantic to define if the response data\n2332: should have all the fields, including the ones that were not set and\n2333: have their default values. This is different from\n2334: `response_model_exclude_defaults` in that if the fields are set,\n2335: they will be included in the response, even if the value is the same\n2336: as the default.\n2337: \n2338: When `True`, default values are omitted from the response.\n2339: \n2340: Read more about it in the\n2341: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n2342: \"\"\"\n2343: ),\n2344: ] = False,\n2345: response_model_exclude_defaults: Annotated[\n2346: bool,\n2347: Doc(\n2348: \"\"\"\n2349: Configuration passed to Pydantic to define if the response data\n2350: should have all the fields, including the ones that have the same value\n2351: as the default. This is different from `response_model_exclude_unset`\n2352: in that if the fields are set but contain the same default values,\n2353: they will be excluded from the response.\n2354: \n2355: When `True`, default values are omitted from the response.\n2356: \n2357: Read more about it in the\n2358: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n2359: \"\"\"\n2360: ),\n2361: ] = False,\n2362: response_model_exclude_none: Annotated[\n2363: bool,\n2364: Doc(\n2365: \"\"\"\n2366: Configuration passed to Pydantic to define if the response data should\n2367: exclude fields set to `None`.\n2368: \n2369: This is much simpler (less smart) than `response_model_exclude_unset`\n2370: and `response_model_exclude_defaults`. You probably want to use one of\n2371: those two instead of this one, as those allow returning `None` values\n2372: when it makes sense.\n2373: \n2374: Read more about it in the\n2375: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n2376: \"\"\"\n2377: ),\n2378: ] = False,\n2379: include_in_schema: Annotated[\n2380: bool,\n2381: Doc(\n2382: \"\"\"\n2383: Include this *path operation* in the generated OpenAPI schema.\n2384: \n2385: This affects the generated OpenAPI (e.g. visible at `/docs`).\n2386: \n2387: Read more about it in the\n2388: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n2389: \"\"\"\n2390: ),\n2391: ] = True,\n2392: response_class: Annotated[\n2393: Type[Response],\n2394: Doc(\n2395: \"\"\"\n2396: Response class to be used for this *path operation*.\n2397: \n2398: This will not be used if you return a response directly.\n2399: \n2400: Read more about it in the\n2401: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n2402: \"\"\"\n2403: ),\n2404: ] = Default(JSONResponse),\n2405: name: Annotated[\n2406: Optional[str],\n2407: Doc(\n2408: \"\"\"\n2409: Name for this *path operation*. Only used internally.\n2410: \"\"\"\n2411: ),\n2412: ] = None,\n2413: callbacks: Annotated[\n2414: Optional[List[BaseRoute]],\n2415: Doc(\n2416: \"\"\"\n2417: List of *path operations* that will be used as OpenAPI callbacks.\n2418: \n2419: This is only for OpenAPI documentation, the callbacks won't be used\n2420: directly.\n2421: \n2422: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2423: \n2424: Read more about it in the\n2425: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n2426: \"\"\"\n2427: ),\n2428: ] = None,\n2429: openapi_extra: Annotated[\n2430: Optional[Dict[str, Any]],\n2431: Doc(\n2432: \"\"\"\n2433: Extra metadata to be included in the OpenAPI schema for this *path\n2434: operation*.\n2435: \n2436: Read more about it in the\n2437: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n2438: \"\"\"\n2439: ),\n2440: ] = None,\n2441: generate_unique_id_function: Annotated[\n2442: Callable[[APIRoute], str],\n2443: Doc(\n2444: \"\"\"\n2445: Customize the function used to generate unique IDs for the *path\n2446: operations* shown in the generated OpenAPI.\n2447: \n2448: This is particularly useful when automatically generating clients or\n2449: SDKs for your API.\n2450: \n2451: Read more about it in the\n2452: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n2453: \"\"\"\n2454: ),\n2455: ] = Default(generate_unique_id),\n2456: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n2457: \"\"\"\n2458: Add a *path operation* using an HTTP POST operation.\n2459: \n2460: ## Example\n2461: \n2462: ```python\n2463: from fastapi import APIRouter, FastAPI\n2464: from pydantic import BaseModel\n2465: \n2466: class Item(BaseModel):\n2467: name: str\n2468: description: str | None = None\n2469: \n2470: app = FastAPI()\n2471: router = APIRouter()\n2472: \n2473: @router.post(\"/items/\")\n2474: def create_item(item: Item):\n2475: return {\"message\": \"Item created\"}\n2476: \n2477: app.include_router(router)\n2478: ```\n2479: \"\"\"\n2480: return self.api_route(\n2481: path=path,\n2482: response_model=response_model,\n2483: status_code=status_code,\n2484: tags=tags,\n2485: dependencies=dependencies,\n2486: summary=summary,\n2487: description=description,\n2488: response_description=response_description,\n2489: responses=responses,\n2490: deprecated=deprecated,\n2491: methods=[\"POST\"],\n2492: operation_id=operation_id,\n2493: response_model_include=response_model_include,\n2494: response_model_exclude=response_model_exclude,\n2495: response_model_by_alias=response_model_by_alias,\n2496: response_model_exclude_unset=response_model_exclude_unset,\n2497: response_model_exclude_defaults=response_model_exclude_defaults,\n2498: response_model_exclude_none=response_model_exclude_none,\n2499: include_in_schema=include_in_schema,\n2500: response_class=response_class,\n2501: name=name,\n2502: callbacks=callbacks,\n2503: openapi_extra=openapi_extra,\n2504: generate_unique_id_function=generate_unique_id_function,\n2505: )\n2506: \n2507: def delete(\n2508: self,\n2509: path: Annotated[\n2510: str,\n2511: Doc(\n2512: \"\"\"\n2513: The URL path to be used for this *path operation*.\n2514: \n2515: For example, in `http://example.com/items`, the path is `/items`.\n2516: \"\"\"\n2517: ),\n2518: ],\n2519: *,\n2520: response_model: Annotated[\n2521: Any,\n2522: Doc(\n2523: \"\"\"\n2524: The type to use for the response.\n2525: \n2526: It could be any valid Pydantic *field* type. So, it doesn't have to\n2527: be a Pydantic model, it could be other things, like a `list`, `dict`,\n2528: etc.\n2529: \n2530: It will be used for:\n2531: \n2532: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n2533: show it as the response (JSON Schema).\n2534: * Serialization: you could return an arbitrary object and the\n2535: `response_model` would be used to serialize that object into the\n2536: corresponding JSON.\n2537: * Filtering: the JSON sent to the client will only contain the data\n2538: (fields) defined in the `response_model`. If you returned an object\n2539: that contains an attribute `password` but the `response_model` does\n2540: not include that field, the JSON sent to the client would not have\n2541: that `password`.\n2542: * Validation: whatever you return will be serialized with the\n2543: `response_model`, converting any data as necessary to generate the\n2544: corresponding JSON. But if the data in the object returned is not\n2545: valid, that would mean a violation of the contract with the client,\n2546: so it's an error from the API developer. So, FastAPI will raise an\n2547: error and return a 500 error code (Internal Server Error).\n2548: \n2549: Read more about it in the\n2550: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n2551: \"\"\"\n2552: ),\n2553: ] = Default(None),\n2554: status_code: Annotated[\n2555: Optional[int],\n2556: Doc(\n2557: \"\"\"\n2558: The default status code to be used for the response.\n2559: \n2560: You could override the status code by returning a response directly.\n2561: \n2562: Read more about it in the\n2563: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n2564: \"\"\"\n2565: ),\n2566: ] = None,\n2567: tags: Annotated[\n2568: Optional[List[Union[str, Enum]]],\n2569: Doc(\n2570: \"\"\"\n2571: A list of tags to be applied to the *path operation*.\n2572: \n2573: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2574: \n2575: Read more about it in the\n2576: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n2577: \"\"\"\n2578: ),\n2579: ] = None,\n2580: dependencies: Annotated[\n2581: Optional[Sequence[params.Depends]],\n2582: Doc(\n2583: \"\"\"\n2584: A list of dependencies (using `Depends()`) to be applied to the\n2585: *path operation*.\n2586: \n2587: Read more about it in the\n2588: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n2589: \"\"\"\n2590: ),\n2591: ] = None,\n2592: summary: Annotated[\n2593: Optional[str],\n2594: Doc(\n2595: \"\"\"\n2596: A summary for the *path operation*.\n2597: \n2598: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2599: \n2600: Read more about it in the\n2601: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n2602: \"\"\"\n2603: ),\n2604: ] = None,\n2605: description: Annotated[\n2606: Optional[str],\n2607: Doc(\n2608: \"\"\"\n2609: A description for the *path operation*.\n2610: \n2611: If not provided, it will be extracted automatically from the docstring\n2612: of the *path operation function*.\n2613: \n2614: It can contain Markdown.\n2615: \n2616: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2617: \n2618: Read more about it in the\n2619: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n2620: \"\"\"\n2621: ),\n2622: ] = None,\n2623: response_description: Annotated[\n2624: str,\n2625: Doc(\n2626: \"\"\"\n2627: The description for the default response.\n2628: \n2629: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2630: \"\"\"\n2631: ),\n2632: ] = \"Successful Response\",\n2633: responses: Annotated[\n2634: Optional[Dict[Union[int, str], Dict[str, Any]]],\n2635: Doc(\n2636: \"\"\"\n2637: Additional responses that could be returned by this *path operation*.\n2638: \n2639: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2640: \"\"\"\n2641: ),\n2642: ] = None,\n2643: deprecated: Annotated[\n2644: Optional[bool],\n2645: Doc(\n2646: \"\"\"\n2647: Mark this *path operation* as deprecated.\n2648: \n2649: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2650: \"\"\"\n2651: ),\n2652: ] = None,\n2653: operation_id: Annotated[\n2654: Optional[str],\n2655: Doc(\n2656: \"\"\"\n2657: Custom operation ID to be used by this *path operation*.\n2658: \n2659: By default, it is generated automatically.\n2660: \n2661: If you provide a custom operation ID, you need to make sure it is\n2662: unique for the whole API.\n2663: \n2664: You can customize the\n2665: operation ID generation with the parameter\n2666: `generate_unique_id_function` in the `FastAPI` class.\n2667: \n2668: Read more about it in the\n2669: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n2670: \"\"\"\n2671: ),\n2672: ] = None,\n2673: response_model_include: Annotated[\n2674: Optional[IncEx],\n2675: Doc(\n2676: \"\"\"\n2677: Configuration passed to Pydantic to include only certain fields in the\n2678: response data.\n2679: \n2680: Read more about it in the\n2681: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n2682: \"\"\"\n2683: ),\n2684: ] = None,\n2685: response_model_exclude: Annotated[\n2686: Optional[IncEx],\n2687: Doc(\n2688: \"\"\"\n2689: Configuration passed to Pydantic to exclude certain fields in the\n2690: response data.\n2691: \n2692: Read more about it in the\n2693: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n2694: \"\"\"\n2695: ),\n2696: ] = None,\n2697: response_model_by_alias: Annotated[\n2698: bool,\n2699: Doc(\n2700: \"\"\"\n2701: Configuration passed to Pydantic to define if the response model\n2702: should be serialized by alias when an alias is used.\n2703: \n2704: Read more about it in the\n2705: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n2706: \"\"\"\n2707: ),\n2708: ] = True,\n2709: response_model_exclude_unset: Annotated[\n2710: bool,\n2711: Doc(\n2712: \"\"\"\n2713: Configuration passed to Pydantic to define if the response data\n2714: should have all the fields, including the ones that were not set and\n2715: have their default values. This is different from\n2716: `response_model_exclude_defaults` in that if the fields are set,\n2717: they will be included in the response, even if the value is the same\n2718: as the default.\n2719: \n2720: When `True`, default values are omitted from the response.\n2721: \n2722: Read more about it in the\n2723: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n2724: \"\"\"\n2725: ),\n2726: ] = False,\n2727: response_model_exclude_defaults: Annotated[\n2728: bool,\n2729: Doc(\n2730: \"\"\"\n2731: Configuration passed to Pydantic to define if the response data\n2732: should have all the fields, including the ones that have the same value\n2733: as the default. This is different from `response_model_exclude_unset`\n2734: in that if the fields are set but contain the same default values,\n2735: they will be excluded from the response.\n2736: \n2737: When `True`, default values are omitted from the response.\n2738: \n2739: Read more about it in the\n2740: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n2741: \"\"\"\n2742: ),\n2743: ] = False,\n2744: response_model_exclude_none: Annotated[\n2745: bool,\n2746: Doc(\n2747: \"\"\"\n2748: Configuration passed to Pydantic to define if the response data should\n2749: exclude fields set to `None`.\n2750: \n2751: This is much simpler (less smart) than `response_model_exclude_unset`\n2752: and `response_model_exclude_defaults`. You probably want to use one of\n2753: those two instead of this one, as those allow returning `None` values\n2754: when it makes sense.\n2755: \n2756: Read more about it in the\n2757: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n2758: \"\"\"\n2759: ),\n2760: ] = False,\n2761: include_in_schema: Annotated[\n2762: bool,\n2763: Doc(\n2764: \"\"\"\n2765: Include this *path operation* in the generated OpenAPI schema.\n2766: \n2767: This affects the generated OpenAPI (e.g. visible at `/docs`).\n2768: \n2769: Read more about it in the\n2770: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n2771: \"\"\"\n2772: ),\n2773: ] = True,\n2774: response_class: Annotated[\n2775: Type[Response],\n2776: Doc(\n2777: \"\"\"\n2778: Response class to be used for this *path operation*.\n2779: \n2780: This will not be used if you return a response directly.\n2781: \n2782: Read more about it in the\n2783: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n2784: \"\"\"\n2785: ),\n2786: ] = Default(JSONResponse),\n2787: name: Annotated[\n2788: Optional[str],\n2789: Doc(\n2790: \"\"\"\n2791: Name for this *path operation*. Only used internally.\n2792: \"\"\"\n2793: ),\n2794: ] = None,\n2795: callbacks: Annotated[\n2796: Optional[List[BaseRoute]],\n2797: Doc(\n2798: \"\"\"\n2799: List of *path operations* that will be used as OpenAPI callbacks.\n2800: \n2801: This is only for OpenAPI documentation, the callbacks won't be used\n2802: directly.\n2803: \n2804: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2805: \n2806: Read more about it in the\n2807: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n2808: \"\"\"\n2809: ),\n2810: ] = None,\n2811: openapi_extra: Annotated[\n2812: Optional[Dict[str, Any]],\n2813: Doc(\n2814: \"\"\"\n2815: Extra metadata to be included in the OpenAPI schema for this *path\n2816: operation*.\n2817: \n2818: Read more about it in the\n2819: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n2820: \"\"\"\n2821: ),\n2822: ] = None,\n2823: generate_unique_id_function: Annotated[\n2824: Callable[[APIRoute], str],\n2825: Doc(\n2826: \"\"\"\n2827: Customize the function used to generate unique IDs for the *path\n2828: operations* shown in the generated OpenAPI.\n2829: \n2830: This is particularly useful when automatically generating clients or\n2831: SDKs for your API.\n2832: \n2833: Read more about it in the\n2834: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n2835: \"\"\"\n2836: ),\n2837: ] = Default(generate_unique_id),\n2838: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n2839: \"\"\"\n2840: Add a *path operation* using an HTTP DELETE operation.\n2841: \n2842: ## Example\n2843: \n2844: ```python\n2845: from fastapi import APIRouter, FastAPI\n2846: \n2847: app = FastAPI()\n2848: router = APIRouter()\n2849: \n2850: @router.delete(\"/items/{item_id}\")\n2851: def delete_item(item_id: str):\n2852: return {\"message\": \"Item deleted\"}\n2853: \n2854: app.include_router(router)\n2855: ```\n2856: \"\"\"\n2857: return self.api_route(\n2858: path=path,\n2859: response_model=response_model,\n2860: status_code=status_code,\n2861: tags=tags,\n2862: dependencies=dependencies,\n2863: summary=summary,\n2864: description=description,\n2865: response_description=response_description,\n2866: responses=responses,\n2867: deprecated=deprecated,\n2868: methods=[\"DELETE\"],\n2869: operation_id=operation_id,\n2870: response_model_include=response_model_include,\n2871: response_model_exclude=response_model_exclude,\n2872: response_model_by_alias=response_model_by_alias,\n2873: response_model_exclude_unset=response_model_exclude_unset,\n2874: response_model_exclude_defaults=response_model_exclude_defaults,\n2875: response_model_exclude_none=response_model_exclude_none,\n2876: include_in_schema=include_in_schema,\n2877: response_class=response_class,\n2878: name=name,\n2879: callbacks=callbacks,\n2880: openapi_extra=openapi_extra,\n2881: generate_unique_id_function=generate_unique_id_function,\n2882: )\n2883: \n2884: def options(\n2885: self,\n2886: path: Annotated[\n2887: str,\n2888: Doc(\n2889: \"\"\"\n2890: The URL path to be used for this *path operation*.\n2891: \n2892: For example, in `http://example.com/items`, the path is `/items`.\n2893: \"\"\"\n2894: ),\n2895: ],\n2896: *,\n2897: response_model: Annotated[\n2898: Any,\n2899: Doc(\n2900: \"\"\"\n2901: The type to use for the response.\n2902: \n2903: It could be any valid Pydantic *field* type. So, it doesn't have to\n2904: be a Pydantic model, it could be other things, like a `list`, `dict`,\n2905: etc.\n2906: \n2907: It will be used for:\n2908: \n2909: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n2910: show it as the response (JSON Schema).\n2911: * Serialization: you could return an arbitrary object and the\n2912: `response_model` would be used to serialize that object into the\n2913: corresponding JSON.\n2914: * Filtering: the JSON sent to the client will only contain the data\n2915: (fields) defined in the `response_model`. If you returned an object\n2916: that contains an attribute `password` but the `response_model` does\n2917: not include that field, the JSON sent to the client would not have\n2918: that `password`.\n2919: * Validation: whatever you return will be serialized with the\n2920: `response_model`, converting any data as necessary to generate the\n2921: corresponding JSON. But if the data in the object returned is not\n2922: valid, that would mean a violation of the contract with the client,\n2923: so it's an error from the API developer. So, FastAPI will raise an\n2924: error and return a 500 error code (Internal Server Error).\n2925: \n2926: Read more about it in the\n2927: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n2928: \"\"\"\n2929: ),\n2930: ] = Default(None),\n2931: status_code: Annotated[\n2932: Optional[int],\n2933: Doc(\n2934: \"\"\"\n2935: The default status code to be used for the response.\n2936: \n2937: You could override the status code by returning a response directly.\n2938: \n2939: Read more about it in the\n2940: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n2941: \"\"\"\n2942: ),\n2943: ] = None,\n2944: tags: Annotated[\n2945: Optional[List[Union[str, Enum]]],\n2946: Doc(\n2947: \"\"\"\n2948: A list of tags to be applied to the *path operation*.\n2949: \n2950: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2951: \n2952: Read more about it in the\n2953: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n2954: \"\"\"\n2955: ),\n2956: ] = None,\n2957: dependencies: Annotated[\n2958: Optional[Sequence[params.Depends]],\n2959: Doc(\n2960: \"\"\"\n2961: A list of dependencies (using `Depends()`) to be applied to the\n2962: *path operation*.\n2963: \n2964: Read more about it in the\n2965: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n2966: \"\"\"\n2967: ),\n2968: ] = None,\n2969: summary: Annotated[\n2970: Optional[str],\n2971: Doc(\n2972: \"\"\"\n2973: A summary for the *path operation*.\n2974: \n2975: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2976: \n2977: Read more about it in the\n2978: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n2979: \"\"\"\n2980: ),\n2981: ] = None,\n2982: description: Annotated[\n2983: Optional[str],\n2984: Doc(\n2985: \"\"\"\n2986: A description for the *path operation*.\n2987: \n2988: If not provided, it will be extracted automatically from the docstring\n2989: of the *path operation function*.\n2990: \n2991: It can contain Markdown.\n2992: \n2993: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n2994: \n2995: Read more about it in the\n2996: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n2997: \"\"\"\n2998: ),\n2999: ] = None,\n3000: response_description: Annotated[\n3001: str,\n3002: Doc(\n3003: \"\"\"\n3004: The description for the default response.\n3005: \n3006: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3007: \"\"\"\n3008: ),\n3009: ] = \"Successful Response\",\n3010: responses: Annotated[\n3011: Optional[Dict[Union[int, str], Dict[str, Any]]],\n3012: Doc(\n3013: \"\"\"\n3014: Additional responses that could be returned by this *path operation*.\n3015: \n3016: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3017: \"\"\"\n3018: ),\n3019: ] = None,\n3020: deprecated: Annotated[\n3021: Optional[bool],\n3022: Doc(\n3023: \"\"\"\n3024: Mark this *path operation* as deprecated.\n3025: \n3026: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3027: \"\"\"\n3028: ),\n3029: ] = None,\n3030: operation_id: Annotated[\n3031: Optional[str],\n3032: Doc(\n3033: \"\"\"\n3034: Custom operation ID to be used by this *path operation*.\n3035: \n3036: By default, it is generated automatically.\n3037: \n3038: If you provide a custom operation ID, you need to make sure it is\n3039: unique for the whole API.\n3040: \n3041: You can customize the\n3042: operation ID generation with the parameter\n3043: `generate_unique_id_function` in the `FastAPI` class.\n3044: \n3045: Read more about it in the\n3046: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3047: \"\"\"\n3048: ),\n3049: ] = None,\n3050: response_model_include: Annotated[\n3051: Optional[IncEx],\n3052: Doc(\n3053: \"\"\"\n3054: Configuration passed to Pydantic to include only certain fields in the\n3055: response data.\n3056: \n3057: Read more about it in the\n3058: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3059: \"\"\"\n3060: ),\n3061: ] = None,\n3062: response_model_exclude: Annotated[\n3063: Optional[IncEx],\n3064: Doc(\n3065: \"\"\"\n3066: Configuration passed to Pydantic to exclude certain fields in the\n3067: response data.\n3068: \n3069: Read more about it in the\n3070: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3071: \"\"\"\n3072: ),\n3073: ] = None,\n3074: response_model_by_alias: Annotated[\n3075: bool,\n3076: Doc(\n3077: \"\"\"\n3078: Configuration passed to Pydantic to define if the response model\n3079: should be serialized by alias when an alias is used.\n3080: \n3081: Read more about it in the\n3082: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3083: \"\"\"\n3084: ),\n3085: ] = True,\n3086: response_model_exclude_unset: Annotated[\n3087: bool,\n3088: Doc(\n3089: \"\"\"\n3090: Configuration passed to Pydantic to define if the response data\n3091: should have all the fields, including the ones that were not set and\n3092: have their default values. This is different from\n3093: `response_model_exclude_defaults` in that if the fields are set,\n3094: they will be included in the response, even if the value is the same\n3095: as the default.\n3096: \n3097: When `True`, default values are omitted from the response.\n3098: \n3099: Read more about it in the\n3100: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3101: \"\"\"\n3102: ),\n3103: ] = False,\n3104: response_model_exclude_defaults: Annotated[\n3105: bool,\n3106: Doc(\n3107: \"\"\"\n3108: Configuration passed to Pydantic to define if the response data\n3109: should have all the fields, including the ones that have the same value\n3110: as the default. This is different from `response_model_exclude_unset`\n3111: in that if the fields are set but contain the same default values,\n3112: they will be excluded from the response.\n3113: \n3114: When `True`, default values are omitted from the response.\n3115: \n3116: Read more about it in the\n3117: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3118: \"\"\"\n3119: ),\n3120: ] = False,\n3121: response_model_exclude_none: Annotated[\n3122: bool,\n3123: Doc(\n3124: \"\"\"\n3125: Configuration passed to Pydantic to define if the response data should\n3126: exclude fields set to `None`.\n3127: \n3128: This is much simpler (less smart) than `response_model_exclude_unset`\n3129: and `response_model_exclude_defaults`. You probably want to use one of\n3130: those two instead of this one, as those allow returning `None` values\n3131: when it makes sense.\n3132: \n3133: Read more about it in the\n3134: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n3135: \"\"\"\n3136: ),\n3137: ] = False,\n3138: include_in_schema: Annotated[\n3139: bool,\n3140: Doc(\n3141: \"\"\"\n3142: Include this *path operation* in the generated OpenAPI schema.\n3143: \n3144: This affects the generated OpenAPI (e.g. visible at `/docs`).\n3145: \n3146: Read more about it in the\n3147: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n3148: \"\"\"\n3149: ),\n3150: ] = True,\n3151: response_class: Annotated[\n3152: Type[Response],\n3153: Doc(\n3154: \"\"\"\n3155: Response class to be used for this *path operation*.\n3156: \n3157: This will not be used if you return a response directly.\n3158: \n3159: Read more about it in the\n3160: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n3161: \"\"\"\n3162: ),\n3163: ] = Default(JSONResponse),\n3164: name: Annotated[\n3165: Optional[str],\n3166: Doc(\n3167: \"\"\"\n3168: Name for this *path operation*. Only used internally.\n3169: \"\"\"\n3170: ),\n3171: ] = None,\n3172: callbacks: Annotated[\n3173: Optional[List[BaseRoute]],\n3174: Doc(\n3175: \"\"\"\n3176: List of *path operations* that will be used as OpenAPI callbacks.\n3177: \n3178: This is only for OpenAPI documentation, the callbacks won't be used\n3179: directly.\n3180: \n3181: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3182: \n3183: Read more about it in the\n3184: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n3185: \"\"\"\n3186: ),\n3187: ] = None,\n3188: openapi_extra: Annotated[\n3189: Optional[Dict[str, Any]],\n3190: Doc(\n3191: \"\"\"\n3192: Extra metadata to be included in the OpenAPI schema for this *path\n3193: operation*.\n3194: \n3195: Read more about it in the\n3196: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n3197: \"\"\"\n3198: ),\n3199: ] = None,\n3200: generate_unique_id_function: Annotated[\n3201: Callable[[APIRoute], str],\n3202: Doc(\n3203: \"\"\"\n3204: Customize the function used to generate unique IDs for the *path\n3205: operations* shown in the generated OpenAPI.\n3206: \n3207: This is particularly useful when automatically generating clients or\n3208: SDKs for your API.\n3209: \n3210: Read more about it in the\n3211: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3212: \"\"\"\n3213: ),\n3214: ] = Default(generate_unique_id),\n3215: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n3216: \"\"\"\n3217: Add a *path operation* using an HTTP OPTIONS operation.\n3218: \n3219: ## Example\n3220: \n3221: ```python\n3222: from fastapi import APIRouter, FastAPI\n3223: \n3224: app = FastAPI()\n3225: router = APIRouter()\n3226: \n3227: @router.options(\"/items/\")\n3228: def get_item_options():\n3229: return {\"additions\": [\"Aji\", \"Guacamole\"]}\n3230: \n3231: app.include_router(router)\n3232: ```\n3233: \"\"\"\n3234: return self.api_route(\n3235: path=path,\n3236: response_model=response_model,\n3237: status_code=status_code,\n3238: tags=tags,\n3239: dependencies=dependencies,\n3240: summary=summary,\n3241: description=description,\n3242: response_description=response_description,\n3243: responses=responses,\n3244: deprecated=deprecated,\n3245: methods=[\"OPTIONS\"],\n3246: operation_id=operation_id,\n3247: response_model_include=response_model_include,\n3248: response_model_exclude=response_model_exclude,\n3249: response_model_by_alias=response_model_by_alias,\n3250: response_model_exclude_unset=response_model_exclude_unset,\n3251: response_model_exclude_defaults=response_model_exclude_defaults,\n3252: response_model_exclude_none=response_model_exclude_none,\n3253: include_in_schema=include_in_schema,\n3254: response_class=response_class,\n3255: name=name,\n3256: callbacks=callbacks,\n3257: openapi_extra=openapi_extra,\n3258: generate_unique_id_function=generate_unique_id_function,\n3259: )\n3260: \n3261: def head(\n3262: self,\n3263: path: Annotated[\n3264: str,\n3265: Doc(\n3266: \"\"\"\n3267: The URL path to be used for this *path operation*.\n3268: \n3269: For example, in `http://example.com/items`, the path is `/items`.\n3270: \"\"\"\n3271: ),\n3272: ],\n3273: *,\n3274: response_model: Annotated[\n3275: Any,\n3276: Doc(\n3277: \"\"\"\n3278: The type to use for the response.\n3279: \n3280: It could be any valid Pydantic *field* type. So, it doesn't have to\n3281: be a Pydantic model, it could be other things, like a `list`, `dict`,\n3282: etc.\n3283: \n3284: It will be used for:\n3285: \n3286: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n3287: show it as the response (JSON Schema).\n3288: * Serialization: you could return an arbitrary object and the\n3289: `response_model` would be used to serialize that object into the\n3290: corresponding JSON.\n3291: * Filtering: the JSON sent to the client will only contain the data\n3292: (fields) defined in the `response_model`. If you returned an object\n3293: that contains an attribute `password` but the `response_model` does\n3294: not include that field, the JSON sent to the client would not have\n3295: that `password`.\n3296: * Validation: whatever you return will be serialized with the\n3297: `response_model`, converting any data as necessary to generate the\n3298: corresponding JSON. But if the data in the object returned is not\n3299: valid, that would mean a violation of the contract with the client,\n3300: so it's an error from the API developer. So, FastAPI will raise an\n3301: error and return a 500 error code (Internal Server Error).\n3302: \n3303: Read more about it in the\n3304: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n3305: \"\"\"\n3306: ),\n3307: ] = Default(None),\n3308: status_code: Annotated[\n3309: Optional[int],\n3310: Doc(\n3311: \"\"\"\n3312: The default status code to be used for the response.\n3313: \n3314: You could override the status code by returning a response directly.\n3315: \n3316: Read more about it in the\n3317: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n3318: \"\"\"\n3319: ),\n3320: ] = None,\n3321: tags: Annotated[\n3322: Optional[List[Union[str, Enum]]],\n3323: Doc(\n3324: \"\"\"\n3325: A list of tags to be applied to the *path operation*.\n3326: \n3327: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3328: \n3329: Read more about it in the\n3330: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n3331: \"\"\"\n3332: ),\n3333: ] = None,\n3334: dependencies: Annotated[\n3335: Optional[Sequence[params.Depends]],\n3336: Doc(\n3337: \"\"\"\n3338: A list of dependencies (using `Depends()`) to be applied to the\n3339: *path operation*.\n3340: \n3341: Read more about it in the\n3342: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n3343: \"\"\"\n3344: ),\n3345: ] = None,\n3346: summary: Annotated[\n3347: Optional[str],\n3348: Doc(\n3349: \"\"\"\n3350: A summary for the *path operation*.\n3351: \n3352: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3353: \n3354: Read more about it in the\n3355: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3356: \"\"\"\n3357: ),\n3358: ] = None,\n3359: description: Annotated[\n3360: Optional[str],\n3361: Doc(\n3362: \"\"\"\n3363: A description for the *path operation*.\n3364: \n3365: If not provided, it will be extracted automatically from the docstring\n3366: of the *path operation function*.\n3367: \n3368: It can contain Markdown.\n3369: \n3370: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3371: \n3372: Read more about it in the\n3373: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3374: \"\"\"\n3375: ),\n3376: ] = None,\n3377: response_description: Annotated[\n3378: str,\n3379: Doc(\n3380: \"\"\"\n3381: The description for the default response.\n3382: \n3383: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3384: \"\"\"\n3385: ),\n3386: ] = \"Successful Response\",\n3387: responses: Annotated[\n3388: Optional[Dict[Union[int, str], Dict[str, Any]]],\n3389: Doc(\n3390: \"\"\"\n3391: Additional responses that could be returned by this *path operation*.\n3392: \n3393: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3394: \"\"\"\n3395: ),\n3396: ] = None,\n3397: deprecated: Annotated[\n3398: Optional[bool],\n3399: Doc(\n3400: \"\"\"\n3401: Mark this *path operation* as deprecated.\n3402: \n3403: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3404: \"\"\"\n3405: ),\n3406: ] = None,\n3407: operation_id: Annotated[\n3408: Optional[str],\n3409: Doc(\n3410: \"\"\"\n3411: Custom operation ID to be used by this *path operation*.\n3412: \n3413: By default, it is generated automatically.\n3414: \n3415: If you provide a custom operation ID, you need to make sure it is\n3416: unique for the whole API.\n3417: \n3418: You can customize the\n3419: operation ID generation with the parameter\n3420: `generate_unique_id_function` in the `FastAPI` class.\n3421: \n3422: Read more about it in the\n3423: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3424: \"\"\"\n3425: ),\n3426: ] = None,\n3427: response_model_include: Annotated[\n3428: Optional[IncEx],\n3429: Doc(\n3430: \"\"\"\n3431: Configuration passed to Pydantic to include only certain fields in the\n3432: response data.\n3433: \n3434: Read more about it in the\n3435: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3436: \"\"\"\n3437: ),\n3438: ] = None,\n3439: response_model_exclude: Annotated[\n3440: Optional[IncEx],\n3441: Doc(\n3442: \"\"\"\n3443: Configuration passed to Pydantic to exclude certain fields in the\n3444: response data.\n3445: \n3446: Read more about it in the\n3447: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3448: \"\"\"\n3449: ),\n3450: ] = None,\n3451: response_model_by_alias: Annotated[\n3452: bool,\n3453: Doc(\n3454: \"\"\"\n3455: Configuration passed to Pydantic to define if the response model\n3456: should be serialized by alias when an alias is used.\n3457: \n3458: Read more about it in the\n3459: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3460: \"\"\"\n3461: ),\n3462: ] = True,\n3463: response_model_exclude_unset: Annotated[\n3464: bool,\n3465: Doc(\n3466: \"\"\"\n3467: Configuration passed to Pydantic to define if the response data\n3468: should have all the fields, including the ones that were not set and\n3469: have their default values. This is different from\n3470: `response_model_exclude_defaults` in that if the fields are set,\n3471: they will be included in the response, even if the value is the same\n3472: as the default.\n3473: \n3474: When `True`, default values are omitted from the response.\n3475: \n3476: Read more about it in the\n3477: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3478: \"\"\"\n3479: ),\n3480: ] = False,\n3481: response_model_exclude_defaults: Annotated[\n3482: bool,\n3483: Doc(\n3484: \"\"\"\n3485: Configuration passed to Pydantic to define if the response data\n3486: should have all the fields, including the ones that have the same value\n3487: as the default. This is different from `response_model_exclude_unset`\n3488: in that if the fields are set but contain the same default values,\n3489: they will be excluded from the response.\n3490: \n3491: When `True`, default values are omitted from the response.\n3492: \n3493: Read more about it in the\n3494: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3495: \"\"\"\n3496: ),\n3497: ] = False,\n3498: response_model_exclude_none: Annotated[\n3499: bool,\n3500: Doc(\n3501: \"\"\"\n3502: Configuration passed to Pydantic to define if the response data should\n3503: exclude fields set to `None`.\n3504: \n3505: This is much simpler (less smart) than `response_model_exclude_unset`\n3506: and `response_model_exclude_defaults`. You probably want to use one of\n3507: those two instead of this one, as those allow returning `None` values\n3508: when it makes sense.\n3509: \n3510: Read more about it in the\n3511: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n3512: \"\"\"\n3513: ),\n3514: ] = False,\n3515: include_in_schema: Annotated[\n3516: bool,\n3517: Doc(\n3518: \"\"\"\n3519: Include this *path operation* in the generated OpenAPI schema.\n3520: \n3521: This affects the generated OpenAPI (e.g. visible at `/docs`).\n3522: \n3523: Read more about it in the\n3524: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n3525: \"\"\"\n3526: ),\n3527: ] = True,\n3528: response_class: Annotated[\n3529: Type[Response],\n3530: Doc(\n3531: \"\"\"\n3532: Response class to be used for this *path operation*.\n3533: \n3534: This will not be used if you return a response directly.\n3535: \n3536: Read more about it in the\n3537: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n3538: \"\"\"\n3539: ),\n3540: ] = Default(JSONResponse),\n3541: name: Annotated[\n3542: Optional[str],\n3543: Doc(\n3544: \"\"\"\n3545: Name for this *path operation*. Only used internally.\n3546: \"\"\"\n3547: ),\n3548: ] = None,\n3549: callbacks: Annotated[\n3550: Optional[List[BaseRoute]],\n3551: Doc(\n3552: \"\"\"\n3553: List of *path operations* that will be used as OpenAPI callbacks.\n3554: \n3555: This is only for OpenAPI documentation, the callbacks won't be used\n3556: directly.\n3557: \n3558: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3559: \n3560: Read more about it in the\n3561: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n3562: \"\"\"\n3563: ),\n3564: ] = None,\n3565: openapi_extra: Annotated[\n3566: Optional[Dict[str, Any]],\n3567: Doc(\n3568: \"\"\"\n3569: Extra metadata to be included in the OpenAPI schema for this *path\n3570: operation*.\n3571: \n3572: Read more about it in the\n3573: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n3574: \"\"\"\n3575: ),\n3576: ] = None,\n3577: generate_unique_id_function: Annotated[\n3578: Callable[[APIRoute], str],\n3579: Doc(\n3580: \"\"\"\n3581: Customize the function used to generate unique IDs for the *path\n3582: operations* shown in the generated OpenAPI.\n3583: \n3584: This is particularly useful when automatically generating clients or\n3585: SDKs for your API.\n3586: \n3587: Read more about it in the\n3588: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3589: \"\"\"\n3590: ),\n3591: ] = Default(generate_unique_id),\n3592: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n3593: \"\"\"\n3594: Add a *path operation* using an HTTP HEAD operation.\n3595: \n3596: ## Example\n3597: \n3598: ```python\n3599: from fastapi import APIRouter, FastAPI\n3600: from pydantic import BaseModel\n3601: \n3602: class Item(BaseModel):\n3603: name: str\n3604: description: str | None = None\n3605: \n3606: app = FastAPI()\n3607: router = APIRouter()\n3608: \n3609: @router.head(\"/items/\", status_code=204)\n3610: def get_items_headers(response: Response):\n3611: response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n3612: \n3613: app.include_router(router)\n3614: ```\n3615: \"\"\"\n3616: return self.api_route(\n3617: path=path,\n3618: response_model=response_model,\n3619: status_code=status_code,\n3620: tags=tags,\n3621: dependencies=dependencies,\n3622: summary=summary,\n3623: description=description,\n3624: response_description=response_description,\n3625: responses=responses,\n3626: deprecated=deprecated,\n3627: methods=[\"HEAD\"],\n3628: operation_id=operation_id,\n3629: response_model_include=response_model_include,\n3630: response_model_exclude=response_model_exclude,\n3631: response_model_by_alias=response_model_by_alias,\n3632: response_model_exclude_unset=response_model_exclude_unset,\n3633: response_model_exclude_defaults=response_model_exclude_defaults,\n3634: response_model_exclude_none=response_model_exclude_none,\n3635: include_in_schema=include_in_schema,\n3636: response_class=response_class,\n3637: name=name,\n3638: callbacks=callbacks,\n3639: openapi_extra=openapi_extra,\n3640: generate_unique_id_function=generate_unique_id_function,\n3641: )\n3642: \n3643: def patch(\n3644: self,\n3645: path: Annotated[\n3646: str,\n3647: Doc(\n3648: \"\"\"\n3649: The URL path to be used for this *path operation*.\n3650: \n3651: For example, in `http://example.com/items`, the path is `/items`.\n3652: \"\"\"\n3653: ),\n3654: ],\n3655: *,\n3656: response_model: Annotated[\n3657: Any,\n3658: Doc(\n3659: \"\"\"\n3660: The type to use for the response.\n3661: \n3662: It could be any valid Pydantic *field* type. So, it doesn't have to\n3663: be a Pydantic model, it could be other things, like a `list`, `dict`,\n3664: etc.\n3665: \n3666: It will be used for:\n3667: \n3668: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n3669: show it as the response (JSON Schema).\n3670: * Serialization: you could return an arbitrary object and the\n3671: `response_model` would be used to serialize that object into the\n3672: corresponding JSON.\n3673: * Filtering: the JSON sent to the client will only contain the data\n3674: (fields) defined in the `response_model`. If you returned an object\n3675: that contains an attribute `password` but the `response_model` does\n3676: not include that field, the JSON sent to the client would not have\n3677: that `password`.\n3678: * Validation: whatever you return will be serialized with the\n3679: `response_model`, converting any data as necessary to generate the\n3680: corresponding JSON. But if the data in the object returned is not\n3681: valid, that would mean a violation of the contract with the client,\n3682: so it's an error from the API developer. So, FastAPI will raise an\n3683: error and return a 500 error code (Internal Server Error).\n3684: \n3685: Read more about it in the\n3686: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n3687: \"\"\"\n3688: ),\n3689: ] = Default(None),\n3690: status_code: Annotated[\n3691: Optional[int],\n3692: Doc(\n3693: \"\"\"\n3694: The default status code to be used for the response.\n3695: \n3696: You could override the status code by returning a response directly.\n3697: \n3698: Read more about it in the\n3699: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n3700: \"\"\"\n3701: ),\n3702: ] = None,\n3703: tags: Annotated[\n3704: Optional[List[Union[str, Enum]]],\n3705: Doc(\n3706: \"\"\"\n3707: A list of tags to be applied to the *path operation*.\n3708: \n3709: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3710: \n3711: Read more about it in the\n3712: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n3713: \"\"\"\n3714: ),\n3715: ] = None,\n3716: dependencies: Annotated[\n3717: Optional[Sequence[params.Depends]],\n3718: Doc(\n3719: \"\"\"\n3720: A list of dependencies (using `Depends()`) to be applied to the\n3721: *path operation*.\n3722: \n3723: Read more about it in the\n3724: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n3725: \"\"\"\n3726: ),\n3727: ] = None,\n3728: summary: Annotated[\n3729: Optional[str],\n3730: Doc(\n3731: \"\"\"\n3732: A summary for the *path operation*.\n3733: \n3734: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3735: \n3736: Read more about it in the\n3737: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3738: \"\"\"\n3739: ),\n3740: ] = None,\n3741: description: Annotated[\n3742: Optional[str],\n3743: Doc(\n3744: \"\"\"\n3745: A description for the *path operation*.\n3746: \n3747: If not provided, it will be extracted automatically from the docstring\n3748: of the *path operation function*.\n3749: \n3750: It can contain Markdown.\n3751: \n3752: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3753: \n3754: Read more about it in the\n3755: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n3756: \"\"\"\n3757: ),\n3758: ] = None,\n3759: response_description: Annotated[\n3760: str,\n3761: Doc(\n3762: \"\"\"\n3763: The description for the default response.\n3764: \n3765: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3766: \"\"\"\n3767: ),\n3768: ] = \"Successful Response\",\n3769: responses: Annotated[\n3770: Optional[Dict[Union[int, str], Dict[str, Any]]],\n3771: Doc(\n3772: \"\"\"\n3773: Additional responses that could be returned by this *path operation*.\n3774: \n3775: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3776: \"\"\"\n3777: ),\n3778: ] = None,\n3779: deprecated: Annotated[\n3780: Optional[bool],\n3781: Doc(\n3782: \"\"\"\n3783: Mark this *path operation* as deprecated.\n3784: \n3785: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3786: \"\"\"\n3787: ),\n3788: ] = None,\n3789: operation_id: Annotated[\n3790: Optional[str],\n3791: Doc(\n3792: \"\"\"\n3793: Custom operation ID to be used by this *path operation*.\n3794: \n3795: By default, it is generated automatically.\n3796: \n3797: If you provide a custom operation ID, you need to make sure it is\n3798: unique for the whole API.\n3799: \n3800: You can customize the\n3801: operation ID generation with the parameter\n3802: `generate_unique_id_function` in the `FastAPI` class.\n3803: \n3804: Read more about it in the\n3805: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3806: \"\"\"\n3807: ),\n3808: ] = None,\n3809: response_model_include: Annotated[\n3810: Optional[IncEx],\n3811: Doc(\n3812: \"\"\"\n3813: Configuration passed to Pydantic to include only certain fields in the\n3814: response data.\n3815: \n3816: Read more about it in the\n3817: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3818: \"\"\"\n3819: ),\n3820: ] = None,\n3821: response_model_exclude: Annotated[\n3822: Optional[IncEx],\n3823: Doc(\n3824: \"\"\"\n3825: Configuration passed to Pydantic to exclude certain fields in the\n3826: response data.\n3827: \n3828: Read more about it in the\n3829: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3830: \"\"\"\n3831: ),\n3832: ] = None,\n3833: response_model_by_alias: Annotated[\n3834: bool,\n3835: Doc(\n3836: \"\"\"\n3837: Configuration passed to Pydantic to define if the response model\n3838: should be serialized by alias when an alias is used.\n3839: \n3840: Read more about it in the\n3841: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n3842: \"\"\"\n3843: ),\n3844: ] = True,\n3845: response_model_exclude_unset: Annotated[\n3846: bool,\n3847: Doc(\n3848: \"\"\"\n3849: Configuration passed to Pydantic to define if the response data\n3850: should have all the fields, including the ones that were not set and\n3851: have their default values. This is different from\n3852: `response_model_exclude_defaults` in that if the fields are set,\n3853: they will be included in the response, even if the value is the same\n3854: as the default.\n3855: \n3856: When `True`, default values are omitted from the response.\n3857: \n3858: Read more about it in the\n3859: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3860: \"\"\"\n3861: ),\n3862: ] = False,\n3863: response_model_exclude_defaults: Annotated[\n3864: bool,\n3865: Doc(\n3866: \"\"\"\n3867: Configuration passed to Pydantic to define if the response data\n3868: should have all the fields, including the ones that have the same value\n3869: as the default. This is different from `response_model_exclude_unset`\n3870: in that if the fields are set but contain the same default values,\n3871: they will be excluded from the response.\n3872: \n3873: When `True`, default values are omitted from the response.\n3874: \n3875: Read more about it in the\n3876: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n3877: \"\"\"\n3878: ),\n3879: ] = False,\n3880: response_model_exclude_none: Annotated[\n3881: bool,\n3882: Doc(\n3883: \"\"\"\n3884: Configuration passed to Pydantic to define if the response data should\n3885: exclude fields set to `None`.\n3886: \n3887: This is much simpler (less smart) than `response_model_exclude_unset`\n3888: and `response_model_exclude_defaults`. You probably want to use one of\n3889: those two instead of this one, as those allow returning `None` values\n3890: when it makes sense.\n3891: \n3892: Read more about it in the\n3893: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n3894: \"\"\"\n3895: ),\n3896: ] = False,\n3897: include_in_schema: Annotated[\n3898: bool,\n3899: Doc(\n3900: \"\"\"\n3901: Include this *path operation* in the generated OpenAPI schema.\n3902: \n3903: This affects the generated OpenAPI (e.g. visible at `/docs`).\n3904: \n3905: Read more about it in the\n3906: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n3907: \"\"\"\n3908: ),\n3909: ] = True,\n3910: response_class: Annotated[\n3911: Type[Response],\n3912: Doc(\n3913: \"\"\"\n3914: Response class to be used for this *path operation*.\n3915: \n3916: This will not be used if you return a response directly.\n3917: \n3918: Read more about it in the\n3919: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n3920: \"\"\"\n3921: ),\n3922: ] = Default(JSONResponse),\n3923: name: Annotated[\n3924: Optional[str],\n3925: Doc(\n3926: \"\"\"\n3927: Name for this *path operation*. Only used internally.\n3928: \"\"\"\n3929: ),\n3930: ] = None,\n3931: callbacks: Annotated[\n3932: Optional[List[BaseRoute]],\n3933: Doc(\n3934: \"\"\"\n3935: List of *path operations* that will be used as OpenAPI callbacks.\n3936: \n3937: This is only for OpenAPI documentation, the callbacks won't be used\n3938: directly.\n3939: \n3940: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n3941: \n3942: Read more about it in the\n3943: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n3944: \"\"\"\n3945: ),\n3946: ] = None,\n3947: openapi_extra: Annotated[\n3948: Optional[Dict[str, Any]],\n3949: Doc(\n3950: \"\"\"\n3951: Extra metadata to be included in the OpenAPI schema for this *path\n3952: operation*.\n3953: \n3954: Read more about it in the\n3955: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n3956: \"\"\"\n3957: ),\n3958: ] = None,\n3959: generate_unique_id_function: Annotated[\n3960: Callable[[APIRoute], str],\n3961: Doc(\n3962: \"\"\"\n3963: Customize the function used to generate unique IDs for the *path\n3964: operations* shown in the generated OpenAPI.\n3965: \n3966: This is particularly useful when automatically generating clients or\n3967: SDKs for your API.\n3968: \n3969: Read more about it in the\n3970: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n3971: \"\"\"\n3972: ),\n3973: ] = Default(generate_unique_id),\n3974: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n3975: \"\"\"\n3976: Add a *path operation* using an HTTP PATCH operation.\n3977: \n3978: ## Example\n3979: \n3980: ```python\n3981: from fastapi import APIRouter, FastAPI\n3982: from pydantic import BaseModel\n3983: \n3984: class Item(BaseModel):\n3985: name: str\n3986: description: str | None = None\n3987: \n3988: app = FastAPI()\n3989: router = APIRouter()\n3990: \n3991: @router.patch(\"/items/\")\n3992: def update_item(item: Item):\n3993: return {\"message\": \"Item updated in place\"}\n3994: \n3995: app.include_router(router)\n3996: ```\n3997: \"\"\"\n3998: return self.api_route(\n3999: path=path,\n4000: response_model=response_model,\n4001: status_code=status_code,\n4002: tags=tags,\n4003: dependencies=dependencies,\n4004: summary=summary,\n4005: description=description,\n4006: response_description=response_description,\n4007: responses=responses,\n4008: deprecated=deprecated,\n4009: methods=[\"PATCH\"],\n4010: operation_id=operation_id,\n4011: response_model_include=response_model_include,\n4012: response_model_exclude=response_model_exclude,\n4013: response_model_by_alias=response_model_by_alias,\n4014: response_model_exclude_unset=response_model_exclude_unset,\n4015: response_model_exclude_defaults=response_model_exclude_defaults,\n4016: response_model_exclude_none=response_model_exclude_none,\n4017: include_in_schema=include_in_schema,\n4018: response_class=response_class,\n4019: name=name,\n4020: callbacks=callbacks,\n4021: openapi_extra=openapi_extra,\n4022: generate_unique_id_function=generate_unique_id_function,\n4023: )\n4024: \n4025: def trace(\n4026: self,\n4027: path: Annotated[\n4028: str,\n4029: Doc(\n4030: \"\"\"\n4031: The URL path to be used for this *path operation*.\n4032: \n4033: For example, in `http://example.com/items`, the path is `/items`.\n4034: \"\"\"\n4035: ),\n4036: ],\n4037: *,\n4038: response_model: Annotated[\n4039: Any,\n4040: Doc(\n4041: \"\"\"\n4042: The type to use for the response.\n4043: \n4044: It could be any valid Pydantic *field* type. So, it doesn't have to\n4045: be a Pydantic model, it could be other things, like a `list`, `dict`,\n4046: etc.\n4047: \n4048: It will be used for:\n4049: \n4050: * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n4051: show it as the response (JSON Schema).\n4052: * Serialization: you could return an arbitrary object and the\n4053: `response_model` would be used to serialize that object into the\n4054: corresponding JSON.\n4055: * Filtering: the JSON sent to the client will only contain the data\n4056: (fields) defined in the `response_model`. If you returned an object\n4057: that contains an attribute `password` but the `response_model` does\n4058: not include that field, the JSON sent to the client would not have\n4059: that `password`.\n4060: * Validation: whatever you return will be serialized with the\n4061: `response_model`, converting any data as necessary to generate the\n4062: corresponding JSON. But if the data in the object returned is not\n4063: valid, that would mean a violation of the contract with the client,\n4064: so it's an error from the API developer. So, FastAPI will raise an\n4065: error and return a 500 error code (Internal Server Error).\n4066: \n4067: Read more about it in the\n4068: [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n4069: \"\"\"\n4070: ),\n4071: ] = Default(None),\n4072: status_code: Annotated[\n4073: Optional[int],\n4074: Doc(\n4075: \"\"\"\n4076: The default status code to be used for the response.\n4077: \n4078: You could override the status code by returning a response directly.\n4079: \n4080: Read more about it in the\n4081: [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n4082: \"\"\"\n4083: ),\n4084: ] = None,\n4085: tags: Annotated[\n4086: Optional[List[Union[str, Enum]]],\n4087: Doc(\n4088: \"\"\"\n4089: A list of tags to be applied to the *path operation*.\n4090: \n4091: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4092: \n4093: Read more about it in the\n4094: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n4095: \"\"\"\n4096: ),\n4097: ] = None,\n4098: dependencies: Annotated[\n4099: Optional[Sequence[params.Depends]],\n4100: Doc(\n4101: \"\"\"\n4102: A list of dependencies (using `Depends()`) to be applied to the\n4103: *path operation*.\n4104: \n4105: Read more about it in the\n4106: [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n4107: \"\"\"\n4108: ),\n4109: ] = None,\n4110: summary: Annotated[\n4111: Optional[str],\n4112: Doc(\n4113: \"\"\"\n4114: A summary for the *path operation*.\n4115: \n4116: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4117: \n4118: Read more about it in the\n4119: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n4120: \"\"\"\n4121: ),\n4122: ] = None,\n4123: description: Annotated[\n4124: Optional[str],\n4125: Doc(\n4126: \"\"\"\n4127: A description for the *path operation*.\n4128: \n4129: If not provided, it will be extracted automatically from the docstring\n4130: of the *path operation function*.\n4131: \n4132: It can contain Markdown.\n4133: \n4134: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4135: \n4136: Read more about it in the\n4137: [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n4138: \"\"\"\n4139: ),\n4140: ] = None,\n4141: response_description: Annotated[\n4142: str,\n4143: Doc(\n4144: \"\"\"\n4145: The description for the default response.\n4146: \n4147: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4148: \"\"\"\n4149: ),\n4150: ] = \"Successful Response\",\n4151: responses: Annotated[\n4152: Optional[Dict[Union[int, str], Dict[str, Any]]],\n4153: Doc(\n4154: \"\"\"\n4155: Additional responses that could be returned by this *path operation*.\n4156: \n4157: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4158: \"\"\"\n4159: ),\n4160: ] = None,\n4161: deprecated: Annotated[\n4162: Optional[bool],\n4163: Doc(\n4164: \"\"\"\n4165: Mark this *path operation* as deprecated.\n4166: \n4167: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4168: \"\"\"\n4169: ),\n4170: ] = None,\n4171: operation_id: Annotated[\n4172: Optional[str],\n4173: Doc(\n4174: \"\"\"\n4175: Custom operation ID to be used by this *path operation*.\n4176: \n4177: By default, it is generated automatically.\n4178: \n4179: If you provide a custom operation ID, you need to make sure it is\n4180: unique for the whole API.\n4181: \n4182: You can customize the\n4183: operation ID generation with the parameter\n4184: `generate_unique_id_function` in the `FastAPI` class.\n4185: \n4186: Read more about it in the\n4187: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n4188: \"\"\"\n4189: ),\n4190: ] = None,\n4191: response_model_include: Annotated[\n4192: Optional[IncEx],\n4193: Doc(\n4194: \"\"\"\n4195: Configuration passed to Pydantic to include only certain fields in the\n4196: response data.\n4197: \n4198: Read more about it in the\n4199: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n4200: \"\"\"\n4201: ),\n4202: ] = None,\n4203: response_model_exclude: Annotated[\n4204: Optional[IncEx],\n4205: Doc(\n4206: \"\"\"\n4207: Configuration passed to Pydantic to exclude certain fields in the\n4208: response data.\n4209: \n4210: Read more about it in the\n4211: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n4212: \"\"\"\n4213: ),\n4214: ] = None,\n4215: response_model_by_alias: Annotated[\n4216: bool,\n4217: Doc(\n4218: \"\"\"\n4219: Configuration passed to Pydantic to define if the response model\n4220: should be serialized by alias when an alias is used.\n4221: \n4222: Read more about it in the\n4223: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n4224: \"\"\"\n4225: ),\n4226: ] = True,\n4227: response_model_exclude_unset: Annotated[\n4228: bool,\n4229: Doc(\n4230: \"\"\"\n4231: Configuration passed to Pydantic to define if the response data\n4232: should have all the fields, including the ones that were not set and\n4233: have their default values. This is different from\n4234: `response_model_exclude_defaults` in that if the fields are set,\n4235: they will be included in the response, even if the value is the same\n4236: as the default.\n4237: \n4238: When `True`, default values are omitted from the response.\n4239: \n4240: Read more about it in the\n4241: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n4242: \"\"\"\n4243: ),\n4244: ] = False,\n4245: response_model_exclude_defaults: Annotated[\n4246: bool,\n4247: Doc(\n4248: \"\"\"\n4249: Configuration passed to Pydantic to define if the response data\n4250: should have all the fields, including the ones that have the same value\n4251: as the default. This is different from `response_model_exclude_unset`\n4252: in that if the fields are set but contain the same default values,\n4253: they will be excluded from the response.\n4254: \n4255: When `True`, default values are omitted from the response.\n4256: \n4257: Read more about it in the\n4258: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n4259: \"\"\"\n4260: ),\n4261: ] = False,\n4262: response_model_exclude_none: Annotated[\n4263: bool,\n4264: Doc(\n4265: \"\"\"\n4266: Configuration passed to Pydantic to define if the response data should\n4267: exclude fields set to `None`.\n4268: \n4269: This is much simpler (less smart) than `response_model_exclude_unset`\n4270: and `response_model_exclude_defaults`. You probably want to use one of\n4271: those two instead of this one, as those allow returning `None` values\n4272: when it makes sense.\n4273: \n4274: Read more about it in the\n4275: [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n4276: \"\"\"\n4277: ),\n4278: ] = False,\n4279: include_in_schema: Annotated[\n4280: bool,\n4281: Doc(\n4282: \"\"\"\n4283: Include this *path operation* in the generated OpenAPI schema.\n4284: \n4285: This affects the generated OpenAPI (e.g. visible at `/docs`).\n4286: \n4287: Read more about it in the\n4288: [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n4289: \"\"\"\n4290: ),\n4291: ] = True,\n4292: response_class: Annotated[\n4293: Type[Response],\n4294: Doc(\n4295: \"\"\"\n4296: Response class to be used for this *path operation*.\n4297: \n4298: This will not be used if you return a response directly.\n4299: \n4300: Read more about it in the\n4301: [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n4302: \"\"\"\n4303: ),\n4304: ] = Default(JSONResponse),\n4305: name: Annotated[\n4306: Optional[str],\n4307: Doc(\n4308: \"\"\"\n4309: Name for this *path operation*. Only used internally.\n4310: \"\"\"\n4311: ),\n4312: ] = None,\n4313: callbacks: Annotated[\n4314: Optional[List[BaseRoute]],\n4315: Doc(\n4316: \"\"\"\n4317: List of *path operations* that will be used as OpenAPI callbacks.\n4318: \n4319: This is only for OpenAPI documentation, the callbacks won't be used\n4320: directly.\n4321: \n4322: It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n4323: \n4324: Read more about it in the\n4325: [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n4326: \"\"\"\n4327: ),\n4328: ] = None,\n4329: openapi_extra: Annotated[\n4330: Optional[Dict[str, Any]],\n4331: Doc(\n4332: \"\"\"\n4333: Extra metadata to be included in the OpenAPI schema for this *path\n4334: operation*.\n4335: \n4336: Read more about it in the\n4337: [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n4338: \"\"\"\n4339: ),\n4340: ] = None,\n4341: generate_unique_id_function: Annotated[\n4342: Callable[[APIRoute], str],\n4343: Doc(\n4344: \"\"\"\n4345: Customize the function used to generate unique IDs for the *path\n4346: operations* shown in the generated OpenAPI.\n4347: \n4348: This is particularly useful when automatically generating clients or\n4349: SDKs for your API.\n4350: \n4351: Read more about it in the\n4352: [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n4353: \"\"\"\n4354: ),\n4355: ] = Default(generate_unique_id),\n4356: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4357: \"\"\"\n4358: Add a *path operation* using an HTTP TRACE operation.\n4359: \n4360: ## Example\n4361: \n4362: ```python\n4363: from fastapi import APIRouter, FastAPI\n4364: from pydantic import BaseModel\n4365: \n4366: class Item(BaseModel):\n4367: name: str\n4368: description: str | None = None\n4369: \n4370: app = FastAPI()\n4371: router = APIRouter()\n4372: \n4373: @router.trace(\"/items/{item_id}\")\n4374: def trace_item(item_id: str):\n4375: return None\n4376: \n4377: app.include_router(router)\n4378: ```\n4379: \"\"\"\n4380: return self.api_route(\n4381: path=path,\n4382: response_model=response_model,\n4383: status_code=status_code,\n4384: tags=tags,\n4385: dependencies=dependencies,\n4386: summary=summary,\n4387: description=description,\n4388: response_description=response_description,\n4389: responses=responses,\n4390: deprecated=deprecated,\n4391: methods=[\"TRACE\"],\n4392: operation_id=operation_id,\n4393: response_model_include=response_model_include,\n4394: response_model_exclude=response_model_exclude,\n4395: response_model_by_alias=response_model_by_alias,\n4396: response_model_exclude_unset=response_model_exclude_unset,\n4397: response_model_exclude_defaults=response_model_exclude_defaults,\n4398: response_model_exclude_none=response_model_exclude_none,\n4399: include_in_schema=include_in_schema,\n4400: response_class=response_class,\n4401: name=name,\n4402: callbacks=callbacks,\n4403: openapi_extra=openapi_extra,\n4404: generate_unique_id_function=generate_unique_id_function,\n4405: )\n4406: \n4407: @deprecated(\n4408: \"\"\"\n4409: on_event is deprecated, use lifespan event handlers instead.\n4410: \n4411: Read more about it in the\n4412: [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n4413: \"\"\"\n4414: )\n4415: def on_event(\n4416: self,\n4417: event_type: Annotated[\n4418: str,\n4419: Doc(\n4420: \"\"\"\n4421: The type of event. `startup` or `shutdown`.\n4422: \"\"\"\n4423: ),\n4424: ],\n4425: ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n4426: \"\"\"\n4427: Add an event handler for the router.\n4428: \n4429: `on_event` is deprecated, use `lifespan` event handlers instead.\n4430: \n4431: Read more about it in the\n4432: [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n4433: \"\"\"\n4434: \n4435: def decorator(func: DecoratedCallable) -> DecoratedCallable:\n4436: self.add_event_handler(event_type, func)\n4437: return func\n4438: \n4439: return decorator\n4440: \n\nfastapi/security/oauth2.py: \n\n1: from typing import Any, Dict, List, Optional, Union, cast\n2: \n3: from fastapi.exceptions import HTTPException\n4: from fastapi.openapi.models import OAuth2 as OAuth2Model\n5: from fastapi.openapi.models import OAuthFlows as OAuthFlowsModel\n6: from fastapi.param_functions import Form\n7: from fastapi.security.base import SecurityBase\n8: from fastapi.security.utils import get_authorization_scheme_param\n9: from starlette.requests import Request\n10: from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN\n11: \n12: # TODO: import from typing when deprecating Python 3.9\n13: from typing_extensions import Annotated, Doc\n14: \n15: \n16: class OAuth2PasswordRequestForm:\n17: \"\"\"\n18: This is a dependency class to collect the `username` and `password` as form data\n19: for an OAuth2 password flow.\n20: \n21: The OAuth2 specification dictates that for a password flow the data should be\n22: collected using form data (instead of JSON) and that it should have the specific\n23: fields `username` and `password`.\n24: \n25: All the initialization parameters are extracted from the request.\n26: \n27: Read more about it in the\n28: [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).\n29: \n30: ## Example\n31: \n32: ```python\n33: from typing import Annotated\n34: \n35: from fastapi import Depends, FastAPI\n36: from fastapi.security import OAuth2PasswordRequestForm\n37: \n38: app = FastAPI()\n39: \n40: \n41: @app.post(\"/login\")\n42: def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]):\n43: data = {}\n44: data[\"scopes\"] = []\n45: for scope in form_data.scopes:\n46: data[\"scopes\"].append(scope)\n47: if form_data.client_id:\n48: data[\"client_id\"] = form_data.client_id\n49: if form_data.client_secret:\n50: data[\"client_secret\"] = form_data.client_secret\n51: return data\n52: ```\n53: \n54: Note that for OAuth2 the scope `items:read` is a single scope in an opaque string.\n55: You could have custom internal logic to separate it by colon characters (`:`) or\n56: similar, and get the two parts `items` and `read`. Many applications do that to\n57: group and organize permissions, you could do it as well in your application, just\n58: know that that it is application specific, it's not part of the specification.\n59: \"\"\"\n60: \n61: def __init__(\n62: self,\n63: *,\n64: grant_type: Annotated[\n65: Union[str, None],\n66: Form(pattern=\"^password$\"),\n67: Doc(\n68: \"\"\"\n69: The OAuth2 spec says it is required and MUST be the fixed string\n70: \"password\". Nevertheless, this dependency class is permissive and\n71: allows not passing it. If you want to enforce it, use instead the\n72: `OAuth2PasswordRequestFormStrict` dependency.\n73: \"\"\"\n74: ),\n75: ] = None,\n76: username: Annotated[\n77: str,\n78: Form(),\n79: Doc(\n80: \"\"\"\n81: `username` string. The OAuth2 spec requires the exact field name\n82: `username`.\n83: \"\"\"\n84: ),\n85: ],\n86: password: Annotated[\n87: str,\n88: Form(),\n89: Doc(\n90: \"\"\"\n91: `password` string. The OAuth2 spec requires the exact field name\n92: `password\".\n93: \"\"\"\n94: ),\n95: ],\n96: scope: Annotated[\n97: str,\n98: Form(),\n99: Doc(\n100: \"\"\"\n101: A single string with actually several scopes separated by spaces. Each\n102: scope is also a string.\n103: \n104: For example, a single string with:\n105: \n106: ```python\n107: \"items:read items:write users:read profile openid\"\n108: ````\n109: \n110: would represent the scopes:\n111: \n112: * `items:read`\n113: * `items:write`\n114: * `users:read`\n115: * `profile`\n116: * `openid`\n117: \"\"\"\n118: ),\n119: ] = \"\",\n120: client_id: Annotated[\n121: Union[str, None],\n122: Form(),\n123: Doc(\n124: \"\"\"\n125: If there's a `client_id`, it can be sent as part of the form fields.\n126: But the OAuth2 specification recommends sending the `client_id` and\n127: `client_secret` (if any) using HTTP Basic auth.\n128: \"\"\"\n129: ),\n130: ] = None,\n131: client_secret: Annotated[\n132: Union[str, None],\n133: Form(),\n134: Doc(\n135: \"\"\"\n136: If there's a `client_password` (and a `client_id`), they can be sent\n137: as part of the form fields. But the OAuth2 specification recommends\n138: sending the `client_id` and `client_secret` (if any) using HTTP Basic\n139: auth.\n140: \"\"\"\n141: ),\n142: ] = None,\n143: ):\n144: self.grant_type = grant_type\n145: self.username = username\n146: self.password = password\n147: self.scopes = scope.split()\n148: self.client_id = client_id\n149: self.client_secret = client_secret\n150: \n151: \n152: class OAuth2PasswordRequestFormStrict(OAuth2PasswordRequestForm):\n153: \"\"\"\n154: This is a dependency class to collect the `username` and `password` as form data\n155: for an OAuth2 password flow.\n156: \n157: The OAuth2 specification dictates that for a password flow the data should be\n158: collected using form data (instead of JSON) and that it should have the specific\n159: fields `username` and `password`.\n160: \n161: All the initialization parameters are extracted from the request.\n162: \n163: The only difference between `OAuth2PasswordRequestFormStrict` and\n164: `OAuth2PasswordRequestForm` is that `OAuth2PasswordRequestFormStrict` requires the\n165: client to send the form field `grant_type` with the value `\"password\"`, which\n166: is required in the OAuth2 specification (it seems that for no particular reason),\n167: while for `OAuth2PasswordRequestForm` `grant_type` is optional.\n168: \n169: Read more about it in the\n170: [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).\n171: \n172: ## Example\n173: \n174: ```python\n175: from typing import Annotated\n176: \n177: from fastapi import Depends, FastAPI\n178: from fastapi.security import OAuth2PasswordRequestForm\n179: \n180: app = FastAPI()\n181: \n182: \n183: @app.post(\"/login\")\n184: def login(form_data: Annotated[OAuth2PasswordRequestFormStrict, Depends()]):\n185: data = {}\n186: data[\"scopes\"] = []\n187: for scope in form_data.scopes:\n188: data[\"scopes\"].append(scope)\n189: if form_data.client_id:\n190: data[\"client_id\"] = form_data.client_id\n191: if form_data.client_secret:\n192: data[\"client_secret\"] = form_data.client_secret\n193: return data\n194: ```\n195: \n196: Note that for OAuth2 the scope `items:read` is a single scope in an opaque string.\n197: You could have custom internal logic to separate it by colon characters (`:`) or\n198: similar, and get the two parts `items` and `read`. Many applications do that to\n199: group and organize permissions, you could do it as well in your application, just\n200: know that that it is application specific, it's not part of the specification.\n201: \n202: \n203: grant_type: the OAuth2 spec says it is required and MUST be the fixed string \"password\".\n204: This dependency is strict about it. If you want to be permissive, use instead the\n205: OAuth2PasswordRequestForm dependency class.\n206: username: username string. The OAuth2 spec requires the exact field name \"username\".\n207: password: password string. The OAuth2 spec requires the exact field name \"password\".\n208: scope: Optional string. Several scopes (each one a string) separated by spaces. E.g.\n209: \"items:read items:write users:read profile openid\"\n210: client_id: optional string. OAuth2 recommends sending the client_id and client_secret (if any)\n211: using HTTP Basic auth, as: client_id:client_secret\n212: client_secret: optional string. OAuth2 recommends sending the client_id and client_secret (if any)\n213: using HTTP Basic auth, as: client_id:client_secret\n214: \"\"\"\n215: \n216: def __init__(\n217: self,\n218: grant_type: Annotated[\n219: str,\n220: Form(pattern=\"^password$\"),\n221: Doc(\n222: \"\"\"\n223: The OAuth2 spec says it is required and MUST be the fixed string\n224: \"password\". This dependency is strict about it. If you want to be\n225: permissive, use instead the `OAuth2PasswordRequestForm` dependency\n226: class.\n227: \"\"\"\n228: ),\n229: ],\n230: username: Annotated[\n231: str,\n232: Form(),\n233: Doc(\n234: \"\"\"\n235: `username` string. The OAuth2 spec requires the exact field name\n236: `username`.\n237: \"\"\"\n238: ),\n239: ],\n240: password: Annotated[\n241: str,\n242: Form(),\n243: Doc(\n244: \"\"\"\n245: `password` string. The OAuth2 spec requires the exact field name\n246: `password\".\n247: \"\"\"\n248: ),\n249: ],\n250: scope: Annotated[\n251: str,\n252: Form(),\n253: Doc(\n254: \"\"\"\n255: A single string with actually several scopes separated by spaces. Each\n256: scope is also a string.\n257: \n258: For example, a single string with:\n259: \n260: ```python\n261: \"items:read items:write users:read profile openid\"\n262: ````\n263: \n264: would represent the scopes:\n265: \n266: * `items:read`\n267: * `items:write`\n268: * `users:read`\n269: * `profile`\n270: * `openid`\n271: \"\"\"\n272: ),\n273: ] = \"\",\n274: client_id: Annotated[\n275: Union[str, None],\n276: Form(),\n277: Doc(\n278: \"\"\"\n279: If there's a `client_id`, it can be sent as part of the form fields.\n280: But the OAuth2 specification recommends sending the `client_id` and\n281: `client_secret` (if any) using HTTP Basic auth.\n282: \"\"\"\n283: ),\n284: ] = None,\n285: client_secret: Annotated[\n286: Union[str, None],\n287: Form(),\n288: Doc(\n289: \"\"\"\n290: If there's a `client_password` (and a `client_id`), they can be sent\n291: as part of the form fields. But the OAuth2 specification recommends\n292: sending the `client_id` and `client_secret` (if any) using HTTP Basic\n293: auth.\n294: \"\"\"\n295: ),\n296: ] = None,\n297: ):\n298: super().__init__(\n299: grant_type=grant_type,\n300: username=username,\n301: password=password,\n302: scope=scope,\n303: client_id=client_id,\n304: client_secret=client_secret,\n305: )\n306: \n307: \n308: class OAuth2(SecurityBase):\n309: \"\"\"\n310: This is the base class for OAuth2 authentication, an instance of it would be used\n311: as a dependency. All other OAuth2 classes inherit from it and customize it for\n312: each OAuth2 flow.\n313: \n314: You normally would not create a new class inheriting from it but use one of the\n315: existing subclasses, and maybe compose them if you want to support multiple flows.\n316: \n317: Read more about it in the\n318: [FastAPI docs for Security](https://fastapi.tiangolo.com/tutorial/security/).\n319: \"\"\"\n320: \n321: def __init__(\n322: self,\n323: *,\n324: flows: Annotated[\n325: Union[OAuthFlowsModel, Dict[str, Dict[str, Any]]],\n326: Doc(\n327: \"\"\"\n328: The dictionary of OAuth2 flows.\n329: \"\"\"\n330: ),\n331: ] = OAuthFlowsModel(),\n332: scheme_name: Annotated[\n333: Optional[str],\n334: Doc(\n335: \"\"\"\n336: Security scheme name.\n337: \n338: It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n339: \"\"\"\n340: ),\n341: ] = None,\n342: description: Annotated[\n343: Optional[str],\n344: Doc(\n345: \"\"\"\n346: Security scheme description.\n347: \n348: It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n349: \"\"\"\n350: ),\n351: ] = None,\n352: auto_error: Annotated[\n353: bool,\n354: Doc(\n355: \"\"\"\n356: By default, if no HTTP Authorization header is provided, required for\n357: OAuth2 authentication, it will automatically cancel the request and\n358: send the client an error.\n359: \n360: If `auto_error` is set to `False`, when the HTTP Authorization header\n361: is not available, instead of erroring out, the dependency result will\n362: be `None`.\n363: \n364: This is useful when you want to have optional authentication.\n365: \n366: It is also useful when you want to have authentication that can be\n367: provided in one of multiple optional ways (for example, with OAuth2\n368: or in a cookie).\n369: \"\"\"\n370: ),\n371: ] = True,\n372: ):\n373: self.model = OAuth2Model(\n374: flows=cast(OAuthFlowsModel, flows), description=description\n375: )\n376: self.scheme_name = scheme_name or self.__class__.__name__\n377: self.auto_error = auto_error\n378: \n379: async def __call__(self, request: Request) -> Optional[str]:\n380: authorization = request.headers.get(\"Authorization\")\n381: if not authorization:\n382: if self.auto_error:\n383: raise HTTPException(\n384: status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n385: )\n386: else:\n387: return None\n388: return authorization\n389: \n390: \n391: class OAuth2PasswordBearer(OAuth2):\n392: \"\"\"\n393: OAuth2 flow for authentication using a bearer token obtained with a password.\n394: An instance of it would be used as a dependency.\n395: \n396: Read more about it in the\n397: [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).\n398: \"\"\"\n399: \n400: def __init__(\n401: self,\n402: tokenUrl: Annotated[\n403: str,\n404: Doc(\n405: \"\"\"\n406: The URL to obtain the OAuth2 token. This would be the *path operation*\n407: that has `OAuth2PasswordRequestForm` as a dependency.\n408: \"\"\"\n409: ),\n410: ],\n411: scheme_name: Annotated[\n412: Optional[str],\n413: Doc(\n414: \"\"\"\n415: Security scheme name.\n416: \n417: It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n418: \"\"\"\n419: ),\n420: ] = None,\n421: scopes: Annotated[\n422: Optional[Dict[str, str]],\n423: Doc(\n424: \"\"\"\n425: The OAuth2 scopes that would be required by the *path operations* that\n426: use this dependency.\n427: \"\"\"\n428: ),\n429: ] = None,\n430: description: Annotated[\n431: Optional[str],\n432: Doc(\n433: \"\"\"\n434: Security scheme description.\n435: \n436: It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n437: \"\"\"\n438: ),\n439: ] = None,\n440: auto_error: Annotated[\n441: bool,\n442: Doc(\n443: \"\"\"\n444: By default, if no HTTP Authorization header is provided, required for\n445: OAuth2 authentication, it will automatically cancel the request and\n446: send the client an error.\n447: \n448: If `auto_error` is set to `False`, when the HTTP Authorization header\n449: is not available, instead of erroring out, the dependency result will\n450: be `None`.\n451: \n452: This is useful when you want to have optional authentication.\n453: \n454: It is also useful when you want to have authentication that can be\n455: provided in one of multiple optional ways (for example, with OAuth2\n456: or in a cookie).\n457: \"\"\"\n458: ),\n459: ] = True,\n460: ):\n461: if not scopes:\n462: scopes = {}\n463: flows = OAuthFlowsModel(\n464: password=cast(Any, {\"tokenUrl\": tokenUrl, \"scopes\": scopes})\n465: )\n466: super().__init__(\n467: flows=flows,\n468: scheme_name=scheme_name,\n469: description=description,\n470: auto_error=auto_error,\n471: )\n472: \n473: async def __call__(self, request: Request) -> Optional[str]:\n474: authorization = request.headers.get(\"Authorization\")\n475: scheme, param = get_authorization_scheme_param(authorization)\n476: if not authorization or scheme.lower() != \"bearer\":\n477: if self.auto_error:\n478: raise HTTPException(\n479: status_code=HTTP_401_UNAUTHORIZED,\n480: detail=\"Not authenticated\",\n481: headers={\"WWW-Authenticate\": \"Bearer\"},\n482: )\n483: else:\n484: return None\n485: return param\n486: \n487: \n488: class OAuth2AuthorizationCodeBearer(OAuth2):\n489: \"\"\"\n490: OAuth2 flow for authentication using a bearer token obtained with an OAuth2 code\n491: flow. An instance of it would be used as a dependency.\n492: \"\"\"\n493: \n494: def __init__(\n495: self,\n496: authorizationUrl: str,\n497: tokenUrl: Annotated[\n498: str,\n499: Doc(\n500: \"\"\"\n501: The URL to obtain the OAuth2 token.\n502: \"\"\"\n503: ),\n504: ],\n505: refreshUrl: Annotated[\n506: Optional[str],\n507: Doc(\n508: \"\"\"\n509: The URL to refresh the token and obtain a new one.\n510: \"\"\"\n511: ),\n512: ] = None,\n513: scheme_name: Annotated[\n514: Optional[str],\n515: Doc(\n516: \"\"\"\n517: Security scheme name.\n518: \n519: It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n520: \"\"\"\n521: ),\n522: ] = None,\n523: scopes: Annotated[\n524: Optional[Dict[str, str]],\n525: Doc(\n526: \"\"\"\n527: The OAuth2 scopes that would be required by the *path operations* that\n528: use this dependency.\n529: \"\"\"\n530: ),\n531: ] = None,\n532: description: Annotated[\n533: Optional[str],\n534: Doc(\n535: \"\"\"\n536: Security scheme description.\n537: \n538: It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n539: \"\"\"\n540: ),\n541: ] = None,\n542: auto_error: Annotated[\n543: bool,\n544: Doc(\n545: \"\"\"\n546: By default, if no HTTP Authorization header is provided, required for\n547: OAuth2 authentication, it will automatically cancel the request and\n548: send the client an error.\n549: \n550: If `auto_error` is set to `False`, when the HTTP Authorization header\n551: is not available, instead of erroring out, the dependency result will\n552: be `None`.\n553: \n554: This is useful when you want to have optional authentication.\n555: \n556: It is also useful when you want to have authentication that can be\n557: provided in one of multiple optional ways (for example, with OAuth2\n558: or in a cookie).\n559: \"\"\"\n560: ),\n561: ] = True,\n562: ):\n563: if not scopes:\n564: scopes = {}\n565: flows = OAuthFlowsModel(\n566: authorizationCode=cast(\n567: Any,\n568: {\n569: \"authorizationUrl\": authorizationUrl,\n570: \"tokenUrl\": tokenUrl,\n571: \"refreshUrl\": refreshUrl,\n572: \"scopes\": scopes,\n573: },\n574: )\n575: )\n576: super().__init__(\n577: flows=flows,\n578: scheme_name=scheme_name,\n579: description=description,\n580: auto_error=auto_error,\n581: )\n582: \n583: async def __call__(self, request: Request) -> Optional[str]:\n584: authorization = request.headers.get(\"Authorization\")\n585: scheme, param = get_authorization_scheme_param(authorization)\n586: if not authorization or scheme.lower() != \"bearer\":\n587: if self.auto_error:\n588: raise HTTPException(\n589: status_code=HTTP_401_UNAUTHORIZED,\n590: detail=\"Not authenticated\",\n591: headers={\"WWW-Authenticate\": \"Bearer\"},\n592: )\n593: else:\n594: return None # pragma: nocover\n595: return param\n596: \n597: \n598: class SecurityScopes:\n599: \"\"\"\n600: This is a special class that you can define in a parameter in a dependency to\n601: obtain the OAuth2 scopes required by all the dependencies in the same chain.\n602: \n603: This way, multiple dependencies can have different scopes, even when used in the\n604: same *path operation*. And with this, you can access all the scopes required in\n605: all those dependencies in a single place.\n606: \n607: Read more about it in the\n608: [FastAPI docs for OAuth2 scopes](https://fastapi.tiangolo.com/advanced/security/oauth2-scopes/).\n609: \"\"\"\n610: \n611: def __init__(\n612: self,\n613: scopes: Annotated[\n614: Optional[List[str]],\n615: Doc(\n616: \"\"\"\n617: This will be filled by FastAPI.\n618: \"\"\"\n619: ),\n620: ] = None,\n621: ):\n622: self.scopes: Annotated[\n623: List[str],\n624: Doc(\n625: \"\"\"\n626: The list of all the scopes required by dependencies.\n627: \"\"\"\n628: ),\n629: ] = scopes or []\n630: self.scope_str: Annotated[\n631: str,\n632: Doc(\n633: \"\"\"\n634: All the scopes required by all the dependencies in a single string\n635: separated by spaces, as defined in the OAuth2 specification.\n636: \"\"\"\n637: ),\n638: ] = \" \".join(self.scopes)\n639: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":93,"cells":{"final_prompt":{"kind":"string","value":"咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。\n\nBasic/my_module.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583\n2: \n3: ### Módulo para pruebas ###\n4: \n5: def sumValue(numberOne, numberTwo, numberThree):\n6: print(numberOne + numberTwo + numberThree)\n7: \n8: \n9: def printValue(value):\n10: print(value)\n11: \n\nBasic/08_conditionals.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=21442\n2: \n3: ### Conditionals ###\n4: \n5: # if\n6: \n7: my_condition = False\n8: \n9: if my_condition: # Es lo mismo que if my_condition == True:\n10: print(\"Se ejecuta la condición del if\")\n11: \n12: my_condition = 5 * 5\n13: \n14: if my_condition == 10:\n15: print(\"Se ejecuta la condición del segundo if\")\n16: \n17: # if, elif, else\n18: \n19: if my_condition > 10 and my_condition < 20:\n20: print(\"Es mayor que 10 y menor que 20\")\n21: elif my_condition == 25:\n22: print(\"Es igual a 25\")\n23: else:\n24: print(\"Es menor o igual que 10 o mayor o igual que 20 o distinto de 25\")\n25: \n26: print(\"La ejecución continúa\")\n27: \n28: # Condicional con ispección de valor\n29: \n30: my_string = \"\"\n31: \n32: if not my_string:\n33: print(\"Mi cadena de texto es vacía\")\n34: \n35: if my_string == \"Mi cadena de textoooooo\":\n36: print(\"Estas cadenas de texto coinciden\")\n37: \n\nBasic/07_dicts.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc\n2: \n3: ### Dictionaries ###\n4: \n5: # Definición\n6: \n7: my_dict = dict()\n8: my_other_dict = {}\n9: \n10: print(type(my_dict))\n11: print(type(my_other_dict))\n12: \n13: my_other_dict = {\"Nombre\": \"Brais\",\n14: \"Apellido\": \"Moure\", \"Edad\": 35, 1: \"Python\"}\n15: \n16: my_dict = {\n17: \"Nombre\": \"Brais\",\n18: \"Apellido\": \"Moure\",\n19: \"Edad\": 35,\n20: \"Lenguajes\": {\"Python\", \"Swift\", \"Kotlin\"},\n21: 1: 1.77\n22: }\n23: \n24: print(my_other_dict)\n25: print(my_dict)\n26: \n27: print(len(my_other_dict))\n28: print(len(my_dict))\n29: \n30: # Búsqueda\n31: \n32: print(my_dict[1])\n33: print(my_dict[\"Nombre\"])\n34: \n35: print(\"Moure\" in my_dict)\n36: print(\"Apellido\" in my_dict)\n37: \n38: # Inserción\n39: \n40: my_dict[\"Calle\"] = \"Calle MoureDev\"\n41: print(my_dict)\n42: \n43: # Actualización\n44: \n45: my_dict[\"Nombre\"] = \"Pedro\"\n46: print(my_dict[\"Nombre\"])\n47: \n48: # Eliminación\n49: \n50: del my_dict[\"Calle\"]\n51: print(my_dict)\n52: \n53: # Otras operaciones\n54: \n55: print(my_dict.items())\n56: print(my_dict.keys())\n57: print(my_dict.values())\n58: \n59: my_list = [\"Nombre\", 1, \"Piso\"]\n60: \n61: my_new_dict = dict.fromkeys((my_list))\n62: print(my_new_dict)\n63: my_new_dict = dict.fromkeys((\"Nombre\", 1, \"Piso\"))\n64: print((my_new_dict))\n65: my_new_dict = dict.fromkeys(my_dict)\n66: print((my_new_dict))\n67: my_new_dict = dict.fromkeys(my_dict, \"MoureDev\")\n68: print((my_new_dict))\n69: \n70: my_values = my_new_dict.values()\n71: print(type(my_values))\n72: \n73: print(my_new_dict.values())\n74: print(list(dict.fromkeys(list(my_new_dict.values())).keys()))\n75: print(tuple(my_new_dict))\n76: print(set(my_new_dict))\n77: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":94,"cells":{"final_prompt":{"kind":"string","value":"十大赌博靠谱网络平台娱乐游戏网址：376838.com\n游戏开户经理 薇：xiaolu460570 飞机：lc15688正规实体平台-创联娱乐实体网赌平台-创联游戏联盟实体网赌平台推荐-十大亚洲博彩娱乐-亚洲赌博平台线上开户-线上赌博/APP-十大实体赌博平台推荐-实体网络赌博平台-实体博彩娱乐创联国际-创联娱乐-创联游戏-全球十大网赌正规平台在线推荐！ 推荐十大赌博靠谱平台-十大赌博靠谱信誉的平台 国际 东南亚线上网赌平台 合法网上赌场,中国网上合法赌场,最好的网上赌场 网赌十大快3平台 - 十大网赌平台推荐- 网赌最好最大平台-十大最好的网赌平台 十大靠谱网赌平台- 网上赌搏网站十大排行 全球最大网赌正规平台: 十大，资金安全有保证 东南亚实体大赌场的现场实况连线平台，连续多年占据全球线上娱乐顶级品牌榜！是您在线博彩娱乐的首选平台！\n\nIntermediate/02_challenges.py: \n\n1: # Clase en vídeo: https://youtu.be/TbcEqkabAWU?t=4142\n2: \n3: ### Challenges ###\n4: \n5: \"\"\"\n6: EL FAMOSO \"FIZZ BUZZ”:\n7: Escribe un programa que muestre por consola (con un print) los\n8: números de 1 a 100 (ambos incluidos y con un salto de línea entre\n9: cada impresión), sustituyendo los siguientes:\n10: - Múltiplos de 3 por la palabra \"fizz\".\n11: - Múltiplos de 5 por la palabra \"buzz\".\n12: - Múltiplos de 3 y de 5 a la vez por la palabra \"fizzbuzz\".\n13: \"\"\"\n14: \n15: \n16: def fizzbuzz():\n17: for index in range(1, 101):\n18: if index % 3 == 0 and index % 5 == 0:\n19: print(\"fizzbuzz\")\n20: elif index % 3 == 0:\n21: print(\"fizz\")\n22: elif index % 5 == 0:\n23: print(\"buzz\")\n24: else:\n25: print(index)\n26: \n27: \n28: fizzbuzz()\n29: \n30: \"\"\"\n31: ¿ES UN ANAGRAMA?\n32: Escribe una función que reciba dos palabras (String) y retorne\n33: verdadero o falso (Bool) según sean o no anagramas.\n34: - Un Anagrama consiste en formar una palabra reordenando TODAS\n35: las letras de otra palabra inicial.\n36: - NO hace falta comprobar que ambas palabras existan.\n37: - Dos palabras exactamente iguales no son anagrama.\n38: \"\"\"\n39: \n40: \n41: def is_anagram(word_one, word_two):\n42: if word_one.lower() == word_two.lower():\n43: return False\n44: return sorted(word_one.lower()) == sorted(word_two.lower())\n45: \n46: \n47: print(is_anagram(\"Amor\", \"Roma\"))\n48: \n49: \"\"\"\n50: LA SUCESIÓN DE FIBONACCI\n51: Escribe un programa que imprima los 50 primeros números de la sucesión\n52: de Fibonacci empezando en 0.\n53: - La serie Fibonacci se compone por una sucesión de números en\n54: la que el siguiente siempre es la suma de los dos anteriores.\n55: 0, 1, 1, 2, 3, 5, 8, 13...\n56: \"\"\"\n57: \n58: \n59: def fibonacci():\n60: \n61: prev = 0\n62: next = 1\n63: \n64: for index in range(0, 50):\n65: print(prev)\n66: fib = prev + next\n67: prev = next\n68: next = fib\n69: \n70: \n71: fibonacci()\n72: \n73: \"\"\"\n74: ¿ES UN NÚMERO PRIMO?\n75: Escribe un programa que se encargue de comprobar si un número es o no primo.\n76: Hecho esto, imprime los números primos entre 1 y 100.\n77: \"\"\"\n78: \n79: \n80: def is_prime():\n81: \n82: for number in range(1, 101):\n83: \n84: if number >= 2:\n85: \n86: is_divisible = False\n87: \n88: for index in range(2, number):\n89: if number % index == 0:\n90: is_divisible = True\n91: break\n92: \n93: if not is_divisible:\n94: print(number)\n95: \n96: \n97: is_prime()\n98: \n99: \"\"\"\n100: INVIRTIENDO CADENAS\n101: Crea un programa que invierta el orden de una cadena de texto\n102: sin usar funciones propias del lenguaje que lo hagan de forma automática.\n103: - Si le pasamos \"Hola mundo\" nos retornaría \"odnum aloH\"\n104: \"\"\"\n105: \n106: \n107: def reverse(text):\n108: text_len = len(text)\n109: reversed_text = \"\"\n110: for index in range(0, text_len):\n111: reversed_text += text[text_len - index - 1]\n112: return reversed_text\n113: \n114: \n115: print(reverse(\"Hola mundo\"))\n116: \n\nIntermediate/00_dates.py: \n\n1: # Clase en vídeo: https://youtu.be/TbcEqkabAWU\n2: \n3: ### Dates ###\n4: \n5: # Date time\n6: \n7: from datetime import timedelta\n8: from datetime import date\n9: from datetime import time\n10: from datetime import datetime\n11: \n12: now = datetime.now()\n13: \n14: \n15: def print_date(date):\n16: print(date.year)\n17: print(date.month)\n18: print(date.day)\n19: print(date.hour)\n20: print(date.minute)\n21: print(date.second)\n22: print(date.timestamp())\n23: \n24: \n25: print_date(now)\n26: \n27: year_2023 = datetime(2023, 1, 1)\n28: \n29: print_date(year_2023)\n30: \n31: # Time\n32: \n33: \n34: current_time = time(21, 6, 0)\n35: \n36: print(current_time.hour)\n37: print(current_time.minute)\n38: print(current_time.second)\n39: \n40: # Date\n41: \n42: \n43: current_date = date.today()\n44: \n45: print(current_date.year)\n46: print(current_date.month)\n47: print(current_date.day)\n48: \n49: current_date = date(2022, 10, 6)\n50: \n51: print(current_date.year)\n52: print(current_date.month)\n53: print(current_date.day)\n54: \n55: current_date = date(current_date.year,\n56: current_date.month + 1, current_date.day)\n57: \n58: print(current_date.month)\n59: \n60: # Operaciones con fechas\n61: \n62: diff = year_2023 - now\n63: print(diff)\n64: \n65: diff = year_2023.date() - current_date\n66: print(diff)\n67: \n68: # Timedelta\n69: \n70: \n71: start_timedelta = timedelta(200, 100, 100, weeks=10)\n72: end_timedelta = timedelta(300, 100, 100, weeks=13)\n73: \n74: print(end_timedelta - start_timedelta)\n75: print(end_timedelta + start_timedelta)\n76: \n\nBackend/FastAPI/db/client.py: \n\n1: # Clase en vídeo: https://youtu.be/_y9qQZXE24A?t=20480)\n2: \n3: ### MongoDB client ###\n4: \n5: # Descarga versión community: https://www.mongodb.com/try/download\n6: # Instalación:https://www.mongodb.com/docs/manual/tutorial\n7: # Módulo conexión MongoDB: pip install pymongo\n8: # Ejecución: sudo mongod --dbpath \"/path/a/la/base/de/datos/\"\n9: # Conexión: mongodb://localhost\n10: \n11: from pymongo import MongoClient\n12: \n13: # Descomentar el db_client local o remoto correspondiente\n14: \n15: # Base de datos local MongoDB\n16: db_client = MongoClient().local\n17: \n18: # Clase en vídeo: https://youtu.be/_y9qQZXE24A?t=25470\n19: \n20: # Base de datos remota MongoDB Atlas (https://mongodb.com)\n21: # db_client = MongoClient(\n22: # \"mongodb+srv://<user>:<password>@<url>/?retryWrites=true&w=majority\").test\n23: \n24: # Despliegue API en la nube:\n25: # Deta - https://www.deta.sh/\n26: # Intrucciones - https://fastapi.tiangolo.com/deployment/deta/\n27: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":95,"cells":{"final_prompt":{"kind":"string","value":"网赌赌博被黑了怎么办、提款迟迟不到账怎么办？\n\n团队经验深（8年老团队）团队掌控着一些 出款最新技术\n\n随着电脑科技的飞速发展，黑客解决方法威:xaiolu460570 飞机：@lc15688网络时代一直在进步，有很多网友都会无意中接触到网赌，在这里我忠诚的和大家说一下，很多时候网赌被黑都是因为自己的盲目无知所造成，好多网友不会辨别平台，所以黑平台就是利用到你的无知给你挖坑！很多黑平台一般都先是以较高的赔率、返水，注册充值就会给你送彩金来引诱你上钩，让你充值等等。在你输钱或者赢不多的时候网站是处于正常状态，充值秒到账，取款也是秒到账。但是你要赢了他们拟定的金额以后，平台就会开始以各种借口不给你出款。\n\n比如说：你的账户登录异常、网站正在维护中、该账户违规下注、出款端口维护、账户涉嫌套利、网站抽查审核、系统抽查审核、银行系统维护等等。所以当你遇到这种情况千万不要抱着侥幸心理，这些都是网站已经准备黑你账户所找的理由，只要半天以上出款不到帐，基本上是被黑了，也别想着找客服议论，因为客服跟黑你的平台是一伙的，客服也是会用各种借口敷衍你，目的很简单，就是不给你出款！\n\n当然了，如果你遇到被黑了也不要太悲观，正所谓一物降一物。平台既然能做出黑你钱财这些不道德的事情，自然就会有一些高手能帮你操作出款。打击黑网，找到被黑的根本原因，然后找到对的人解决。一般只要账号能正常登录额度能正常转换的情况下，就可以通过以下办法解决出款。\n\n一 、不要和网站客服争吵（有直接冻结你账户的风险，出款前提必须保证账号能正常登录）\n\n二 、如果你赢得不是特别多可以以介绍朋友去的理由诱惑客服\n\n三 、如果赢钱超过网站额度你可以输一部分回去再提款试试（这个没必要）\n\n四 、可以假装做代理忽悠网站，告诉他们你有多少会员要注册充值。\n\n五 、技术出款（找到专业人员转换额度藏分操作，收前期费用都是骗子）\n\n最后个人建议大家远离赌博，不赌为赢！\n\nBasic/my_module.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583\n2: \n3: ### Módulo para pruebas ###\n4: \n5: def sumValue(numberOne, numberTwo, numberThree):\n6: print(numberOne + numberTwo + numberThree)\n7: \n8: \n9: def printValue(value):\n10: print(value)\n11: \n\nBasic/08_conditionals.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=21442\n2: \n3: ### Conditionals ###\n4: \n5: # if\n6: \n7: my_condition = False\n8: \n9: if my_condition: # Es lo mismo que if my_condition == True:\n10: print(\"Se ejecuta la condición del if\")\n11: \n12: my_condition = 5 * 5\n13: \n14: if my_condition == 10:\n15: print(\"Se ejecuta la condición del segundo if\")\n16: \n17: # if, elif, else\n18: \n19: if my_condition > 10 and my_condition < 20:\n20: print(\"Es mayor que 10 y menor que 20\")\n21: elif my_condition == 25:\n22: print(\"Es igual a 25\")\n23: else:\n24: print(\"Es menor o igual que 10 o mayor o igual que 20 o distinto de 25\")\n25: \n26: print(\"La ejecución continúa\")\n27: \n28: # Condicional con ispección de valor\n29: \n30: my_string = \"\"\n31: \n32: if not my_string:\n33: print(\"Mi cadena de texto es vacía\")\n34: \n35: if my_string == \"Mi cadena de textoooooo\":\n36: print(\"Estas cadenas de texto coinciden\")\n37: \n\nBasic/07_dicts.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc\n2: \n3: ### Dictionaries ###\n4: \n5: # Definición\n6: \n7: my_dict = dict()\n8: my_other_dict = {}\n9: \n10: print(type(my_dict))\n11: print(type(my_other_dict))\n12: \n13: my_other_dict = {\"Nombre\": \"Brais\",\n14: \"Apellido\": \"Moure\", \"Edad\": 35, 1: \"Python\"}\n15: \n16: my_dict = {\n17: \"Nombre\": \"Brais\",\n18: \"Apellido\": \"Moure\",\n19: \"Edad\": 35,\n20: \"Lenguajes\": {\"Python\", \"Swift\", \"Kotlin\"},\n21: 1: 1.77\n22: }\n23: \n24: print(my_other_dict)\n25: print(my_dict)\n26: \n27: print(len(my_other_dict))\n28: print(len(my_dict))\n29: \n30: # Búsqueda\n31: \n32: print(my_dict[1])\n33: print(my_dict[\"Nombre\"])\n34: \n35: print(\"Moure\" in my_dict)\n36: print(\"Apellido\" in my_dict)\n37: \n38: # Inserción\n39: \n40: my_dict[\"Calle\"] = \"Calle MoureDev\"\n41: print(my_dict)\n42: \n43: # Actualización\n44: \n45: my_dict[\"Nombre\"] = \"Pedro\"\n46: print(my_dict[\"Nombre\"])\n47: \n48: # Eliminación\n49: \n50: del my_dict[\"Calle\"]\n51: print(my_dict)\n52: \n53: # Otras operaciones\n54: \n55: print(my_dict.items())\n56: print(my_dict.keys())\n57: print(my_dict.values())\n58: \n59: my_list = [\"Nombre\", 1, \"Piso\"]\n60: \n61: my_new_dict = dict.fromkeys((my_list))\n62: print(my_new_dict)\n63: my_new_dict = dict.fromkeys((\"Nombre\", 1, \"Piso\"))\n64: print((my_new_dict))\n65: my_new_dict = dict.fromkeys(my_dict)\n66: print((my_new_dict))\n67: my_new_dict = dict.fromkeys(my_dict, \"MoureDev\")\n68: print((my_new_dict))\n69: \n70: my_values = my_new_dict.values()\n71: print(type(my_values))\n72: \n73: print(my_new_dict.values())\n74: print(list(dict.fromkeys(list(my_new_dict.values())).keys()))\n75: print(tuple(my_new_dict))\n76: print(set(my_new_dict))\n77: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":96,"cells":{"final_prompt":{"kind":"string","value":"澳门平台（威尼斯人，出黑拿回微信：xiaolu460570飞机：@lc15688金沙，巴黎人，美高梅，银河，新葡京，太阳城等等）不给出款怎么办？\n\n \n关于网上网赌娱乐平台赢钱了各种借口不给出款最新解决方法\n\n \n切记，只要你赢钱了，遇到任何不给你提现的借口，基本表明你已经被黑了。\n\n \n第一：提款被拒绝，各种借口理由，就是不让出款，让打倍投流水等等！\n\n \n第二：限制你账号的部分功能！出款和入款端口关闭，以及让你充值解开取款通道等等！\n\n \n第三：客服找一些借口说什么系统维护，风控审核等等借口，就是不让取款！\n\n \n第四：确认被黑了，应该怎么做？ （找专业团队教你怎么办挽回损失，出款不成功不收取任何前期费用）\n\nBasic/my_module.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583\n2: \n3: ### Módulo para pruebas ###\n4: \n5: def sumValue(numberOne, numberTwo, numberThree):\n6: print(numberOne + numberTwo + numberThree)\n7: \n8: \n9: def printValue(value):\n10: print(value)\n11: \n\nBasic/08_conditionals.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=21442\n2: \n3: ### Conditionals ###\n4: \n5: # if\n6: \n7: my_condition = False\n8: \n9: if my_condition: # Es lo mismo que if my_condition == True:\n10: print(\"Se ejecuta la condición del if\")\n11: \n12: my_condition = 5 * 5\n13: \n14: if my_condition == 10:\n15: print(\"Se ejecuta la condición del segundo if\")\n16: \n17: # if, elif, else\n18: \n19: if my_condition > 10 and my_condition < 20:\n20: print(\"Es mayor que 10 y menor que 20\")\n21: elif my_condition == 25:\n22: print(\"Es igual a 25\")\n23: else:\n24: print(\"Es menor o igual que 10 o mayor o igual que 20 o distinto de 25\")\n25: \n26: print(\"La ejecución continúa\")\n27: \n28: # Condicional con ispección de valor\n29: \n30: my_string = \"\"\n31: \n32: if not my_string:\n33: print(\"Mi cadena de texto es vacía\")\n34: \n35: if my_string == \"Mi cadena de textoooooo\":\n36: print(\"Estas cadenas de texto coinciden\")\n37: \n\nBasic/07_dicts.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc\n2: \n3: ### Dictionaries ###\n4: \n5: # Definición\n6: \n7: my_dict = dict()\n8: my_other_dict = {}\n9: \n10: print(type(my_dict))\n11: print(type(my_other_dict))\n12: \n13: my_other_dict = {\"Nombre\": \"Brais\",\n14: \"Apellido\": \"Moure\", \"Edad\": 35, 1: \"Python\"}\n15: \n16: my_dict = {\n17: \"Nombre\": \"Brais\",\n18: \"Apellido\": \"Moure\",\n19: \"Edad\": 35,\n20: \"Lenguajes\": {\"Python\", \"Swift\", \"Kotlin\"},\n21: 1: 1.77\n22: }\n23: \n24: print(my_other_dict)\n25: print(my_dict)\n26: \n27: print(len(my_other_dict))\n28: print(len(my_dict))\n29: \n30: # Búsqueda\n31: \n32: print(my_dict[1])\n33: print(my_dict[\"Nombre\"])\n34: \n35: print(\"Moure\" in my_dict)\n36: print(\"Apellido\" in my_dict)\n37: \n38: # Inserción\n39: \n40: my_dict[\"Calle\"] = \"Calle MoureDev\"\n41: print(my_dict)\n42: \n43: # Actualización\n44: \n45: my_dict[\"Nombre\"] = \"Pedro\"\n46: print(my_dict[\"Nombre\"])\n47: \n48: # Eliminación\n49: \n50: del my_dict[\"Calle\"]\n51: print(my_dict)\n52: \n53: # Otras operaciones\n54: \n55: print(my_dict.items())\n56: print(my_dict.keys())\n57: print(my_dict.values())\n58: \n59: my_list = [\"Nombre\", 1, \"Piso\"]\n60: \n61: my_new_dict = dict.fromkeys((my_list))\n62: print(my_new_dict)\n63: my_new_dict = dict.fromkeys((\"Nombre\", 1, \"Piso\"))\n64: print((my_new_dict))\n65: my_new_dict = dict.fromkeys(my_dict)\n66: print((my_new_dict))\n67: my_new_dict = dict.fromkeys(my_dict, \"MoureDev\")\n68: print((my_new_dict))\n69: \n70: my_values = my_new_dict.values()\n71: print(type(my_values))\n72: \n73: print(my_new_dict.values())\n74: print(list(dict.fromkeys(list(my_new_dict.values())).keys()))\n75: print(tuple(my_new_dict))\n76: print(set(my_new_dict))\n77: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":97,"cells":{"final_prompt":{"kind":"string","value":"咨询详情联系薇：zdh24588 飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台何种理由不让提现，首先我们应该保持冷静，如果提现被退回就不要去重复点了，切记不能跟平台客服或者所谓的代理人有任何的争执，一旦激怒对方，极有可能造成账号冻结之类的情况，这样问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系专业出黑团队，通过藏分锁卡等手段分批出款，这样问题就能妥善解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。\n\n\nBasic/my_module.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583\n2: \n3: ### Módulo para pruebas ###\n4: \n5: def sumValue(numberOne, numberTwo, numberThree):\n6: print(numberOne + numberTwo + numberThree)\n7: \n8: \n9: def printValue(value):\n10: print(value)\n11: \n\nBasic/08_conditionals.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=21442\n2: \n3: ### Conditionals ###\n4: \n5: # if\n6: \n7: my_condition = False\n8: \n9: if my_condition: # Es lo mismo que if my_condition == True:\n10: print(\"Se ejecuta la condición del if\")\n11: \n12: my_condition = 5 * 5\n13: \n14: if my_condition == 10:\n15: print(\"Se ejecuta la condición del segundo if\")\n16: \n17: # if, elif, else\n18: \n19: if my_condition > 10 and my_condition < 20:\n20: print(\"Es mayor que 10 y menor que 20\")\n21: elif my_condition == 25:\n22: print(\"Es igual a 25\")\n23: else:\n24: print(\"Es menor o igual que 10 o mayor o igual que 20 o distinto de 25\")\n25: \n26: print(\"La ejecución continúa\")\n27: \n28: # Condicional con ispección de valor\n29: \n30: my_string = \"\"\n31: \n32: if not my_string:\n33: print(\"Mi cadena de texto es vacía\")\n34: \n35: if my_string == \"Mi cadena de textoooooo\":\n36: print(\"Estas cadenas de texto coinciden\")\n37: \n\nBasic/07_dicts.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc\n2: \n3: ### Dictionaries ###\n4: \n5: # Definición\n6: \n7: my_dict = dict()\n8: my_other_dict = {}\n9: \n10: print(type(my_dict))\n11: print(type(my_other_dict))\n12: \n13: my_other_dict = {\"Nombre\": \"Brais\",\n14: \"Apellido\": \"Moure\", \"Edad\": 35, 1: \"Python\"}\n15: \n16: my_dict = {\n17: \"Nombre\": \"Brais\",\n18: \"Apellido\": \"Moure\",\n19: \"Edad\": 35,\n20: \"Lenguajes\": {\"Python\", \"Swift\", \"Kotlin\"},\n21: 1: 1.77\n22: }\n23: \n24: print(my_other_dict)\n25: print(my_dict)\n26: \n27: print(len(my_other_dict))\n28: print(len(my_dict))\n29: \n30: # Búsqueda\n31: \n32: print(my_dict[1])\n33: print(my_dict[\"Nombre\"])\n34: \n35: print(\"Moure\" in my_dict)\n36: print(\"Apellido\" in my_dict)\n37: \n38: # Inserción\n39: \n40: my_dict[\"Calle\"] = \"Calle MoureDev\"\n41: print(my_dict)\n42: \n43: # Actualización\n44: \n45: my_dict[\"Nombre\"] = \"Pedro\"\n46: print(my_dict[\"Nombre\"])\n47: \n48: # Eliminación\n49: \n50: del my_dict[\"Calle\"]\n51: print(my_dict)\n52: \n53: # Otras operaciones\n54: \n55: print(my_dict.items())\n56: print(my_dict.keys())\n57: print(my_dict.values())\n58: \n59: my_list = [\"Nombre\", 1, \"Piso\"]\n60: \n61: my_new_dict = dict.fromkeys((my_list))\n62: print(my_new_dict)\n63: my_new_dict = dict.fromkeys((\"Nombre\", 1, \"Piso\"))\n64: print((my_new_dict))\n65: my_new_dict = dict.fromkeys(my_dict)\n66: print((my_new_dict))\n67: my_new_dict = dict.fromkeys(my_dict, \"MoureDev\")\n68: print((my_new_dict))\n69: \n70: my_values = my_new_dict.values()\n71: print(type(my_values))\n72: \n73: print(my_new_dict.values())\n74: print(list(dict.fromkeys(list(my_new_dict.values())).keys()))\n75: print(tuple(my_new_dict))\n76: print(set(my_new_dict))\n77: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":98,"cells":{"final_prompt":{"kind":"string","value":"关于网上网赌娱乐平台赢钱了各种借口不给出款最新解决方法\n\n网出黑咨询微：xiaolu460570飞机：lc15688如果您目前遇到这样的情况，请第一时间联系我们专业出黑团队，通过藏分等技术手段分批出款，这样问题就能得到很好的解决。网络时代很多人都喜欢在网络上玩娱乐博彩但是很多人都不懂网上有很多黑台了，黑台不给出款的借口说你的账号异常登录。平台网站，网站出款端口维护账号涉嫌套利，系统自动抽查审核，网址抽查审核，账号下注违规，银行系统维护款等借口维护不给你出甚至冻结你账号，网投不给出款怎么办如何拿回。\n\n切记，只要你赢钱了，遇到任何不给你提现的借口，基本表明你已经被黑了。\n\n第一：提款被拒绝，各种借口理由，就是不让出款，让打倍投流水等等！\n\n第二：限制你账号的部分功能！出款和入款端口关闭，以及让你充值解开取款通道等等！\n\n第三：客服找一些借口说什么系统维护，风控审核等等借口，就是不让取款！\n\n第四：确认被黑了，应该怎么做？ （找专业团队教你怎么办挽回损失，出款不成功不收取任何前期费用）\n\nBasic/my_module.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583\n2: \n3: ### Módulo para pruebas ###\n4: \n5: def sumValue(numberOne, numberTwo, numberThree):\n6: print(numberOne + numberTwo + numberThree)\n7: \n8: \n9: def printValue(value):\n10: print(value)\n11: \n\nBasic/08_conditionals.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=21442\n2: \n3: ### Conditionals ###\n4: \n5: # if\n6: \n7: my_condition = False\n8: \n9: if my_condition: # Es lo mismo que if my_condition == True:\n10: print(\"Se ejecuta la condición del if\")\n11: \n12: my_condition = 5 * 5\n13: \n14: if my_condition == 10:\n15: print(\"Se ejecuta la condición del segundo if\")\n16: \n17: # if, elif, else\n18: \n19: if my_condition > 10 and my_condition < 20:\n20: print(\"Es mayor que 10 y menor que 20\")\n21: elif my_condition == 25:\n22: print(\"Es igual a 25\")\n23: else:\n24: print(\"Es menor o igual que 10 o mayor o igual que 20 o distinto de 25\")\n25: \n26: print(\"La ejecución continúa\")\n27: \n28: # Condicional con ispección de valor\n29: \n30: my_string = \"\"\n31: \n32: if not my_string:\n33: print(\"Mi cadena de texto es vacía\")\n34: \n35: if my_string == \"Mi cadena de textoooooo\":\n36: print(\"Estas cadenas de texto coinciden\")\n37: \n\nBasic/07_dicts.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc\n2: \n3: ### Dictionaries ###\n4: \n5: # Definición\n6: \n7: my_dict = dict()\n8: my_other_dict = {}\n9: \n10: print(type(my_dict))\n11: print(type(my_other_dict))\n12: \n13: my_other_dict = {\"Nombre\": \"Brais\",\n14: \"Apellido\": \"Moure\", \"Edad\": 35, 1: \"Python\"}\n15: \n16: my_dict = {\n17: \"Nombre\": \"Brais\",\n18: \"Apellido\": \"Moure\",\n19: \"Edad\": 35,\n20: \"Lenguajes\": {\"Python\", \"Swift\", \"Kotlin\"},\n21: 1: 1.77\n22: }\n23: \n24: print(my_other_dict)\n25: print(my_dict)\n26: \n27: print(len(my_other_dict))\n28: print(len(my_dict))\n29: \n30: # Búsqueda\n31: \n32: print(my_dict[1])\n33: print(my_dict[\"Nombre\"])\n34: \n35: print(\"Moure\" in my_dict)\n36: print(\"Apellido\" in my_dict)\n37: \n38: # Inserción\n39: \n40: my_dict[\"Calle\"] = \"Calle MoureDev\"\n41: print(my_dict)\n42: \n43: # Actualización\n44: \n45: my_dict[\"Nombre\"] = \"Pedro\"\n46: print(my_dict[\"Nombre\"])\n47: \n48: # Eliminación\n49: \n50: del my_dict[\"Calle\"]\n51: print(my_dict)\n52: \n53: # Otras operaciones\n54: \n55: print(my_dict.items())\n56: print(my_dict.keys())\n57: print(my_dict.values())\n58: \n59: my_list = [\"Nombre\", 1, \"Piso\"]\n60: \n61: my_new_dict = dict.fromkeys((my_list))\n62: print(my_new_dict)\n63: my_new_dict = dict.fromkeys((\"Nombre\", 1, \"Piso\"))\n64: print((my_new_dict))\n65: my_new_dict = dict.fromkeys(my_dict)\n66: print((my_new_dict))\n67: my_new_dict = dict.fromkeys(my_dict, \"MoureDev\")\n68: print((my_new_dict))\n69: \n70: my_values = my_new_dict.values()\n71: print(type(my_values))\n72: \n73: print(my_new_dict.values())\n74: print(list(dict.fromkeys(list(my_new_dict.values())).keys()))\n75: print(tuple(my_new_dict))\n76: print(set(my_new_dict))\n77: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}},{"rowIdx":99,"cells":{"final_prompt":{"kind":"string","value":"皇家国际创联娱乐公司游戏平台开户微：xiaolu460570 飞机：lc15688 下载游戏APP网址：[376838.com](http://376838.com/)】全球创联国际娱乐游戏注册网站是一家创立于1998年的在线网站菠菜公司。由库拉索岛政府授权，官网[376838.com](http://376838.com/)]东南亚实体大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！在线菠菜娱乐的首选平台！现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！出款灵活，支持颖航卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，200亿彩金让您发货。游戏第一现场实况连线，全透明牌靴，无接触发牌，先发牌后下注，100%公正透明；资金安全，出款高效，无忧！总部客服中心24小时恭候您的光临]([376838.com](http://376838.com/))\n\nBasic/my_module.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583\n2: \n3: ### Módulo para pruebas ###\n4: \n5: def sumValue(numberOne, numberTwo, numberThree):\n6: print(numberOne + numberTwo + numberThree)\n7: \n8: \n9: def printValue(value):\n10: print(value)\n11: \n\nBasic/08_conditionals.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=21442\n2: \n3: ### Conditionals ###\n4: \n5: # if\n6: \n7: my_condition = False\n8: \n9: if my_condition: # Es lo mismo que if my_condition == True:\n10: print(\"Se ejecuta la condición del if\")\n11: \n12: my_condition = 5 * 5\n13: \n14: if my_condition == 10:\n15: print(\"Se ejecuta la condición del segundo if\")\n16: \n17: # if, elif, else\n18: \n19: if my_condition > 10 and my_condition < 20:\n20: print(\"Es mayor que 10 y menor que 20\")\n21: elif my_condition == 25:\n22: print(\"Es igual a 25\")\n23: else:\n24: print(\"Es menor o igual que 10 o mayor o igual que 20 o distinto de 25\")\n25: \n26: print(\"La ejecución continúa\")\n27: \n28: # Condicional con ispección de valor\n29: \n30: my_string = \"\"\n31: \n32: if not my_string:\n33: print(\"Mi cadena de texto es vacía\")\n34: \n35: if my_string == \"Mi cadena de textoooooo\":\n36: print(\"Estas cadenas de texto coinciden\")\n37: \n\nBasic/07_dicts.py: \n\n1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc\n2: \n3: ### Dictionaries ###\n4: \n5: # Definición\n6: \n7: my_dict = dict()\n8: my_other_dict = {}\n9: \n10: print(type(my_dict))\n11: print(type(my_other_dict))\n12: \n13: my_other_dict = {\"Nombre\": \"Brais\",\n14: \"Apellido\": \"Moure\", \"Edad\": 35, 1: \"Python\"}\n15: \n16: my_dict = {\n17: \"Nombre\": \"Brais\",\n18: \"Apellido\": \"Moure\",\n19: \"Edad\": 35,\n20: \"Lenguajes\": {\"Python\", \"Swift\", \"Kotlin\"},\n21: 1: 1.77\n22: }\n23: \n24: print(my_other_dict)\n25: print(my_dict)\n26: \n27: print(len(my_other_dict))\n28: print(len(my_dict))\n29: \n30: # Búsqueda\n31: \n32: print(my_dict[1])\n33: print(my_dict[\"Nombre\"])\n34: \n35: print(\"Moure\" in my_dict)\n36: print(\"Apellido\" in my_dict)\n37: \n38: # Inserción\n39: \n40: my_dict[\"Calle\"] = \"Calle MoureDev\"\n41: print(my_dict)\n42: \n43: # Actualización\n44: \n45: my_dict[\"Nombre\"] = \"Pedro\"\n46: print(my_dict[\"Nombre\"])\n47: \n48: # Eliminación\n49: \n50: del my_dict[\"Calle\"]\n51: print(my_dict)\n52: \n53: # Otras operaciones\n54: \n55: print(my_dict.items())\n56: print(my_dict.keys())\n57: print(my_dict.values())\n58: \n59: my_list = [\"Nombre\", 1, \"Piso\"]\n60: \n61: my_new_dict = dict.fromkeys((my_list))\n62: print(my_new_dict)\n63: my_new_dict = dict.fromkeys((\"Nombre\", 1, \"Piso\"))\n64: print((my_new_dict))\n65: my_new_dict = dict.fromkeys(my_dict)\n66: print((my_new_dict))\n67: my_new_dict = dict.fromkeys(my_dict, \"MoureDev\")\n68: print((my_new_dict))\n69: \n70: my_values = my_new_dict.values()\n71: print(type(my_values))\n72: \n73: print(my_new_dict.values())\n74: print(list(dict.fromkeys(list(my_new_dict.values())).keys()))\n75: print(tuple(my_new_dict))\n76: print(set(my_new_dict))\n77: \n\n\n\nAnswer the Github Issue with a diff patch format. Here is an example:\n <patch>\n diff --git a/backend/config.py b/backend/config.py\n --- a/backend/config.py\n +++ b/backend/config.py\n @@ -24,7 +24,7 @@ class Config:\n DEBUG = False\n TESTING = False\n - SECRET_KEY = 'default-insecure-key'\n + SECRET_KEY = os.environ.get('SECRET_KEY', 'default-insecure-key')\n \n @staticmethod\n def init_app(app):\n </patch>\n "}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":0,"numItemsPerPage":100,"numTotalItems":222651,"offset":0,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sInJlcG9JZHMiOlsiNjdlYWNkZDgyODE3OWM2MWJlMTNlYjFhIl0sImlhdCI6MTc5Mzk0MDA2MywianRpIjoiOTUwOWEzNWYtNGVjNS00NTEwLWE0YTUtMDdjZGFlOGQwOThhIiwic3ViIjoiL2RhdGFzZXRzL21sZm91bmRhdGlvbnMtZGV2L3NjYWxlX3VwX3N3ZWd5bV9mdWxsX2Fubm90YXRlZCIsImV4cCI6MTc5Mzk0MzY2MywiaXNzIjoiaHR0cHM6Ly9odWdnaW5nZmFjZS5jbyJ9.V5L2s5Najy6o3B-PSM87NlRlHV9KC1i9UhG_qzgtJ4XPzzDoa9jPTYIx6N1ozBbHiNPeDob41r9GXFuiRC_4BA","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":222651,"numBytesParquet":10368793219}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
final_prompt stringlengths 1.16k 6M |
|---|
a very basic just gradio having app
fast api 111 fixes issue
all of my followers now reporting errors and so hard to fix all
i don't know how can you publish such a devastating bug having version please fix it ASAP
```
2024-09-06 00:12:20,515 - INFO - HTTP Request: GET https://api.gradio.app/gradio-messa... |
创联娱乐博彩体育公司是一家推荐亚洲十大在线博彩平台的网站》376838.com》，威《zdn200》 飞机：@lc15688专业提供亚洲各地区正规博彩平台的排名，比如体育博彩、在线赌场、线上娱乐城、大陆博彩、随着互联网的兴起，越来越多的人选择在体育博彩平台上进行投注，英超、欧冠和世界杯等重要赛事一键投注，方便快捷。然而体育博彩网站鱼龙混杂，如何才能找到靠谱的体育博彩平台呢？一定是那种奖金明晰有价格优惠的体育博彩平台才好！亚洲博彩平台排名为喜欢足球博彩的玩家精心编撰了一部足球博彩指南，为大家筛选出顶级足球博彩平台。这些平台由大型公司运营，信誉可靠，支持玩家下注、取款，并拥有实力雄厚以及合法执照，受国际行业协会认可，安全、公平、公正！
... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
I have a POST method with FastAPI which has 2 params with UploadFile type. But one of them is required and one of them is Optional. When I send required param with None value, I got 422 error relating to "Fiel... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
from fastapi import FastAPI, UploadFile, File, Form
from typing import List, Optional
app = FastAPI()
@app.post("/upload/")
async def upload_files(
required_files: List[UploadFile] = File(...),
... |
出黑咨询威:zdn200 飞机：@lc15688
切记，只要您赢钱了，遇到任何不给你提现的借口，基本表明您被黑了。
如果你出现以下这些情况，说明你已经被黑了：↓ ↓
【1】限制你账号的部分功能!出款和入款端口关闭，以及让你充值解开取款通道等等!
【2】客服找一些借口说什么系统维护，风控审核等等借口，就是不让取款!
【网赌被黑怎么办】【网赌赢了平台不给出款】【系统更新】【取款失败】【注单异常】【网络波动】【提交失败】
【单注为回归】【单注未更新】【出款通道维护】 【打双倍流水】 【充值同等的金额】
关于网上网赌娱乐平台赢钱了各种借口不给出款最新解决方法
切记，只要你赢钱了，遇到任何不给你提现的借口，基本表明你已经被黑了。... |
### Discussed in https://github.com/fastapi/fastapi/discussions/12218
<div type='discussions-op-text'>
<sup>Originally posted by **nat236919** September 19, 2024</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
-... |
### Privileged issue
- [ ] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#required-parameters
python interpreter... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
### Privileged issue
- [ ] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
This is my MRE code:
```python
from __future__ import annotations
from typing import Annotated
import uvicorn
from fastapi import FastAPI, Path
app = FastAPI()
@app.get('/{item_id}')
async de... |
被黑了不能出款找我们老毕灯出黑团队多年经验，如果你被黑了请联系我们帮你把损失降到最低 / 微 x:<>《微信zdq1136》《QQ3321499968》前期出款不收任何费用，我们团队都是先出款/后收费。不成功 不收费、
当网赌遇到赢了不能提款的问题怎么办呢？
首先我们应该保持冷静，如果提现被退回就不要去重复点了，切记不能跟平台客服或者所谓的代理人有任何的争执，一旦激怒对方，极有可能造成账号冻结之类的情况，这样问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后.
第一时间联系专业出黑团队，通过藏分锁卡等手段分批出款，这样问题就能妥善解决了，如果您目前正遭遇网赌赢钱不能提款的，请第... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
Everything demo, o smal sample is oriented to json, not web templates,
could u include samples with html samples, about login jwt many concurrent users.
pls
fastapi/routing.py:
1: import asyncio
2: i... |
东南亚线上网平台合法合法网上赌场,中国网上赌场,最好的网上赌场网赌十大快3平台 — 十大赌网平台推荐网最大最大平台-十大最好的网平台-十大赌排行全球最大赌排网正规网平台: 十大赌排网正规网平台
网站推荐376838.com游戏开户微信zdn200开户纸飞机：@lc15688联系我们详细正规实体咨询平台，东南亚大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！是您在线博彩娱乐的首选平台！
现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！
出款灵活，支持银行卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，200亿彩金让您... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
Thank you for all the work you have done. I have initiated the [discussion ](https://github.com/fastapi/fastapi/discussions/12401)as requested, but I think this issue is quite important. Initiating this issue is just to prevent the discussion from being drowned out, and I apologize for any offense.
### Example Code
... |
创联娱乐博彩体育公司是一家推荐亚洲十大在线博彩平台的网站》376838.com》，威《zdn200》 飞机：@lc15688专业提供亚洲各地区正规博彩平台的排名，比如体育博彩、在线赌场、线上娱乐城、大陆博彩、随着互联网的兴起，越来越多的人选择在体育博彩平台上进行投注，英超、欧冠和世界杯等重要赛事一键投注，方便快捷。然而体育博彩网站鱼龙混杂，如何才能找到靠谱的体育博彩平台呢？一定是那种奖金明晰有价格优惠的体育博彩平台才好！亚洲博彩平台排名为喜欢足球博彩的玩家精心编撰了一部足球博彩指南，为大家筛选出顶级足球博彩平台。这些平台由大型公司运营，信誉可靠，支持玩家下注、取款，并拥有实力雄厚以及合法执照，受国际行业协会认可，安全、公平、公正！
... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
### Discussed in https://github.com/fastapi/fastapi/discussions/12418
<div type='discussions-op-text'>
<sup>Originally posted by **bowenerchen** October 10, 2024</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
-... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
i use this command to start my application
`
nohup uvicorn app:app --host 0.0.0.0 --port 8000 --workers 5 > ../app.log 2>&1 &`
my task code
`async def my_task():
do some curd code
trigge... |
[体育投资实体靠谱的平台推荐体育官网](http://376838.com/)
创联娱乐国际科技实业有限公司主要经营产业有，文旅、酒店、商业地产、培训、金融、竞技、娱乐、投资、行 业App软件应用开发、商学传媒、同城服务、餐具加工、时政媒体、餐饮山庄等设计、开发、经营为一 体大型多元化发展的实业有限公司，公司业务覆盖柬埔寨多省多市，公司拥有职员万余名、中层管理上百人，总部立足西港、是一家发展潜力巨 大的实业科技公司之一，在(创联娱乐国际董事长张忠诚先生)率国际化管理运营团队的带领下，以“策略先行、经营致胜、管理为本”的商业推广 理念，以核心“创联娱乐百川、恩泽四方，助利国家经济发展为使命”！一步一个脚印发展，立足西港，利他 思维、... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
Chrome does not display Swagger UI, but Edge can.
Is this a bug?
fastapi/security/api_key.py:
1: from typing ... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
o activate this project's virtualenv, run pipenv shell.
Alternatively, run a command inside the virtualenv with pipenv run.
Installing dependencies from Pipfile.lock (527371)...
: Collecting click==8.1.7 (f... |
[东南亚腾龙博彩娱乐实体三大正规网赌平台推荐官网](http://376838.com/)
腾龙国际娱乐线上的公司主营：百家乐，龙虎斗，牛牛 赌场直播：与现场真人玩家同步投注 绝无任何作假可能确保每位玩家都是真实玩家。 24小时接受视频验证现场。 24小时可充值提现正规实体平台负责人经理微信：xiaolu460570 飞机：@lc15688官网网址：376838.com
一大型实体对接，资金安全有保障
二先发牌后下注，公平公正公开
三24小时视频验证现场绝无造假可能
四24小时游戏在线客服办理业务
五存储支持USDT 网银支付宝微信
六同城接受现金上分下分
公司规定进出款姓名一致，过沥脏款。 所以本公司的资金干净， ... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
INFO: Will watch for changes in these directories: ['C:\\Users\\wangy']
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO: Started reloader process [20616] using WatchFil... |
[东南亚腾龙博彩娱乐实体三大正规网赌平台推荐官网](http://376838.com/)
腾龙国际娱乐线上的公司主营：百家乐，龙虎斗，牛牛 赌场直播：与现场真人玩家同步投注 绝无任何作假可能确保每位玩家都是真实玩家。 24小时接受视频验证现场。 24小时可充值提现正规实体平台负责人经理微信：xiaolu460570 飞机：@lc15688官网网址：376838.com
一大型实体对接，资金安全有保障
二先发牌后下注，公平公正公开
三24小时视频验证现场绝无造假可能
四24小时游戏在线客服办理业务
五存储支持USDT 网银支付宝微信
六同城接受现金上分下分
公司规定进出款姓名一致，过沥脏款。 所以本公司的资金干净， ... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
code
```
def get_db():
db = SessionLocal2()
try:
yield db
except Exception as e:
logger.exception(e)
db.rollback()
raise e
finally:
db.close(... |
东南亚在线华纳创联娱乐公司24小时上线开户官网：376838.com 华纳公司的开户与注册流程可以根据不同的方式进行 以下是几种常见的注册开户流程描述。在线注册，通过华纳公司的官方网站或移动端应该进行注册。首先需要填写基本信息首先到浏览器搜索下载安装，姓名，手机号，电子邮箱等】提交验证码后，完成注册过程 安装aqq流程走 在线开户微信：xiaolu460570 飞机：@lc15688 缅甸正规实体平台 公平 公正 透明 洗牌 过牌 全程可看 真人在线发牌 科普一下华纳公司平台怎么注册 答：第一步、首先打开~华纳公司,然后点击页面加了微】或进入官网【376838.com】第二步、点击主页右上角的“注册”填写一个你想要的账号。第三步、在... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
The following check:
https://github.com/fastapi/fastapi/blob/5a48c37056397e47ab164ba4430807aa6fc9a710/fastapi/params.py#L108-L109
is going to be flawed when we release Pydantic 2.10 (in a week):
... |
创联娱乐国际科技实业有限公司主要经营产业有，文旅、酒店、商业地产、培训、金融、竞技、娱乐、投资、行 业App软件应用开发、商学传媒、同城服务、餐具加工、时政媒体、餐饮山庄等设计、开发、经营为一 体大型多元化发展的实业有限公司，公司业务覆盖柬埔寨多省多市，公司拥有职员万余名、中层管理上百人，总部立足西港、是一家发展潜力巨 大的实业科技公司之一，在(创联娱乐国际董事长张忠诚先生)率国际化管理运营团队的带领下，以“策略先行、经营致胜、管理为本”的商业推广 理念，以核心“创联娱乐百川、恩泽四方，助利国家经济发展为使命”！一步一个脚印发展，立足西港，利他 思维、包容有爱走向世界为己任的战略目标！致力打造最具柬埔寨影响力的实业公司。助力腾飞，同... |
### Discussed in https://github.com/fastapi/fastapi/discussions/12182
<div type='discussions-op-text'>
<sup>Originally posted by **rbubley** September 10, 2024</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
- [... |
东南亚在线华纳创联娱乐公司24小时上线开户官网：376838.com 华纳公司的开户与注册流程可以根据不同的方式进行 以下是几种常见的注册开户流程描述。在线注册，通过华纳公司的官方网站或移动端应该进行注册。首先需要填写基本信息首先到浏览器搜索下载安装，姓名，手机号，电子邮箱等】提交验证码后，完成注册过程 安装aqq流程走 在线开户微信：xiaolu460570 飞机：@lc15688 缅甸正规实体平台 公平 公正 透明 洗牌 过牌 全程可看 真人在线发牌 科普一下华纳公司平台怎么注册 答：第一步、首先打开~华纳公司,然后点击页面加了微】或进入官网【376838.com】第二步、点击主页右上角的“注册”填写一个你想要的账号。第三步、在... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
腾龙国际娱乐线上的公司主营：百家乐，龙虎斗，牛牛 赌场直播：与现场真人玩家同步投注 绝无任何作假可能确保每位玩家都是真实玩家。 24小时接受视频验证现场。 24小时可充值提现正规实体平台负责人经理微信：xiaolu460570 飞机：@lc15688官网网址：376838.com
一大型实体对接，资金安全有保障
二先发牌后下注，公平公正公开
三24小时视频验证现场绝无造假可能
四24小时游戏在线客服办理业务
五存储支持USDT 网银支付宝微信
六同城接受现金上分下分
公司规定进出款姓名一致，过沥脏款。 所以本公司的资金干净， ... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
This is a good first contribution. :nerd_face:
The code examples shown in the docs are actual Python files. They are even tested in CI, that's why you can always copy paste an example and it will alw... |
创联娱乐国际科技实业有限公司主要经营产业有，文旅、酒店、商业地产、培训、金融、竞技、娱乐、投资、行 业App软件应用开发、商学传媒、同城服务、餐具加工、时政媒体、餐饮山庄等设计、开发、经营为一 体大型多元化发展的实业有限公司，公司业务覆盖柬埔寨多省多市，公司拥有职员万余名、中层管理上百人，总部立足西港、是一家发展潜力巨 大的实业科技公司之一，在(创联娱乐国际董事长张忠诚先生)率国际化管理运营团队的带领下，以“策略先行、经营致胜、管理为本”的商业推广 理念，以核心“创联娱乐百川、恩泽四方，助利国家经济发展为使命”！一步一个脚印发展，立足西港，利他 思维、包容有爱走向世界为己任的战略目标！致力打造最具柬埔寨影响力的实业公司。助力腾飞，同... |
### Discussed in https://github.com/fastapi/fastapi/discussions/12227
<div type='discussions-op-text'>
<sup>Originally posted by **MartinAchtnerAA** September 19, 2024</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find ... |
2025最佳豪赌在线赌场
欢迎来到令人着迷的高额在线赌场世界，在这个世界中，您的高额赌注可以为您带来更高的回报。如果您是一位喜欢高额赌注并获得丰厚奖金的玩家，那么现在是时候踏入高额赌场的上线赌博公司 使用华纳探索顶级高额赌场。此外，通过查阅我们的华纳 赌场排行榜来增强您的游戏之旅——这是您发现为高额赌客量身定制的最佳赌场的首选资源！
华纳上线博彩平台推荐现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7–8大类游戏72张牌桌，游戏项目全网最丰富！
娱乐游戏网站：[376838.com](http://376838.com/)
游戏开户经理微：xiaolu460570
飞机：lc156... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
Hai
We using fastapi last 1.5 Yr we facing daily issues on that on performance like 100 to 200 clients requesting every 5 sec some time not responding some time totally hanging we restarting the services
A... |
关于上线创联娱乐AG真人博彩公司的平台娱乐个个官网-376838.com 上线创联娱乐AG真人是AG亚游旗下的在线真人娱乐平台，提供包括百家乐、龙虎斗、骰宝、轮盘等多种经典的真人娱乐游戏，玩家可以在真人主持的直播间里享受到与真实赌场相似的游戏体验。上线创联娱乐AG真人采用高清视频技术和现场音效，为玩家带来逼真的赌场感觉。同时，AG真人平台拥有严格的安全保障机制和多项资质认证，确保玩家的账户和个人信息安全。上线AG创联娱乐博彩真人的各种游戏介绍 上线AG创联娱乐真人是一个在线真人娱乐平台，提供多种真人游戏选择。以下是一些AG真人的游戏介绍：百家乐 龙虎斗 牛牛，轮盘 炸金花，大小，单双，推筒子..8大类游戏，公平 公正，出入款安全龙虎... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
async def generate_predictions(model_name):
global stop_flag
mean, std, labels, model, pca_model = get_init(model_name)
async for prediction in collect_predict(mean, std, labels, model, pca_mo... |
创联娱乐米乐体育博彩平台官网-376838.com
米乐体育是一家线上体育博彩平台，成立于2018年，总部位于菲律宾马尼拉。米乐体育提供全球范围内的赛事投注，包括足球、篮球、网球、电子竞技等多种体育项目，同时也提供在线真人娱乐场和电子游戏。米乐体育拥有安全可靠的游戏平台和专业的客服团队，致力于为用户提供优质的游戏体验和服务。
沙巴体育 – 亚洲最具影响力的体育博彩平台官网—376838.com
米乐体育博彩公司的一些优点
米乐体育是一家备受欢迎的在线博彩平台，其主要优点包括官网：376838.com
多样化的游戏选择
米乐体育提供了丰富的体育博彩、电子游戏、彩票游戏、真人娱乐和棋牌游戏等多种游戏选择，满足玩家不同的需求和偏好。
安全... |
### Issue Content
The following code doesn't generate the correct OpenAPI json:
```py
from __future__ import annotations
from dataclasses import dataclass
from typing import Annotated
from fastapi import Depends, FastAPI
app = FastAPI()
def get_potato() -> Potato:
return Potato(color='red', s... |
出黑咨询微：xiaolu460570 飞机：@lc15688
摘要：网赌赢钱后，遭拒取款的情况不少见。本文从账户审核、账户活动、规则遵守、客服沟通四个方面，详细阐述了网赌赢钱遭拒取款的解决方法。希望能为赌客朋友提供一些有用的指导。
1、账户审核
赌客需要梳理自己的账户信息，确保所有信息都是完整、准确、真实的。如果账户审核未通过，赌客需要认真检查并提供缺失或错误的信息。或者，赌客可以联系客服为自己的审核提供帮助。
此外，赌客还需要留意账户审核的时间。如果在该赌场的审核期限内还没有收到审核结果，赌客需要主动联系客服，询问处理进度。有时候，账户审核周期过长也是赌客遭拒取款的原因。
赌客在提交账户信息时，应保留好自己的... |
### Privileged issue
- [X] I'm ~@tiangolo or he asked me directly to create an issue here~ a liar, but the discussion template was crazy onerous, and I'm confident I can write a decent, succinct issue description that's worth reading here ;-)
### Issue Content
If I apply this diff to the [full-stack-fastapi-te... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
### Privileged issue
- [x] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
I cloned the project and installed requirements.txt. When I run ```python ./scripts/docs.py live az```, I get the following error.
OS: Windows 10
Python version 3.12.5
率国际化管理运营团队的带领下，以“策略先行、经营致胜、管理为本”的商业推广 理念，以核心“创联娱乐百川、恩泽四方，助利国家经济发展为使命”！一步一个脚印发展，立足西港，利他 思维、包容有爱走向世界为己任的战略目标！致力打造最具柬埔寨影响力的实业公司。助力腾飞，同... |
### Discussed in https://github.com/fastapi/fastapi/discussions/12226
<div type='discussions-op-text'>
<sup>Originally posted by **mzealey** September 19, 2024</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
- [... |
解决网被黑的问题可以按照以下步骤进行：
收集所有与赌博平台相关的证据，包括一周记录、聊天记录、平台登录信息等。
截屏保存所有的交易记录和沟通记录。
立即停止在该平台上的任何操作，避免进一步的资金损失。
请专业出黑进行咨询，通过我们出黑的手段追讨被骗资金。
如果被骗金额增加，可以考虑联合其他受害者进行集体诉讼。
微信：xiaolu460570 飞机：@lc15688
提高个人防护意识，不轻信高回报的投资回报。
审核平台的合法性，选择有资质、有信誉的投资平台。
利用社交媒体和媒体曝光：
利用社交媒体平台曝光网赌平台的行为，引起公众关注，促使相关部门介入调查。
联系媒体，通过新闻报道等方式揭露平台的骗局。
寻求专业机构... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
```python
from fastapi import FastAPI, HTTPException, BackgroundTasks
app = FastAPI()
items = {
'apple': 10,
'banana': 5,
}
def task1():
print("Task 1 is running in the background")
... |
2025最佳豪赌在线赌场
欢迎来到令人着迷的高额在线赌场世界，在这个世界中，您的高额赌注可以为您带来更高的回报。如果您是一位喜欢高额赌注并获得丰厚奖金的玩家，那么现在是时候踏入高额赌场的上线赌博公司 使用华纳探索顶级高额赌场。此外，通过查阅我们的华纳 赌场排行榜来增强您的游戏之旅——这是您发现为高额赌客量身定制的最佳赌场的首选资源！
华纳上线博彩平台推荐现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7–8大类游戏72张牌桌，游戏项目全网最丰富！
娱乐游戏网站：[376838.com](http://376838.com/)
游戏开户经理微：xiaolu460570
飞机：lc156... |
### Discussed in https://github.com/fastapi/fastapi/discussions/8428
<div type='discussions-op-text'>
<sup>Originally posted by **NewSouthMjos** December 5, 2022</sup>
### First Check
- [X] I added a very descriptive title to this issue.
- [X] I used the GitHub search to find a similar issue and didn't find... |
腾龙官网网址【376838.com】微信：【xiaolu460570 飞机：@lc15688】 下面就是基本流程腾龙公司开户流程大致如下：
1. 开户前准备：需要准备好个人或企业的有效身份证件，如身份证、护照、营业执照等，并确保这些证件在有效期内。了解腾龙公司的开户要求和规定，准备好与开户相关的其他材料，如公司章程、股东会决议等 。
2. 选择开户渠道：腾龙公司提供了线上开户和线下开户两种方式。线上开户方便快捷，客户只需在官方网站或手机APP上填写相关信息并提交申请即可。线下开户则需要客户前往腾龙公司的指定营业网点进行办理 。
3. 填写开户申请：在选择好开户渠道后，客户需要填写开户申请表格，并仔细核对所填信息的准确性和完整性。同... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
https://fastapi.tiangolo.com/tutorial/cookie-param-models/#cookies-with-a-pydantic-model
```python
from typing import Annotated
from fastapi import Cookie, FastAPI
from pydantic import BaseModel
app =... |
上线华纳博彩平台推荐正规官网：376838.com华纳国际注册官网：376838.com经理负责人微信：xiaolu460570 飞机：@lc15688
亚洲最靠谱实体结合线上平台华纳国际娱乐在线开户！实力公司靠谱正规，，多种游戏在线，主营：百家乐牛牛龙虎
推筒子炸金花电竞电子棋牌多种游戏应有尽有在线体验，公平公正公开真人荷官美女在线发牌实时视讯现场步
东南亚最大赌博平台之一华纳国际娱乐平台，信誉良好大额提款无忧！
华纳公司成立14年以来一直有着不错的口碑和信誉度，知名度也是网上众所皆知的，资金安全方面也是得到了广大网们的认可的大家都知道。
喜欢玩娱乐就要选择真人在线实体老平台，因为老平台经济实力雄厚，信誉度好，华纳公司不... |
### Privileged issue
- [x] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
#### code
```
def print_task_id(mn: str):
try:
print(mn, "task_id", id(asyncio.current_task()))
except Exception:
print(mn, "task_id", "None")
def print_thread_id(flag:... |
皇家国际创联娱乐公司游戏平台开户微：xiaolu460570 飞机：lc15688 下载游戏APP网址：[376838.com](http://376838.com/)】全球创联国际娱乐游戏注册网站是一家创立于1998年的在线网站菠菜公司。由库拉索岛政府授权，官网[376838.com](http://376838.com/)]东南亚实体大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！在线菠菜娱乐的首选平台！现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！出款灵活，支持颖航卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，... |
### Discussed in https://github.com/fastapi/fastapi/discussions/13160
<div type='discussions-op-text'>
<sup>Originally posted by **freud14-tm** January 6, 2025</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
- [X] I se... |
皇家国际创联娱乐公司游戏平台开户微：xiaolu460570 飞机：lc15688 下载游戏APP网址：[376838.com](http://376838.com/)】全球创联国际娱乐游戏注册网站是一家创立于1998年的在线网站菠菜公司。由库拉索岛政府授权，官网[376838.com](http://376838.com/)]东南亚实体大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！在线菠菜娱乐的首选平台！现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！出款灵活，支持颖航卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，... |
### Discussed in https://github.com/fastapi/fastapi/discussions/13431
<div type='discussions-op-text'>
<sup>Originally posted by **amacfie-tc** February 28, 2025</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
- [X] I s... |
皇家国际创联娱乐公司游戏平台开户微：xiaolu460570 飞机：lc15688 下载游戏APP网址：[376838.com](http://376838.com/)】全球创联国际娱乐游戏注册网站是一家创立于1998年的在线网站菠菜公司。由库拉索岛政府授权，官网[376838.com](http://376838.com/)]东南亚实体大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！在线菠菜娱乐的首选平台！现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！出款灵活，支持颖航卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，... |
According to https://datatracker.ietf.org/doc/html/rfc7617#autoid-3 , specification of the `realm` parameter is REQUIRED, so making `realm` optional here
https://github.com/fastapi/fastapi/blob/643d2845de09a437b955a163ab25eb0887bfd0e1/fastapi/security/http.py#L195
and at related places, is misleading and makes it eas... |
2025最佳豪赌在线赌场
欢迎来到令人着迷的高额在线赌场世界，在这个世界中，您的高额赌注可以为您带来更高的回报。如果您是一位喜欢高额赌注并获得丰厚奖金的玩家，那么现在是时候踏入高额赌场的上线赌博公司 使用华纳探索顶级高额赌场。此外，通过查阅我们的华纳 赌场排行榜来增强您的游戏之旅——这是您发现为高额赌客量身定制的最佳赌场的首选资源！
华纳上线博彩平台推荐现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7–8大类游戏72张牌桌，游戏项目全网最丰富！
娱乐游戏网站：[376838.com](http://376838.com/)
游戏开户经理微：xiaolu460570
飞机：lc156... |
### Discussed in https://github.com/fastapi/fastapi/discussions/6049
<div type='discussions-op-text'>
<sup>Originally posted by **FilipeMarch** December 16, 2022</sup>
### First Check
- [X] I added a very descriptive title to this issue.
- [X] I used the GitHub search to find a similar issue and didn't find ... |
上线博彩对于那些寻求顶级在线博彩平台的人来说，皇家国际创联娱乐在线赌场是最佳选择。创联娱 下载游戏APP对该平台进行了彻底研究并深入研究，以提供全面的见解。是皇家国际创联娱乐一家值得信赖且信誉良好的在线赌场，拥有各种在线赌场游戏，注重玩家安全、隐私和用户友好性。 创联娱乐开始您的在线博彩游戏娱乐平台
下载创联娱乐游戏APP网址-376838.com 也可以通过加微信我们工作人员帮你 开户欢迎各位喜爱玩家来咨询 微信：：xiaolu460570 和飞机：@lc15688
凭借十多年的经验创联娱乐在线赌场已经建立了庞大而忠诚的客户群，包括游戏爱好者和来自各个行业的名人，巩固了其作为皇家国际公司顶级在线赌场之一的地位。这家值得信赖的在线... |
### Issue Content
We have found at least 2 regression in the way forms are handled while trying to migrate to v0.115.11 from version v0.112.4. After investigation we were able to identify 2 commits that introduce 2 separate bugs that break the handling of default values in both `x-form-urlencoded` and `mutlipart` fr... |
[东南亚腾龙博彩娱乐实体三大正规网赌平台推荐官网](http://376838.com/)
腾龙国际娱乐线上的公司主营：百家乐，龙虎斗，牛牛 赌场直播：与现场真人玩家同步投注 绝无任何作假可能确保每位玩家都是真实玩家。 24小时接受视频验证现场。 24小时可充值提现正规实体平台负责人经理微信：xiaolu460570 飞机：@lc15688官网网址：376838.com
一大型实体对接，资金安全有保障
二先发牌后下注，公平公正公开
三24小时视频验证现场绝无造假可能
四24小时游戏在线客服办理业务
五存储支持USDT 网银支付宝微信
六同城接受现金上分下分
公司规定进出款姓名一致，过沥脏款。 所以本公司的资金干净， ... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
code:
error:
scripts/tr... |
Basic/my_module.py:
1: # Clase en vídeo: https://youtu.be/Kp4Mvapo5kc?t=34583
2:
3: ### Módulo para pruebas ###
4:
5: def sumValue(numberOne, numberTwo, numberThree):
6: print(numberOne + numberTwo + numberThree)
7:
8:
9: def printValue(value):
10: print(value)
11:
Basic/08_conditionals.py:
1: # Cla... |
皇家国际创联娱乐公司游戏平台开户微：xiaolu460570 飞机：lc15688 下载游戏APP网址：[376838.com](http://376838.com/)】全球创联国际娱乐游戏注册网站是一家创立于1998年的在线网站菠菜公司。由库拉索岛政府授权，官网[376838.com](http://376838.com/)]东南亚实体大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！在线菠菜娱乐的首选平台！现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！出款灵活，支持颖航卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，... |
### Discussed in https://github.com/fastapi/fastapi/discussions/13380
<div type='discussions-op-text'>
<sup>Originally posted by **sneakers-the-rat** February 16, 2025</sup>
### First Check
- [X] I added a very descriptive title here.
- [X] I used the GitHub search to find a similar question and didn't find it.
- [... |
2025最佳豪赌在线赌场
欢迎来到令人着迷的高额在线赌场世界，在这个世界中，您的高额赌注可以为您带来更高的回报。如果您是一位喜欢高额赌注并获得丰厚奖金的玩家，那么现在是时候踏入高额赌场的上线赌博公司 使用华纳探索顶级高额赌场。此外，通过查阅我们的华纳 赌场排行榜来增强您的游戏之旅——这是您发现为高额赌客量身定制的最佳赌场的首选资源！
华纳上线博彩平台推荐现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7–8大类游戏72张牌桌，游戏项目全网最丰富！
娱乐游戏网站：[376838.com](http://376838.com/)
游戏开户经理微：xiaolu460570
飞机：lc156... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
Issue in Fastapi website in ubuntu-mint flavor
Look at the top of the menu bar
fastapi/security/api_key.... |
咨询详情联系薇：zdh24588 飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台何种理由不让提现，首先我们应该保持冷静，如果提现被退回就不要去重复点了，切记不能跟平台客服或者所谓的代理人有任何的争执，一旦激怒对方，极有可能造成账号冻结之类的情况，这样问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系专业出黑团队，通过藏分锁卡等手段分批出款，这样问题就能妥善解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: ht... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://yout... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://yout... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://yout... |
上线华纳博彩平台推荐正规官网：376838.com华纳国际注册官网：376838.com经理负责人微信：xiaolu460570 飞机：@lc15688
亚洲最靠谱实体结合线上平台华纳国际娱乐在线开户！实力公司靠谱正规，，多种游戏在线，主营：百家乐牛牛龙虎
推筒子炸金花电竞电子棋牌多种游戏应有尽有在线体验，公平公正公开真人荷官美女在线发牌实时视讯现场步
东南亚最大赌博平台之一华纳国际娱乐平台，信誉良好大额提款无忧！
华纳公司成立14年以来一直有着不错的口碑和信誉度，知名度也是网上众所皆知的，资金安全方面也是得到了广大网们的认可的大家都知道。
喜欢玩娱乐就要选择真人在线实体老平台，因为老平台经济实力雄厚，信誉度好，华纳公司不... |
### Privileged issue
- [X] I'm @tiangolo or he asked me directly to create an issue here.
### Issue Content
## Summary
Simplify tests for variants, from multiple test files (one test file per variant) to a single test file with parameters to test each variant.
## Background
Currently, we have multiple sourc... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://yout... |
关于上线创联娱乐AG真人博彩公司的平台娱乐个个官网-376838.com 上线创联娱乐AG真人是AG亚游旗下的在线真人娱乐平台，提供包括百家乐、龙虎斗、骰宝、轮盘等多种经典的真人娱乐游戏，玩家可以在真人主持的直播间里享受到与真实赌场相似的游戏体验。上线创联娱乐AG真人采用高清视频技术和现场音效，为玩家带来逼真的赌场感觉。同时，AG真人平台拥有严格的安全保障机制和多项资质认证，确保玩家的账户和个人信息安全。上线AG创联娱乐博彩真人的各种游戏介绍 上线AG创联娱乐真人是一个在线真人娱乐平台，提供多种真人游戏选择。以下是一些AG真人的游戏介绍：百家乐 龙虎斗 牛牛，轮盘 炸金花，大小，单双，推筒子..8大类游戏，公平 公正，出入款安全龙虎... |
```
Expected boundary character 45, got 20 at index 2
```
Related:
https://github.com/fastapi/fastapi/discussions/7062#discussioncomment-6090647_
fastapi/security/http.py:
1: import binascii
2: from base64 import b64decode
3: from typing import Optional
4:
5: from fastapi.exceptions import HTTPException
6: f... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://yout... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台何种理由不让提现，首先我们应该保持冷静，如果提现被退回就不要去重复点了，切记不能跟平台客服或者所谓的代理人有任何的争执，一旦激怒对方，极有可能造成账号冻结之类的情况，这样问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系专业出黑团队，通过藏分锁卡等手段分批出款，这样问题就能妥善解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://youtu... |
创联娱乐博彩娱乐游戏平台注册官网可以电脑或手机APP软件为载体，太阳城网络赌场实现了手机与PC版数据互通，操作简单，传播面极广。亚洲博彩平台排名欧冠在线买球平台入口：376838.com【体育娱乐平台下载可以买球的软件app天天电玩城唯一下载地址：376838.com【体育娱乐平台网络押龙虎的方法与技巧?【体育娱乐平台电子pt试玩体验【体育娱乐平台欧冠杯买球网站：376838.com【体育娱乐平台电玩城游戏大厅官网版下载【体育娱乐平台手机上怎么买彩票2025【体育娱乐平台：376838.com真人在哪可以注册？【体育娱乐平台大发彩票平台登录网址：376838.com【体育娱乐平台大家用的什么软件买球【体育娱乐平台欧冠哪个网站能买球【... |
### Discussed in https://github.com/fastapi/fastapi/discussions/8449
<div type='discussions-op-text'>
<sup>Originally posted by **bruchar1** March 30, 2022</sup>
### First Check
- [X] I added a very descriptive title to this issue.
- [X] I used the GitHub search to find a similar issue and didn't find it.
-... |
咨询详情联系飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台坚固不让提现，首先我们应该保持冷静，如果提现被终止不再重复点了，切记不能跟平台客服或者所谓的代理人有任何争执，一旦激起对方愤怒，极有可能造成账号冻结之类的情绪情况，这样的问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系我们专业出黑团队，通过藏分锁卡等手段分批出款，这样问题才能顺利解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: https://yout... |
十大赌博靠谱网络平台娱乐游戏网址：376838.com
游戏开户经理 薇：xiaolu460570 飞机：lc15688正规实体平台-创联娱乐实体网赌平台-创联游戏联盟实体网赌平台推荐-十大亚洲博彩娱乐-亚洲赌博平台线上开户-线上赌博/APP-十大实体赌博平台推荐-实体网络赌博平台-实体博彩娱乐创联国际-创联娱乐-创联游戏-全球十大网赌正规平台在线推荐！ 推荐十大赌博靠谱平台-十大赌博靠谱信誉的平台 国际 东南亚线上网赌平台 合法网上赌场,中国网上合法赌场,最好的网上赌场 网赌十大快3平台 - 十大网赌平台推荐- 网赌最好最大平台-十大最好的网赌平台 十大靠谱网赌平台- 网上赌搏网站十大排行 全球最大网赌正规平台: 十大，资金安全有... |
网赌赌博被黑了怎么办、提款迟迟不到账怎么办？
团队经验深（8年老团队）团队掌控着一些 出款最新技术
随着电脑科技的飞速发展，黑客解决方法威:xaiolu460570 飞机：@lc15688网络时代一直在进步，有很多网友都会无意中接触到网赌，在这里我忠诚的和大家说一下，很多时候网赌被黑都是因为自己的盲目无知所造成，好多网友不会辨别平台，所以黑平台就是利用到你的无知给你挖坑！很多黑平台一般都先是以较高的赔率、返水，注册充值就会给你送彩金来引诱你上钩，让你充值等等。在你输钱或者赢不多的时候网站是处于正常状态，充值秒到账，取款也是秒到账。但是你要赢了他们拟定的金额以后，平台就会开始以各种借口不给你出款。
比如说：你的账户登录异常、网站... |
澳门平台（威尼斯人，出黑拿回微信：xiaolu460570飞机：@lc15688金沙，巴黎人，美高梅，银河，新葡京，太阳城等等）不给出款怎么办？
关于网上网赌娱乐平台赢钱了各种借口不给出款最新解决方法
切记，只要你赢钱了，遇到任何不给你提现的借口，基本表明你已经被黑了。
第一：提款被拒绝，各种借口理由，就是不让出款，让打倍投流水等等！
第二：限制你账号的部分功能！出款和入款端口关闭，以及让你充值解开取款通道等等！
第三：客服找一些借口说什么系统维护，风控审核等等借口，就是不让取款！
第四：确认被黑了，应该怎么做？ （找专业团队教你怎么办挽回损失，出款不成功不收取任何前期费用）
Basic/my_... |
咨询详情联系薇：zdh24588 飞机：lc15688微信：xiaolu460570无任何前期当网赌遇到提现被退回，平台何种理由不让提现，首先我们应该保持冷静，如果提现被退回就不要去重复点了，切记不能跟平台客服或者所谓的代理人有任何的争执，一旦激怒对方，极有可能造成账号冻结之类的情况，这样问题就很难得到处理了，这个时候对方的理由或者借口我们都要表示相信，并希望尽快得到处理，在稳住对方后，第一时间联系专业出黑团队，通过藏分锁卡等手段分批出款，这样问题就能妥善解决了，如果您目前正遭遇网赌赢钱不能提款的，请第一时间联系我们专业出黑团队为您处理。
Basic/my_module.py:
1: # Clase en vídeo: ht... |
关于网上网赌娱乐平台赢钱了各种借口不给出款最新解决方法
网出黑咨询微：xiaolu460570飞机：lc15688如果您目前遇到这样的情况，请第一时间联系我们专业出黑团队，通过藏分等技术手段分批出款，这样问题就能得到很好的解决。网络时代很多人都喜欢在网络上玩娱乐博彩但是很多人都不懂网上有很多黑台了，黑台不给出款的借口说你的账号异常登录。平台网站，网站出款端口维护账号涉嫌套利，系统自动抽查审核，网址抽查审核，账号下注违规，银行系统维护款等借口维护不给你出甚至冻结你账号，网投不给出款怎么办如何拿回。
切记，只要你赢钱了，遇到任何不给你提现的借口，基本表明你已经被黑了。
第一：提款被拒绝，各种借口理由，就是不让出款，让打倍投流水等等... |
皇家国际创联娱乐公司游戏平台开户微：xiaolu460570 飞机：lc15688 下载游戏APP网址：[376838.com](http://376838.com/)】全球创联国际娱乐游戏注册网站是一家创立于1998年的在线网站菠菜公司。由库拉索岛政府授权，官网[376838.com](http://376838.com/)]东南亚实体大赌场的现场实况连线平台，连续多年讨论全球线上娱乐顶级品牌榜！在线菠菜娱乐的首选平台！现场百家乐、现场龙虎、VIP百家乐、VIP龙虎，牛牛、炸金花、大小、单双、筒子……7-8大类游戏72张牌桌，游戏项目全网最丰富！出款灵活，支持颖航卡、支付宝、微信及USDT充值和出款，总部客服24小时随时在线办理，... |