Pycycle: Find and fix circular imports in python projects
Pycycle is an experimental project that aims to help python developers fix their circular dependencies problems.
ImportError: Cannot import name X is a python exception that is related to the circular imports, but the exception tells nothing about where or what.
This tool automatically analyzes the imports of your projects, and looks for imports that may cause a circular dependency problem.
Features
- Shows you the whole chain of the circular imports.
- Gives you lines of code where each import is, for you to easily find and fix the problem.
- Visualizes your imports in a graph (Not Yet Implemented)
Usage
$ pycycle
Usage: pycycle [OPTIONS] COMMAND [ARGS]...
Examples:
Get the circular imports in current project:
$ pycycle --here
Look for circular imports in another project
$ pycycle --source /home/user/workspace/awesome_project
Ignore specific directories when looking for circular import
$ pycycle --source /home/user/workspace/awesome_project --ignore some_dir,some_dir2
Get verbose output
$ pycycle --source /home/user/workspace/awesome_project --verbose
Options:
--verbose Verbose output.
--here Try to find cycles in the current project.
--source TEXT Try to find cycles in the path provided.
--ignore TEXT Comma separated directories that will be ignored during
analysis.
--encoding TEXT Change enconding with which the project is read.
--help Show this message then exit.
--version Show the version and exit.
$ pycycle --here Project successfully transformed to AST, checking imports for cycles.. Cycle Found :( a_module.a_file: Line 1 -> a_module.b_module.b_file: Line 1 -> c_module.c_file: Line 1 -> d_module.d_file: Line 1 =>> a_module.a_file Finished.
$ pycycle --source /Users/vkravcenko/workspace/awesome_project Target source provided:/Users/vkravcenko/workspace/awesome_project Project successfully transformed to AST, checking imports for cycles.. No worries, no cycles here! If you think some cycle was missed, please open an Issue on Github. Finished.
Installation
$ pip install pycycle
