Skip to content

import_object

faststream.cli.utils.imports.import_object #

import_object(module: Path, app: str) -> object

Import an object from a module.

PARAMETER DESCRIPTION
module

The path to the module file.

TYPE: Path

app

The name of the object to import.

TYPE: str

RETURNS DESCRIPTION
object

The imported object.
RAISES DESCRIPTION
FileNotFoundError

If the module file is not found.
ValueError

If the module has no loader.
AttributeError

If the object is not found in the module.
Source code in faststream/cli/utils/imports.py 
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
66
67
68
69
70
71
72
73
74
75
76
77
def import_object(module: Path, app: str) -> object:
    """Import an object from a module.

    Args:
        module: The path to the module file.
        app: The name of the object to import.

    Returns:
        The imported object.

    Raises:
        FileNotFoundError: If the module file is not found.
        ValueError: If the module has no loader.
        AttributeError: If the object is not found in the module.

    """
    spec = spec_from_file_location(
        "mode",
        f"{module}.py",
        submodule_search_locations=[str(module.parent.absolute())],
    )

    if spec is None:  # pragma: no cover
        raise FileNotFoundError(module)

    mod = module_from_spec(spec)
    loader = spec.loader

    if loader is None:  # pragma: no cover
        raise ValueError(f"{spec} has no loader")

    loader.exec_module(mod)

    try:
        obj = getattr(mod, app)
    except AttributeError as e:
        raise FileNotFoundError(module) from e

    return obj