scanoss 1.19.6__py3-none-any.whl → 1.20.1__py3-none-any.whl

scanoss/scanoss_settings.py

@@ -119,7 +119,9 @@ class ScanossSettings(ScanossBase):
         result = validate_json_file(json_file)
         if not result.is_valid:
             if result.error_code == JSON_ERROR_FILE_NOT_FOUND or result.error_code == JSON_ERROR_FILE_EMPTY:
-                self.print_msg(f'WARNING: The supplied settings file "{filepath}" was not found or is empty. Skipping...')
+                self.print_msg(
+                    f'WARNING: The supplied settings file "{filepath}" was not found or is empty. Skipping...'
+                )
                 return self
             else:
                 raise ScanossSettingsError(f'Problem with settings file. {result.error}')
@@ -234,8 +236,8 @@ class ScanossSettings(ScanossBase):
             replace_bom_entries = self._remove_duplicates(self.normalize_bom_entries(self.get_bom_replace()))
             self.print_debug(
                 f"Scan type set to 'identify'. Adding {len(include_bom_entries) + len(replace_bom_entries)} components as context to the scan. \n"
-                f"From Include list: {[entry['purl'] for entry in include_bom_entries]} \n"
-                f"From Replace list: {[entry['purl'] for entry in replace_bom_entries]} \n"
+                f'From Include list: {[entry["purl"] for entry in include_bom_entries]} \n'
+                f'From Replace list: {[entry["purl"] for entry in replace_bom_entries]} \n'
             )
             return include_bom_entries + replace_bom_entries
         return self.normalize_bom_entries(self.get_bom_remove())

scanoss/scanossapi.py

@@ -1,26 +1,27 @@
 """
- SPDX-License-Identifier: MIT
-
-   Copyright (c) 2022, 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.
+SPDX-License-Identifier: MIT
+
+  Copyright (c) 2022, 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.
 """
+
 import logging
 import os
 import sys
@@ -39,10 +40,10 @@ from .scanossbase import ScanossBase
 from . import __version__
 
 
-DEFAULT_URL = "https://api.osskb.org/scan/direct"  # default free service URL
-DEFAULT_URL2 = "https://api.scanoss.com/scan/direct"  # default premium service URL
-SCANOSS_SCAN_URL = os.environ.get("SCANOSS_SCAN_URL") if os.environ.get("SCANOSS_SCAN_URL") else DEFAULT_URL
-SCANOSS_API_KEY = os.environ.get("SCANOSS_API_KEY") if os.environ.get("SCANOSS_API_KEY") else ''
+DEFAULT_URL = 'https://api.osskb.org/scan/direct'  # default free service URL
+DEFAULT_URL2 = 'https://api.scanoss.com/scan/direct'  # default premium service URL
+SCANOSS_SCAN_URL = os.environ.get('SCANOSS_SCAN_URL') if os.environ.get('SCANOSS_SCAN_URL') else DEFAULT_URL
+SCANOSS_API_KEY = os.environ.get('SCANOSS_API_KEY') if os.environ.get('SCANOSS_API_KEY') else ''
 
 
 class ScanossApi(ScanossBase):
@@ -51,10 +52,23 @@ class ScanossApi(ScanossBase):
     Currently support posting scan requests to the SCANOSS streaming API
     """
 
-    def __init__(self, scan_format: str = None, flags: str = None,
-                 url: str = None, api_key: str = None, debug: bool = False, trace: bool = False, quiet: bool = False,
-                 timeout: int = 180, ver_details: str = None, ignore_cert_errors: bool = False,
-                 proxy: str = None, ca_cert: str = None, pac: PACFile = None, retry: int = 5):
+    def __init__(
+        self,
+        scan_format: str = None,
+        flags: str = None,
+        url: str = None,
+        api_key: str = None,
+        debug: bool = False,
+        trace: bool = False,
+        quiet: bool = False,
+        timeout: int = 180,
+        ver_details: str = None,
+        ignore_cert_errors: bool = False,
+        proxy: str = None,
+        ca_cert: str = None,
+        pac: PACFile = None,
+        retry: int = 5,
+    ):
         """
         Initialise the SCANOSS API
         :param scan_format: Scan format (default plain)
@@ -74,7 +88,7 @@ class ScanossApi(ScanossBase):
         super().__init__(debug, trace, quiet)
         self.url = url if url else SCANOSS_SCAN_URL
         self.api_key = api_key if api_key else SCANOSS_API_KEY
-        if self.api_key and not url and not os.environ.get("SCANOSS_SCAN_URL"):
+        if self.api_key and not url and not os.environ.get('SCANOSS_SCAN_URL'):
             self.url = DEFAULT_URL2  # API key specific and no alternative URL, so use the default premium
         self.sbom = None
         self.scan_format = scan_format if scan_format else 'plain'
@@ -108,7 +122,7 @@ class ScanossApi(ScanossBase):
             self.verify = ca_cert
             self.session.verify = ca_cert
         self.proxies = {'https': proxy, 'http': proxy} if proxy else None
