Skip to content

get

faststream.asgi.handlers.get #

get(
    func: UserApp,
    *,
    include_in_schema: bool = True,
    description: Optional[str] = None,
    tags: Optional[
        Sequence[Union[Tag, TagDict, AnyDict]]
    ] = None,
    unique_id: Optional[str] = None,
) -> ASGIApp

get(
    func: None = None,
    *,
    include_in_schema: bool = True,
    description: Optional[str] = None,
    tags: Optional[
        Sequence[Union[Tag, TagDict, AnyDict]]
    ] = None,
    unique_id: Optional[str] = None,
) -> Callable[[UserApp], ASGIApp]

get(
    func=None,
    *,
    include_in_schema=True,
    description=None,
    tags=None,
    unique_id=None,
)
Source code in faststream/asgi/handlers.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def get(
    func: Optional["UserApp"] = None,
    *,
    include_in_schema: bool = True,
    description: Optional[str] = None,
    tags: Optional[Sequence[Union["Tag", "TagDict", "AnyDict"]]] = None,
    unique_id: Optional[str] = None,
) -> Union[Callable[["UserApp"], "ASGIApp"], "ASGIApp"]:
    def decorator(inner_func: "UserApp") -> "ASGIApp":
        return GetHandler(
            inner_func,
            include_in_schema=include_in_schema,
            description=description,
            tags=tags,
            unique_id=unique_id,
        )

    if func is None:
        return decorator

    return decorator(func)