Skip to content

Hudl Sportscode

kloppy.sportscode

Functions for loading and saving Hudl SportsCode XML files.

load 

1
load(data)

Load SportsCode data.

PARAMETER DESCRIPTION
data

The raw SportsCode XML data.

TYPE: FileLike

RETURNS DESCRIPTION
CodeDataset

The parsed SportsCode data.
Source code in kloppy/_providers/sportscode.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def load(data: FileLike) -> CodeDataset:
    """
    Load SportsCode data.

    Args:
        data: The raw SportsCode XML data.

    Returns:
        The parsed SportsCode data.
    """
    deserializer = SportsCodeDeserializer()

    with open_as_file(data) as data_fp:
        return deserializer.deserialize(inputs=SportsCodeInputs(data=data_fp))

save 

1
save(dataset, output_filename)

Save SportsCode data to an XML file.

PARAMETER DESCRIPTION
dataset

The SportsCode dataset to save.

TYPE: CodeDataset

output_filename

The output filename.

TYPE: str

Source code in kloppy/_providers/sportscode.py 
27
28
29
30
31
32
33
34
35
36
37
def save(dataset: CodeDataset, output_filename: str) -> None:
    """
    Save SportsCode data to an XML file.

    Args:
        dataset: The SportsCode dataset to save.
        output_filename: The output filename.
    """
    with open_as_file(output_filename, "wb") as data_fp:
        serializer = SportsCodeSerializer()
        serializer.serialize(dataset, outputs=SportsCodeOutputs(data=data_fp))