-        if self. proxies:
+        if self.proxies:
             self.session.proxies = self.proxies
 
     def scan(self, wfp: str, context: str = None, scan_id: int = None):
@@ -122,16 +136,16 @@ class ScanossApi(ScanossBase):
         request_id = str(uuid.uuid4())
         form_data = {}
         if self.sbom:
-            form_data['type'] = self.sbom.get("scan_type")
-            form_data['assets'] = self.sbom.get("assets")
+            form_data['type'] = self.sbom.get('scan_type')
+            form_data['assets'] = self.sbom.get('assets')
         if self.scan_format:
             form_data['format'] = self.scan_format
         if self.flags:
             form_data['flags'] = self.flags
         if context:
             form_data['context'] = context
-        
-        scan_files = {'file': ("%s.wfp" % request_id, wfp)}
+
+        scan_files = {'file': ('%s.wfp' % request_id, wfp)}
         headers = self.headers
         headers['x-request-id'] = request_id  # send a unique request id for each post
         r = None
@@ -140,75 +154,87 @@ class ScanossApi(ScanossBase):
             retry += 1
             try:
                 r = None
-                r = self.session.post(self.url, files=scan_files, data=form_data, headers=self.headers,
-                                      timeout=self.timeout
-                                      )
+                r = self.session.post(
+                    self.url, files=scan_files, data=form_data, headers=self.headers, timeout=self.timeout
+                )
             except (requests.exceptions.SSLError, requests.exceptions.ProxyError) as e:
                 self.print_stderr(f'ERROR: Exception ({e.__class__.__name__}) POSTing data - {e}.')
-                raise Exception(f"ERROR: The SCANOSS API request failed for {self.url}") from e
+                raise Exception(f'ERROR: The SCANOSS API request failed for {self.url}') from e
             except (requests.exceptions.Timeout, requests.exceptions.ConnectionError) as e:
                 if retry > self.retry_limit:  # Timed out retry_limit or more times, fail
                     self.print_stderr(f'ERROR: {e.__class__.__name__} POSTing data ({request_id}) - {e}: {scan_files}')
-                    raise Exception(f"ERROR: The SCANOSS API request timed out ({e.__class__.__name__}) for"
-                                    f" {self.url}") from e
+                    raise Exception(
+                        f'ERROR: The SCANOSS API request timed out ({e.__class__.__name__}) for {self.url}'
+                    ) from e
                 else:
                     self.print_stderr(f'Warning: {e.__class__.__name__} communicating with {self.url}. Retrying...')
                     time.sleep(5)
             except Exception as e:
-                self.print_stderr(f'ERROR: Exception ({e.__class__.__name__}) POSTing data ({request_id}) - {e}:'
-                                  f' {scan_files}')
-                raise Exception(f"ERROR: The SCANOSS API request failed for {self.url}") from e
+                self.print_stderr(
+                    f'ERROR: Exception ({e.__class__.__name__}) POSTing data ({request_id}) - {e}: {scan_files}'
+                )
+                raise Exception(f'ERROR: The SCANOSS API request failed for {self.url}') from e
             else:
                 if r is None:
                     if retry > self.retry_limit:  # No response retry_limit or more times, fail
                         self.save_bad_req_wfp(scan_files, request_id, scan_id)
-                        raise Exception(f"ERROR: The SCANOSS API request ({request_id}) response object is empty "
-                                        f"for {self.url}")
+                        raise Exception(
+                            f'ERROR: The SCANOSS API request ({request_id}) response object is empty for {self.url}'
+                        )
                     else:
                         self.print_stderr(f'Warning: No response received from {self.url}. Retrying...')
                         time.sleep(5)
                 elif r.status_code == 503:  # Service limits have most likely been reached
-                    self.print_stderr(f'ERROR: SCANOSS API rejected the scan request ({request_id}) due to '
-                                      f'service limits being exceeded')
+                    self.print_stderr(
+                        f'ERROR: SCANOSS API rejected the scan request ({request_id}) due to '
+                        f'service limits being exceeded'
+                    )
                     self.print_stderr(f'ERROR: Details: {r.text.strip()}')
-                    raise Exception(f"ERROR: {r.status_code} - The SCANOSS API request ({request_id}) rejected "
-                                    f"for {self.url} due to service limits being exceeded.")
+                    raise Exception(
+                        f'ERROR: {r.status_code} - The SCANOSS API request ({request_id}) rejected '
+                        f'for {self.url} due to service limits being exceeded.'
+                    )
                 elif r.status_code >= 400:
                     if retry > self.retry_limit:  # No response retry_limit or more times, fail
                         self.save_bad_req_wfp(scan_files, request_id, scan_id)
                         raise Exception(
-                            f"ERROR: The SCANOSS API returned the following error: HTTP {r.status_code}, "
-                            f"{r.text.strip()}")
+                            f'ERROR: The SCANOSS API returned the following error: HTTP {r.status_code}, '
+                            f'{r.text.strip()}'
+                        )
                     else:
                         self.save_bad_req_wfp(scan_files, request_id, scan_id)
