Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schettino72/import-deps
find python module imports
https://github.com/schettino72/import-deps
ast dependency graph import python quality
Last synced: 2 months ago
JSON representation
find python module imports
- Host: GitHub
- URL: https://github.com/schettino72/import-deps
- Owner: schettino72
- License: mit
- Created: 2018-06-18T18:55:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-04T03:40:55.000Z (8 months ago)
- Last Synced: 2024-10-15T09:52:39.175Z (3 months ago)
- Topics: ast, dependency, graph, import, python, quality
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 17
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
Awesome Lists containing this project
README
# import_deps
[](https://pypi.org/project/import-deps/)
[](https://pypi.org/project/import-deps/)
[](https://github.com/schettino72/import-deps/actions/workflows/test.yml?query=branch%3Amaster)
Find python module's import dependencies.
`import_deps` is based on [ast module](https://docs.python.org/3/library/ast.html) from standard library,
so the modules being analysed are *not* executed.
## Install
```
pip install import_deps
```
## Usage
`import_deps` is designed to track only imports within a known set of package and modules.
Given a package with the modules:
- `foo/__init__.py`
- `foo/foo_a.py`
- `foo/foo_b.py`
- `foo/foo_c.py`
Where `foo_a.py` has the following imports:
```python3
from . import foo_b
from .foo_c import obj_c
```
## Usage (CLI)
```bash
> import_deps foo/foo_a.py
foo.foo_b
foo.foo_c
```
## Usage (lib)
```python3
import pathlib
from import_deps import ModuleSet
# First initialise a ModuleSet instance with a list str of modules to track
pkg_paths = pathlib.Path('foo').glob('**/*.py')
module_set = ModuleSet([str(p) for p in pkg_paths])
# then you can get the set of imports
for imported in module_set.mod_imports('foo.foo_a'):
print(imported)
# foo.foo_c
# foo.foo_b
```
### ModuleSet
You can get a list of all modules in a `ModuleSet` by path or module's full qualified name.
`by_path`
Note that key for `by_path` must be exactly the as provided on ModuleSet initialization.
```python3
for mod in sorted(module_set.by_path.keys()):
print(mod)
# results in:
# foo/__init__.py
# foo/foo_a.py
# foo/foo_b.py
# foo/foo_c.py
```
`by_name`
```python3
for mod in sorted(module_set.by_name.keys()):
print(mod)
# results in:
# foo.__init__
# foo.foo_a
# foo.foo_b
# foo.foo_c
```
### ast_imports(file_path)
`ast_imports` is a low level function that returns a list of entries for import statement in the module.
The parameter `file_path` can be a string or `pathlib.Path` instance.
The return value is a list of 4-tuple items with values:
- module name (of the "from" statement, `None` if a plain `import`)
- object name
- as name
- level of relative import (number of parent, `None` if plain `import`)
```python3
from import_deps import ast_imports
ast_imports('foo.py')
```
```python3
# import datetime
(None, 'datetime', None, None)
# from datetime import time
('datetime', 'time', None, 0)
# from datetime import datetime as dt
('datetime', 'datetime', 'dt', 0)
# from .. import bar
(None, 'bar', None, 2)
# from .acme import baz
('acme', 'baz', None, 1)
# note that a single statement will contain one entry per imported "name"
# from datetime import time, timedelta
('datetime', 'time', None, 0)
('datetime', 'timedelta', None, 0)
```