Source code for cookiecutter_python.utils

from os import path
import sys
from typing import List, Optional, Type, TypeVar
from inspect import isclass
from pkgutil import iter_modules
from importlib import import_module


T = TypeVar('T')


def load(interface: Type[T], module: Optional[str] = None) -> List[Type[T]]:
    """Dynamically import all class objects that implement the given interface.

    The classes (class objects) are discovered and imported in the namespace, by
    searching within each module found inside the input 'dire' (path) directory.

    Each class object is an attribute found in a module's namespace.
    We classify an attribute as a (correct) "class to import", if the following
    python boolean expression evaluates to True:

    isclass(attribute) and issubclass(attribute, interface)

    If 'dire' is not given then we consider the modules that are inside the same
    directory as the one where the module of the invoking code resides.

    Args:
        interface (Type[T]): the type (ie class) that the imported classes
            should 'inherit' (subclass) from
        module (str): module containing the modules to inspect. Defaults to the
            same module (directory) as the one where the module of the invoking
            code resides.
    """
    project_package_location = path.dirname(
        path.realpath(path.dirname(path.realpath(__file__))))
    if module is None:  # set path as the dir where the invoking code is
        namespace = sys._getframe(1).f_globals  # caller's globals
        directory: str = path.dirname(path.realpath(namespace['__file__']))
        relative_path = path.relpath(directory, start=project_package_location)
        _module = relative_path.replace('\\', '/').replace('/', '.')
    else:
        directory = str(module).replace('/', '.')
        # find the distro path as installed at runtime
        module_object = import_module(directory)
        # if top-level init is at '/site-packages/some_python_package/__init__.py'
        # then distro_path is '/site-packages/some_python_package'
        from pathlib import Path
        distro_path: Path = Path(str(module_object.__file__)).parent
        directory = str(distro_path) 
        _module = module

    objects = []
    # iterate through the modules inside the directory
    for (_, module_name, _) in iter_modules([directory]):
        module_object = import_module('{package}.{module}'.format(
            package=_module,
            module=module_name
        ))

        for attribute_name in dir(module_object):
            attribute = getattr(module_object, attribute_name)

            if attribute != interface and isclass(attribute) and issubclass(attribute, interface):
                # Add the class to this package's variables
                globals()[attribute_name] = attribute
                objects.append(attribute)
    return objects