Skip to content

proxystore.utils.config

proxystore/utils/config.py

Read and write TOML config files using Pydantic BaseClasses.

dump() 

dump(
    model: BaseModel,
    fp: BinaryIO,
    *,
    exclude_none: bool = True
) -> None

Serialize data class as a TOML formatted stream to file-like object.

Parameters:

  • model (BaseModel) –

    Config model instance to write.

  • fp (BinaryIO) –

    File-like bytes stream to write to.

  • exclude_none (bool, default: True ) –

    Skip writing none attributes.

Source code in proxystore/utils/config.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def dump(
    model: BaseModel,
    fp: BinaryIO,
    *,
    exclude_none: bool = True,
) -> None:
    """Serialize data class as a TOML formatted stream to file-like object.

    Args:
        model: Config model instance to write.
        fp: File-like bytes stream to write to.
        exclude_none: Skip writing none attributes.
    """
    if pydantic_v2:
        data_dict = model.model_dump(exclude_none=exclude_none)
    else:  # pragma: no cover
        data_dict = model.dict(exclude_none=exclude_none)
    tomli_w.dump(data_dict, fp)

dumps() 

dumps(
    model: BaseModel, *, exclude_none: bool = True
) -> str

Serialize data class to a TOML formatted string.

Parameters:

  • model (BaseModel) –

    Config model instance to write.

  • exclude_none (bool, default: True ) –

    Skip writing none attributes.

Returns:

  • str –

    TOML string of data class.

Source code in proxystore/utils/config.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def dumps(model: BaseModel, *, exclude_none: bool = True) -> str:
    """Serialize data class to a TOML formatted string.

    Args:
        model: Config model instance to write.
        exclude_none: Skip writing none attributes.

    Returns:
        TOML string of data class.
    """
    if pydantic_v2:
        data_dict = model.model_dump(exclude_none=exclude_none)
    else:  # pragma: no cover
        data_dict = model.dict(exclude_none=exclude_none)
    return tomli_w.dumps(data_dict)

load() 

load(model: type[BaseModelT], fp: BinaryIO) -> BaseModelT

Parse TOML from a binary file to a data class.

Parameters:

  • model (type[BaseModelT]) –

    Config model type to parse TOML using.

  • fp (BinaryIO) –

    File-like bytes stream to read in.

Returns:

  • BaseModelT –

    Model initialized from TOML file.

Source code in proxystore/utils/config.py 
73
74
75
76
77
78
79
80
81
82
83
def load(model: type[BaseModelT], fp: BinaryIO) -> BaseModelT:
    """Parse TOML from a binary file to a data class.

    Args:
        model: Config model type to parse TOML using.
        fp: File-like bytes stream to read in.

    Returns:
        Model initialized from TOML file.
    """
    return loads(model, fp.read().decode())

loads() 

loads(model: type[BaseModelT], data: str) -> BaseModelT

Parse TOML string to data class.

Parameters:

  • model (type[BaseModelT]) –

    Config model type to parse TOML using.

  • data (str) –

    TOML string to parse.

Returns:

  • BaseModelT –

    Model initialized from TOML file.

Source code in proxystore/utils/config.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def loads(model: type[BaseModelT], data: str) -> BaseModelT:
    """Parse TOML string to data class.

    Args:
        model: Config model type to parse TOML using.
        data: TOML string to parse.

    Returns:
        Model initialized from TOML file.
    """
    data = tomllib.loads(data)
    if pydantic_v2:
        return model.model_validate(data, strict=True)
    else:  # pragma: no cover
        return model.parse_obj(data)