https://github.com/bndr/pycycle

Tool for pinpointing circular imports in Python. Find cyclic imports in any project
https://github.com/bndr/pycycle

cli python utilities

Last synced: about 1 month ago
JSON representation

Tool for pinpointing circular imports in Python. Find cyclic imports in any project

• Host: GitHub
• URL: https://github.com/bndr/pycycle
• Owner: bndr
• License: mit
• Created: 2017-01-28T17:22:00.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-15T20:44:01.000Z (almost 3 years ago)
• Last Synced: 2024-03-15T09:38:46.116Z (9 months ago)
• Topics: cli, python, utilities
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 324
• Watchers: 6
• Forks: 24
• Open Issues: 19
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - pycycle - Tool for pinpointing circular imports in Python. Find cyclic imports in any project (Python)

README

        
Pycycle: Find and fix circular imports in python projects

=========================================================

.. image:: https://img.shields.io/pypi/v/pycycle.svg

    :target: https://pypi.python.org/pypi/pycycle

.. image:: https://img.shields.io/pypi/l/pycycle.svg

    :target: https://pypi.python.org/pypi/pycycle

.. image:: https://img.shields.io/pypi/wheel/pycycle.svg

    :target: https://pypi.python.org/pypi/pycycle

.. image:: https://img.shields.io/pypi/pyversions/pipenv.svg

    :target: https://pypi.python.org/pypi/pycycle

.. image:: https://api.travis-ci.org/bndr/pycycle.svg?branch=master

    :target: https://travis-ci.org/bndr/pycycle

---------------

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

.. image:: https://i.imgur.com/8JeLQxu.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.

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