Skip to main content

Find and repair your import cycles in any project

Project description

https://img.shields.io/pypi/v/pycycle.svg https://img.shields.io/pypi/l/pycycle.svg https://img.shields.io/pypi/wheel/pycycle.svg https://img.shields.io/pypi/pyversions/pipenv.svg https://api.travis-ci.org/bndr/pycycle.svg?branch=master

Pycycle is an experimental project that aims to help developers fix their circular dependencies problems. ImportError: Cannot import name X is a python exception that is related to the circular imports, but it’s not clear from the start. This tool automatically analyzes the imports of your projects, and looks for imports that may cause a circular dependency problem.

https://i.imgur.com/QVgTJ8h.gif

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.
  --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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pycycle, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size pycycle-0.0.3-py2-none-any.whl (7.6 kB) File type Wheel Python version 2.7 Upload date Hashes View hashes
Filename, size pycycle-0.0.3.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page