-                        self.print_stderr(f'Warning: Error response code {r.status_code} ({r.text.strip()}) from '
-                                          f'{self.url}. Retrying...')
+                        self.print_stderr(
+                            f'Warning: Error response code {r.status_code} ({r.text.strip()}) from '
+                            f'{self.url}. Retrying...'
+                        )
                         time.sleep(5)
                 else:
                     break  # Valid response, break out of the retry loop
         # End of while loop
         if r is None:
             self.save_bad_req_wfp(scan_files, request_id, scan_id)
-            raise Exception(f"ERROR: The SCANOSS API request response object is empty for {self.url}")
+            raise Exception(f'ERROR: The SCANOSS API request response object is empty for {self.url}')
         try:
             if 'xml' in self.scan_format:  # TODO remove XML parsing option?
                 return r.text
             json_resp = r.json()
             return json_resp
         except (JSONDecodeError, Exception) as e:
-            self.print_stderr(f'ERROR: The SCANOSS API returned an invalid JSON '
-                              f'({e.__class__.__name__} - {request_id}): {e}')
+            self.print_stderr(
+                f'ERROR: The SCANOSS API returned an invalid JSON ({e.__class__.__name__} - {request_id}): {e}'
+            )
             bad_json_file = f'bad_json-{scan_id}-{request_id}.txt' if scan_id else f'bad_json-{request_id}.txt'
             self.print_stderr(f'Ignoring result. Please look in "{bad_json_file}" for more details.')
             try:
                 with open(bad_json_file, 'w') as f:
-                    f.write(f"---Request ID Begin---\n{request_id}\n---Request ID End---\n")
-                    f.write(f"---WFP Begin---\n{scan_files}\n---WFP End---\n---Bad JSON Begin---\n")
+                    f.write(f'---Request ID Begin---\n{request_id}\n---Request ID End---\n')
+                    f.write(f'---WFP Begin---\n{scan_files}\n---WFP End---\n---Bad JSON Begin---\n')
                     f.write(r.text)
-                    f.write("---Bad JSON End---\n")
+                    f.write('---Bad JSON End---\n')
             except Exception as ee:
-                self.print_stderr(f'Warning: Issue writing bad json file - {bad_json_file} ({ee.__class__.__name__}):'
-                                  f' {ee}')
+                self.print_stderr(
+                    f'Warning: Issue writing bad json file - {bad_json_file} ({ee.__class__.__name__}): {ee}'
+                )
             return None
 
     def save_bad_req_wfp(self, scan_files, request_id, scan_id):
@@ -220,19 +246,22 @@ class ScanossApi(ScanossBase):
         """
         bad_req_file = f'bad_request-{scan_id}-{request_id}.txt' if scan_id else f'bad_request-{request_id}.txt'
         try:
-            self.print_stderr(f'No response object returned from API. Please look in "{bad_req_file}" for the '
-                              f'offending WFP.')
+            self.print_stderr(
+                f'No response object returned from API. Please look in "{bad_req_file}" for the offending WFP.'
+            )
             with open(bad_req_file, 'w') as f:
-                f.write(f"---Request ID Begin---\n{request_id}\n---Request ID End---\n")
-                f.write(f"---WFP Begin---\n{scan_files}\n---WFP End---\n")
+                f.write(f'---Request ID Begin---\n{request_id}\n---Request ID End---\n')
+                f.write(f'---WFP Begin---\n{scan_files}\n---WFP End---\n')
         except Exception as ee:
-            self.print_stderr(f'Warning: Issue writing bad request file - {bad_req_file} ({ee.__class__.__name__}):'
-                              f' {ee}')
-    
+            self.print_stderr(
+                f'Warning: Issue writing bad request file - {bad_req_file} ({ee.__class__.__name__}): {ee}'
+            )
+
     def set_sbom(self, sbom):
         self.sbom = sbom
         return self
 
+
 #
 # End of ScanossApi Class
 #

scanoss/scanossbase.py

@@ -1,25 +1,25 @@
 """
- SPDX-License-Identifier: MIT
+SPDX-License-Identifier: MIT
 
-   Copyright (c) 2021, SCANOSS
+  Copyright (c) 2021, 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:
+  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 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.
+  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.
 """
 
 import sys
@@ -85,7 +85,7 @@ class ScanossBase:
         Print message to file if provided or stdout
         """
         if file:
-            with open(file, "w") as f:
+            with open(file, 'w') as f:
                 f.write(msg)
         else:
             self.print_stdout(msg)
@@ -95,7 +95,7 @@ class ScanossBase:
         Print message to file if provided or stderr
         """
         if file:
-            with open(file, "w") as f:
+            with open(file, 'w') as f:
                 f.write(msg)
         else:
             self.print_stderr(msg)