updated style/syntax per black and flake8. added black config

Author: TimidRobot

tools/add_cc0_links.py

@@ -14,26 +14,33 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import os.path, re, sys
 from pathlib import Path
+import os.path
+import re
+import sys
 
 
 class AddCC0Links(object):
     def usage(self):
         print("add-cc0-links.py LANGUAGE_CODE LANGUAGE_NAME")
         print("    e.g. add-cc0-links.py nl Nederlands")
         print(
-            "    LANGUAGE_CODE must be 2 letters or 2-hyphen-N, the same used in filename."
+            "    LANGUAGE_CODE must be 2 letters or 2-hyphen-N,"
+            " the same used in filename."
         )
         print("    LANGUAGE_NAME must be in the relevant language")
-        print("                  if it contains whitespace, enclose in quotes.")
+        print(
+            "                  if it contains whitespace, enclose in quotes."
+        )
 
     def get_args(self):
         # Make sure there are enough args
         # Make sure arg 2 is a language code
         # Make sure arg 3 is not a language code
         self.args_ok = (
-            (len(sys.argv) == 3) and (len(sys.argv[1]) >= 2) and (len(sys.argv[2]) >= 2)
+            (len(sys.argv) == 3)
+            and (len(sys.argv[1]) >= 2)
+            and (len(sys.argv[2]) >= 2)
         )
         if self.args_ok:
             self.language_code = sys.argv[1]
@@ -56,7 +63,7 @@ def get_path(self):
             self.path = path.parent / "docroot" / "legalcode"
         if not self.path:
             print("Please run from within the checked-out project.")
-        return self.path != False
+        return self.path is not False
 
     def get_files(self):
         """Get all the CC0 files *except* those we are linking to"""
@@ -83,13 +90,14 @@ def file_license_and_language(self, filepath):
     def links_in_page(self, content):
         """Find the translated license links at the bottom of the page"""
         return re.findall(
-            r'//creativecommons\.org/publicdomain/zero/1\.0/legalcode(\.[^"]{2,})?">([^>]+)</a>',
+            r"//creativecommons\.org/publicdomain/zero/1\.0/"
+            'legalcode([.][^"]{2,})?">([^>]+)</a>',
             content,
         )
 
     def is_rtl(self, content):
         """Determine whether the page is in a right-to-left script"""
-        return re.search(r' dir="rtl"', content) != None
+        return re.search(r' dir="rtl"', content) is not None
 
     def insert_at_index(self, links, rtl):
         """Find the alphabetic position in the list of translated license links
@@ -135,7 +143,7 @@ def file_contains_link_already(self, links):
                 ),
                 False,
             )
-            != False
+            is not False
         )
 
     def process_file(self, filepath):

tools/add_cc4_links.py

@@ -14,35 +14,44 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import os.path, re, sys
 from pathlib import Path
+import os.path
+import re
+import sys
 
 
 class AddCC4Links(object):
     """Adds a link to a license, specified by language code and name, to all
        existing CC 4.0 license legalcodes where they do not already contain a
        link to it.
+
        Make sure to run it in a checked out version of the creativecommons.org
        repository, either in the tools directory, docroot,
        or docroot/legalcode.
