init() — fastapi Function Reference

Architecture documentation for the __init__() function in http.py from the fastapi codebase.

Function python Security Schemes

Entity Profile

Security→ Schemes→ __init__() — fastapi Function Reference

Dependency Diagram

graph TD
  43b65f2d_ec05_8f70_3e9c_1ece256be8dc["__init__()"]
  4e2b048a_4ece_200c_1c67_a89f28fd47db["HTTPBasic"]
  43b65f2d_ec05_8f70_3e9c_1ece256be8dc -->|defined in| 4e2b048a_4ece_200c_1c67_a89f28fd47db
  style 43b65f2d_ec05_8f70_3e9c_1ece256be8dc fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/security/http.py lines 142–197

    def __init__(
        self,
        *,
        scheme_name: Annotated[
            Optional[str],
            Doc(
                """
                Security scheme name.

                It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
        ] = None,
        realm: Annotated[
            Optional[str],
            Doc(
                """
                HTTP Basic authentication realm.
                """
            ),
        ] = None,
        description: Annotated[
            Optional[str],
            Doc(
                """
                Security scheme description.

                It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
        ] = None,
        auto_error: Annotated[
            bool,
            Doc(
                """
                By default, if the HTTP Basic authentication is not provided (a
                header), `HTTPBasic` will automatically cancel the request and send the
                client an error.

                If `auto_error` is set to `False`, when the HTTP Basic authentication
                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 HTTP Basic
                authentication or in an HTTP Bearer token).
                """
            ),
        ] = True,
    ):
        self.model = HTTPBaseModel(scheme="basic", description=description)
        self.scheme_name = scheme_name or self.__class__.__name__
        self.realm = realm
        self.auto_error = auto_error