update style/syntax (mostly line length)

- renamed disabled files instead of commenting them out (and added
  header)

Author: TimidRobot

cc_licenses/settings/base.py

@@ -11,7 +11,8 @@
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 # SETTINGS_DIR is where this settings file is
 SETTINGS_DIR = os.path.dirname(os.path.abspath(__file__))
-# PROJECT_DIR is the directory under root that contains the settings directory, urls.py, and other global stuff.
+# PROJECT_DIR is the directory under root that contains the settings directory,
+#             urls.py, and other global stuff.
 PROJECT_DIR = os.path.dirname(SETTINGS_DIR)
 # ROOT_DIR is the top directory under source control
 ROOT_DIR = os.path.dirname(PROJECT_DIR)
@@ -92,7 +93,9 @@
 LOGGING = {
     "version": 1,
     "disable_existing_loggers": False,
-    "filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}},
+    "filters": {
+        "require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}
+    },
     "formatters": {
         "basic": {
             "format": "%(asctime)s %(name)-20s %(levelname)-8s %(message)s",
@@ -202,22 +205,33 @@
 # https://docs.djangoproject.com/en/1.9/topics/auth/passwords/#password-validation
 AUTH_PASSWORD_VALIDATORS = [
     {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+        "NAME": (
+            "django.contrib.auth."
+            "password_validation.UserAttributeSimilarityValidator"
+        ),
     },
     {
-        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+        "NAME": (
+            "django.contrib.auth.password_validation.MinimumLengthValidator"
+        ),
     },
     {
-        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+        "NAME": (
+            "django.contrib.auth."
+            "password_validation.CommonPasswordValidator"
+        ),
     },
     {
-        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+        "NAME": (
+            "django.contrib.auth."
+            "password_validation.NumericPasswordValidator"
+        ),
     },
 ]
 
 # Make things more secure by default. Run "python manage.py check --deploy"
-# for even more suggestions that you might want to add to the settings, depending
-# on how the site uses SSL.
+# for even more suggestions that you might want to add to the settings,
+# depending on how the site uses SSL.
 SECURE_CONTENT_TYPE_NOSNIFF = True
 SECURE_BROWSER_XSS_FILTER = True
 CSRF_COOKIE_HTTPONLY = True
@@ -244,17 +258,20 @@
 # Percent translated that languages should be at or above
 TRANSLATION_THRESHOLD = 80
 
-# Location of the translation data's repo. Look in env for TRANSLATION_REPOSITORY_DIRECTORY.
+# Location of the translation data's repo. Look in env for
+# TRANSLATION_REPOSITORY_DIRECTORY.
 # Default is next to this one.
 TRANSLATION_REPOSITORY_DIRECTORY = os.getenv(
-    "TRANSLATION_REPOSITORY_DIRECTORY", os.path.join(ROOT_DIR, "..", "cc-licenses-data")
+    "TRANSLATION_REPOSITORY_DIRECTORY",
+    os.path.join(ROOT_DIR, "..", "cc-licenses-data"),
 )
 
 # django-distill settings
 DISTILL_DIR = f"{TRANSLATION_REPOSITORY_DIRECTORY}/build/"
 
 # Django translations are in the translation repo directory, under "locale".
-# License translations are in the translation repo directory, under "translations".
+# License translations are in the translation repo directory, under
+# "translations".
 LOCALE_PATHS = (
     os.path.join(TRANSLATION_REPOSITORY_DIRECTORY, "locale"),
     os.path.join(TRANSLATION_REPOSITORY_DIRECTORY, "legalcode"),
@@ -266,8 +283,11 @@
     "API_TOKEN": os.getenv("TRANSIFEX_API_TOKEN", "missing"),
 }
 
-# The git branch where the official, approved, used in production translations are.
+# The git branch where the official, approved, used in production translations
+# are.
 OFFICIAL_GIT_BRANCH = "develop"
 
 # Path to private keyfile to use when pushing up to data repo
-TRANSLATION_REPOSITORY_DEPLOY_KEY = os.getenv("TRANSLATION_REPOSITORY_DEPLOY_KEY", "")
+TRANSLATION_REPOSITORY_DEPLOY_KEY = os.getenv(
+    "TRANSLATION_REPOSITORY_DEPLOY_KEY", ""
+)

cc_licenses/settings/deploy.py

@@ -48,7 +48,9 @@
 
     # Simplified static file serving.
     # https://warehouse.python.org/project/whitenoise/
-    STATICFILES_STORAGE = "whitenoise.storage.CompressedManifestStaticFilesStorage"
+    STATICFILES_STORAGE = (
+        "whitenoise.storage.CompressedManifestStaticFilesStorage"
+    )
 
 else:
     SECRET_KEY = os.environ["SECRET_KEY"]
@@ -81,7 +83,9 @@
 EMAIL_SUBJECT_PREFIX = os.getenv(
     "EMAIL_SUBJECT_PREFIX", "[CC-Licenses %s] " % ENVIRONMENT.title()
 )
-DEFAULT_FROM_EMAIL = os.getenv("DEFAULT_FROM_EMAIL", "noreply@%(DOMAIN)s" % os.environ)
+DEFAULT_FROM_EMAIL = os.getenv(
+    "DEFAULT_FROM_EMAIL", "noreply@%(DOMAIN)s" % os.environ
+)
 SERVER_EMAIL = DEFAULT_FROM_EMAIL
 
 CSRF_COOKIE_SECURE = True
@@ -99,7 +103,9 @@
     if backend["BACKEND"] == "django.template.backends.django.DjangoTemplates":
         default_loaders = ["django.template.loaders.filesystem.Loader"]
         if backend.get("APP_DIRS", False):
-            default_loaders.append("django.template.loaders.app_directories.Loader")
+            default_loaders.append(
+                "django.template.loaders.app_directories.Loader"
+            )
             # Django gets annoyed if you both set APP_DIRS True and specify your own loaders
             backend["APP_DIRS"] = False
         loaders = backend["OPTIONS"].get("loaders", default_loaders)

cc_licenses/wsgi.py

@@ -15,7 +15,9 @@
 
 if "DATABASE_URL" in os.environ:
     # Dokku or similar
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "cc_licenses.settings.deploy")
+    os.environ.setdefault(
+        "DJANGO_SETTINGS_MODULE", "cc_licenses.settings.deploy"
+    )
 else:
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "cc_licenses.settings")
 

docs/conf.py

@@ -138,8 +138,8 @@
 # html_logo = None
 
 # The name of an image file (relative to this directory) to use as a favicon of
-# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or
+# 32x32 pixels large.
 # html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -261,7 +261,9 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "cc_licenses", "Cc_Licenses Documentation", [author], 1)]
+man_pages = [
+    (master_doc, "cc_licenses", "Cc_Licenses Documentation", [author], 1)
+]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False

i18n/__init__.py

@@ -8,7 +8,13 @@
 
 logger = logging.getLogger(__name__)
 
-CSV_HEADERS = ["lang", "num_messages", "num_trans", "num_fuzzy", "percent_trans"]
+CSV_HEADERS = [
+    "lang",
+    "num_messages",
+    "num_trans",
+    "num_fuzzy",
+    "percent_trans",
+]
 DEFAULT_INPUT_DIR = settings.LOCALE_PATHS[0]
 DEFAULT_CSV_FILE = os.path.join(DEFAULT_INPUT_DIR, "transstats.csv")
 # If something has no language listed, that generally means it's English.
@@ -21,9 +27,10 @@
 # The language codes here are CC language codes, which sometimes differ from
 # Django language codes.
 DEFAULT_JURISDICTION_LANGUAGES = {
-    # Map jurisdiction code to language code. IMPORTANT: Some of the jurisdiction codes
-    # look like language codes, but they're not necessarily related. E.g. "ar" is the
-    # language code for Arabic, but the jurisdiction code for Argentina.
+    # Map jurisdiction code to language code. IMPORTANT: Some of the
+    # jurisdiction codes look like language codes, but they're not necessarily
+    # related. E.g. "ar" is the language code for Arabic, but the jurisdiction
+    # code for Argentina.
     # See the "JURISDICTION_NAMES", just below this.
     "am": "hy",  # Armenian - not in jurisdictions.rdf
     "ar": "es",
@@ -52,7 +59,7 @@
     # YES https://creativecommons.org/licenses/by/3.0/ch/legalcode.de
     "ch": "de",  # ch=Switzerland, default in jurisdictions.rdf=de
     "cl": "es",
-    "cn": "zh-Hans",  # "cn" is China Mainland, language is simplified Chinese = zh-Hans
+    "cn": "zh-Hans",  # "cn" is China Mainland, language is simplified Chinese
     "co": "es",
     "cr": "es",
     "cz": "cs",
@@ -64,7 +71,8 @@
     # For "es", jurisdictions.rdf says "es-es".
     # Deed https://creativecommons.org/licenses/by/3.0/es/ is valid
     # NOT https://creativecommons.org/licenses/by/3.0/es/legalcode
-    # License https://creativecommons.org/licenses/by/3.0/es/legalcode.es is valid
+    # License https://creativecommons.org/licenses/by/3.0/es/legalcode.es is
+    # valid
     # NOT https://creativecommons.org/licenses/by/3.0/es/legalcode.es-es
     # BUT the filename is by-nc-nd_3.0_es_es ????
     "es": "es",

i18n/management/commands/transstats.py

@@ -60,7 +60,9 @@ def gen_statistics(input_dir, output_file):
                     "num_messages": len(pofile),
                     "num_trans": translated,
                     "num_fuzzy": fuzzies,
-                    "percent_trans": int((float(translated) / len(pofile)) * 100),
+                    "percent_trans": int(
+                        (float(translated) / len(pofile)) * 100
+                    ),
                 }
             )
 
