Vigilance
A simple tool for enforcing code quality metrics on a codebase
 All Classes Namespaces Files Functions Variables Groups
QualityReport Class Reference

Represents a parsed code quality report. More...

+ Inheritance diagram for QualityReport:

Public Member Functions

def __init__
 Creates a new QualityReport instance. More...
 
def scrutinize
 Vigilantly asserts that the provided constraints are satisfied by the quality report. More...
 

Public Attributes

 items
 

Detailed Description

Represents a parsed code quality report.

Constraints are applied to coverage reports to determine if a code base meets the required standards.

Constructor & Destructor Documentation

def __init__ (   self,
  items 
)

Creates a new QualityReport instance.

Parameters
itemsA list of QualityItem instances that together comprise the full coverage report.

Member Function Documentation

def scrutinize (   self,
  constraints 
)

Vigilantly asserts that the provided constraints are satisfied by the quality report.

Parameters
constraintsA vigilance.constraints.ConstraintSet instance.
Returns
A list containing any failed vigilance.representation.Satisfaction instances generated by the constraint application.

Member Data Documentation

items

The documentation for this class was generated from the following file: