The Understand Python API gives scripts access to everything Understand knows about your code — entities, references, metrics, and dependencies — and powers custom checks, graphs, and reports.

Python API: getting started · Sample & solution scripts

Report#

class understand.Report#

Bases: object

Accessors for available report plugins.

Methods Summary

`description`	Return the report description.
`list`	Return a list of reports.
`name`	Return the report name.
`options`	Return options available for this report and target.
`tags`	Return report tags.

Methods Documentation

description() → str#

Return the report description.

Description is optional and may be an empty string.

classmethod list(target=None, enabled_only=True) → list[understand.Report]#

Return a list of reports.

Parameters:

target (understand.Ent or understand.Arch or understand.Db or None) – optional, list only reports valid for this target
enabled_only (bool) – optional, defaults to True. When True, return only enabled report plugins.

Return type:

list[understand.Report]

name() → str#: Return the report name.

options(target) → understand.Options#

Return options available for this report and target.

Parameters:: target (understand.Db, understand.Ent, or understand.Arch) – database, entity, or architecture the report applies to
Return type:: understand.Options

tags() → list[str]#

Return report tags.

Tags are optional and may be empty.