Skip to main content

cppclean

Build status

Goal

cppclean attempts to find problems in C++ source that slow development in large code bases, for example various forms of unused code. Unused code can be unused functions, methods, data members, types, etc to unnecessary #include directives. Unnecessary #includes can cause considerable extra compiles increasing the edit-compile-run cycle.

This is a fork of the original cppclean project. The original project home page, which no longer contains code, is at https://code.google.com/p/cppclean/.

Features

cppclean finds the following:

  • Classes with virtual methods, no virtual destructor, and no bases

  • Global/static data that are potential problems when using threads

  • Functions that are declared but not defined

  • Unnecessary forward class declarations

  • Unnecessary function declarations

  • Undeclared function definitions

  • Unnecessary #includes in header files
    • No direct reference to anything in the header

    • Header is unnecessary if classes were forward declared instead

  • (planned) Unnecessary #includes in source files

  • (planned) Source files that reference headers not directly #included, ie, files that rely on a transitive #include from another header

  • (planned) Unused members (private, protected, & public) methods and data

  • (planned) using namespace std in header files

  • (planned) Methods that are declared but not defined

AST is Abstract Syntax Tree, a representation of parsed source code (https://en.wikipedia.org/wiki/Abstract_syntax_tree).

Installation

$ pip install --upgrade cppclean

Run

$ cppclean <path>

Multiple include paths can be specified:

$ cppclean --include-path=directory1 --include-path=directory2 <path>

Current status

The parser works pretty well for header files, parsing about 99% of Google’s header files. Anything which inspects structure of C++ source files should work reasonably well. Function bodies are not transformed to an AST, but left as tokens.

Non-goals

  • Parsing all valid C++ source

  • Handling invalid C++ source gracefully

  • Compiling to machine code (or anything beyond an AST)

Metadata

Release files for cppclean 0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cppclean 0.6
File Size Uploaded Provenance Actions
cppclean-0.6.tar.gz 29.7 kB Without provenance Details for cppclean-0.6.tar.gz

Release files / cppclean-0.6.tar.gz

Download URL cppclean-0.6.tar.gz
Size 29.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d55b540a3ef5885df985cc1321650b6454c01fc4f25e3385f211daccde275fce
BLAKE2b-256 checksum
How to use checksums
8793a8fe36b1fd6b2e37414cab4c0503b93e84f0ba9a5a2dffbaaf0bb088a628
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for cppclean 0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page