Format code with Ruff and run doc8 for documentation validation.

Signed-off-by: Chin Yeung Li <tli@nexb.com>

Author: chinyeungli

docs/source/conf.py

@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'aboutcode-toolkit'
+project = "aboutcode-toolkit"
 copyright = "nexB Inc. and others."
 author = "AboutCode.org authors and contributors"
 

src/attributecode/__init__.py

@@ -20,9 +20,9 @@
 
 import saneyaml
 
-__version__ = '11.1.1'
+__version__ = "11.1.1"
 
-__about_spec_version__ = '4.0.0'
+__about_spec_version__ = "4.0.0"
 
 __copyright__ = """
 Copyright (c) nexB Inc. All rights reserved. http://dejacode.org
@@ -38,7 +38,7 @@
 """
 
 
-class Error(namedtuple('Error', ['severity', 'message'])):
+class Error(namedtuple("Error", ["severity", "message"])):
     """
     An Error data with a severity and message.
     """
@@ -51,12 +51,11 @@ def __new__(self, severity, message):
                 message = self._clean_string(repr(message))
                 message = message.strip('"')
 
-        return super(Error, self).__new__(
-            Error, severity, message)
+        return super(Error, self).__new__(Error, severity, message)
 
     def __repr__(self, *args, **kwargs):
         sev, msg = self._get_values()
-        return 'Error(%(sev)s,  %(msg)s)' % locals()
+        return "Error(%(sev)s,  %(msg)s)" % locals()
 
     def __eq__(self, other):
         return repr(self) == repr(other)
@@ -68,7 +67,7 @@ def _get_values(self):
 
     def render(self):
         sev, msg = self._get_values()
-        return '%(sev)s: %(msg)s' % locals()
+        return "%(sev)s: %(msg)s" % locals()
 
     def to_dict(self, *args, **kwargs):
         """
@@ -85,7 +84,7 @@ def _clean_string(s):
         if not s:
             return s
         if s.startswith(('u"', "u'")):
-            s = s.lstrip('u')
+            s = s.lstrip("u")
         s = s.replace('[u"', '["')
         s = s.replace("[u'", "['")
         s = s.replace("(u'", "('")
@@ -107,10 +106,10 @@ def _clean_string(s):
 NOTSET = 0
 
 severities = {
-    CRITICAL: 'CRITICAL',
-    ERROR: 'ERROR',
-    WARNING: 'WARNING',
-    INFO: 'INFO',
-    DEBUG: 'DEBUG',
-    NOTSET: 'NOTSET'
+    CRITICAL: "CRITICAL",
+    ERROR: "ERROR",
+    WARNING: "WARNING",
+    INFO: "INFO",
+    DEBUG: "DEBUG",
+    NOTSET: "NOTSET",
 }

src/attributecode/__main__.py

@@ -14,6 +14,7 @@
 #  limitations under the License.
 # ============================================================================
 
-if __name__ == '__main__':  # pragma: nocover
+if __name__ == "__main__":  # pragma: nocover
     from attributecode import cmd
+
     cmd.about()

src/attributecode/api.py

@@ -36,18 +36,14 @@ def request_license_data(api_url, api_key, license_key):
     `license_key`. Send a request to `api_url` authenticating with `api_key`.
     """
     headers = {
-        'Authorization': 'Token %s' % api_key,
-    }
-    payload = {
-        'api_key': api_key,
-        'key': license_key,
-        'format': 'json'
+        "Authorization": "Token %s" % api_key,
     }
+    payload = {"api_key": api_key, "key": license_key, "format": "json"}
 
-    api_url = api_url.rstrip('/')
+    api_url = api_url.rstrip("/")
     payload = urlencode(payload)
 
-    full_url = '%(api_url)s/?%(payload)s' % locals()
+    full_url = "%(api_url)s/?%(payload)s" % locals()
     # handle special characters in URL such as space etc.
     quoted_url = quote(full_url, safe="%/:=&?~#+!$,;'@()*[]")
 
@@ -58,23 +54,21 @@ def request_license_data(api_url, api_key, license_key):
         response_content = response.text
         # FIXME: this should be an ordered dict
         license_data = json.loads(response_content)
-        if not license_data.get('results', []):
-            msg = u"Invalid 'license': %s" % license_key
+        if not license_data.get("results", []):
+            msg = "Invalid 'license': %s" % license_key
             errors.append(Error(ERROR, msg))
     except HTTPError as http_e:
-        msg = (u"Authorization denied. Invalid '--api_key'. "
-               u"License generation is skipped.")
+        msg = "Authorization denied. Invalid '--api_key'. License generation is skipped."
         errors.append(Error(ERROR, msg))
     except Exception as e:
         # Already checked the authorization and accessible of the URL.
         # The only exception left is URL is accessible, but it's not a valid API URL
