Violation

class understand.Violation

Bases: object

A violation

Violations are errors and warnings. They have a location that can be accessed with file, line, and column. Use text to get a description of the error or warning. The id method will return the check id the violation came from. Analysis errors and warnings have the check ids “UND_ERROR” and “UND_WARNING” respectively.

Violation line and column numbers are 1-based.

Methods Summary

check_id	Return the id of the check this violation came from.
column	Return the column number.
ent_uniquename	Return the unique name of the entity the violation is associated with.
file	Return the file the issue is located in.
ignores	Return a list of (source, note) ignore tuples.
line	Return the line number.
text	Return the text describing the violation.

Methods Documentation

check_id()

Return the id of the check this violation came from.

Return type:

str

Returns:

the violation’s check id

column()

Return the column number.

Return type:

int

Returns:

the column number

ent_uniquename()

Return the unique name of the entity the violation is associated with.

This will be an empty string if there is no associated entity. To retrieve the entity, if it still exists, use db.lookup_uniquename.

Return type:

str

Returns:

the entity’s unique name or empty string

file()

Return the file the issue is located in.

Return type:

str

Returns:

the violation’s file

ignores()

Return a list of (source, note) ignore tuples.

The source of the ignore will be one of the following:

• “Annotation”: undcc keyword in an annotation.

• “Comment”: undcc keyword in a comment.

• “Baseline”: violation found in baseline.

• “User”: false positive rule stored in project

• “Excluded”: violation outside inspected regions. This can happen when a global check references files outside the target files, or when Git is used and the violation was not on a line changed since the Git commit.

• “Unknown”: possible with violations imported from another tool

Some ignore sources support notes. The second value in the tuple will be the note or empty string if no note was given. It’s possible for the same source to appear in the list multiple times, for example, if multiple comments matched the violation.

Return type:

list[tuple(str,str)]

Returns:

the list of ignore tuples

line()

Return the line number.

Return type:

int

Returns:

the column number

text()

Return the text describing the violation.

Return type:

str

Returns:

the violation’s text