@@ -594,10 +594,51 @@ def output_pdf(
594594 exploits : bool = False ,
595595 all_product_data = None ,
596596 ):
597+ """Output a PDF of CVEs
598+ Required module: Reportlab not found"""
597599 LOGGER .warning ("PDF output requires install of reportlab" )
598600
599601
600602class OutputEngine :
603+ """
604+ Class represention of OutputEngine
605+ Attributes:
606+ all_cve_data (dict[ProductInfo, CVEData])
607+ scanned_dir (str)
608+ filename (str)
609+ themes_dir (str)
610+ time_of_last_update
611+ tag (str)
612+ logger
613+ products_with_cve (int)
614+ products_without_cve (int)
615+ total_files (int)
616+ is_report (bool)
617+ no_zero_cve_report (bool)
618+ append
619+ merge_report
620+ affected_versions (int)
621+ all_cve_version_info
622+ detailed (bool)
623+ vex_filename (str)
624+ exploits (bool)
625+ all_product_data
626+ sbom_filename (str)
627+ sbom_type (str)
628+ sbom_format (str)
629+ sbom_root (str)
630+ offline (bool)
631+
632+ Methods:
633+ output_cves: Output a list of CVEs to other formats like CSV or JSON.
634+ generate_vex: Generate a vex file and create vulnerability entry.
635+ generate_sbom: Create SBOM package and generate SBOM file.
636+ output_file_wrapper:
637+ output_file: Generate a file for list of CVE
638+ check_file_path: Generate a new filename if file already exists.
639+ check_dir_path: Generate a new filename if filepath is a directory.
640+ """
641+
601642 def __init__ (
602643 self ,
603644 all_cve_data : dict [ProductInfo , CVEData ],
@@ -626,6 +667,7 @@ def __init__(
626667 sbom_root : str = "CVE_SBOM" ,
627668 offline : bool = False ,
628669 ):
670+ """Constructor for OutputEngine class."""
629671 self .logger = logger or LOGGER .getChild (self .__class__ .__name__ )
630672 self .all_cve_version_info = all_cve_version_info
631673 self .scanned_dir = scanned_dir
@@ -735,6 +777,7 @@ def output_cves(self, outfile, output_type="console"):
735777 )
736778
737779 def generate_vex (self , all_cve_data : dict [ProductInfo , CVEData ], filename : str ):
780+ """Generate a vex file and create vulnerability entry."""
738781 analysis_state = {
739782 Remarks .NewFound : "in_triage" ,
740783 Remarks .Unexplored : "in_triage" ,
@@ -840,6 +883,7 @@ def generate_sbom(
840883 sbom_format = "tag" ,
841884 sbom_root = "CVE-SCAN" ,
842885 ):
886+ """Create SBOM package and generate SBOM file."""
843887 # Create SBOM
844888 sbom_packages = {}
845889 sbom_relationships = []
@@ -895,6 +939,7 @@ def generate_sbom(
895939 my_generator .generate (parent , my_sbom .get_sbom (), filename = filename )
896940
897941 def output_file_wrapper (self , output_types = ["console" ]):
942+ """Call output_file method for all output types."""
898943 for output_type in output_types :
899944 self .output_file (output_type )
900945
@@ -959,6 +1004,7 @@ def output_file(self, output_type="console"):
9591004 self .output_cves (f , output_type )
9601005
9611006 def check_file_path (self , filepath : str , output_type : str , prefix : str = "output" ):
1007+ """Generate a new filename if file already exists."""
9621008 # check if the file already exists
9631009 if Path (filepath ).is_file ():
9641010 self .logger .warning (f"Failed to write at '{ filepath } )
@@ -970,6 +1016,7 @@ def check_file_path(self, filepath: str, output_type: str, prefix: str = "output
9701016 def check_dir_path (
9711017 self , filepath : str , output_type : str , prefix : str = "intermediate"
9721018 ):
1019+ """Generate a new filename if filepath is a directory."""
9731020 if Path (filepath ).is_dir ():
9741021 self .logger .info (
9751022 f"Generating a new filename with Default Naming Convention in directory path { filepath }
0 commit comments