Apply cosmetic refactorings

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

docs/source/conf.py

@@ -94,7 +94,8 @@
 html_show_sphinx = True
 
 # Define CSS and HTML abbreviations used in .rst files.  These are examples.
-# .. role:: is used to refer to styles defined in _static/theme_overrides.css and is used like this: :red:`text`
+# .. role:: is used to refer to styles defined in _static/theme_overrides.css
+# and is used like this: :red:`text`
 rst_prolog = """
 .. |psf| replace:: Python Software Foundation
 

etc/scripts/check_thirdparty.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -41,8 +40,7 @@ def check_thirdparty_dir(
     """
     Check a thirdparty directory for problems and print these on screen.
     """
-    # check for problems
-    print(f"==> CHECK FOR PROBLEMS")
+    print("==> CHECK FOR PROBLEMS")
     utils_thirdparty.find_problems(
         dest_dir=dest,
         report_missing_sources=sdists,

etc/scripts/fetch_thirdparty.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -10,7 +9,6 @@
 #
 
 import itertools
-import os
 import sys
 from collections import defaultdict
 
@@ -109,7 +107,8 @@
 @click.option(
     "--use-cached-index",
     is_flag=True,
-    help="Use on disk cached PyPI indexes list of packages and versions and do not refetch if present.",
+    help="Use on disk cached PyPI indexes list of packages and versions and "
+    "do not refetch if present.",
 )
 @click.option(
     "--sdist-only",
@@ -261,7 +260,7 @@ def fetch_thirdparty(
                 if not fetched:
                     wheels_or_sdist_not_found[f"{name}=={version}"].append(environment)
                     if TRACE:
-                        print(f"      NOT FOUND")
+                        print("      NOT FOUND")
 
         if sdists or (f"{name}=={version}" in wheels_or_sdist_not_found and name in sdist_only):
             if TRACE:
@@ -276,17 +275,17 @@ def fetch_thirdparty(
             if not fetched:
                 wheels_or_sdist_not_found[f"{name}=={version}"].append("sdist")
                 if TRACE:
-                    print(f"      NOT FOUND")
+                    print("      NOT FOUND")
 
     mia = []
     for nv, dists in wheels_or_sdist_not_found.items():
         name, _, version = nv.partition("==")
         if name in no_dist:
             continue
-        sdist_missing = sdists and "sdist" in dists and not name in wheel_only
+        sdist_missing = sdists and "sdist" in dists and name not in wheel_only
         if sdist_missing:
             mia.append(f"SDist missing: {nv} {dists}")
-        wheels_missing = wheels and any(d for d in dists if d != "sdist") and not name in sdist_only
+        wheels_missing = wheels and any(d for d in dists if d != "sdist") and name not in sdist_only
         if wheels_missing:
             mia.append(f"Wheels missing: {nv} {dists}")
 
@@ -295,12 +294,12 @@ def fetch_thirdparty(
             print(m)
         raise Exception(mia)
 
-    print(f"==> FETCHING OR CREATING ABOUT AND LICENSE FILES")
+    print("==> FETCHING OR CREATING ABOUT AND LICENSE FILES")
     utils_thirdparty.fetch_abouts_and_licenses(dest_dir=dest_dir, use_cached_index=use_cached_index)
     utils_thirdparty.clean_about_files(dest_dir=dest_dir)
 
     # check for problems
-    print(f"==> CHECK FOR PROBLEMS")
+    print("==> CHECK FOR PROBLEMS")
     utils_thirdparty.find_problems(
         dest_dir=dest_dir,
         report_missing_sources=sdists,

etc/scripts/gen_pypi_simple.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 # SPDX-License-Identifier: BSD-2-Clause-Views AND MIT
 # Copyright (c) 2010 David Wolever <david@wolever.net>. All rights reserved.
@@ -132,7 +131,7 @@ def build_links_package_index(packages_by_package_name, base_url):
     Return an HTML document as string which is a links index of all packages
     """
     document = []
-    header = f"""<!DOCTYPE html>
+    header = """<!DOCTYPE html>
 <html>
   <head>
     <title>Links for all packages</title>
@@ -177,13 +176,13 @@ def simple_index_entry(self, base_url):
 
 def build_pypi_index(directory, base_url="https://thirdparty.aboutcode.org/pypi"):
     """
-    Using a ``directory`` directory of wheels and sdists, create the a PyPI
-    simple directory index at ``directory``/simple/ populated with the proper
-    PyPI simple index directory structure crafted using symlinks.
+    Create the a PyPI simple directory index using a ``directory`` directory of wheels and sdists in
+    the direvctory at ``directory``/simple/ populated with the proper PyPI simple index directory
+    structure crafted using symlinks.
 
-    WARNING: The ``directory``/simple/ directory is removed if it exists.
-    NOTE: in addition to the a PyPI simple index.html there is also a links.html
-    index file generated which is suitable to use with pip's --find-links
+    WARNING: The ``directory``/simple/ directory is removed if it exists. NOTE: in addition to the a
+    PyPI simple index.html there is also a links.html index file generated which is suitable to use
+    with pip's --find-links
     """
 
     directory = Path(directory)

etc/scripts/gen_requirements.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -34,7 +33,8 @@ def gen_requirements():
         type=pathlib.Path,
         required=True,
         metavar="DIR",
