Skip to content

BaseApplicationSchema

faststream.specification.base.schema.BaseApplicationSchema #

Bases: BaseModel

A class to represent a Pydantic-serializable application schema.

METHOD DESCRIPTION
to_jsonable

Convert the schema to a JSON-serializable object.
to_json

Convert the schema to a JSON string.
to_yaml

Convert the schema to a YAML string.

info instance-attribute #

info: BaseApplicationInfo

title property #

title: str

to_jsonable #

to_jsonable() -> Any

Convert the schema to a JSON-serializable object.

Source code in faststream/specification/base/schema.py 
28
29
30
31
32
33
34
def to_jsonable(self) -> Any:
    """Convert the schema to a JSON-serializable object."""
    return model_to_jsonable(
        self,
        by_alias=True,
        exclude_none=True,
    )

to_json #

to_json() -> str

Convert the schema to a JSON string.

Source code in faststream/specification/base/schema.py 
36
37
38
39
40
41
42
def to_json(self) -> str:
    """Convert the schema to a JSON string."""
    return model_to_json(
        self,
        by_alias=True,
        exclude_none=True,
    )

to_yaml #

to_yaml() -> str

Convert the schema to a YAML string.

Source code in faststream/specification/base/schema.py 
44
45
46
47
48
49
50
51
52
def to_yaml(self) -> str:
    """Convert the schema to a YAML string."""
    from io import StringIO

    import yaml

    io = StringIO(initial_value="", newline="\n")
    yaml.dump(self.to_jsonable(), io, sort_keys=False)
    return io.getvalue()