Merge pull request #33 from mCallesen/5-add-list-imports-function

Added python_package_imports functioN

d8s_python/python_data.py

@@ -1,7 +1,10 @@
 import argparse
 import re
 import sys
-from typing import Any, Iterator, List, Union
+from ast import Import, ImportFrom
+from typing import Any, Dict, Iterator, List, Union
+
+from .ast_data import python_ast_objects_of_type
 
 
 # @decorators.map_firstp_arg
@@ -359,3 +362,44 @@ def python_type_name(python_type: type) -> str:
 def python_object_type_to_word(python_object: Any) -> str:
     """Convert the given python type to a string."""
     return python_type_name(type(python_object))
+
+
+def _get_importfrom_module_name(node: ImportFrom) -> str:
+    """Extract the module name from an ast.ImportFrom node.
+
+    The module name on the ast.ImportFrom node can be None for relative imports
+    In this case, this function will return the name as the dots from the import statement.
+    A few examples:
+    "from requests import get" -> "requests"
+    "from . import *" -> "."
+    "from .. import *" -> ".."
+    "from .foo import bar" -> "foo"
+    """
+    if node.module is None:
+        module_name = "." * node.level
+    else:
+        module_name = node.module
+
+    return module_name
+
+
+def python_package_imports(code: str) -> Dict[str, List[str]]:
+    """Return a dictionary containing the names of all imported modules."""
+    # Start with the Import nodes.
+    # These will always have an empty list of submodules
+    # so we can just overwrite them without losing any data
+    modules = dict()
+    nodes = python_ast_objects_of_type(code, Import)
+    for node in nodes:
+        for alias in node.names:
+            modules[alias.name] = []
+
+    # Now for the ImportFrom nodes
+    importfrom_nodes = python_ast_objects_of_type(code, ImportFrom)
+    for node in importfrom_nodes:
+        module_name = _get_importfrom_module_name(node)
+
+        for alias in node.names:
+            modules.setdefault(module_name, []).append(alias.name)
+
+    return modules

tests/test_python_data.py

@@ -28,6 +28,7 @@
     python_object_source_code,
     python_object_source_file,
     python_object_type_to_word,
+    python_package_imports,
     python_sort_type_list_by_name,
     python_stack_local_data,
     python_todos,
@@ -482,3 +483,34 @@ def test_python_function_blocks__async_functions():
         'def foo(n):\n    """Foo."""\n    return n',
         'async def bar(n):\n    """Some async func."""\n    return n',
     ]
+
+
+def test_python_package_imports():
+    s = ''
+    assert python_package_imports(s) == {}
+
+    s = '''import requests'''
+    assert python_package_imports(s) == {'requests': []}
+
+    s = '''from math import sqrt'''
+    assert python_package_imports(s) == {'math': ['sqrt']}
+
+    s = '''
+import os as _
+import sys,random'''
+    assert python_package_imports(s) == {'os': [], 'sys': [], 'random': []}
+
+    s = '''
+from democritus_dates import date_parse, date_now
+import requests
+
+print(date_parse('2 days from now'))
+    '''
+    assert python_package_imports(s) == {'democritus_dates': ['date_parse', 'date_now'], 'requests': []}
+
+    s = '''
+from . import everything
+from ..foo.bar import *
+    '''
+
+    assert python_package_imports(s) == {'.': ['everything'], 'foo.bar': ['*']}