Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 7 of 7 for doc (0.03 seconds)

  1. fastapi/datastructures.py

        """
    
        file: Annotated[
            BinaryIO,
            Doc("The standard Python file object (non-async)."),
        ]
        filename: Annotated[Optional[str], Doc("The original file name.")]
        size: Annotated[Optional[int], Doc("The size of the file in bytes.")]
        headers: Annotated[Headers, Doc("The headers of the request.")]
        content_type: Annotated[
            Optional[str], Doc("The content type of the request, from the headers.")
        ]
    
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 5.1K bytes
    - Click Count (0)
  2. fastapi/param_functions.py

            Optional[int],
            Doc(
                """
                Maximum length for strings.
                """
            ),
        ] = None,
        pattern: Annotated[
            Optional[str],
            Doc(
                """
                RegEx pattern for strings.
                """
            ),
        ] = None,
        regex: Annotated[
            Optional[str],
            Doc(
                """
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 63K bytes
    - Click Count (0)
  3. fastapi/routing.py

        def include_router(
            self,
            router: Annotated["APIRouter", Doc("The `APIRouter` to include.")],
            *,
            prefix: Annotated[str, Doc("An optional path prefix for the router.")] = "",
            tags: Annotated[
                Optional[list[Union[str, Enum]]],
                Doc(
                    """
                    A list of tags to be applied to all the *path operations* in this
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 174.6K bytes
    - Click Count (0)
  4. fastapi/encoders.py

    
    def jsonable_encoder(
        obj: Annotated[
            Any,
            Doc(
                """
                The input object to convert to JSON.
                """
            ),
        ],
        include: Annotated[
            Optional[IncEx],
            Doc(
                """
                Pydantic's `include` parameter, passed to Pydantic models to set the
                fields to include.
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 10.7K bytes
    - Click Count (0)
  5. fastapi/exceptions.py

            code: Annotated[
                int,
                Doc(
                    """
                    A closing code from the
                    [valid codes defined in the specification](https://datatracker.ietf.org/doc/html/rfc6455#section-7.4.1).
                    """
                ),
            ],
            reason: Annotated[
                Union[str, None],
                Doc(
                    """
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 6.8K bytes
    - Click Count (0)
  6. pyproject.toml

        "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
        "Topic :: Internet :: WWW/HTTP",
    ]
    dependencies = [
        "starlette>=0.40.0,<0.51.0",
        "pydantic>=2.7.0",
        "typing-extensions>=4.8.0",
        "annotated-doc>=0.0.2",
    ]
    
    [project.urls]
    Homepage = "https://github.com/fastapi/fastapi"
    Documentation = "https://fastapi.tiangolo.com/"
    Repository = "https://github.com/fastapi/fastapi"
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 12:54:56 GMT 2025
    - 9.3K bytes
    - Click Count (0)
  7. docs/en/docs/release-notes.md

    internal reference documentation now uses `annotated_doc.Doc` instead of `typing_extensions.Doc`, this adds a new (very small) dependency on [`annotated-doc`](https://github.com/fastapi/annotated-doc), a package made just to provide that `Doc` documentation utility class.
    
    I would expect `typing_extensions.Doc` to be deprecated and then removed at some point from `typing_extensions`, for that reason there's the new `annotated-doc` micro-package. If you are curious about this, you can read...
    Created: Sun Dec 28 07:19:09 GMT 2025
    - Last Modified: Sat Dec 27 19:06:15 GMT 2025
    - 586.7K bytes
    - Click Count (0)
Back to Top