Find all the imports in your library
Project description
depfinder
Installation
depfinder
is on pypi. It is tested against Python 2.7 and 3.6-3.8.
pip install depfinder
It is available via conda.
conda install -c conda-forge depfinder
It is also via github.
git clone git@github.com:ericdill/depfinder
cd depfinder
python setup.py install
Using depfinder
$ depfinder -h
usage: depfinder [-h] [-y] [-V] [--no-remap] [-v] [-q] [-k KEY] [--conda]
[--pdb]
file_or_directory
Tool for inspecting the dependencies of your python project.
positional arguments:
file_or_directory Valid options are a single python file, a single jupyter
(ipython) notebook or a directory of files that include
python files
optional arguments:
-h, --help show this help message and exit
-y, --yaml Output in syntactically valid yaml when true. Defaults to
False
-V, --version Print out the version of depfinder and exit
--no-remap Do not remap the names of the imported libraries to their
proper conda name
-v, --verbose Enable debug level logging info from depfinder
-q, --quiet Turn off all logging from depfinder
-k KEY, --key KEY Select some or all of the output keys. Valid options are
'required', 'optional', 'builtin', 'relative', 'all'.
Defaults to 'all'
--conda Format output so it can be passed as an argument to conda
install or conda create
--pdb Enable PDB debugging on exception
Ok, great. That's the help output. Not super helpful. What does the output of depfinder look like when we run it on the source code for depfinder?
$ depfinder depfinder
{'builtin': ['__future__',
'argparse',
'ast',
'collections',
'copy',
'errno',
'json',
'logging',
'os',
'pprint',
're',
'subprocess',
'sys'],
'relative': ['_version', 'main'],
'required': ['pyyaml', 'stdlib-list']}
So, what do these things mean? Well builtin
are modules
that are built in to the standard library. required
are
modules that are not from the standard library or from within the
depfinder
package and relative
are modules
that are imported from one module to another within the
depfinder
source code.
Also see this notebook
Description
Find all the unique imports in your library, automatically, because who
likes do it by hand? depfinder
uses the ast (Abstract
Syntax Tree) module (and more ast
docs) to find all
:pyast.Try
{.interpreted-text role="class"} and
:pyast.ImportFrom
{.interpreted-text role="class"} nodes. These
:pyast.Import
{.interpreted-text role="class"} and
:pyast.ImportFrom
{.interpreted-text role="class"} nodes are then
grouped according to the following categories, in order of decreasing
precedence:
-
relative : The import is a relative import from within the same library
-
builtin : The import is built into the standard library, as determined by scraping the official python docs for the builtins with stdlib-list
-
questionable : The import occurs inside any combination of
- {py:class}
ast.Try
({py:class}ast.TryExcept
on py27) - {py:class}
ast.FunctionDef
or {py:class}ast.AsyncFunctionDef
- {py:class}
ast.If
, {py:class}ast.While
, {py:class}ast.For
, or {py:class}ast.AsyncFor
. - {py:class}
ast.match_case
.
The module may be importable without these imports, but the it will likely not have full functionality.
- {py:class}
-
required : The import occurs at the top level of the module and will get executed when the module is imported. These imports must be accounted for in an environment, or the module will not be importable.
Testing
It has dependencies on,
stdlib-list and
pyyaml. I use stdlib-list
to get the
list of libraries built in to the standard library. These requirements
can be installed via pip :
pip install -r requirements.txt
Also install the test-requiements :
pip install -r test-requirements.txt
Then you can run the tests from the root of the git repository :
coverage run run_tests.py
Releasing
manual:
- create an annotated tag and push it to github.
git tag -a TAG and then
git push --tags` git checkout TAG
python -m build --sdist --wheel . --outdir dist
twine check dist/*
twine upload dist/* --verbose
API
.. currentmodule:: depfinder.main
.. autofunction:: get_imported_libs
.. autofunction:: iterate_over_library
.. autofunction:: simple_import_search
IPython/Jupyter Notebook support
depfinder
has support for v4 Jupyter notebooks.
.. autofunction:: notebook_path_to_dependencies
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for depfinder-2.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a7cdf3af2a06ceca306e0b717560bd9a841dafa007989fd0728dcd51e6701e8 |
|
MD5 | 11ef657ff2804b694b160803bfa2d649 |
|
BLAKE2b-256 | 52e423af5a0e69cc86a9b2bccfc779024c62e24727b2b4d5c700ef74a5f1427b |