Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 51 for Annotation (0.22 sec)

  1. tests/test_response_model_as_return_annotation.py

    app = FastAPI()
    
    
    @app.get("/no_response_model-no_annotation-return_model")
    def no_response_model_no_annotation_return_model():
        return User(name="John", surname="Doe")
    
    
    @app.get("/no_response_model-no_annotation-return_dict")
    def no_response_model_no_annotation_return_dict():
        return {"name": "John", "surname": "Doe"}
    
    
    @app.get("/response_model-no_annotation-return_same_model", response_model=User)
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Aug 14 09:49:57 GMT 2023
    - 47.7K bytes
    - Viewed (0)
  2. tests/test_compat.py

    from typing import List, Union
    
    from fastapi import FastAPI, UploadFile
    from fastapi._compat import (
        ModelField,
        Undefined,
        _get_model_config,
        is_bytes_sequence_annotation,
        is_uploadfile_sequence_annotation,
    )
    from fastapi.testclient import TestClient
    from pydantic import BaseConfig, BaseModel, ConfigDict
    from pydantic.fields import FieldInfo
    
    from .utils import needs_pydanticv1, needs_pydanticv2
    
    
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Sep 28 04:14:40 GMT 2023
    - 2.8K bytes
    - Viewed (0)
  3. fastapi/params.py

                self.deprecated = deprecated
            else:
                kwargs["deprecated"] = deprecated
            if PYDANTIC_V2:
                kwargs.update(
                    {
                        "annotation": annotation,
                        "alias_priority": alias_priority,
                        "validation_alias": validation_alias,
                        "serialization_alias": serialization_alias,
                        "strict": strict,
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 27.5K bytes
    - Viewed (1)
  4. docs/en/docs/tutorial/response-model.md

    This simple case is handled automatically by FastAPI because the return type annotation is the class (or a subclass) of `Response`.
    
    And tools will also be happy because both `RedirectResponse` and `JSONResponse` are subclasses of `Response`, so the type annotation is correct.
    
    ### Annotate a Response Subclass
    
    You can also use a subclass of `Response` in the type annotation:
    
    ```Python hl_lines="8-9"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17.9K bytes
    - Viewed (0)
  5. docs/en/docs/advanced/dataclasses.md

    7. Here the `response_model` is using a type annotation of a list of `Author` dataclasses.
    
        Again, you can combine `dataclasses` with standard type annotations.
    
    8. Notice that this *path operation function* uses regular `def` instead of `async def`.
    
        As always, in FastAPI you can combine `def` and `async def` as needed.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 4.1K bytes
    - Viewed (0)
  6. fastapi/utils.py

                f"check that {type_} is a valid Pydantic field type. "
                "If you are using a return type annotation that is not a valid Pydantic "
                "field (e.g. Union[Response, dict, None]) you can disable generating the "
                "response model from the type annotation with the path operation decorator "
                "parameter response_model=None. Read more: "
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 7.8K bytes
    - Viewed (0)
  7. tests/test_operations_signatures.py

                router_param: inspect.Parameter = router_sig.parameters[key]
                app_param: inspect.Parameter = app_sig.parameters[key]
                assert param.annotation == router_param.annotation
                assert param.annotation == app_param.annotation
                assert param.default == router_param.default
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon May 27 12:08:13 GMT 2019
    - 934 bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/path-params.md

    ### Declare a *path parameter*
    
    Then create a *path parameter* with a type annotation using the enum class you created (`ModelName`):
    
    ```Python hl_lines="16"
    {!../../../docs_src/path_params/tutorial005.py!}
    ```
    
    ### Check the docs
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  9. docs/fr/docs/tutorial/path-params.md

    ### Déclarer un paramètre de chemin
    
    Créez ensuite un *paramètre de chemin* avec une annotation de type désignant l'énumération créée précédemment (`ModelName`) :
    
    ```Python hl_lines="16"
    {!../../../docs_src/path_params/tutorial005.py!}
    ```
    
    ### Documentation
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 10K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/cookie-params.md

        ```
    
    ## Declare `Cookie` parameters
    
    Then declare the cookie parameters using the same structure as with `Path` and `Query`.
    
    The first value is the default value, you can pass all the extra validation or annotation parameters:
    
    === "Python 3.10+"
    
        ```Python hl_lines="9"
        {!> ../../../docs_src/cookie_params/tutorial001_an_py310.py!}
        ```
    
    === "Python 3.9+"
    
        ```Python hl_lines="9"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 2.4K bytes
    - Viewed (0)
Back to top