Python API reference¶
The complete class-by-class reference for the understand Python module — plus feature guides for
Architectures, CodeCheck, Graphs, Metrics, and Reports and a page of worked Examples — is generated
from the product each release:
In Understand you can also open the same manual from Help → Python API Documentation (it matches your installed build).
Tutorials¶
The Python API tutorials walk through the core concepts end to end:
- Getting started
- Writing your first script
- Entities, references & filters
- Lexers & lexemes
- Graphs
- Interactive reports
- Retrieving violations
Also see¶
- Python API: getting started — set up
upythonand run your first query. - Which API should I use? — Python vs. Perl vs. C.
- Sample & solution scripts — ready-to-run scripts to copy from.