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

AutomaticArch

class understand.AutomaticArch

Bases: object

Accessors for available automatic architecture generators.

Methods Summary

description	Return the automatic architecture description.
list	Return automatic architecture generators.
name	Return the name of this automatic architecture.
options	Return the options available for the automatic architecture.
tags	Return automatic architecture tags.

Methods Documentation

description() → str

Return the automatic architecture description.

Description is optional and may be an empty string.

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

Return automatic architecture generators.

Parameters:

• target (understand.Db or None) – optional, list only architectures for the database

• enabled_only (bool) – optional, defaults to True. When True, return only enabled automatic architecture plugins.

Return type:

list[understand.AutomaticArch]

name() → str

Return the name of this automatic architecture.

options() → understand.Options

Return the options available for the automatic architecture.

Return type:

understand.Options

tags() → list[str]

Return automatic architecture tags.

Tags are optional and may be empty.