Skip to content

pandas

Classes:

Attributes:

arrow_dataframe_serializer module-attribute

arrow_dataframe_serializer = ArrowDataFrameSerializer()

ArrowDataFrameSerializer with default settings.

arrow_dataframe_stream_serializer module-attribute

arrow_dataframe_stream_serializer = (
    ArrowDataFrameStreamSerializer()
)

ArrowDataFrameStreamSerializer with default settings.

parquet_dataframe_serializer module-attribute

parquet_dataframe_serializer = ParquetDataFrameSerializer()

ParquetDataFrameSerializer with default settings.

parquet_dataframe_stream_serializer module-attribute

parquet_dataframe_stream_serializer = (
    ParquetDataFrameStreamSerializer()
)

ParquetDataFrameStreamSerializer with default settings.

ArrowDataFrameSerializer

ArrowDataFrameSerializer(
    write_options: IpcReadOptions | None = None,
    read_options: IpcReadOptions | None = None,
)

Bases: Serializer[DataFrame]

Serializer for Pandas DataFrames using Arrow.

Methods:

Attributes:

content_types class-attribute instance-attribute

content_types: tuple[str, ...] = ()

The content types that the serializer uses.

Used to get serializers by content type in the registry.

deserialize_config

deserialize_config(config: str) -> C

Deserialize the configuration from a JSON string.

deserialize_data

deserialize_data(content: SerializedData) -> DataFrame

Deserialize the given DataFrame.

serialize_config

serialize_config(config: C) -> str

Serialize the configuration to a JSON string.

serialize_data

serialize_data(value: DataFrame) -> SerializedData

Serialize the given DataFrame.

ArrowDataFrameStreamSerializer

ArrowDataFrameStreamSerializer(
    write_options: IpcReadOptions | None = None,
    read_options: IpcReadOptions | None = None,
)

Bases: StreamSerializer[DataFrame]

Serializer for Pandas DataFrames using Arrow in a streaming manner.

Methods:

Attributes:

content_types class-attribute instance-attribute

content_types: tuple[str, ...] = ()

The content types that the serializer uses.

Used to get serializers by content type in the registry.

deserialize_config

deserialize_config(config: str) -> C

Deserialize the configuration from a JSON string.

deserialize_data_stream

deserialize_data_stream(
    content: SerializedDataStream,
) -> AsyncGenerator[DataFrame]

Deserialize the given DataFrame stream.

serialize_config

serialize_config(config: C) -> str

Serialize the configuration to a JSON string.

serialize_data_stream

serialize_data_stream(
    stream: AsyncIterable[DataFrame],
) -> SerializedDataStream

Serialize the given DataFrame stream.

ParquetDataFrameSerializer

ParquetDataFrameSerializer(
    *,
    write_options: ParquetWriteOptions | None = None,
    read_options: ParquetReadOptions | None = None
)

Bases: Serializer[DataFrame]

Serializer for Pandas DataFrames using Parquet.

Methods:

Attributes:

content_types class-attribute instance-attribute

content_types: tuple[str, ...] = ()

The content types that the serializer uses.

Used to get serializers by content type in the registry.

deserialize_config

deserialize_config(config: str) -> C

Deserialize the configuration from a JSON string.

deserialize_data

deserialize_data(content: SerializedData) -> DataFrame

Deserialize the given DataFrame.

serialize_config

serialize_config(config: C) -> str

Serialize the configuration to a JSON string.

serialize_data

serialize_data(value: DataFrame) -> SerializedData

Serialize the given DataFrame.

ParquetDataFrameStreamSerializer

ParquetDataFrameStreamSerializer(
    *,
    write_options: ParquetWriteOptions | None = None,
    read_options: ParquetReadOptions | None = None
)

Bases: StreamSerializer[DataFrame]

Serializer for Pandas DataFrames using Parquet in a streaming manner.

Methods:

Attributes:

content_types class-attribute instance-attribute

content_types: tuple[str, ...] = ()

The content types that the serializer uses.

Used to get serializers by content type in the registry.

deserialize_config

deserialize_config(config: str) -> C

Deserialize the configuration from a JSON string.

deserialize_data_stream

deserialize_data_stream(
    content: SerializedDataStream,
) -> AsyncGenerator[DataFrame]

Deserialize the given DataFrame stream.

serialize_config

serialize_config(config: C) -> str

Serialize the configuration to a JSON string.

serialize_data_stream

serialize_data_stream(
    stream: AsyncIterable[DataFrame],
) -> SerializedDataStream

Serialize the given DataFrame stream.

ParquetReadOptions

Bases: TypedDict

Constructor arguments for ParquetFile.

ParquetWriteOptions

Bases: TypedDict

Constructor arguments for ParquetWriter.