Skip to content

proxystore.utils.environment

Utilities related to the current execution environment.

Warning

This module is an internal implementation detail which may change between releases without notice (see Versioning and Compatibility).

home_dir 

home_dir() -> str

Return the absolute path to the proxystore home directory.

If set, $PROXYSTORE_HOME is preferred. Otherwise, $XDG_DATA_HOME/proxystore is returned where $XDG_DATA_HOME defaults to $HOME/.local/share if unset.

Source code in proxystore/utils/environment.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def home_dir() -> str:
    """Return the absolute path to the proxystore home directory.

    If set, `$PROXYSTORE_HOME` is preferred. Otherwise,
    `$XDG_DATA_HOME/proxystore` is returned where `$XDG_DATA_HOME` defaults
    to `$HOME/.local/share` if unset.
    """
    path = os.environ.get('PROXYSTORE_HOME')
    if path is None:
        prefix = os.environ.get('XDG_DATA_HOME') or os.path.expanduser(
            '~/.local/share',
        )
        path = os.path.join(prefix, 'proxystore')
    return os.path.abspath(path)

hostname 

hostname() -> str

Return current hostname.

Source code in proxystore/utils/environment.py 
31
32
33
def hostname() -> str:
    """Return current hostname."""
    return socket.gethostname()