BaseApplicationSchema

faststream.specification.base.schema.BaseApplicationSchema

Bases: BaseModel

A class to represent a Pydantic-serializable application schema.

ATTRIBUTE	DESCRIPTION
info	information about the 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

title property

title

to_jsonable

to_jsonable()

Convert the schema to a JSON-serializable object.

Source code in faststream/specification/base/schema.py

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()

Convert the schema to a JSON string.

Source code in faststream/specification/base/schema.py

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()

Convert the schema to a YAML string.

Source code in faststream/specification/base/schema.py

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()