@@ -73,7 +75,8 @@ def add_arguments(self, parser):
             "-i",
             "--input_dir",
             dest="input_dir",
-            help="Directory to search for .po files to generate statistics on.",
+            help="Directory to search for .po files to generate statistics"
+            " on.",
             default=DEFAULT_INPUT_DIR,
         )
         parser.add_argument(

i18n/tests/test_utils.py

@@ -7,10 +7,17 @@
 from django.test import TestCase, override_settings
 
 # First-party/Local
-from i18n.utils import get_translation_object, save_content_as_pofile_and_mofile
+from i18n.utils import (
+    get_translation_object,
+    save_content_as_pofile_and_mofile,
+)
 
 TEST_POFILE = os.path.join(
-    os.path.dirname(__file__), "locales", "es_test_4.0", "LC_MESSAGES", "test-4.0.po"
+    os.path.dirname(__file__),
+    "locales",
+    "es_test_4.0",
+    "LC_MESSAGES",
+    "test-4.0.po",
 )
 
 
@@ -26,7 +33,9 @@ def test_get_translation_object(self):
                     django_language_code="code", domain="cnn.com"
                 )
         mock_djt.assert_called_with(
-            domain="cnn.com", language="code", localedirs=["/foo/bar/translations"]
+            domain="cnn.com",
+            language="code",
+            localedirs=["/foo/bar/translations"],
         )
         mock_trans.assert_called_with("code")
         self.assertEqual(translation_object, result)