-        help="Path to the 'site-packages' directory where wheels are installed such as lib/python3.6/site-packages",
+        help="Path to the 'site-packages' directory where wheels are installed "
+        "such as lib/python3.12/site-packages",
     )
     parser.add_argument(
         "-r",

etc/scripts/gen_requirements_dev.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -36,7 +35,8 @@ def gen_dev_requirements():
         type=pathlib.Path,
         required=True,
         metavar="DIR",
-        help='Path to the "site-packages" directory where wheels are installed such as lib/python3.6/site-packages',
+        help="Path to the 'site-packages' directory where wheels are installed "
+        "such as lib/python3.12/site-packages",
     )
     parser.add_argument(
         "-d",

etc/scripts/test_utils_pip_compatibility_tags.py

@@ -1,4 +1,5 @@
-"""Generate and work with PEP 425 Compatibility Tags.
+"""
+Generate and work with PEP 425 Compatibility Tags.
 
 copied from pip-20.3.1 pip/tests/unit/test_utils_compatibility_tags.py
 download_url: https://raw.githubusercontent.com/pypa/pip/20.3.1/tests/unit/test_utils_compatibility_tags.py
@@ -50,7 +51,7 @@ def test_version_info_to_nodot(version_info, expected):
     assert actual == expected
 
 
-class Testcompatibility_tags(object):
+class Testcompatibility_tags:
     def mock_get_config_var(self, **kwd):
         """
         Patch sysconfig.get_config_var for arbitrary keys.
@@ -81,7 +82,7 @@ def test_no_hyphen_tag(self):
             assert "-" not in tag.platform
 
 
-class TestManylinux2010Tags(object):
+class TestManylinux2010Tags:
     @pytest.mark.parametrize(
         "manylinux2010,manylinux1",
         [
@@ -104,7 +105,7 @@ def test_manylinux2010_implies_manylinux1(self, manylinux2010, manylinux1):
             assert arches[:2] == [manylinux2010, manylinux1]
 
 
-class TestManylinux2014Tags(object):
+class TestManylinux2014Tags:
     @pytest.mark.parametrize(
         "manylinuxA,manylinuxB",
         [

etc/scripts/utils_dejacode.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -25,7 +24,7 @@
 
 DEJACODE_API_URL_PACKAGES = f"{DEJACODE_API_URL}packages/"
 DEJACODE_API_HEADERS = {
-    "Authorization": "Token {}".format(DEJACODE_API_KEY),
+    "Authorization": f"Token {DEJACODE_API_KEY}",
     "Accept": "application/json; indent=4",
 }
 
@@ -50,6 +49,7 @@ def fetch_dejacode_packages(params):
         DEJACODE_API_URL_PACKAGES,
         params=params,
         headers=DEJACODE_API_HEADERS,
+        timeout=10,
     )
 
     return response.json()["results"]
@@ -93,7 +93,7 @@ def update_with_dejacode_about_data(distribution):
     if package_data:
         package_api_url = package_data["api_url"]
         about_url = f"{package_api_url}about"
-        response = requests.get(about_url, headers=DEJACODE_API_HEADERS)
+        response = requests.get(about_url, headers=DEJACODE_API_HEADERS, timeout=10)
         # note that this is YAML-formatted
         about_text = response.json()["about_data"]
         about_data = saneyaml.load(about_text)
@@ -113,7 +113,7 @@ def fetch_and_save_about_files(distribution, dest_dir="thirdparty"):
     if package_data:
         package_api_url = package_data["api_url"]
         about_url = f"{package_api_url}about_files"
-        response = requests.get(about_url, headers=DEJACODE_API_HEADERS)
+        response = requests.get(about_url, headers=DEJACODE_API_HEADERS, timeout=10)
         about_zip = response.content
         with io.BytesIO(about_zip) as zf:
             with zipfile.ZipFile(zf) as zi:
@@ -201,6 +201,7 @@ def create_dejacode_package(distribution):
         DEJACODE_API_URL_PACKAGES,
         data=new_package_payload,
         headers=DEJACODE_API_HEADERS,
+        timeout=10,
     )
     new_package_data = response.json()
     if response.status_code != 201:

etc/scripts/utils_pip_compatibility_tags.py

@@ -1,4 +1,5 @@
-"""Generate and work with PEP 425 Compatibility Tags.
+"""
+Generate and work with PEP 425 Compatibility Tags.
 
 copied from pip-20.3.1 pip/_internal/utils/compatibility_tags.py
 download_url: https://github.com/pypa/pip/blob/20.3.1/src/pip/_internal/utils/compatibility_tags.py
@@ -130,7 +131,7 @@ def _get_custom_interpreter(implementation=None, version=None):
         implementation = interpreter_name()
     if version is None:
         version = interpreter_version()
-    return "{}{}".format(implementation, version)
+    return f"{implementation}{version}"
 
 
 def get_supported(
@@ -140,7 +141,8 @@ def get_supported(
     abis=None,  # type: Optional[List[str]]
 ):
     # type: (...) -> List[Tag]
-    """Return a list of supported tags for each version specified in
+    """
+    Return a list of supported tags for each version specified in
     `versions`.
 
     :param version: a string version, of the form "33" or "32",

etc/scripts/utils_requirements.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 #
 # Copyright (c) nexB Inc. and others. All rights reserved.
 # ScanCode is a trademark of nexB Inc.
@@ -40,7 +39,7 @@ def get_required_name_versions(requirement_lines, with_unpinned=False):
         req_line = req_line.strip()
         if not req_line or req_line.startswith("#"):
             continue
-        if req_line.startswith("-") or (not with_unpinned and not "==" in req_line):
+        if req_line.startswith("-") or (not with_unpinned and "==" not in req_line):
             print(f"Requirement line is not supported: ignored: {req_line}")
             continue
         yield get_required_name_version(requirement=req_line, with_unpinned=with_unpinned)