vhdl-style-guide/vsg/utils.py

85 lines
1.9 KiB
Python

# -*- coding: utf-8 -*-
import os
def get_violation_line_number(dViolation):
"""
Returns a line number of a violation.
Parameters:
dViolation: Violation dictionary
Returns: integer
"""
return dViolation.get_line_number()
def get_violation_at_line_number(lViolations, iLineNumber):
"""
Returns a violation from a violation dictionary at the given line number.
Parameters:
lViolation : (List of Violation dictionaries)
iViolation : (integer)
Return: Violation Dictionary
"""
for oViolation in lViolations:
if oViolation.get_line_number() == iLineNumber:
return oViolation
def get_violation_solution_at_line_number(lViolations, iLineNumber):
"""
Returns a the solution for a violation at a given line number.
Parameters:
lViolation : (List of Violation dictionaries)
iViolation : (integer)
Return: string
"""
try:
dViolation = get_violation_at_line_number(lViolations, iLineNumber)
return dViolation["solution"]
except TypeError:
oViolation = get_violation_at_line_number(lViolations, iLineNumber)
try:
return oViolation.get_solution()
except AttributeError:
return None
def expand_filename(sFileName):
"""Expands environment variables in filenames."""
return os.path.expanduser(os.path.expandvars(sFileName))
def write_junit_xml_file(oJunitFile):
with open(oJunitFile.filename, "w") as oFile:
oFile.write("\n".join(oJunitFile.build_junit()))
oFile.write("\n")
def extract_file_names_from_file_list(lFiles):
lReturn = []
for dFile in lFiles:
if isinstance(dFile, dict):
lReturn.extend(extract_keys_from_dict(dFile))
else:
lReturn.append(dFile)
return lReturn
def extract_keys_from_dict(dFile):
lReturn = []
lReturn.extend(list(dFile.keys()))
return lReturn