@@ -39,7 +48,9 @@ def test_save_content_as_pofile_and_mofile(self):
         with mock.patch("i18n.utils.polib") as mock_polib:
             return_value = save_content_as_pofile_and_mofile(path, content)
         self.assertEqual(("/foo/bar.po", "/foo/bar.mo"), return_value)
-        mock_polib.pofile.assert_called_with(pofile=content.decode(), encoding="utf-8")
+        mock_polib.pofile.assert_called_with(
+            pofile=content.decode(), encoding="utf-8"
+        )
         pofile = mock_polib.pofile.return_value
         pofile.save.assert_called_with(path)
         pofile.save_as_mofile.assert_called_with("/foo/bar.mo")

i18n/tests/tests.py

@@ -68,7 +68,10 @@ def test_rtl_context_stuff(self):
     #     )
     #     # Alphabetized
     #     self.assertEqual(
-    #         [{"code": "en", "name": "English"}, {"code": "fr", "name": "français"}],
+    #         [
+    #             {"code": "en", "name": "English"},
+    #             {"code": "fr", "name": "français"},
+    #         ],
     #         result,
     #     )
 
@@ -89,7 +92,9 @@ def test_ugettext_for_locale(self):
     #
     #     with self.subTest("Uses cached result"):
     #         CACHED_TRANS_STATS["unused filename"] = "ding dong"
