Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Find dirs which appear to be broken python packages, as a pre-commit hook.

Project description

Latest PyPI version Build Status

Find dirs which appear to be broken python packages, i.e. dirs which contain *.py files without the necessary __init__.py

Suggested use is to run as a Pre-commit hook.

Why?

In your main code it’s unlikely to have orphan modules since they are not importable and likely a cause of visible errors.

However in your unit tests, particularly if you have a lot of tests, you may find orphans. They go undetected because while developing you maybe pass the full path to the orphan to your test runner, and it works. But when you run the full suite of tests the orphans won’t be found and so you have tests which aren’t running!

By running pyorphans as a pre-commit hook you can catch the orphans and fix them immediately.

CLI Usage

pip install pyorphans

This will install a console script pyorphans.

To run the checker, just pass it a list of the root packages in your project:

pyorphans tests myproject

It returns output like:

tests/unit
-> test_important_stuff.py

tests/integration/important_stuff
tests/integration/important_stuff/api
-> test_views.py

We can see here that tests/unit dir is missing an __init__.py but contains test_important_stuff.py

Also tests/integration/important_stuff and tests/integration/important_stuff/api dirs are both missing their __init__.py files. Inside both directories is found a single ‘orphan’ file, tests/integration/important_stuff/api/test_views.py.

Say you get an output like:

myproject/scripts
-> do_something.py

Maybe scripts is not intended to be a package and do_something.py is a perfectly good standalone script that runs from the command-line.

In this case create a .pyorphans_ignore file in the root of your project (the dir that pyorphans will be run from), containing:

myproject/scripts

Now myproject/scripts (and all its subdirs) will be excluded from the search for orphans.

Pre-commit Hook

We suggest using Pre-commit.

pip install pre-commit

Pyorphans is configured as a Pre-commit plugin. To apply it to your project, add a .pre-commit-config.yaml file to the root of your project like so:

repos:
  - repo: https://github.com/depop/pyorphans
    rev: "0.2.0"
    hooks:
    - id: pyorphans
      args:
        - myproject
        - tests

Now every time you commit, Pyorphans will run and ask you to fix any that it finds. Pyorphans runs fast so you’ll hardly notice it’s there!

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pyorphans-0.2.1.tar.gz (4.2 kB) Copy SHA256 hash SHA256 Source None

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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page