Source code for pyfileconf.io.file.load.active.userdef

import importlib.util
from importlib.abc import Loader
from types import ModuleType
import sys
from typing import Optional

from pyfileconf.exceptions.imports import CouldNotImportException
from pyfileconf.imports.models.statements.container import ImportStatementContainer

def get_user_defined_dict_from_filepath(filepath: str, module_name: str=None, remove_imports=False,
                                        imports: ImportStatementContainer=None) -> dict:
    module = _load_file_as_module(filepath, name=module_name)
    user_defined_dict = _get_user_defined_dict_from_module(module)
    if remove_imports:
        if imports is None:
            raise ValueError('must pass imports when passing remove_imports=True')
        return {
            key: value for key, value in user_defined_dict.items() \
            if imports.get_import_for_module_or_obj_name(key) is None
        }
    else:
        return user_defined_dict

def _get_user_defined_dict_from_module(module: ModuleType) -> dict:
    out_dict = {}
    for key, value in module.__dict__.items():
        if key.startswith('__') or isinstance(value, ModuleType):
            continue
        out_dict.update({key: value})

    return out_dict


def _load_file_as_module(filepath: str, name: Optional[str] = 'module.name') -> ModuleType:
    if name is None:
        name = 'module.name'
        add_to_sys = False
    else:
        add_to_sys = True

    spec = importlib.util.spec_from_file_location(name, filepath)
    module = importlib.util.module_from_spec(spec)
    if spec is None or spec.loader is None or not isinstance(spec.loader, Loader):
        raise CouldNotImportException(
            f'got no spec.loader after calling importlib.util.spec_from_file_location on {filepath}'
        )
    spec.loader.exec_module(module)

    if add_to_sys:
        sys.modules.update({name: module})

    return module