Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 22 for notice (0.19 sec)

  1. docs/en/docs/advanced/events.md

    !!! tip
        The `shutdown` would happen when you are **stopping** the application.
    
        Maybe you need to start a new version, or you just got tired of running it. 🤷
    
    ### Lifespan function
    
    The first thing to notice, is that we are defining an async function with `yield`. This is very similar to Dependencies with `yield`.
    
    ```Python hl_lines="14-19"
    {!../../../docs_src/events/tutorial003.py!}
    ```
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 7.8K bytes
    - Viewed (0)
  2. docs/en/docs/how-to/configure-swagger-ui.md

    <img src="/img/tutorial/extending-openapi/image03.png">
    
    ## Change the Theme
    
    The same way you could set the syntax highlighting theme with the key `"syntaxHighlight.theme"` (notice that it has a dot in the middle):
    
    ```Python hl_lines="3"
    {!../../../docs_src/configure_swagger_ui/tutorial002.py!}
    ```
    
    That configuration would change the syntax highlighting color theme:
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 2.8K bytes
    - Viewed (0)
  3. docs/en/docs/tutorial/sql-databases.md

    !!! tip
        Notice that the values you return are SQLAlchemy models, or lists of SQLAlchemy models.
    
        But as all the *path operations* have a `response_model` with Pydantic *models* / schemas using `orm_mode`, the data declared in your Pydantic models will be extracted from them and returned to the client, with all the normal filtering and validation.
    
    !!! tip
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 29.6K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/dependencies/classes-as-dependencies.md

    ```Python
    something()
    ```
    
    or
    
    ```Python
    something(some_argument, some_keyword_argument="foo")
    ```
    
    then it is a "callable".
    
    ## Classes as dependencies
    
    You might notice that to create an instance of a Python class, you use that same syntax.
    
    For example:
    
    ```Python
    class Cat:
        def __init__(self, name: str):
            self.name = name
    
    
    fluffy = Cat(name="Mr Fluffy")
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.4K bytes
    - Viewed (0)
  5. docs/en/docs/advanced/settings.md

    ### The config file
    
    Coming from the previous example, your `config.py` file could look like:
    
    ```Python hl_lines="10"
    {!../../../docs_src/settings/app02/config.py!}
    ```
    
    Notice that now we don't create a default instance `settings = Settings()`.
    
    ### The main app file
    
    Now we create a dependency that returns a new `config.Settings()`.
    
    === "Python 3.9+"
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 15.7K bytes
    - Viewed (0)
  6. docs/en/docs/tutorial/body-updates.md

        ```
    
    !!! tip
        You can actually use this same technique with an HTTP `PUT` operation.
    
        But the example here uses `PATCH` because it was created for these use cases.
    
    !!! note
        Notice that the input model is still validated.
    
        So, if you want to receive partial updates that can omit all the attributes, you need to have a model with all the attributes marked as optional (with default values or `None`).
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 5.6K bytes
    - Viewed (0)
  7. docs/en/docs/advanced/custom-response.md

        By doing it this way, we can put it in a `with` block, and that way, ensure that it is closed after finishing.
    
    !!! tip
        Notice that here as we are using standard `open()` that doesn't support `async` and `await`, we declare the path operation with normal `def`.
    
    ### `FileResponse`
    
    Asynchronously streams a file as the response.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.7K bytes
    - Viewed (0)
  8. docs/en/docs/advanced/openapi-callbacks.md

        "paid": true
    }
    ```
    
    and it would expect a response from that *external API* with a JSON body like:
    
    ```JSON
    {
        "ok": true
    }
    ```
    
    !!! tip
        Notice how the callback URL used contains the URL received as a query parameter in `callback_url` (`https://www.external.org/events`) and also the invoice `id` from inside of the JSON body (`2expen51ve`).
    
    ### Add the callback router
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 7.7K bytes
    - Viewed (0)
  9. docs/en/docs/how-to/async-sql-encode-databases.md

    !!! note
        Notice that as we communicate with the database using `await`, the *path operation function* is declared with `async`.
    
    ### About `{**note.dict(), "id": last_record_id}`
    
    `note` is a Pydantic `Note` object.
    
    `note.dict()` returns a `dict` with its data, something like:
    
    ```Python
    {
        "text": "Some note",
        "completed": False,
    }
    ```
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 5.3K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/generate-clients.md

    ### Try Out the Client Code
    
    Now you can import and use the client code, it could look like this, notice that you get autocompletion for the methods:
    
    <img src="/img/tutorial/generate-clients/image02.png">
    
    You will also get autocompletion for the payload to send:
    
    <img src="/img/tutorial/generate-clients/image03.png">
    
    !!! tip
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 10.5K bytes
    - Viewed (0)
Back to top