fastapi Architecture Docs
Home / File/ test_security_oauth2_password_bearer_optional_description.py — fastapi Source File

test_security_oauth2_password_bearer_optional_description.py — fastapi Source File

Architecture documentation for test_security_oauth2_password_bearer_optional_description.py, a python file in the fastapi codebase. 5 imports, 0 dependents.

File python FastAPI Applications 5 imports 5 functions

Entity Profile

Dependency Diagram

graph LR
  4ecec10b_1186_7900_ddaa_cf1af07dedce["test_security_oauth2_password_bearer_optional_description.py"]
  0dda2280_3359_8460_301c_e98c77e78185["typing"]
  4ecec10b_1186_7900_ddaa_cf1af07dedce --> 0dda2280_3359_8460_301c_e98c77e78185
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  4ecec10b_1186_7900_ddaa_cf1af07dedce --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  35c4ea20_c454_5afd_6cda_f0818bbcc650["__init__.py"]
  4ecec10b_1186_7900_ddaa_cf1af07dedce --> 35c4ea20_c454_5afd_6cda_f0818bbcc650
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  4ecec10b_1186_7900_ddaa_cf1af07dedce --> a7c04dee_ee23_5891_b185_47ff6bed036d
  a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"]
  4ecec10b_1186_7900_ddaa_cf1af07dedce --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a
  style 4ecec10b_1186_7900_ddaa_cf1af07dedce fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from typing import Optional

from fastapi import FastAPI, Security
from fastapi.security import OAuth2PasswordBearer
from fastapi.testclient import TestClient
from inline_snapshot import snapshot

app = FastAPI()

oauth2_scheme = OAuth2PasswordBearer(
    tokenUrl="/token",
    description="OAuth2PasswordBearer security scheme",
    auto_error=False,
)


@app.get("/items/")
async def read_items(token: Optional[str] = Security(oauth2_scheme)):
    if token is None:
        return {"msg": "Create an account first"}
    return {"token": token}


client = TestClient(app)


def test_no_token():
    response = client.get("/items")
    assert response.status_code == 200, response.text
    assert response.json() == {"msg": "Create an account first"}


def test_token():
    response = client.get("/items", headers={"Authorization": "Bearer testtoken"})
    assert response.status_code == 200, response.text
    assert response.json() == {"token": "testtoken"}


def test_incorrect_token():
    response = client.get("/items", headers={"Authorization": "Notexistent testtoken"})
    assert response.status_code == 200, response.text
    assert response.json() == {"msg": "Create an account first"}


def test_openapi_schema():
    response = client.get("/openapi.json")
    assert response.status_code == 200, response.text
    assert response.json() == snapshot(
        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/items/": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "summary": "Read Items",
                        "operationId": "read_items_items__get",
                        "security": [{"OAuth2PasswordBearer": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "OAuth2PasswordBearer": {
                        "type": "oauth2",
                        "flows": {"password": {"scopes": {}, "tokenUrl": "/token"}},
                        "description": "OAuth2PasswordBearer security scheme",
                    }
                }
            },
        }
    )

Domain

Subdomains

Functions

Dependencies

Source

Frequently Asked Questions

What does test_security_oauth2_password_bearer_optional_description.py do?
test_security_oauth2_password_bearer_optional_description.py is a source file in the fastapi codebase, written in python. It belongs to the FastAPI domain, Applications subdomain.
What functions are defined in test_security_oauth2_password_bearer_optional_description.py?
test_security_oauth2_password_bearer_optional_description.py defines 5 function(s): read_items, test_incorrect_token, test_no_token, test_openapi_schema, test_token.
What does test_security_oauth2_password_bearer_optional_description.py depend on?
test_security_oauth2_password_bearer_optional_description.py imports 5 module(s): __init__.py, __init__.py, inline_snapshot, testclient.py, typing.
Where is test_security_oauth2_password_bearer_optional_description.py in the architecture?
test_security_oauth2_password_bearer_optional_description.py is located at tests/test_security_oauth2_password_bearer_optional_description.py (domain: FastAPI, subdomain: Applications, directory: tests).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free