vsg.rule_list

This is one of two classes you will use when incorporating vsg into another python program.

class vsg.rule_list.rule_list(oVhdlFile, sLocalRulesDirectory=None)

Contains a list of all rules to be checked. It loads all base rules. Localized rules are loaded if specified.

Parameters:

oVhdlFile: (vhdlFile object)

sLocalRulesDirectory: (string) (optional)

check_rules()

Analyzes all rules in increasing phase order. If there is a violation in a phase, analysis is halted.

Parameters: None

configure(configurationFile)

Configures individual rules based on dictionary passed.

Parameters:

configurationFile: (dictionary)
extract_junit_testcase(sVhdlFileName)

Creates JUnit XML file listing all violations found.

Parameters:

sVhdlFileName (string)

Returns: (junit testcase object)

fix(iPhase)

Applies fixes to all violations found.

Parameters:

iPhase: (integer)
get_configuration()

Returns a dictionary with every rule and how it is configured.

Parameters:

None

Returns: (dictionary)

report_violations(sOutputFormat)

Prints out violations to stdout.

Parameters:

sOutputFormat (string)