g#SSKJr SSKJrJr SSKJr SSKJr SSK J r SSK J r SSK JrJr "SS \5r"S S \5r"S S \5r"SS\5rg))Optional)APIKeyAPIKeyIn) SecurityBase) HTTPException)Request)HTTP_403_FORBIDDEN) AnnotatedDocc@\rSrSr\S\\S\S\\4Sj5rSr g) APIKeyBase api_key auto_errorreturnc@U(dU(a[[SS9egU$)NzNot authenticated) status_codedetail)rr )rrs Q/home/matz/Project1/venv/lib/python3.13/site-packages/fastapi/security/api_key.py check_api_keyAPIKeyBase.check_api_key s%# 2;NN) __name__ __module__ __qualname____firstlineno__ staticmethodrstrboolr__static_attributes__rrrr r s1x}$8C=rr c \rSrSrSrSSSS.S\\\"S54S\\\\"S 54S \\\\"S 54S \\ \"S 544Sjjr S\ S\\4Sjr Sr g) APIKeyQuerya, API key authentication using a query parameter. This defines the name of the query parameter that should be provided in the request with the API key and integrates that into the OpenAPI documentation. It extracts the key value sent in the query parameter automatically and provides it as the dependency result. But it doesn't define how to send that API key to the client. ## Usage Create an instance object and use that object as the dependency in `Depends()`. The dependency result will be a string containing the key value. ## Example ```python from fastapi import Depends, FastAPI from fastapi.security import APIKeyQuery app = FastAPI() query_scheme = APIKeyQuery(name="api_key") @app.get("/items/") async def read_items(api_key: str = Depends(query_scheme)): return {"api_key": api_key} ``` NT scheme_name descriptionrnamezQuery parameter name.r& Security scheme name. It will be included in the generated OpenAPI (e.g. visible at `/docs`). r' Security scheme description. It will be included in the generated OpenAPI (e.g. visible at `/docs`). ra By default, if the query parameter is not provided, `APIKeyQuery` will automatically cancel the request and send the client an error. If `auto_error` is set to `False`, when the query parameter is not available, instead of erroring out, the dependency result will be `None`. This is useful when you want to have optional authentication. It is also useful when you want to have authentication that can be provided in one of multiple optional ways (for example, in a query parameter or in an HTTP Bearer token). c[S0S[R0DUUS.D6UlU=(d URR UlX@lgNin)r(r'r)rrquerymodel __class__rr&rselfr(r&r'rs r__init__APIKeyQuery.__init__7sK^$ X^^$ #  'A$..*A*A$rrequestrc# URRURR5nUR X R 5$7fN) query_paramsgetr/r(rrr2r5rs r__call__APIKeyQuery.__call__ns8&&**4::??;!!'??;;A A rr/r&rrrr__doc__r rr rr r3rr;r!rrrr#r#s^  & [5%  ' ( * 5% SM     5%" SM     #5%6      75%nr?rrrrBrBsX  $ S1%S0011% SM     1% SM     1%0      11%fr?rrrrNrNrLrrNN)typingrfastapi.openapi.modelsrrfastapi.security.baserstarlette.exceptionsrstarlette.requestsrstarlette.statusr typing_extensionsr r r r#rBrNrrrr]sR3..&/,  Y<*Y