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

Abstract interface for parsing test coverage output. More...

+ Inheritance diagram for Parser:

Public Member Functions

def parse
 Parses coverage output. More...
 

Detailed Description

Abstract interface for parsing test coverage output.

The primary reponsibiliy of a Parser subclass is to convert output files into the Vigilance internal representation.

Member Function Documentation

def parse (   self,
  fileContents 
)

Parses coverage output.

Parameters
fileContentsThe string contents of the coverage output file.
Returns
A vigilance.representation.QualityReport instance.
Exceptions
vigilance.error.ReportParsingErrorif an unrecoverable error is encountered during parsing.

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