Skip to main content

dead simple python dead code detection

Project description

Build Status

dead

dead simple python dead code detection

installation

pip install dead

cli

Consult the help for the latest usage:

$ dead --help
usage: dead [-h] [--files FILES] [--exclude EXCLUDE] [--tests TESTS]

optional arguments:
  -h, --help         show this help message and exit
  --files FILES      regex for file inclusion, default: ''
  --exclude EXCLUDE  regex for file exclusion, default '^$'
  --tests TESTS      regex to mark files as tests, default
                     '(^|/)(tests?|testing)/'

run the dead utility from the root of a git repository.

as a pre-commit hook

See pre-commit for instructions

Sample .pre-commit-config.yaml:

-   repo: https://github.com/asottile/dead
    rev: v0.0.7
    hooks:
    -   id: dead

how it works

  1. find all files in a repository using git ls-files and filtering:
    • only include files matched by the --files regex
    • exclude files matched by the --exclude regex
    • only include files identified as python by identify
    • classify test files by the --tests regex
  2. ast parse each file
    • search for definitions and references
  3. report things which do not have references

false positives

I wrote this in ~15 minutes on an airplane, it's far from perfect but often finds things. Here's a few things it's not good at:

  • functions which implement an interface are often marked as unused
  • metaclass magic is often marked as unused (enums, model classes, etc.)

suppressing dead

The # dead: disable comment will tell dead to ignore any line which has reportedly dead code.

is this project dead?

maybe.

Project details


Download files

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

Source Distribution

dead-0.0.7.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

dead-0.0.7-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file dead-0.0.7.tar.gz.

File metadata

  • Download URL: dead-0.0.7.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for dead-0.0.7.tar.gz
Algorithm Hash digest
SHA256 2b1057c9a20d6425076f2aa0fe7371588513ec01acfb2fe6ddf70ca9d2f4c443
MD5 99c84b3022d58a4fc2e1f1b4be00820e
BLAKE2b-256 c5863394732340f0699a83658136f3f688390f33a137750969e9fda02e155475

See more details on using hashes here.

File details

Details for the file dead-0.0.7-py2.py3-none-any.whl.

File metadata

  • Download URL: dead-0.0.7-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.7

File hashes

Hashes for dead-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6151b27bfc7aaaae0b4a6927bfcfa03bec66cc3d4416cb83d9d4903ed3f152b2
MD5 e9a5e1236f843b9fd0f102e214ab4086
BLAKE2b-256 a1018cd371fdcb0926c0d9017287ac2d2223fc648c32ed8cfb2548a7d293b11a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page