Deadcode

Find and Fix Unused Python Code

Rationale

ruff and flake8 - don’t have rules for unused global code detection, only for local ones F823, F841, F842. deadcode package tries to add new DCXXX checks for detecting variables/functions/classes/files which are not used in a whole code base.

deadcode - is supposed to be used inline with other static code checkers like ruff.

There is an alternative vulture package.

Read the Installation page to install deadcode.

Read the Usage page for usage examples, command line options, the glossary, decorator matching, and exit status.

Read the Rules page for the implemented rules and for ignoring findings with # noqa comments.

Read the FastAPI page for running deadcode on a FastAPI project, including common use cases, dependency injection, and a complete example application.

Read the Pre-commit hook page for setting up and using the pre-commit hook.

Read the Contributing page for the contribution workflow and the feature-request checklist.

Read the Security page for the vulnerability detection process and how to respond to a finding.

Read the Known limitations page for the analyser’s known limitations.

Read the Release notes page for the release history.

Read the Features page for the checked map of README features to source files, tests, and minimum test cases.

Read the Comparison with vulture page for a comparison of deadcode with vulture, starting with the differences that matter most when choosing between them.

• Installation
• Usage
  • Command line options
• Rules
  • Ignoring checks with noqa comments
  • Ignoring unittest lifecycle methods
• FastAPI
  • Recommended configuration
  • Common use cases
  • Example application
  • Dependency injection
  • Verifying the recommended configuration
  • Limitations
• Pre-commit hook
  • What the hook checks
  • Install
  • Configuration
  • The rev is a release tag
  • Automatic fixing
  • Passing options and file selection
  • Exit status
  • Running on all files
  • Troubleshooting: why the hook differs from deadcode .
  • Solving it
• Contributing
  • Security
  • Feature requests
• Security
  • What runs and when
  • Dependabot
  • How to read and fix a finding
  • Reproduce locally
  • Accepted exception: filelock on Python 3.10
• Known limitations
• Release notes
• Features
  • Coverage map
  • Not behaviour
  • Coverage policy
• Comparison with vulture
  • Key differences for developers
  • At a glance
  • Detection and findings
  • Automatic fixing and integrations
  • Configuration and suppression
  • Adapting suppression to a framework