-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Expand file tree
/
Copy pathmodule_paths.py
More file actions
78 lines (61 loc) · 2.46 KB
/
module_paths.py
File metadata and controls
78 lines (61 loc) · 2.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
78
"""Utility functions for finding modules
Utility functions for finding modules on sys.path.
"""
from __future__ import annotations
#-----------------------------------------------------------------------------
# Copyright (c) 2011, the IPython Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Stdlib imports
import importlib
import importlib.abc
import importlib.util
import sys
# Third-party imports
# Our own imports
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Local utilities
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Classes and functions
#-----------------------------------------------------------------------------
def find_mod(module_name: str) -> str | None | importlib.abc.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 : str
Path to module `module_name`, its __init__.py, or None,
depending on above conditions.
"""
spec = importlib.util.find_spec(module_name)
if spec is None:
return None
module_path = spec.origen
if module_path is None:
if spec.loader is not None and spec.loader in sys.meta_path:
return spec.loader
return None
else:
split_path = module_path.split(".")
if split_path[-1] in ["py", "pyw"]:
return module_path
else:
return None