Reed - Code Search

docs/en/docs/tutorial/request-files.md

    * E.g., `await myfile.seek(0)` would go to the start of the file.
    * This is especially useful if you run `await myfile.read()` once and then need to read the contents again.
* `close()`: Closes the file.

As all these methods are `async` methods, you need to "await" them.

For example, inside of an `async` *path operation function* you can get the contents with:

```Python
contents = await myfile.read()
```

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Wed Mar 13 19:02:19 GMT 2024

- 10.2K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/query-params-str-validations.md

    {!> ../../../docs_src/query_params_str_validations/tutorial002.py!}
    ```

As in this case (without using `Annotated`) we have to replace the default value `None` in the function with `Query()`, we now need to set the default value with the parameter `Query(default=None)`, it serves the same purpose of defining that default value (at least for FastAPI).

So:

```Python
q: Union[str, None] = Query(default=None)
```

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Fri Mar 22 01:42:11 GMT 2024

- 25.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/help-fastapi.md

* Also don't worry about style rules, there are already automatized tools checking that.

And if there's any other style or consistency need, I'll ask directly for that, or I'll add commits on top with the needed changes.

### Check the code

* Check and read the code, see if it makes sense, **run it locally** and see if it actually solves the problem.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 13.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/how-to/sql-databases-peewee.md

If you are developing an application with an older non-async framework, and can work with all its defaults, **it can be a great tool**.

But if you need to change some of the defaults, support more than one predefined database, work with an async framework (like FastAPI), etc, you will need to add quite some complex extra code to override those defaults.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Tue Jan 16 13:23:25 GMT 2024

- 23.6K bytes

- Viewed (1)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/security/simple-oauth2.md

    If you need to enforce it, use `OAuth2PasswordRequestFormStrict` instead of `OAuth2PasswordRequestForm`.

* An optional `client_id` (we don't need it for our example).
* An optional `client_secret` (we don't need it for our example).

!!! info

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 12.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/security/oauth2-scopes.md

    You don't necessarily need OAuth2 scopes, and you can handle authentication and authorization however you want.

    But OAuth2 with scopes can be nicely integrated into your API (with OpenAPI) and your API docs.

    Nevertheless, you still enforce those scopes, or any other security/authorization requirement, however you need, in your code.

    In many cases, OAuth2 with scopes can be an overkill.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Jan 11 21:21:35 GMT 2024

- 20.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/openapi/docs.py

    """
    return HTMLResponse(html)


def get_swagger_ui_oauth2_redirect_html() -> HTMLResponse:
    """
    Generate the HTML response with the OAuth2 redirection for Swagger UI.

    You normally don't need to use or change this.
    """
    # copied from https://github.com/swagger-api/swagger-ui/blob/v4.14.0/dist/oauth2-redirect.html
    html = """
    <!doctype html>
    <html lang="en-US">
    <head>

Python

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Tue Apr 02 02:48:51 GMT 2024

- 10.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/async.md

---

If you just don't know, use normal `def`.

---

**Note**: You can mix `def` and `async def` in your *path operation functions* as much as you need and define each one using the best option for you. FastAPI will do the right thing with them.

Anyway, in any of the cases above, FastAPI will still work asynchronously and be extremely fast.

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 23K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/settings.md

# Settings and Environment Variables

In many cases your application could need some external settings or configurations, for example secret keys, database credentials, credentials for email services, etc.

Most of these settings are variable (can change), like database URLs. And many could be sensitive, like secrets.

For this reason it's common to provide them in environment variables that are read by the application.

## Environment Variables

!!! tip

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu May 02 22:37:31 GMT 2024

- 15.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/sql-databases.md

    But in FastAPI, using normal functions (`def`) more than one thread could interact with the database for the same request, so we need to make SQLite know that it should allow that with `connect_args={"check_same_thread": False}`.

    Also, we will make sure each request gets its own database connection session in a dependency, so there's no need for that default mechanism.

### Create a `SessionLocal` class

Plain Text

- Registered: Sun May 05 07:19:11 GMT 2024

- Last Modified: Thu Apr 18 19:53:19 GMT 2024

- 29.6K bytes

- Viewed (0)

Search Options