Module: utils.module_paths

Utility functions for finding modules

Utility functions for finding modules on sys.path.

1 Function

IPython.utils.module_paths.find_mod(module_name: str) str | None | Loader

Find module module_name on sys.path, and return the path to module module_name.

  • If module_name refers to a module directory, then return path to __init__ file.
    • If module_name is a directory without an __init__file, return None.

  • If module is missing or does not have a .py or .pyw extension, return None.
    • Note that we are not interested in running bytecode.

  • Otherwise, return the fill path of the module.

Parameters:

module_name (str)

Returns:

module_path – Path to module module_name, its __init__.py, or None, depending on above conditions.

Return type:

str