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

Represents a coverage constraint that must be enforced. More...

+ Inheritance diagram for Constraint:

Public Member Functions

def is_of_type
 Returns whether the Constraint is considered to be of a certain constraint type. More...
 
def satisfied_by
 Returns whether the Constraint is satisfied by some item under coverage. More...
 
def applies_to
 Returns whether the Constraint should be applied to an item under coverage. More...
 

Detailed Description

Represents a coverage constraint that must be enforced.

Member Function Documentation

def applies_to (   self,
  item 
)

Returns whether the Constraint should be applied to an item under coverage.

This is useful for allowing specific constraints to be applied to smaller subsets of a codebase.

Returns
A boolean.
def is_of_type (   self,
  constraintType 
)

Returns whether the Constraint is considered to be of a certain constraint type.

def satisfied_by (   self,
  item 
)

Returns whether the Constraint is satisfied by some item under coverage.

Parameters
itemA vigilance.representation.QualityItem instance.
Returns
A vigilance.representation.Satisfaction instance.

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