6.2.5.17. Architecture-CustomRFGFunction

Modifies the RFG using user-defined python functions

Required inputs: RFG

This rule allows to apply a user-specified function to an RFG which can read and modify the given RFG.

Possible Messages

This rule has no predefined messages.

Options

• This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity

• The following places define options that affect this rule: Analysis-GlobalOptions

export_warnings

export_warnings : bool = True

Export output messages to the analysis database.

 

function

function : typing.Callable[[_dg.Graph], typing.Optional[_dg.Graph]] | None = None

User-defined function that gets an RFG graph as an argument; the rule calls it with the current RFG, the return value will be returned by the rule. If the option is set to None, the unmodified RFG is returned by the rule.

 

loglevel

loglevel : LogLevel = 'WARNING'

Logging mode. WARNING only outputs errors and warnings, INFO additionally prints info messages, DEBUG additionally outputs info and debug messages.

 

Option Types

These types are used by options listed above:

LogLevel

An enumeration.

 

• WARNING

• INFO

• DEBUG