Config

class understand.Config

Bases: object

A configuration

A configuration is a list CodeCheck checks and their properties.

Methods Summary

check_kind	The kind of the check with the given id.
check_name	The name of the check with the given id.
check_tags	The tags of the check with the given id.
checks	The list of check ids.
name	Return the name of the configuration.

Methods Documentation

check_kind(id)

The kind of the check with the given id.

Possible kinds are:

• Perl Script

• Python Script

• Dependency

• Parser

• Not Supported

• Implicitly Supported

Return type:

str

Returns:

the check kind

check_name(id)

The name of the check with the given id.

Return type:

str

Returns:

the check name

check_tags(id)

The tags of the check with the given id.

Tags by convention are “key: value” or “value”. Properties defined by tags include the standard and severity.

Return type:

list[str]

Returns:

the check tags

checks()

The list of check ids.

Return type:

list[str]

Returns:

the check ids

name()

Return the name of the configuration.

Return type:

str

Returns:

the configuration name