Skip to content

serialization

Serialization utilities for BWD objects.

deserialize(json_str)

Deserialize a balancer object from JSON string

Reconstructs a balancer object from its serialized JSON representation, restoring both its definition and state.

Parameters:

Name Type Description Default
json_str str

JSON string containing the serialized balancer

 required

Returns:

Type Description
BWD, BWDRandom, MultiBWD, or Online

The deserialized balancer object with restored state
Source code in src/bwd/serialization.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def deserialize(json_str):
    """Deserialize a balancer object from JSON string

    Reconstructs a balancer object from its serialized JSON representation,
    restoring both its definition and state.

    Parameters
    ----------
    json_str : str
        JSON string containing the serialized balancer

    Returns
    -------
    BWD, BWDRandom, MultiBWD, or Online
        The deserialized balancer object with restored state
    """
    defs = json.loads(json_str)
    cls_name = list(defs.keys())[0]
    defs = defs[cls_name]

    bal_object = name2class[cls_name](**defs["definition"])
    bal_object.update_state(**defs["state"])
    return bal_object

normalize(to_serialize)

Normalize data structures for JSON serialization

Recursively converts numpy arrays to lists and normalizes nested dictionaries to ensure all data types are JSON-serializable.

Parameters:

Name Type Description Default
to_serialize dict

Dictionary containing data to normalize

 required

Returns:

Type Description
dict

Normalized dictionary with JSON-compatible types
Source code in src/bwd/serialization.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def normalize(to_serialize):
    """Normalize data structures for JSON serialization

    Recursively converts numpy arrays to lists and normalizes nested dictionaries
    to ensure all data types are JSON-serializable.

    Parameters
    ----------
    to_serialize : dict
        Dictionary containing data to normalize

    Returns
    -------
    dict
        Normalized dictionary with JSON-compatible types
    """
    result = {}
    for k, v in to_serialize.items():
        if isinstance(v, np.ndarray):
            v = v.tolist()
        if isinstance(v, dict):
            v = normalize(v)
        result[k] = v
    return result

serialize(obj)

Serialize a balancer object to JSON string

Serializes the balancer's definition and state to a JSON-formatted string that can be saved and later deserialized.

Parameters:

Name Type Description Default
obj BWD, BWDRandom, MultiBWD, or Online

The balancer object to serialize

 required

Returns:

Type Description
str

JSON string representation of the object
Source code in src/bwd/serialization.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def serialize(obj):
    """Serialize a balancer object to JSON string

    Serializes the balancer's definition and state to a JSON-formatted string
    that can be saved and later deserialized.

    Parameters
    ----------
    obj : BWD, BWDRandom, MultiBWD, or Online
        The balancer object to serialize

    Returns
    -------
    str
        JSON string representation of the object
    """
    return json.dumps(
        {
            str(type(obj).__name__): {
                "definition": normalize(obj.definition),
                "state": normalize(obj.state),
            }
        }
    )