Inspection¶
- class understand.Inspection¶
Bases:
objectAn inspection
An inspection wraps CodeCheck output. The main purpose is to provide the violations and ignored violations found from a particular CodeCheck run. Information about the inspection as a whole is also available, including the configuration and files inspected and the time of the inspection.
Methods Summary
The configuration run or None if not available.
The end time of the inspection in ISO format.
A list of inspection error messages.
The list of input files.
The name of the inspection.
The start time of the inspection in ISO format.
The list of violations.
Methods Documentation
- config()¶
The configuration run or None if not available.
- Return type:
- Returns:
the configuration
- end_time()¶
The end time of the inspection in ISO format.
This may be an empty string if the time is not known or the inspection is still running.
- Return type:
str
- Returns:
the end time of the inspection
- errors()¶
A list of inspection error messages.
- Return type:
list[str]
- Returns:
the error messages
- files()¶
The list of input files.
- Return type:
list[str]
- Returns:
the input files
- name()¶
The name of the inspection.
- Return type:
str
- Returns:
the inspection name
- start_time()¶
The start time of the inspection in ISO format.
This may be an empty string if the time is not known.
- Return type:
str
- Returns:
the start time of the inspection
- violations()¶
The list of violations.
- Return type:
list[understand.Violation]
- Returns:
the violations