aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/ipython/py3/IPython/utils/module_paths.py
blob: 2184884335134e6ec4ee1c879b21eeafe7a918fc (plain) (blame)
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
"""Utility functions for finding modules 
 
Utility functions for finding modules on sys.path. 
 
`find_module` returns a path to module or None, given certain conditions. 
 
""" 
#----------------------------------------------------------------------------- 
# 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 os 
 
# Third-party imports 
 
# Our own imports 
 
 
#----------------------------------------------------------------------------- 
# Globals and constants 
#----------------------------------------------------------------------------- 
 
#----------------------------------------------------------------------------- 
# Local utilities 
#----------------------------------------------------------------------------- 
 
#----------------------------------------------------------------------------- 
# Classes and functions 
#----------------------------------------------------------------------------- 
 
def find_mod(module_name): 
    """ 
    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. 
    """ 
    loader = importlib.util.find_spec(module_name) 
    module_path = loader.origin 
    if module_path is None: 
        return None 
    else: 
        split_path = module_path.split(".") 
        if split_path[-1] in ["py", "pyw"]: 
            return module_path 
        else: 
            return None