Don - Code Search

fastapi/param_functions.py

        ),
    ] = None,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            To include (or not) this parameter field in the generated OpenAPI.
            You probably don't need it, but it's available.

            This affects the generated OpenAPI (e.g. visible at `/docs`).
            """
        ),
    ] = True,
    json_schema_extra: Annotated[

Python

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

- Last Modified: Thu Apr 18 19:40:57 GMT 2024

- 62.5K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/dependencies/tutorial008d.py

from fastapi import Depends, FastAPI, HTTPException

app = FastAPI()


class InternalError(Exception):
    pass


def get_username():
    try:
        yield "Rick"
    except InternalError:
        print("We don't swallow the internal error here, we raise again 😎")
        raise


@app.get("/items/{item_id}")
def get_item(item_id: str, username: str = Depends(get_username)):
    if item_id == "portal-gun":

Python

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

- Last Modified: Sat Feb 24 23:06:37 GMT 2024

- 694 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/dependencies/tutorial008d_an.py

from typing_extensions import Annotated

app = FastAPI()


class InternalError(Exception):
    pass


def get_username():
    try:
        yield "Rick"
    except InternalError:
        print("We don't swallow the internal error here, we raise again 😎")
        raise


@app.get("/items/{item_id}")
def get_item(item_id: str, username: Annotated[str, Depends(get_username)]):
    if item_id == "portal-gun":

Python

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

- Last Modified: Sat Feb 24 23:06:37 GMT 2024

- 744 bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/dependencies/tutorial008d_an_py39.py

app = FastAPI()


class InternalError(Exception):
    pass


def get_username():
    try:
        yield "Rick"
    except InternalError:
        print("We don't swallow the internal error here, we raise again 😎")
        raise


@app.get("/items/{item_id}")
def get_item(item_id: str, username: Annotated[str, Depends(get_username)]):
    if item_id == "portal-gun":

Python

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

- Last Modified: Sat Feb 24 23:06:37 GMT 2024

- 734 bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_handling_errors/test_tutorial006.py

            ]
        }
    )


def test_get_http_error():
    response = client.get("/items/3")
    assert response.status_code == 418, response.text
    assert response.json() == {"detail": "Nope! I don't like 3."}


def test_get():
    response = client.get("/items/2")
    assert response.status_code == 200, response.text
    assert response.json() == {"item_id": 2}


def test_openapi_schema():

Python

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Thu Apr 18 19:40:57 GMT 2024

- 4K bytes

- Viewed (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_handling_errors/test_tutorial004.py

        in response.text
    )


def test_get_http_error():
    response = client.get("/items/3")
    assert response.status_code == 418, response.text
    assert response.content == b"Nope! I don't like 3."


def test_get():
    response = client.get("/items/2")
    assert response.status_code == 200, response.text
    assert response.json() == {"item_id": 2}


def test_openapi_schema():

Python

- Registered: Sun Apr 28 07:19:10 GMT 2024

- Last Modified: Fri Jul 07 17:12:13 GMT 2023

- 3.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

scripts/docs.py

        raise typer.Abort()
    typer.echo(f"Building docs for: {lang}")
    build_site_dist_path = build_site_path / lang
    if lang == "en":
        dist_path = site_path
        # Don't remove en dist_path as it might already contain other languages.
        # When running build_all(), that function already removes site_path.
        # All this is only relevant locally, on GitHub Actions all this is done through

Python

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

- Last Modified: Mon Jan 22 19:26:14 GMT 2024

- 10.9K bytes

- Viewed (1)

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

fastapi/applications.py

            ),
        ] = None,
        deprecated: Annotated[
            Optional[bool],
            Doc(
                """
                Mark all *path operations* as deprecated. You probably don't need it,
                but it's available.

                It will be added to the generated OpenAPI (e.g. visible at `/docs`).

                Read more about it in the

Python

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

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

- 172.2K bytes

- Viewed (0)

Search Options