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
  013b85a6_a1fa_f855_6dc6_f0b56dff5dc6["__init__()"]
  787896c0_cb31_1b11_93c2_5e2fac3ff58e["HTTPDigest"]
  013b85a6_a1fa_f855_6dc6_f0b56dff5dc6 -->|defined in| 787896c0_cb31_1b11_93c2_5e2fac3ff58e
  style 013b85a6_a1fa_f855_6dc6_f0b56dff5dc6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

fastapi/security/http.py lines 361–406

    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,
        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 Digest is not provided, `HTTPDigest` will
                automatically cancel the request and send the client an error.

                If `auto_error` is set to `False`, when the HTTP Digest 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
                Digest or in a cookie).
                """
            ),
        ] = True,
    ):
        self.model = HTTPBaseModel(scheme="digest", description=description)
        self.scheme_name = scheme_name or self.__class__.__name__
        self.auto_error = auto_error