-        msg = (u"Invalid '--api_url'. "
-               u"License generation is skipped.")
+        msg = "Invalid '--api_url'. License generation is skipped."
         errors.append(Error(ERROR, msg))
 
     finally:
-        if license_data.get('count') == 1:
-            license_data = license_data.get('results')[0]
+        if license_data.get("count") == 1:
+            license_data = license_data.get("results")[0]
         else:
             license_data = {}
 

src/attributecode/attrib.py

@@ -30,15 +30,19 @@
 from attributecode.attrib_util import multi_sort
 
 DEFAULT_TEMPLATE_FILE = os.path.join(
-    os.path.dirname(os.path.realpath(__file__)), 'templates', 'default_html.template')
+    os.path.dirname(os.path.realpath(__file__)), "templates", "default_html.template"
+)
 
 DEFAULT_TEMPLATE_SCANCODE_FILE = os.path.join(
-    os.path.dirname(os.path.realpath(__file__)), 'templates', 'scancode_html.template')
+    os.path.dirname(os.path.realpath(__file__)), "templates", "scancode_html.template"
+)
 
 DEFAULT_LICENSE_SCORE = 100
 
 
-def generate(abouts, is_about_input, license_dict, scancode, min_license_score, template=None, vartext=None):
+def generate(
+    abouts, is_about_input, license_dict, scancode, min_license_score, template=None, vartext=None
+):
     """
     Generate an attribution text from an `abouts` list of About objects, a
     `template` template text and a `vartext` optional dict of extra
@@ -53,9 +57,7 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
     if template_error:
         lineno, message = template_error
         error = Error(
-            CRITICAL,
-            'Template validation error at line: {lineno}: "{message}"'.format(
-                **locals())
+            CRITICAL, 'Template validation error at line: {lineno}: "{message}"'.format(**locals())
         )
         errors.append(error)
         return error, None
@@ -87,14 +89,13 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
                         filename = list(about.license_file.value.keys())[index]
                         text = list(about.license_file.value.values())[index]
                     else:
-                        error = Error(
-                            CRITICAL, 'No license file found for ' + name)
+                        error = Error(CRITICAL, "No license file found for " + name)
                         errors.append(error)
                         break
                     if about.license_url.value:
                         url = about.license_url.value[index]
                     else:
-                        url = ''
+                        url = ""
                     license_object = License(key, name, filename, url, text)
                     licenses_list.append(license_object)
                 index = index + 1
@@ -114,7 +115,8 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
     # The process will update the license_key, license_name and license_score.
     if scancode:
         abouts, meet_score_licenses_list = generate_sctk_input(
-            abouts, min_license_score, license_dict)
+            abouts, min_license_score, license_dict
+        )
         # Remove the license object
         remove_list = []
         for lic in licenses_list:
@@ -126,7 +128,7 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
 
     for about in abouts:
         # Create a license expression with license name
-        lic_name_expression = ''
+        lic_name_expression = ""
         lic_name_expression_list = []
         if about.license_expression.value:
             for segment in about.license_expression.value.split():
@@ -139,12 +141,13 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
                 if not_lic:
                     lic_name_expression_list.append(segment)
             # Join the license name expression into a single string
-            lic_name_expression = ' '.join(lic_name_expression_list)
+            lic_name_expression = " ".join(lic_name_expression_list)
 
             # Add the license name expression string into the about object as a custom field
             custom_field = StringField(
-                name='license_name_expression', value=lic_name_expression, present=True)
-            setattr(about, 'license_name_expression', custom_field)
+                name="license_name_expression", value=lic_name_expression, present=True
+            )
+            setattr(about, "license_name_expression", custom_field)
 
     # Sort the about objects by name
     abouts = sorted(abouts, key=lambda x: x.name.value.lower())
@@ -158,7 +161,7 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
         licenses_list=licenses_list,
         utcnow=utcnow,
         tkversion=__version__,
-        vartext=vartext
+        vartext=vartext,
     )
 
     return errors, rendered
@@ -211,13 +214,11 @@ def generate_sctk_input(abouts, min_license_score, license_dict):
                         previous_score, _name = updated_dict[key]
                         current_score = lic_score[index]
                         if current_score > previous_score:
-                            updated_dict[key] = (
-                                lic_score[index], lic_name[index])
+                            updated_dict[key] = (lic_score[index], lic_name[index])
                         # Track the duplicated index
                         removed_index.append(index)
                     else:
-                        updated_dict[key] = (
-                            lic_score[index], lic_name[index])
+                        updated_dict[key] = (lic_score[index], lic_name[index])
                         updated_lic_key_expression.append(key)
                 # Remove the duplication
                 for index, key in enumerate(about.license_key.value):
@@ -231,8 +232,7 @@ def generate_sctk_input(abouts, min_license_score, license_dict):
             updated_lic_name = []
             updated_lic_score = []
             for index, lic in enumerate(updated_dict):
-                _sp_char, lic_keys, _invalid_lic_exp = parse_license_expression(
-                    lic)
+                _sp_char, lic_keys, _invalid_lic_exp = parse_license_expression(lic)
                 score, name = updated_dict[lic]
                 if score >= min_license_score:
                     for lic_key in lic_keys:
@@ -259,10 +259,10 @@ def generate_sctk_input(abouts, min_license_score, license_dict):
 
 
 def get_license_file_key(license_text_name):
-    if license_text_name.endswith('.LICENSE'):
+    if license_text_name.endswith(".LICENSE"):
         # See https://github.com/aboutcode-org/aboutcode-toolkit/issues/439
         # for why using split instead of strip
-        return license_text_name.rsplit('.', 1)[0]
+        return license_text_name.rsplit(".", 1)[0]
     else:
         return license_text_name
 
@@ -273,13 +273,21 @@ def check_template(template_string):
     message) if the template is invalid or None if it is valid.
     """
     try:
-        jinja2.filters.FILTERS['multi_sort'] = multi_sort
+        jinja2.filters.FILTERS["multi_sort"] = multi_sort
         jinja2.Template(template_string)
     except (jinja2.TemplateSyntaxError, jinja2.TemplateAssertionError) as e:
         return e.lineno, e.message
 
 
-def generate_from_file(abouts, is_about_input, license_dict, scancode, min_license_score, template_loc=None, vartext=None):
+def generate_from_file(
+    abouts,
+    is_about_input,
+    license_dict,
+    scancode,
+    min_license_score,
+    template_loc=None,
+    vartext=None,
+):
     """
     Generate an attribution text from an `abouts` list of About objects, a
     `template_loc` template file location and a `vartext` optional
@@ -295,12 +303,29 @@ def generate_from_file(abouts, is_about_input, license_dict, scancode, min_licen
             template_loc = add_unc(DEFAULT_TEMPLATE_FILE)
     else:
         template_loc = add_unc(template_loc)
-    with open(template_loc, encoding='utf-8', errors='replace') as tplf:
+    with open(template_loc, encoding="utf-8", errors="replace") as tplf:
         tpls = tplf.read()
-    return generate(abouts, is_about_input, license_dict, scancode, min_license_score, template=tpls, vartext=vartext)
+    return generate(
+        abouts,
+        is_about_input,
+        license_dict,
+        scancode,
+        min_license_score,
+        template=tpls,
+        vartext=vartext,
+    )
 
 
-def generate_and_save(abouts, is_about_input, license_dict, output_location, scancode=False, min_license_score=0, template_loc=None, vartext=None):
+def generate_and_save(
+    abouts,
+    is_about_input,
+    license_dict,
+    output_location,
+    scancode=False,
+    min_license_score=0,
+    template_loc=None,
+    vartext=None,
+):
     """
     Generate an attribution text from an `abouts` list of About objects, a
     `template_loc` template file location and a `vartext` optional
@@ -314,14 +339,15 @@ def generate_and_save(abouts, is_about_input, license_dict, output_location, sca
         if not about.license_expression.value:
             continue
         special_char_in_expression, lic_list, invalid_lic_exp = parse_license_expression(
-            about.license_expression.value)
+            about.license_expression.value
+        )
         if special_char_in_expression or invalid_lic_exp:
             if special_char_in_expression:
-                msg = (u"The following character(s) cannot be in the license_expression: " +
-                       str(special_char_in_expression))
+                msg = "The following character(s) cannot be in the license_expression: " + str(
+                    special_char_in_expression
+                )
             else:
-                msg = (u"This license_expression is invalid: " +
-                       str(invalid_lic_exp))
+                msg = "This license_expression is invalid: " + str(invalid_lic_exp)
             errors.append(Error(ERROR, msg))
 
     rendering_error, rendered = generate_from_file(
@@ -339,7 +365,7 @@ def generate_and_save(abouts, is_about_input, license_dict, output_location, sca
 
     if rendered:
         output_location = add_unc(output_location)
-        with open(output_location, 'w', encoding='utf-8', errors='replace') as of:
+        with open(output_location, "w", encoding="utf-8", errors="replace") as of:
             of.write(rendered)
 
     return errors, rendered