caellion-python-commons
caellion.pycommons.codeanalysis.reports.ReportBuilder Class Reference

Public Member Functions

def __init__ (self)
 
def extract_basename_file (self, path)
 
def addIssue (self, path, severity, message, lineStart=-1, lineEnd=-1, columnStart=-1, columnEnd=-1, category=None, type=None, description=None, packageName=None, moduleName=None, additionalProperties=None)
 
def generateReport (self)
 

Public Attributes

 issues_all
 

Static Public Attributes

dictionary issues_all = {"_class": "io.jenkins.plugins.analysis.core.restapi.ReportApi", "issues": [], "size": 0}
 

Detailed Description

Definition at line 5 of file reports.py.

Constructor & Destructor Documentation

◆ __init__()

def caellion.pycommons.codeanalysis.reports.ReportBuilder.__init__ (   self)

Definition at line 9 of file reports.py.

Member Function Documentation

◆ addIssue()

def caellion.pycommons.codeanalysis.reports.ReportBuilder.addIssue (   self,
  path,
  severity,
  message,
  lineStart = -1,
  lineEnd = -1,
  columnStart = -1,
  columnEnd = -1,
  category = None,
  type = None,
  description = None,
  packageName = None,
  moduleName = None,
  additionalProperties = None 
)

Definition at line 24 of file reports.py.

◆ extract_basename_file()

def caellion.pycommons.codeanalysis.reports.ReportBuilder.extract_basename_file (   self,
  path 
)
Extracts basename of a given path (only files). Should Work with any OS Path on any OS

Definition at line 18 of file reports.py.

◆ generateReport()

def caellion.pycommons.codeanalysis.reports.ReportBuilder.generateReport (   self)

Definition at line 76 of file reports.py.

Member Data Documentation

◆ issues_all [1/2]

dictionary caellion.pycommons.codeanalysis.reports.ReportBuilder.issues_all = {"_class": "io.jenkins.plugins.analysis.core.restapi.ReportApi", "issues": [], "size": 0}
static

Definition at line 7 of file reports.py.

◆ issues_all [2/2]

caellion.pycommons.codeanalysis.reports.ReportBuilder.issues_all

Definition at line 10 of file reports.py.


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