Skip to content

Status

plateforme.core.api.status

This module provides utilities for managing status codes within the Plateforme framework's API using FastAPI and Starlette features.

StatusClass module-attribute 

StatusClass = Literal[
    "HTTP_1", "HTTP_2", "HTTP_3", "HTTP_4", "HTTP_5", "WS_1"
]

A literal type representing the classes of status codes.

get_status_class 

get_status_class(status_code: int) -> StatusClass | None

Get the status code class for a given status code.

Source code in .venv/lib/python3.12/site-packages/plateforme/core/api/status.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def get_status_class(status_code: int) -> StatusClass | None:
    """Get the status code class for a given status code."""

    if 100 <= status_code < 200:
        return 'HTTP_1'
    elif 200 <= status_code < 300:
        return 'HTTP_2'
    elif 300 <= status_code < 400:
        return 'HTTP_3'
    elif 400 <= status_code < 500:
        return 'HTTP_4'
    elif 500 <= status_code < 600:
        return 'HTTP_5'
    elif 1000 <= status_code < 1100:
        return 'WS_1'

    return None