snapshot

Snapshot testing utilities for FFmpeg DAG structures.

This module provides extensions for the syrupy snapshot testing library that enable serialization and testing of FFmpeg's Directed Acyclic Graph (DAG) structures. It helps in writing tests that verify the correct structure and behavior of filter graphs.

Classes:

Name	Description
DAGSnapshotExtenstion	A snapshot extension for serializing and testing FFmpeg DAG structures.

DAGSnapshotExtenstion

Bases: JSONSnapshotExtension

A snapshot extension for serializing and testing FFmpeg DAG structures.

This extension extends the JSON snapshot extension from syrupy to handle the special case of FFmpeg DAG nodes. It converts DAG nodes into a serializable form suitable for snapshot testing by wrapping them in a Stream object and converting to a dictionary.

This allows for robust testing of filter graph structures and ensures that changes to the graph structure are intentional and documented through snapshot testing.

Methods:

Name	Description
serialize	Serialize a DAG node for snapshot testing.

serialize

serialize(
    data: SerializableData,
    *,
    exclude: Optional[PropertyFilter] = None,
    include: Optional[PropertyFilter] = None,
    matcher: Optional[PropertyMatcher] = None
) -> SerializedData

Serialize a DAG node for snapshot testing.

This method converts a DAG node into a serializable format by wrapping it in a Stream object and then converting that to a dictionary. This approach ensures that all relevant properties of the node are captured in the snapshot.

Parameters:

Name	Type	Description	Default
data	SerializableData	The DAG node to serialize	required
exclude	Optional[PropertyFilter]	Optional filter specifying properties to exclude	None
include	Optional[PropertyFilter]	Optional filter specifying properties to include	None
matcher	Optional[PropertyMatcher]	Optional property matcher	None

Returns:

Type	Description
SerializedData	The serialized representation of the DAG node