-    #         self.assertEqual("ding dong", get_all_trans_stats("unused filename"))
+    #         self.assertEqual(
+    #             "ding dong", get_all_trans_stats("unused filename")
+    #         )
     #         CACHED_TRANS_STATS.clear()
     #
     #     with self.subTest("Nonexistent file raises exception"):
@@ -154,6 +159,10 @@ def test_locale_to_lower_upper(self):
 
     def test_get_language_for_jurisdiction(self):
         # 'be' default is "fr"
-        self.assertEqual("fr", get_default_language_for_jurisdiction("be", "ar"))
+        self.assertEqual(
+            "fr", get_default_language_for_jurisdiction("be", "ar")
+        )
         # There is none for "xx" so we return the default instead
-        self.assertEqual("ar", get_default_language_for_jurisdiction("xx", "ar"))
+        self.assertEqual(
+            "ar", get_default_language_for_jurisdiction("xx", "ar")
+        )

i18n/utils.py

@@ -33,7 +33,10 @@
 #     Return list of locale names under our locale dir.
 #     """
 #     dir = settings.LOCALE_PATHS[0]
-#     return [item for item in os.listdir(dir) if os.path.isdir(os.path.join(dir, item))]
+#     return [
+#         item for item in os.listdir(dir)
+#         if os.path.isdir(os.path.join(dir, item))
+#     ]
 
 
 LANGUAGE_JURISDICTION_MAPPING = {}
@@ -78,10 +81,12 @@ def get_translation_object(
     )
     # Start with a translation object for the domain for this license.
     license_translation_object = DjangoTranslation(
-        language=django_language_code, domain=domain, localedirs=[license_locale_dir]
+        language=django_language_code,
+        domain=domain,
+        localedirs=[license_locale_dir],
     )
-    # Add a fallback to the standard Django translation for this language. This gets us the
-    # non-legalcode parts of the pages.
+    # Add a fallback to the standard Django translation for this language. This
+    # gets us the non-legalcode parts of the pages.
     license_translation_object.add_fallback(translation(django_language_code))
 
     return license_translation_object
@@ -170,7 +175,9 @@ def get_default_language_for_jurisdiction(
 ):
     # Input: a jurisdiction code
     # Output: a CC language code
-    return DEFAULT_JURISDICTION_LANGUAGES.get(jurisdiction_code, default_language)
+    return DEFAULT_JURISDICTION_LANGUAGES.get(
+        jurisdiction_code, default_language
+    )
 
 
 def get_locale_text_orientation(locale_identifier: str) -> str:
@@ -180,7 +187,9 @@ def get_locale_text_orientation(locale_identifier: str) -> str:
     try:
         locale = Locale.parse(locale_identifier, sep="-")
     except UnknownLocaleError:
-        raise ValueError("No locale found with identifier %r" % locale_identifier)
+        raise ValueError(
+            "No locale found with identifier %r" % locale_identifier
+        )
     return "ltr" if locale.character_order == "left-to-right" else "rtl"
 
 
@@ -313,7 +322,8 @@ def _wrapped_ugettext(message):
 #
 #     if not os.path.exists(trans_file):
 #         raise IOError(
-#             f"No such CSV file {trans_file}.  Maybe run `python manage.py transstats`?"
+#             f"No such CSV file {trans_file}. Maybe run"
+#             " `python manage.py transstats`?"
 #         )
 #
 #     reader = csv.DictReader(open(trans_file, "r"), CSV_HEADERS)

licenses/bs_utils.py

@@ -65,7 +65,8 @@ def name_and_text(tag: Tag):
 
     E.g. "<strong>Truck</strong> is a <strong>heavy</strong> vehicle."
 
-    Returns a dictionary {"name": "Truck", "text": "is a <strong>heavy</strong> vehicle."}
+    Returns a dictionary:
+        {"name": "Truck", "text": "is a <strong>heavy</strong> vehicle."}
     """
     top_level_children = list(tag.children)