scanoss 1.20.5__py3-none-any.whl → 1.22.0__py3-none-any.whl

scanoss/results.py

@@ -25,6 +25,8 @@ SPDX-License-Identifier: MIT
 import json
 from typing import Any, Dict, List
 
+from scanoss.utils.abstract_presenter import AbstractPresenter
+
 from .scanossbase import ScanossBase
 
 MATCH_TYPES = ['file', 'snippet']
@@ -47,16 +49,89 @@ PENDING_IDENTIFICATION_FILTERS = {
     'status': ['pending'],
 }
 
-AVAILABLE_OUTPUT_FORMATS = ['json', 'plain']
 
+class ResultsPresenter(AbstractPresenter):
+    """
+    SCANOSS Results presenter class
+    Handles the presentation of the scan results
+    """
+
+    def __init__(self, results_instance, **kwargs):
+        super().__init__(**kwargs)
+        self.results = results_instance
+
+    def _format_json_output(self) -> str:
+        """
+        Format the output data into a JSON object
+        """
+
+        formatted_data = []
+        for item in self.results.data:
+            formatted_data.append(
+                {
+                    'file': item.get('filename'),
+                    'status': item.get('status', 'N/A'),
+                    'match_type': item['id'],
+                    'matched': item.get('matched', 'N/A'),
+                    'purl': (item.get('purl')[0] if item.get('purl') else 'N/A'),
+                    'license': (item.get('licenses')[0].get('name', 'N/A') if item.get('licenses') else 'N/A'),
+                }
+            )
+        try:
+            return json.dumps({'results': formatted_data, 'total': len(formatted_data)}, indent=2)
+        except Exception as e:
+            self.base.print_stderr(f'ERROR: Problem formatting JSON output: {e}')
+            return ''
+
+    def _format_cyclonedx_output(self) -> str:
+        raise NotImplementedError('CycloneDX output is not implemented')
+
+    def _format_spdxlite_output(self) -> str:
+        raise NotImplementedError('SPDXlite output is not implemented')
+
+    def _format_csv_output(self) -> str:
+        raise NotImplementedError('CSV output is not implemented')
+
+    def _format_raw_output(self) -> str:
+        raise NotImplementedError('Raw output is not implemented')
+
+    def _format_plain_output(self) -> str:
+        """Format the output data into a plain text string
+
+        Returns:
+            str: The formatted output data
+        """
+        if not self.results.data:
+            msg = 'No results to present'
+            return msg
 
-class Results(ScanossBase):
+        formatted = ''
+        for item in self.results.data:
+            formatted += f'{self._format_plain_output_item(item)}\n'
+        return formatted
+
+    @staticmethod
+    def _format_plain_output_item(item):
+        purls = item.get('purl', [])
+        licenses = item.get('licenses', [])
+
+        return (
+            f'File: {item.get("filename")}\n'
+            f'Match type: {item.get("id")}\n'
+            f'Status: {item.get("status", "N/A")}\n'
+            f'Matched: {item.get("matched", "N/A")}\n'
+            f'Purl: {purls[0] if purls else "N/A"}\n'
+            f'License: {licenses[0].get("name", "N/A") if licenses else "N/A"}\n'
+        )
+
+
+class Results:
     """
     SCANOSS Results class \n
     Handles the parsing and filtering of the scan results
     """
 
