Function decideRecursion

nuitka/importing/Recursion.py:159–224

Decide if we should recurse into a module. This function caches its results and handles the logic to decide if a module should be included in the compilation or not. It respects the user choices, plugins, and standard library rules. Args: using_module_name: The module name

(
    using_module_name, module_filename, module_name, module_kind, extra_recursion=False
)

def decideRecursion(
    using_module_name, module_filename, module_name, module_kind, extra_recursion=False
):
    """Decide if we should recurse into a module.

    This function caches its results and handles the logic to decide if a
    module should be included in the compilation or not. It respects the
    user choices, plugins, and standard library rules.

    Args:
        using_module_name: The module name that triggers this recursion.
        module_filename: The filename of the module.
        module_name: The name of the module.
        module_kind: The kind of the module.
        extra_recursion: If true, this is a forced recursion (e.g. plugin).

    Returns:
        A tuple (decision, reason) where decision is a boolean or None, and
        reason is a string explaining the decision.
    """
    package_part, _remainder = module_name.splitModuleBasename()

    if package_part is not None and package_part.getTopLevelPackageName() != "":
        (
            _package_part,
            package_filename,
            package_module_kind,
            package_finding,
        ) = locateModule(module_name=package_part, parent_package=None, level=0)
        assert _package_part == package_part, (_package_part, package_part)

        # For bad decisions, this may already not work.
        if package_finding != "not-found":
            package_decision, package_reason = decideRecursion(
                using_module_name=using_module_name,
                module_filename=package_filename,
                module_name=package_part,
                module_kind=package_module_kind,
                extra_recursion=extra_recursion,
            )

            if package_decision is False:
                return package_decision, package_reason

    key = using_module_name, module_filename, module_name, module_kind, extra_recursion

    if key not in _recursion_decision_cache:
        _recursion_decision_cache[key] = _decideRecursion(
            using_module_name,
            module_filename,
            module_name,
            module_kind,
            extra_recursion,
        )

        # If decided true, give the plugins a chance to e.g. add more hard
        # module information, this indicates tentatively, that a module might
        # get used, but it may also not happen at all.