DataFactory

kloppy.datafactory

Functions for loading DataFactory event data.

load

load(
    event_data,
    event_types=None,
    coordinates=None,
    event_factory=None,
)

Load DataFactory event data.

PARAMETER	DESCRIPTION
event_data	JSON feed with the raw event data of a game. TYPE: FileLike
event_types	A list of event types to load. TYPE: Optional[List[str]] DEFAULT: None
coordinates	The coordinate system to use. TYPE: Optional[str] DEFAULT: None
event_factory	A custom event factory. TYPE: Optional[EventFactory] DEFAULT: None

RETURNS	DESCRIPTION
EventDataset	The parsed event data.

Source code in kloppy/_providers/datafactory.py

def load(
    event_data: FileLike,
    event_types: Optional[List[str]] = None,
    coordinates: Optional[str] = None,
    event_factory: Optional[EventFactory] = None,
) -> EventDataset:
    """
    Load DataFactory event data.

    Args:
        event_data: JSON feed with the raw event data of a game.
        event_types: A list of event types to load.
        coordinates: The coordinate system to use.
        event_factory: A custom event factory.

    Returns:
        The parsed event data.
    """
    deserializer = DatafactoryDeserializer(
        event_types=event_types,
        coordinate_system=coordinates,
        event_factory=event_factory or get_config("event_factory"),
    )
    with open_as_file(event_data) as event_data_fp:
        return deserializer.deserialize(
            inputs=DatafactoryInputs(event_data=event_data_fp),
        )