Skip to content

proxystore.store.local

proxystore/store/local.py

LocalStore Implementation.

LocalStore 

LocalStore(
    name: str,
    store_dict: dict[LocalKey, bytes] | None = None,
    *,
    serializer: SerializerT | None = None,
    deserializer: DeserializerT | None = None,
    cache_size: int = 16,
    metrics: bool = False
) -> None

Bases: Store[LocalConnector]

Store wrapper for local in-process storage.

Warning

This wrapper exists for backwards compatibility with ProxyStore <=0.4.* and will be deprecated in version 0.6.0.

Parameters:

  • name (str) –

    Name of the store instance.

  • store_dict (dict[LocalKey, bytes] | None) –

    Dictionary to store data in. If not specified, a new empty dict will be generated.

  • serializer (SerializerT | None) –

    Optional callable which serializes the object. If None, the default serializer (serialize()) will be used.

  • deserializer (DeserializerT | None) –

    Optional callable used by the factory to deserialize the byte string. If None, the default deserializer (deserialize()) will be used.

  • cache_size (int) –

    Size of LRU cache (in # of objects). If 0, the cache is disabled. The cache is local to the Python process.

  • metrics (bool) –

    Enable recording operation metrics.

Source code in proxystore/store/local.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def __init__(
    self,
    name: str,
    store_dict: dict[LocalKey, bytes] | None = None,
    *,
    serializer: SerializerT | None = None,
    deserializer: DeserializerT | None = None,
    cache_size: int = 16,
    metrics: bool = False,
) -> None:
    warnings.warn(
        'The LocalStore will be deprecated in v0.6.0. Initializing a '
        'Store with a Connector is preferred. See '
        'https://github.com/proxystore/proxystore/issues/214 for details.',
        DeprecationWarning,
        stacklevel=2,
    )
    connector = LocalConnector(store_dict)
    super().__init__(
        name,
        connector,
        serializer=serializer,
        deserializer=deserializer,
        cache_size=cache_size,
        metrics=metrics,
    )