Skip to content

proxystore.store.utils

proxystore/store/utils.py

Store utilities.

ConnectorKeyT module-attribute 

ConnectorKeyT = Tuple[Any, ...]

Connector key type alias.

get_key() 

get_key(proxy: Proxy[T]) -> ConnectorKeyT

Extract the key from the proxy's factory.

Parameters:

  • proxy (Proxy[T]) –

    Proxy instance to get key from.

Returns:

Raises:

Source code in proxystore/store/utils.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def get_key(proxy: Proxy[T]) -> ConnectorKeyT:
    """Extract the key from the proxy's factory.

    Args:
        proxy: Proxy instance to get key from.

    Returns:
        The key, a NamedTuple unique to the \
        [`Store`][proxystore.store.base.Store] that created the proxy..

    Raises:
        ProxyStoreFactoryError: If the proxy's factory is not an instance of
            [`StoreFactory`][proxystore.store.base.StoreFactory].
    """
    factory = get_factory(proxy)
    if isinstance(factory, base.StoreFactory):
        return factory.key
    else:
        raise ProxyStoreFactoryError(
            'The proxy must contain a factory with type '
            f'{base.StoreFactory.__name__}. {type(factory).__name__} '
            'is not supported.',
        )

resolve_async() 

resolve_async(proxy: Proxy[T]) -> None

Begin resolving proxy asynchronously.

Useful if the user knows a proxy will be needed soon and wants to resolve the proxy concurrently with other computation.

from proxystore.store.utils import resolve_async

resolve_async(my_proxy)
computation_without_proxy(...)
# p is hopefully resolved
computation_with_proxy(my_proxy, ...)
Note

The asynchronous resolving functionality is implemented by StoreFactory. Factories that are not of this type will error when used with this function.

Parameters:

  • proxy (Proxy[T]) –

    Proxy instance to begin asynchronously resolving.

Raises:

Source code in proxystore/store/utils.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def resolve_async(proxy: Proxy[T]) -> None:
    """Begin resolving proxy asynchronously.

    Useful if the user knows a proxy will be needed soon and wants to
    resolve the proxy concurrently with other computation.

    ```python
    from proxystore.store.utils import resolve_async

    resolve_async(my_proxy)
    computation_without_proxy(...)
    # p is hopefully resolved
    computation_with_proxy(my_proxy, ...)
    ```

    Note:
        The asynchronous resolving functionality is implemented
        by [`StoreFactory`][proxystore.store.base.StoreFactory]. Factories that
        are not of this type will error when used with this function.

    Args:
        proxy: Proxy instance to begin asynchronously resolving.

    Raises:
        ProxyStoreFactoryError: If the proxy's factory is not an instance of
            [`StoreFactory`][proxystore.store.base.StoreFactory].
    """
    factory = get_factory(proxy)
    if isinstance(factory, base.StoreFactory):
        if not is_resolved(proxy):
            factory.resolve_async()
    else:
        raise ProxyStoreFactoryError(
            'The proxy must contain a factory with type '
            f'{base.StoreFactory.__name__}. {type(factory).__name__} '
            'is not supported.',
        )