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

Represents a single stanza within a vigilance configuration file. More...

+ Inheritance diagram for ConfigurationStanza:

Public Member Functions

def __init__
 
def parse
 Parses a single configuration stanza into its constituent constraints. More...
 

Public Attributes

 suite
 

Detailed Description

Represents a single stanza within a vigilance configuration file.

These stanzas exist to easily allow configuration of vigilance constraints that should be applied to a codebase.

Constructor & Destructor Documentation

def __init__ (   self,
  suite 
)

Member Function Documentation

def parse (   self,
  stanza 
)

Parses a single configuration stanza into its constituent constraints.

Parameters
stanzaA dictionary (obtained from parsing vigilance configuration YAML).
Returns
A list of vigilance.constraint.Constraint instances.
Exceptions
vigilance.error.ConfigurationParsingErrorif the configuration stanza cannot be parsed.

Member Data Documentation

suite

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