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

Relates multiple constraints together into a constraint suite. More...

+ Inheritance diagram for ConstraintSuite:

Public Member Functions

def __init__
 
def all_types
 Returns an iterable of all available constraint types. More...
 
def all_labels
 Returns an iterable of all available constraint labels. More...
 
def get_constraint
 Returns the constraint associated with a given label. More...
 
def group_constraints
 Groups constraints into subgroups based on their constraint types. More...
 

Public Attributes

 constraints
 

Detailed Description

Relates multiple constraints together into a constraint suite.

Constructor & Destructor Documentation

def __init__ (   self,
  constraints 
)

Member Function Documentation

def all_labels (   self)

Returns an iterable of all available constraint labels.

def all_types (   self)

Returns an iterable of all available constraint types.

def get_constraint (   self,
  label 
)

Returns the constraint associated with a given label.

Parameters
labelThe string type representing the constraint.
Returns
A subclass of Constraint.
def group_constraints (   self,
  constraints 
)

Groups constraints into subgroups based on their constraint types.

Parameters
constraintsA list of Constraint instances.
Returns
A dictionary mapping constraint types to distinct subsets of constraints.

Member Data Documentation

constraints

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