René's URL Explorer Experiment


Title: Python API reference - Understand Documentation

Description: The full class-by-class Python API reference (regenerated each release), plus the getting-started guide and tutorials.

Generator: mkdocs-ProperDocs 1.6.7, mkdocs-materialx-10.1.8

direct link

Domain: docs.scitools.com

Links:

Skip to content https://docs.scitools.com/help/reference/python-api-reference.html#python-api-reference
https://docs.scitools.com/index.html
https://docs.scitools.com/index.html
Home https://docs.scitools.com/help/index.html
What is Understand? https://docs.scitools.com/help/getting-started/what-is-understand.html
Download & create an account https://docs.scitools.com/help/getting-started/download-and-account.html
Install Understand https://docs.scitools.com/help/getting-started/install.html
Choose what to install on Windows https://docs.scitools.com/help/getting-started/install-components-windows.html
Create an offline install kit for Windows https://docs.scitools.com/help/getting-started/offline-install-kit-windows.html
Quick start (create → analyze → explore) https://docs.scitools.com/help/getting-started/quick-start.html
Supported languages & OSes https://docs.scitools.com/help/getting-started/supported-languages.html
Update & uninstall Understand https://docs.scitools.com/help/getting-started/update-and-uninstall.html
How do I get help / contact support? https://docs.scitools.com/help/getting-started/contact-support.html
Is Understand a compiler? https://docs.scitools.com/help/getting-started/is-understand-a-compiler.html
Which license do I have? https://docs.scitools.com/help/licensing/license-types.html
Activate — redeem a claim code https://docs.scitools.com/help/licensing/redeem-a-license.html
Start a trial https://docs.scitools.com/help/licensing/start-a-trial.html
Use free for open-source projects https://docs.scitools.com/help/licensing/open-source-license.html
Apply for an educational license https://docs.scitools.com/help/licensing/educational-license.html
Check out an offline license https://docs.scitools.com/help/licensing/offline-license-checkout.html
Return an offline or node-lock license https://docs.scitools.com/help/licensing/return-offline-license.html
Licensing from the command line https://docs.scitools.com/help/licensing/command-line-licensing.html
Fix: no license detected https://docs.scitools.com/help/licensing/fix-no-license.html
Manage a team (usage & seats) https://docs.scitools.com/help/licensing/team-administration.html
On-premises license server (Icarus) https://docs.scitools.com/help/licensing/icarus-license-server.html
Create your first project https://docs.scitools.com/help/projects/create-first-project.html
What Understand needs to analyze accurately https://docs.scitools.com/help/projects/what-understand-needs.html
Create a project from Git https://docs.scitools.com/help/projects/project-from-git.html
Manage your project's files https://docs.scitools.com/help/projects/manage-file-set.html
Keep your analysis up to date https://docs.scitools.com/help/projects/keep-analysis-current.html
Manage the .und database https://docs.scitools.com/help/projects/manage-und-database.html
Accurate C/C++ projects (Strict vs Fuzzy) https://docs.scitools.com/help/accuracy/accurate-c-cpp-projects.html
Build from CMake (compile_commands.json) https://docs.scitools.com/help/accuracy/build-from-cmake.html
Capture your build (Build Watcher vs Buildspy) https://docs.scitools.com/help/accuracy/build-watcher-vs-buildspy.html
Fix parse errors (headers/macros/inactive code) https://docs.scitools.com/help/accuracy/fix-parse-errors.html
Per-language accuracy notes https://docs.scitools.com/help/accuracy/per-language-notes.html
Analyze a mixed / multi-language project https://docs.scitools.com/help/accuracy/combined-language-analysis.html
Set up an embedded / firmware project https://docs.scitools.com/help/accuracy/embedded-firmware-projects.html
Analyze machine-generated code (Simulink) https://docs.scitools.com/help/accuracy/generated-code.html
Explore an unfamiliar codebase (10-min tour) https://docs.scitools.com/help/explore/10-minute-tour.html
Read the Information Browser https://docs.scitools.com/help/explore/information-browser.html
Contextual information & scope https://docs.scitools.com/help/explore/contextual-info-and-scope.html
Navigate with Browse Mode https://docs.scitools.com/help/explore/browse-mode.html
Find things fast (which search?) https://docs.scitools.com/help/explore/find-things-fast.html
Trace logic with the Virtual Debugger https://docs.scitools.com/help/explore/virtual-debugger.html
What are dependencies & how are they determined? https://docs.scitools.com/help/dependencies/what-are-dependencies.html
Browse & export dependencies https://docs.scitools.com/help/dependencies/browse-and-export-dependencies.html
What is the Dependency Matrix? (yes, it's a DSM) https://docs.scitools.com/help/dependencies/dependency-matrix.html
Enforce dependency rules ("X must not depend on Y") https://docs.scitools.com/help/dependencies/enforce-architecture-rules.html
What is an architecture & why build one? https://docs.scitools.com/help/architecture/what-is-an-architecture.html
Build, browse & enable architectures https://docs.scitools.com/help/architecture/build-and-enable-architectures.html
Build a custom architecture https://docs.scitools.com/help/architecture/build-a-custom-architecture.html
Auto-generate architectures from Git https://docs.scitools.com/help/architecture/architectures-from-git.html
Write an architecture plugin (Python) https://docs.scitools.com/help/architecture/write-an-architecture-plugin.html
Open a graph & choose a variant https://docs.scitools.com/help/graphs/open-a-graph.html
Which graph should I use? https://docs.scitools.com/help/graphs/which-graph.html
Style a graph (color by metric) https://docs.scitools.com/help/graphs/style-graphs.html
Export, print & script a graph https://docs.scitools.com/help/graphs/export-graphs.html
Write a graph plugin (Python) https://docs.scitools.com/help/graphs/graph-plugin.html
Where is my risky / complex code? https://docs.scitools.com/help/risk/find-risky-complex-code.html
Find unused / dead code https://docs.scitools.com/help/risk/find-dead-code.html
Home dashboard: grades & technical debt https://docs.scitools.com/help/risk/home-dashboard.html
What metrics does Understand have? https://docs.scitools.com/help/metrics/metrics-overview.html
Browse metrics (Metrics Browser) https://docs.scitools.com/help/metrics/metric-browser.html
What does Cyclomatic Complexity mean? https://docs.scitools.com/help/metrics/cyclomatic-complexity-meaning.html
Interpret key metrics (when to worry) https://docs.scitools.com/help/metrics/interpret-key-metrics.html
Rank & compare entities by a metric https://docs.scitools.com/help/metrics/rank-by-metric.html
Measure & track technical debt https://docs.scitools.com/help/metrics/technical-debt.html
Measure coupling & cohesion https://docs.scitools.com/help/metrics/coupling-and-cohesion.html
Bring in test coverage (lcov) https://docs.scitools.com/help/metrics/test-coverage.html
Why don't my metrics add up? https://docs.scitools.com/help/metrics/why-metrics-dont-add-up.html
Export & track metrics over time https://docs.scitools.com/help/metrics/export-and-track-metrics.html
Push metrics to leadership dashboards https://docs.scitools.com/help/metrics/metrics-to-dashboards.html
HIS (Hersteller-Initiative Software) metrics https://docs.scitools.com/help/metrics/his-metrics.html
Write a metric plugin (Python) https://docs.scitools.com/help/metrics/custom-metric-plugin.html
What is a report & how do I run one? https://docs.scitools.com/help/reports/what-is-a-report.html
Which report should I use? https://docs.scitools.com/help/reports/which-report.html
Export & script reports https://docs.scitools.com/help/reports/export-reports.html
Export Mermaid diagrams https://docs.scitools.com/help/reports/mermaid-exports.html
Helpers for script writers https://docs.scitools.com/help/reports/script-writer-reports.html
Write a report plugin (Python) https://docs.scitools.com/help/reports/write-a-report-plugin.html
What is CodeCheck? https://docs.scitools.com/help/codecheck/what-is-codecheck.html
Run your first check https://docs.scitools.com/help/codecheck/run-your-first-check.html
Which standard should I check against? https://docs.scitools.com/help/codecheck/which-standard.html
Check for security vulnerabilities (CWE, CERT) https://docs.scitools.com/help/codecheck/security-vulnerabilities.html
Build & share a custom configuration https://docs.scitools.com/help/codecheck/custom-configuration.html
Share config via the .und folder https://docs.scitools.com/help/licensing/share-config-und-folder.html
Bug Hunter (deep C/C++ defect checks) https://docs.scitools.com/help/codecheck/bug-hunter.html
View & triage violations https://docs.scitools.com/help/codecheck/view-violations.html
Suppress a violation / document a deviation https://docs.scitools.com/help/codecheck/suppress-a-violation.html
Turn suppressions into deviation records https://docs.scitools.com/help/codecheck/deviation-records.html
Baseline existing violations https://docs.scitools.com/help/codecheck/baseline-violations.html
Produce a compliance report https://docs.scitools.com/help/codecheck/compliance-report.html
Run automatically in the background https://docs.scitools.com/help/codecheck/background-checks.html
Run from the command line https://docs.scitools.com/help/codecheck/run-from-command-line.html
Run in CI (Jenkins) https://docs.scitools.com/help/codecheck/run-in-ci.html
Import SARIF from another tool https://docs.scitools.com/help/codecheck/import-sarif.html
Write a custom check (Python) https://docs.scitools.com/help/codecheck/write-a-custom-check.html
Report a rule issue https://docs.scitools.com/help/codecheck/report-a-rule-issue.html
The compliance lifecycle https://docs.scitools.com/help/compliance/compliance-lifecycle.html
Is Understand certified? https://docs.scitools.com/help/compliance/certification.html
DO-178C tool qualification https://docs.scitools.com/help/compliance/do-178c.html
ISO 26262 functional safety https://docs.scitools.com/help/compliance/iso-26262.html
IEC 62304 medical-device documentation https://docs.scitools.com/help/compliance/iec-62304.html
Compare files, folders, entities & text https://docs.scitools.com/help/compare/compare-files.html
Compare two versions of a project https://docs.scitools.com/help/compare/compare-project-versions.html
Assess the impact of a change (ripple analysis) https://docs.scitools.com/help/compare/change-impact-analysis.html
Where did the churn happen? (Changes Treemap) https://docs.scitools.com/help/compare/change-treemap.html
Git blame & file history https://docs.scitools.com/help/compare/git-blame-history.html
Run Understand from the command line (und) https://docs.scitools.com/help/automate/und-cli.html
Headless workflow: create → analyze → check → report https://docs.scitools.com/help/automate/headless-workflow.html
Interactive mode & batch scripts https://docs.scitools.com/help/automate/interactive-and-batch.html
Configure settings & filter files https://docs.scitools.com/help/automate/settings-and-filters.html
Run Understand in a CI pipeline (end-to-end) https://docs.scitools.com/help/cicd/pipeline-end-to-end.html
The Understand Jenkins plugin https://docs.scitools.com/help/cicd/jenkins-plugin.html
Buildspy in CI: exit codes & gating https://docs.scitools.com/help/cicd/buildspy-in-ci.html
Portable projects & Named Roots in CI https://docs.scitools.com/help/cicd/portable-projects.html
Which API should I use? https://docs.scitools.com/help/apis/which-api.html
Python API: getting started https://docs.scitools.com/help/apis/python-getting-started.html
1. Getting started https://docs.scitools.com/help/apis/tutorials/tutorial-1-getting-started.html
2. Writing your first API script https://docs.scitools.com/help/apis/tutorials/tutorial-2-first-script.html
3. Entities, references, and filters https://docs.scitools.com/help/apis/tutorials/tutorial-3-entities-references-filters.html
4. Lexers and lexemes https://docs.scitools.com/help/apis/tutorials/tutorial-4-lexers-lexemes.html
5. Graphs https://docs.scitools.com/help/apis/tutorials/tutorial-5-graphs.html
6. Interactive reports https://docs.scitools.com/help/apis/tutorials/tutorial-6-interactive-reports.html
7. Retrieving violations https://docs.scitools.com/help/apis/tutorials/tutorial-7-retrieving-violations.html
Write a plugin https://docs.scitools.com/help/apis/write-a-plugin.html
Build a plugin with AI https://docs.scitools.com/help/apis/ai-assisted-plugin.html
Install & run plugins (Plugin Manager) https://docs.scitools.com/help/apis/plugin-manager.html
Breaking API changes in 8.0 https://docs.scitools.com/help/apis/api-changes-8.html
Sample & solution scripts (cookbook) https://docs.scitools.com/help/apis/script-cookbook.html
Understand AI: overview & setup https://docs.scitools.com/help/ai/overview-and-setup.html
Choose a model (local or cloud) https://docs.scitools.com/help/ai/choose-a-local-llm.html
Run the Understand AI server (ullama) https://docs.scitools.com/help/ai/understand-ai-server.html
Set up a local AI server (LM Studio, Ollama) https://docs.scitools.com/help/ai/local-ai-server.html
Share one AI server across your team https://docs.scitools.com/help/ai/share-ai-server.html
Chat with the AI about your code https://docs.scitools.com/help/ai/ai-chat-in-gui.html
Connect an AI agent via MCP https://docs.scitools.com/help/ai/connect-via-mcp.html
Work with an AI agent on your code https://docs.scitools.com/help/ai/agent-workflows.html
What can the AI access? (privacy) https://docs.scitools.com/help/ai/ai-permissions-and-privacy.html
Why Understand when AI does the same thing? https://docs.scitools.com/help/ai/why-understand-with-ai.html
Refactor safely (Rename, Inline, Extract) https://docs.scitools.com/help/editor/refactor-safely.html
Advanced editor features https://docs.scitools.com/help/editor/advanced-editing.html
Annotate & share notes without touching source https://docs.scitools.com/help/editor/annotations.html
Standardize team notes with annotation templates https://docs.scitools.com/help/editor/annotation-templates.html
Bookmarks, tabs, layouts & sessions https://docs.scitools.com/help/editor/bookmarks-tabs-layouts.html
Use an external editor (VS Code, SlickEdit, Emacs, Vi) https://docs.scitools.com/help/editor/external-editor.html
Understand for VS Code (extension) https://docs.scitools.com/help/editor/understand-for-vscode.html
Install & run fully offline https://docs.scitools.com/help/air-gapped/install-offline.html
Licensing without internet https://docs.scitools.com/help/air-gapped/licensing-offline.html
What leaves the machine? (network & telemetry) https://docs.scitools.com/help/air-gapped/network-and-telemetry.html
Local AI with no cloud calls https://docs.scitools.com/help/air-gapped/local-ai-no-cloud.html
Run the AI server as a background service https://docs.scitools.com/help/air-gapped/ai-server-as-a-service.html
Security-review answers https://docs.scitools.com/help/air-gapped/security-questionnaire.html
Understanding & reverse-engineering legacy code https://docs.scitools.com/help/use-cases/legacy-reverse-engineering.html
Safety-critical software (aerospace, defense, automotive, medical) https://docs.scitools.com/help/use-cases/safety-critical.html
What can I solve with annotation templates? https://docs.scitools.com/help/use-cases/annotation-templates.html
Working across mixed-language codebases https://docs.scitools.com/help/use-cases/mixed-language-codebases.html
Refactoring at scale https://docs.scitools.com/help/use-cases/refactoring-at-scale.html
Onboarding to an unfamiliar codebase https://docs.scitools.com/help/use-cases/onboarding.html
Finding & reducing complexity https://docs.scitools.com/help/use-cases/reducing-complexity.html
Size up a legacy codebase to plan & estimate https://docs.scitools.com/help/use-cases/scope-a-modernization.html
Generate design documentation from your code https://docs.scitools.com/help/use-cases/generate-documentation.html
Review code you don't own (audits, forensics) https://docs.scitools.com/help/use-cases/review-code-you-dont-own.html
Prioritize testing from code changes (QA) https://docs.scitools.com/help/use-cases/qa-test-prioritization.html
Understand crashed — how do I report it? https://docs.scitools.com/help/troubleshooting/report-a-crash.html
Error & warning message index https://docs.scitools.com/help/troubleshooting/error-message-index.html
Fix: Failed to load the model file https://docs.scitools.com/help/troubleshooting/failed-to-load-model-file.html
Understand won't start https://docs.scitools.com/help/troubleshooting/wont-start.html
Search results are wrong or stale https://docs.scitools.com/help/troubleshooting/reset-search-index.html
Reset Understand to default settings https://docs.scitools.com/help/troubleshooting/reset-settings.html
Performance on a large codebase https://docs.scitools.com/help/troubleshooting/performance-large-codebase.html
Slow drawing over X11 / remote display https://docs.scitools.com/help/troubleshooting/slow-x11-drawing.html
A teammate can't open my project / paths broke https://docs.scitools.com/help/troubleshooting/portability-project-paths.html
Release notes — where to find them https://docs.scitools.com/help/release-notes/release-notes.html
Version releases https://docs.scitools.com/help/release-notes/version-releases.html
Understand 8.0 https://docs.scitools.com/help/release-notes/releases/understand-8-0.html
Understand 7.2 https://docs.scitools.com/help/release-notes/releases/understand-7-2.html
Understand 7.1 https://docs.scitools.com/help/release-notes/releases/understand-7-1.html
Understand 7.0 https://docs.scitools.com/help/release-notes/releases/understand-7-0.html
Understand 6.5 https://docs.scitools.com/help/release-notes/releases/understand-6-5.html
Understand 6.4 https://docs.scitools.com/help/release-notes/releases/understand-6-4.html
Understand 6.3 https://docs.scitools.com/help/release-notes/releases/understand-6-3.html
Understand 6.2 https://docs.scitools.com/help/release-notes/releases/understand-6-2.html
Understand 6.1 https://docs.scitools.com/help/release-notes/releases/understand-6-1.html
Understand 6.0 https://docs.scitools.com/help/release-notes/releases/understand-6-0.html
Migrating from an older version https://docs.scitools.com/help/release-notes/migrating.html
Deprecated tools & features https://docs.scitools.com/help/release-notes/deprecated-tools.html
Glossary https://docs.scitools.com/help/reference/glossary.html
Keyboard shortcuts https://docs.scitools.com/help/reference/keyboard-shortcuts.html
Instant Search query syntax https://docs.scitools.com/help/reference/instant-search-syntax.html
Filter syntax (Issue Browser & Checks) https://docs.scitools.com/help/reference/filter-syntax.html
und command reference https://docs.scitools.com/help/reference/cli-reference.html
Python API reference https://docs.scitools.com/help/reference/python-api-reference.html
Tutorials https://docs.scitools.com/help/reference/python-api-reference.html#tutorials
Also see https://docs.scitools.com/help/reference/python-api-reference.html#also-see
Graph catalog https://docs.scitools.com/help/reference/graph-catalog.html
Reports catalog https://docs.scitools.com/help/reference/reports-catalog.html
Metrics catalog https://docs.scitools.com/help/reference/metrics-catalog.html
Architecture catalog https://docs.scitools.com/help/reference/architecture-catalog.html
CodeCheck standards & rule coverage https://docs.scitools.com/help/reference/codecheck-standards.html
Project settings reference https://docs.scitools.com/help/reference/settings-reference.html
Tutorials https://docs.scitools.com/help/reference/python-api-reference.html#tutorials
Also see https://docs.scitools.com/help/reference/python-api-reference.html#also-see
https://docs.scitools.com/help/reference/python-api-reference.html#python-api-reference
Open the full Python API reference →https://docs.scitools.com/python/index.html
https://docs.scitools.com/help/reference/python-api-reference.html#tutorials
Getting startedhttps://docs.scitools.com/help/apis/tutorials/tutorial-1-getting-started.html
Writing your first scripthttps://docs.scitools.com/help/apis/tutorials/tutorial-2-first-script.html
Entities, references & filtershttps://docs.scitools.com/help/apis/tutorials/tutorial-3-entities-references-filters.html
Lexers & lexemeshttps://docs.scitools.com/help/apis/tutorials/tutorial-4-lexers-lexemes.html
Graphshttps://docs.scitools.com/help/apis/tutorials/tutorial-5-graphs.html
Interactive reportshttps://docs.scitools.com/help/apis/tutorials/tutorial-6-interactive-reports.html
Retrieving violationshttps://docs.scitools.com/help/apis/tutorials/tutorial-7-retrieving-violations.html
https://docs.scitools.com/help/reference/python-api-reference.html#also-see
Python API: getting startedhttps://docs.scitools.com/help/apis/python-getting-started.html
Which API should I use?https://docs.scitools.com/help/apis/which-api.html
Sample & solution scriptshttps://docs.scitools.com/help/apis/script-cookbook.html
MaterialX https://jaywhj.github.io/mkdocs-materialx/

Viewport: width=device-width,initial-scale=1


URLs of crawlers that visited me.