Skip to content

proxystore.store

Module containing all Store implementations.

Type Use Case
LocalStore In-memory object store local to the process. Useful for development.
RedisStore Store objects in a preconfigured Redis server.
FileStore Use a globally accessible file system for string objects.
GlobusStore Transfer objects between two Globus endpoints.
EndpointStore Experimental: P2P object stores for multi-site applications.
MargoStore Experimental: Distributed in-memory storage across nodes with Margo communication.
UCXStore Experimental: Distributed in-memory storage across nodes with UCX communication.
WebsocketStore Experimental: Distributed in-memory storage across nodes with Websocket communication.

get_store 

get_store(val: str | Proxy[T]) -> Store[Any] | None

Get the backend store with name.

Parameters:

  • val (str | Proxy[T]) –

    name of the store to get or a Proxy instance.

Returns:

  • Store[Any] | None –

    Store if a store matching the name or belonging to the proxy exists. If the store does not exist, returns None.

Raises:

Source code in proxystore/store/__init__.py 
32
33
34
35
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
62
63
64
65
def get_store(val: str | Proxy[T]) -> Store[Any] | None:
    """Get the backend store with name.

    Args:
        val: name of the store to get or a [`Proxy`][proxystore.proxy.Proxy]
            instance.

    Returns:
        [`Store`][proxystore.store.base.Store] if a store matching the \
        name or belonging to the proxy exists. If the store does not exist, \
        returns `None`.

    Raises:
        ProxyStoreFactoryError: If the value is a proxy but does not contain a
            factory of type
            [`StoreFactory`][proxystore.store.base.StoreFactory].
    """
    if isinstance(val, Proxy):
        # If the object is a proxy, get the factory that will access the store
        factory = val.__factory__
        if isinstance(factory, StoreFactory):
            return factory.get_store()
        else:
            raise ProxyStoreFactoryError(
                'The proxy must contain a factory with type '
                f'{type(StoreFactory).__name__}. {type(factory).__name__} '
                'is not supported.',
            )
    else:
        name = val

    if name in _stores:
        return _stores[name]
    return None

register_store 

register_store(
    store: Store[Any], exist_ok: bool = False
) -> None

Register the store instance to the global registry.

Note

Global means globally accessible within the Python process.

Parameters:

  • store (Store[Any]) –

    Store instance to register.

  • exist_ok (bool) –

    If a store with the same name exists, overwrite it.

Raises:

  • StoreExistsError –

    If a store with the same name is already registered and exist_ok is false.

Source code in proxystore/store/__init__.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def register_store(store: Store[Any], exist_ok: bool = False) -> None:
    """Register the store instance to the global registry.

    Note:
        Global means globally accessible within the Python process.

    Args:
        store: Store instance to register.
        exist_ok: If a store with the same name exists, overwrite it.

    Raises:
        StoreExistsError: If a store with the same name is already registered
            and `exist_ok` is false.
    """
    if store.name in _stores and not exist_ok:
        raise StoreExistsError(f'A store named {store.name} already exists.')

    _stores[store.name] = store
    logger.debug(f'added {store.name} to global registry of stores')

unregister_store 

unregister_store(name: str) -> None

Unregisters the store instance from the global registry.

Note

This function is a no-op if no store matching the name exists (i.e., no exception will be raised).

Parameters:

  • name (str) –

    Name of the store to unregister.

Source code in proxystore/store/__init__.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def unregister_store(name: str) -> None:
    """Unregisters the store instance from the global registry.

    Note:
        This function is a no-op if no store matching the name
        exists (i.e., no exception will be raised).

    Args:
        name: Name of the store to unregister.
    """
    if name in _stores:
        del _stores[name]
        logger.debug(f'removed {name} from global registry of stores')