+
        Note that this code modifies files inline. Commit any other changes
        before running it."""
 
     def usage(self):
         print("add-cc4-links.py LANGUAGE_CODE LANGUAGE_NAME")
         print("    e.g. add-cc4-links.py nl Nederlands")
         print(
-            "    LANGUAGE_CODE must be 2 letters or 2-hyphen-N, the same used in filename."
+            "    LANGUAGE_CODE must be 2 letters or 2-hyphen-N,"
+            " the same used in filename."
         )
         print("    LANGUAGE_NAME must be in the relevant language")
-        print("                  if it contains whitespace, enclose in quotes.")
+        print(
+            "                  if it contains whitespace, enclose in quotes."
+        )
 
     def get_args(self):
         # Make sure there are enough args
         # Make sure arg 2 is a language code
         # Make sure arg 3 is not a language code
         self.args_ok = (
-            (len(sys.argv) == 3) and (len(sys.argv[1]) >= 2) and (len(sys.argv[2]) >= 2)
+            (len(sys.argv) == 3)
+            and (len(sys.argv[1]) >= 2)
+            and (len(sys.argv[2]) >= 2)
         )
         if self.args_ok:
             self.language_code = sys.argv[1]
@@ -65,7 +74,7 @@ def get_path(self):
             self.path = path.parent / "docroot" / "legalcode"
         if not self.path:
             print("Please run from within the checked-out project.")
-        return self.path != False
+        return self.path is not False
 
     def get_files(self):
         """Get all the 4.0 files *except* those we are linking to"""
@@ -92,14 +101,15 @@ def file_license_and_language(self, filepath):
     def links_in_page(self, content):
         """Find the translated license links at the bottom of the page"""
         return re.findall(
-            r'//creativecommons\.org/licenses/[^/]+/4\.0/legalcode(\.[^"]{2,})?">([^>]+)</a>',
+            r"//creativecommons\.org/licenses/[^/]+/4\.0/"
+            'legalcode([.][^"]{2,})?">([^>]+)</a>',
             content,
         )
 
     def is_rtl(self, content):
         """Determine whether the page is in a right-to-left script"""
-        return (re.search(r' dir="rtl"', content) != None) or (
-            re.search(r'class="rtl"', content) != None
+        return (re.search(r' dir="rtl"', content) is not None) or (
+            re.search(r'class="rtl"', content) is not None
         )
 
     def insert_at_index_rtl(self, links):
@@ -160,7 +170,7 @@ def file_contains_link_already(self, links):
                 ),
                 False,
             )
-            != False
+            is not False
         )
 
     def process_file(self, filepath):

tools/prep_cc4_code.py

@@ -14,14 +14,18 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import re, sys, re, getopt
 from pathlib import Path
+import getopt
+import re
+import sys
 
 
 class UpdateLicenseCode(object):
-    """One time script modifying 4.0 legal code files for updated look. This does not change
-       legal code language. It adds a header and footer placeholders, and updates the HTML head.
-       This allows the update_cc4_code.py script to function."""
+    """One time script modifying 4.0 legal code files for updated look. This
+    does not change legal code language. It adds a header and footer
+    placeholders, and updates the HTML head.
+
+    This allows the update_cc4_code.py script to function."""
 
     placeholders = {
         "head": (
@@ -43,7 +47,10 @@ class UpdateLicenseCode(object):
     }
 
     image_map = {
-        "by": {"file": "attribution_icon_white.svg", "alt_text": "Attribution"},
+        "by": {
+            "file": "attribution_icon_white.svg",
+            "alt_text": "Attribution",
+        },
         "sa": {"file": "sa_white.svg", "alt_text": "Share Alike"},
         "nd": {"file": "nd_white.svg", "alt_text": "No Derivatives"},
         "nc": {"file": "nc_white.svg", "alt_text": "Non-Commerical"},
@@ -62,8 +69,8 @@ def log(self, message, type="standard"):
             print(message)
 
     def get_args(self):
-        """Get arguments/options and set corresponding flags. On validation error
-           print usage help"""
+        """Get arguments/options and set corresponding flags. On validation
+        error print usage help"""
         try:
             opts, args = getopt.getopt(sys.argv[1:], "va")
         except getopt.GetoptError:
@@ -95,7 +102,7 @@ def get_path(self):
             print("Please run from within the checked-out project.")
         if self.path:
             self.includes_path = self.path / "includes"
-        return self.path != False
+        return self.path is not False
 
     def process_files(self, filelist):
         """File processing loop"""
@@ -129,8 +136,9 @@ def process_file(self, filepath):
 
     def handle_placeholders(self, content):
         self.log("   Adding placeholders", "verbose")
-        # The language selector has to come after the header. Because dictionaries don't
-        # maint order the easiest way to maintain order is sorting the interation keys.
+        # The language selector has to come after the header. Because
+        # dictionaries don't maintain order the easiest way to maintain order
+        # is sorting the interation keys.
         for placeholder_pair in sorted(UpdateLicenseCode.placeholders):
             if self.has_placeholders(content, placeholder_pair):
                 self.log(
@@ -166,18 +174,27 @@ def remove_deed3_css(self, content):
         """Remove refererences to deed3 css stylesheets from HEAD"""
         self.log("   Removing deed3 css references from head", "verbose")
         content = re.sub(r"\n.*?<link.*?deed3\.css.*?>.*?\n", "\n", content)
-        content = re.sub(r"\n.*?<link.*?deed3\-print\.css.*?>.*?\n", "\n", content)
-        content = re.sub(r"\n.*?<link.*?deed3\-ie\.css.*?>.*?\n", "\n", content)
+        content = re.sub(
+            r"\n.*?<link.*?deed3\-print\.css.*?>.*?\n", "\n", content
+        )
+        content = re.sub(
+            r"\n.*?<link.*?deed3\-ie\.css.*?>.*?\n", "\n", content
+        )
         return content
 
     def handle_rtl_css(self, content):
         """The Right-to-Left stylesheet needs to come after the HEAD includes
             and be renamed"""
         self.log("   Handling right to left css", "verbose")
         if content.find("deed3-rtl.css") != -1:
-            content = re.sub(r"\n.*?<link.*?deed3\-rtl\.css.*?>.*?\n", "\n", content)
+            content = re.sub(
+                r"\n.*?<link.*?deed3\-rtl\.css.*?>.*?\n", "\n", content
+            )
             bottom_placholder = UpdateLicenseCode.placeholders["head"][1]
-            new_rtl_css = '<link rel="stylesheet" type="text/css" href="/includes/legalcode-rtl.css" media="all">'
+            new_rtl_css = (
+                '<link rel="stylesheet" type="text/css"'
+                ' href="/includes/legalcode-rtl.css" media="all">'
+            )
             content = content.replace(
                 bottom_placholder, bottom_placholder + "\n" + new_rtl_css
             )
@@ -211,9 +228,15 @@ def add_language_class(self, content, language_code):
         if body_tag.find(language_class) == -1:
             # If language class not on body, add it
             if body_tag.find("class") > 0:
-                existing_classes = re.search('class="(.*?)"', body_tag).group(1)
+                existing_classes = re.search('class="(.*?)"', body_tag).group(
+                    1
+                )
                 new_body_tag = (
-                    '<body class="' + existing_classes + " " + language_class + '">'
+                    '<body class="'
+                    + existing_classes
+                    + " "
+                    + language_class
+                    + '">'
                 )
             else:
                 new_body_tag = '<body class="' + language_class + '">'
@@ -236,25 +259,36 @@ def add_type_logos(self, content, lic_type):
             filename = UpdateLicenseCode.image_map[lic_attr]["file"]
             alt_text = UpdateLicenseCode.image_map[lic_attr]["alt_text"]
             image_tag = (
-                '<img src="/images/deed/svg/' + filename + '" alt="' + alt_text + '"/>'
+                '<img src="/images/deed/svg/'
+                + filename
+                + '" alt="'
+                + alt_text
+                + '"/>'
             )
             lic_images += (
-                '<span class="cc-icon-' + lic_attr + '">' + image_tag + "</span>"
+                '<span class="cc-icon-'
+                + lic_attr
+                + '">'
+                + image_tag
+                + "</span>"
             )
         cc_logo_section = re.search(
             '<div id="cc-logo">.*?</div>', content, re.DOTALL
         ).group()
         new_cc_logo_section = (
             '<div id="cc-logo">'
-            + '<span class="cc-icon-logo"><img src="/images/deed/svg/cc_white.svg" alt="CC"/></span>'
+            + '<span class="cc-icon-logo">'
+            + '<img src="/images/deed/svg/cc_white.svg" alt="CC"/></span>'
             + lic_images
             + "</div>"
         )
         content = content.replace(cc_logo_section, new_cc_logo_section)
         return content
 
     def handling_consideration_blockquotes(self, content):
-        content = content.replace("<blockquote>", '<p class="usage-considerations">')
+        content = content.replace(
+            "<blockquote>", '<p class="usage-considerations">'
+        )
         content = content.replace("</blockquote>", "</p>")
         return content
 

tools/pyproject.toml

@@ -0,0 +1,2 @@
+[tool.black]
+line-length = 79