Skip to content

proxystore.utils.imports

proxystore/utils/imports.py

Resolve imports by string paths.

get_class_path() 

get_class_path(cls: type[Any]) -> str

Get the fully qualified path of a type.

Example 
>>> from proxystore.connectors.protocols import Connector
>>> get_class_path(Connector)
'proxystore.connectors.protocols.Connector'

Parameters:

  • cls (type[Any]) –

    Class type to get fully qualified path of.

Returns:

  • str –

    Fully qualified path of cls.

Source code in proxystore/utils/imports.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
def get_class_path(cls: type[Any]) -> str:
    """Get the fully qualified path of a type.

    Example:
        ```python
        >>> from proxystore.connectors.protocols import Connector
        >>> get_class_path(Connector)
        'proxystore.connectors.protocols.Connector'
        ```

    Args:
        cls: Class type to get fully qualified path of.

    Returns:
        Fully qualified path of `cls`.
    """
    return f'{cls.__module__}.{cls.__qualname__}'

import_class() 

import_class(path: str) -> type[Any]

Import class via its fully qualified path.

Example 
>>> import_class('proxystore.connectors.protocols.Connector')
<class 'proxystore.connectors.protocols.Connector'>

Parameters:

  • path (str) –

    Fully qualified path of class to import.

Returns:

Raises:

Source code in proxystore/utils/imports.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def import_class(path: str) -> type[Any]:
    """Import class via its fully qualified path.

    Example:
        ```python
        >>> import_class('proxystore.connectors.protocols.Connector')
        <class 'proxystore.connectors.protocols.Connector'>
        ```

    Args:
        path: Fully qualified path of class to import.

    Returns:
        Imported class.

    Raises:
        ImportError: If a class at the `path` is not found.
    """
    module_path, _, name = path.rpartition('.')
    if len(module_path) == 0:
        raise ImportError(
            f'Class path must contain at least one module. Got {path}',
        )
    module = importlib.import_module(module_path)
    return getattr(module, name)