-    def __init__(
+    def __init__(  # noqa: PLR0913
         self,
         debug: bool = False,
         trace: bool = False,
@@ -80,11 +155,17 @@ class Results(ScanossBase):
             output_format (str, optional): Output format. Defaults to None.
         """
 
-        super().__init__(debug, trace, quiet)
+        self.base = ScanossBase(debug, trace, quiet)
         self.data = self._load_and_transform(filepath)
         self.filters = self._load_filters(match_type=match_type, status=status)
-        self.output_file = output_file
-        self.output_format = output_format
+        self.presenter = ResultsPresenter(
+            self,
+            debug=debug,
+            trace=trace,
+            quiet=quiet,
+            output_file=output_file,
+            output_format=output_format,
+        )
 
     def load_file(self, file: str) -> Dict[str, Any]:
         """Load the JSON file
@@ -99,7 +180,7 @@ class Results(ScanossBase):
             try:
                 return json.load(jsonfile)
             except Exception as e:
-                self.print_stderr(f'ERROR: Problem parsing input JSON: {e}')
+                self.base.print_stderr(f'ERROR: Problem parsing input JSON: {e}')
 
     def _load_and_transform(self, file: str) -> List[Dict[str, Any]]:
         """
@@ -174,8 +255,8 @@ class Results(ScanossBase):
     def _validate_filter_values(filter_key: str, filter_value: List[str]):
         if any(value not in AVAILABLE_FILTER_VALUES.get(filter_key, []) for value in filter_value):
             valid_values = ', '.join(AVAILABLE_FILTER_VALUES.get(filter_key, []))
-            raise Exception(
-                f"ERROR: Invalid filter value '{filter_value}' for filter '{filter_key.value}'. "
+            raise ValueError(
+                f"ERROR: Invalid filter value '{filter_value}' for filter '{filter_key}'. "
                 f'Valid values are: {valid_values}'
             )
 
@@ -190,103 +271,5 @@ class Results(ScanossBase):
         return bool(self.data)
 
     def present(self, output_format: str = None, output_file: str = None):
-        """Format and present the results. If no output format is provided, the results will be printed to stdout
-
-        Args:
-            output_format (str, optional): Output format. Defaults to None.
-            output_file (str, optional): Output file. Defaults to None.
-
-        Raises:
-            Exception: Invalid output format
-
-        Returns:
-            None
-        """
-        file_path = output_file or self.output_file
-        fmt = output_format or self.output_format
-
-        if fmt and fmt not in AVAILABLE_OUTPUT_FORMATS:
-            raise Exception(
-                f"ERROR: Invalid output format '{output_format}'. Valid values are: {', '.join(AVAILABLE_OUTPUT_FORMATS)}"
-            )
-
-        if fmt == 'json':
-            return self._present_json(file_path)
-        elif fmt == 'plain':
-            return self._present_plain(file_path)
-        else:
-            return self._present_stdout()
-
-    def _present_json(self, file: str = None):
-        """Present the results in JSON format
-
-        Args:
-            file (str, optional): Output file. Defaults to None.
-        """
-        self.print_to_file_or_stdout(json.dumps(self._format_json_output(), indent=2), file)
-
-    def _format_json_output(self):
-        """
-        Format the output data into a JSON object
-        """
-
-        formatted_data = []
-        for item in self.data:
-            formatted_data.append(
-                {
-                    'file': item.get('filename'),
-                    'status': item.get('status', 'N/A'),
-                    'match_type': item['id'],
-                    'matched': item.get('matched', 'N/A'),
-                    'purl': (item.get('purl')[0] if item.get('purl') else 'N/A'),
-                    'license': (item.get('licenses')[0].get('name', 'N/A') if item.get('licenses') else 'N/A'),
-                }
-            )
-        return {'results': formatted_data, 'total': len(formatted_data)}
-
-    def _present_plain(self, file: str = None):
-        """Present the results in plain text format
-
-        Args:
-            file (str, optional): Output file. Defaults to None.
-
-        Returns:
-            None
-        """
-        if not self.data:
-            return self.print_stderr('No results to present')
-        self.print_to_file_or_stdout(self._format_plain_output(), file)
-
-    def _present_stdout(self):
-        """Present the results to stdout
-
-        Returns:
-            None
-        """
-        if not self.data:
-            return self.print_stderr('No results to present')
-        self.print_to_file_or_stdout(self._format_plain_output())
-
-    def _format_plain_output(self):
-        """
-        Format the output data into a plain text string
-        """
-
-        formatted = ''
-        for item in self.data:
-            formatted += f'{self._format_plain_output_item(item)} \n'
-        return formatted
-
-    @staticmethod
-    def _format_plain_output_item(item):
-        purls = item.get('purl', [])
-        licenses = item.get('licenses', [])
-
-        return (
-            f'File: {item.get("filename")}\n'
-            f'Match type: {item.get("id")}\n'
-            f'Status: {item.get("status", "N/A")}\n'
-            f'Matched: {item.get("matched", "N/A")}\n'
-            f'Purl: {purls[0] if purls else "N/A"}\n'
-            f'License: {licenses[0].get("name", "N/A") if licenses else "N/A"}\n'
-        )
+        """Present the results in the selected format"""
+        self.presenter.present(output_format=output_format, output_file=output_file)

scanoss/scanner.py

@@ -69,7 +69,7 @@ class Scanner(ScanossBase):
     Handle the scanning of files, snippets and dependencies
     """
 
-    def __init__(
+    def __init__( # noqa: PLR0913, PLR0915
         self,
         wfp: str = None,
         scan_output: str = None,
@@ -106,6 +106,7 @@ class Scanner(ScanossBase):
         strip_snippet_ids=None,
         skip_md5_ids=None,
         scan_settings: 'ScanossSettings | None' = None,
+        req_headers: dict = None,
     ):
         """
         Initialise scanning class, including Winnowing, ScanossApi, ThreadedScanning
@@ -129,6 +130,7 @@ class Scanner(ScanossBase):
         self.skip_folders = skip_folders
         self.skip_size = skip_size
         self.skip_extensions = skip_extensions
+        self.req_headers = req_headers
         ver_details = Scanner.version_details()
 
         self.winnowing = Winnowing(
@@ -156,6 +158,7 @@ class Scanner(ScanossBase):
             ca_cert=ca_cert,
             pac=pac,
             retry=retry,
+            req_headers= self.req_headers,
         )
         sc_deps = ScancodeDeps(debug=debug, quiet=quiet, trace=trace, timeout=sc_timeout, sc_command=sc_command)
         grpc_api = ScanossGrpc(
@@ -169,6 +172,7 @@ class Scanner(ScanossBase):
             proxy=proxy,
             pac=pac,
             grpc_proxy=grpc_proxy,
+            req_headers=self.req_headers,
         )
         self.threaded_deps = ThreadedDependencies(sc_deps, grpc_api, debug=debug, quiet=quiet, trace=trace)
         self.nb_threads = nb_threads
@@ -302,7 +306,7 @@ class Scanner(ScanossBase):
 
         success = True
         if not scan_dir:
-            raise Exception(f'ERROR: Please specify a folder to scan')
+            raise Exception('ERROR: Please specify a folder to scan')
         if not os.path.exists(scan_dir) or not os.path.isdir(scan_dir):
             raise Exception(f'ERROR: Specified folder does not exist or is not a folder: {scan_dir}')
         if not self.is_file_or_snippet_scan() and not self.is_dependency_scan():
@@ -386,7 +390,8 @@ class Scanner(ScanossBase):
             file_count += 1
             if self.threaded_scan:
                 wfp_size = len(wfp.encode('utf-8'))
-                # If the WFP is bigger than the max post size and we already have something stored in the scan block, add it to the queue
+                # If the WFP is bigger than the max post size and we already have something stored in the scan block,
+                # add it to the queue
                 if scan_block != '' and (wfp_size + scan_size) >= self.max_post_size:
                     self.threaded_scan.queue_add(scan_block)
                     queue_size += 1
@@ -436,7 +441,7 @@ class Scanner(ScanossBase):
         self.threaded_scan.update_bar(create=True, file_count=file_count)
         if not scan_started:
             if not self.threaded_scan.run(wait=False):  # Run the scan but do not wait for it to complete
-                self.print_stderr(f'Warning: Some errors encounted while scanning. Results might be incomplete.')
+                self.print_stderr('Warning: Some errors encounted while scanning. Results might be incomplete.')
                 success = False
         return success
 
@@ -457,14 +462,14 @@ class Scanner(ScanossBase):
         dep_responses = None
         if self.is_file_or_snippet_scan():
             if not self.threaded_scan.complete():  # Wait for the scans to complete
-                self.print_stderr(f'Warning: Scanning analysis ran into some trouble.')
+                self.print_stderr('Warning: Scanning analysis ran into some trouble.')
                 success = False
             self.threaded_scan.complete_bar()
             scan_responses = self.threaded_scan.responses
         if self.is_dependency_scan():
             self.print_msg('Retrieving dependency data...')
             if not self.threaded_deps.complete():
-                self.print_stderr(f'Warning: Dependency analysis ran into some trouble.')
+                self.print_stderr('Warning: Dependency analysis ran into some trouble.')
                 success = False
             dep_responses = self.threaded_deps.responses
 
@@ -546,7 +551,7 @@ class Scanner(ScanossBase):
         """
         success = True
         if not file:
-            raise Exception(f'ERROR: Please specify a file to scan')
+            raise Exception('ERROR: Please specify a file to scan')
         if not os.path.exists(file) or not os.path.isfile(file):
             raise Exception(f'ERROR: Specified file does not exist or is not a file: {file}')
         if not self.is_file_or_snippet_scan() and not self.is_dependency_scan():
@@ -583,7 +588,7 @@ class Scanner(ScanossBase):
         """
         success = True
         if not file:
-            raise Exception(f'ERROR: Please specify a file to scan')
+            raise Exception('ERROR: Please specify a file to scan')
         if not os.path.exists(file) or not os.path.isfile(file):
             raise Exception(f'ERROR: Specified files does not exist or is not a file: {file}')
         self.print_debug(f'Fingerprinting {file}...')
@@ -608,7 +613,7 @@ class Scanner(ScanossBase):
         """
         success = True
         if not files:
-            raise Exception(f'ERROR: Please provide a non-empty list of filenames to scan')
+            raise Exception('ERROR: Please provide a non-empty list of filenames to scan')
 
         file_filters = FileFilters(
             debug=self.debug,
@@ -671,7 +676,7 @@ class Scanner(ScanossBase):
                     scan_started = True
                     if not self.threaded_scan.run(wait=False):
                         self.print_stderr(
-                            f'Warning: Some errors encounted while scanning. Results might be incomplete.'
+                            'Warning: Some errors encounted while scanning. Results might be incomplete.'
                         )
                         success = False
 
@@ -704,12 +709,12 @@ class Scanner(ScanossBase):
         """
         success = True
         if not files:
-            raise Exception(f'ERROR: Please specify a list of files to scan')
+            raise Exception('ERROR: Please specify a list of files to scan')
         if not self.is_file_or_snippet_scan():
             raise Exception(f'ERROR: file or snippet scan options have to be set to scan files: {files}')
         if self.is_dependency_scan() or deps_file:
             raise Exception(
-                f'ERROR: The dependency scan option is currently not supported when scanning a list of files'
+                'ERROR: The dependency scan option is currently not supported when scanning a list of files'
             )
         if self.scan_output:
             self.print_msg(f'Writing results to {self.scan_output}...')
@@ -731,9 +736,9 @@ class Scanner(ScanossBase):
         """
         success = True
         if not filename:
-            raise Exception(f'ERROR: Please specify a filename to scan')
+            raise Exception('ERROR: Please specify a filename to scan')
         if not contents:
-            raise Exception(f'ERROR: Please specify a file contents to scan')
+            raise Exception('ERROR: Please specify a file contents to scan')
 
         self.print_debug(f'Fingerprinting {filename}...')
         wfp = self.winnowing.wfp_for_contents(filename, False, contents)
@@ -924,7 +929,7 @@ class Scanner(ScanossBase):
                         scan_started = True
                         if not self.threaded_scan.run(wait=False):
                             self.print_stderr(
-                                f'Warning: Some errors encounted while scanning. Results might be incomplete.'
+                                'Warning: Some errors uncounted while scanning. Results might be incomplete.'
                             )
                             success = False
             # End for loop
@@ -948,7 +953,7 @@ class Scanner(ScanossBase):
         """
         success = True
         if not wfp:
-            raise Exception(f'ERROR: Please specify a WFP to scan')
+            raise Exception('ERROR: Please specify a WFP to scan')
         raw_output = '{\n'
         scan_resp = self.scanoss_api.scan(wfp)
         if scan_resp is not None:
@@ -984,9 +989,9 @@ class Scanner(ScanossBase):
         :return:
         """
         if not filename:
-            raise Exception(f'ERROR: Please specify a filename to scan')
+            raise Exception('ERROR: Please specify a filename to scan')
         if not contents:
-            raise Exception(f'ERROR: Please specify a file contents to scan')
+            raise Exception('ERROR: Please specify a file contents to scan')
 
         self.print_debug(f'Fingerprinting {filename}...')
         wfp = self.winnowing.wfp_for_contents(filename, False, contents)
@@ -1005,7 +1010,7 @@ class Scanner(ScanossBase):
         Fingerprint the specified file
         """
         if not scan_file:
-            raise Exception(f'ERROR: Please specify a file to fingerprint')
+            raise Exception('ERROR: Please specify a file to fingerprint')
         if not os.path.exists(scan_file) or not os.path.isfile(scan_file):
             raise Exception(f'ERROR: Specified file does not exist or is not a file: {scan_file}')
 
@@ -1026,7 +1031,7 @@ class Scanner(ScanossBase):
         Fingerprint the specified folder producing fingerprints
         """
         if not scan_dir:
-            raise Exception(f'ERROR: Please specify a folder to fingerprint')
+            raise Exception('ERROR: Please specify a folder to fingerprint')
         if not os.path.exists(scan_dir) or not os.path.isdir(scan_dir):
             raise Exception(f'ERROR: Specified folder does not exist or is not a folder: {scan_dir}')
         file_filters = FileFilters(

scanoss/scanners/__init__.py

@@ -0,0 +1,23 @@
+"""
+SPDX-License-Identifier: MIT
+
+  Copyright (c) 2025, SCANOSS
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+"""