Improve error handling, update style, update deps

TimidRobot · TimidRobot · commit 46fdaf36aab8 · 2021-04-12T13:25:49.000-07:00
diff --git a/.flake8 b/.flake8
@@ -1,8 +1,7 @@
 [flake8]
-max-line-length = 119
-exclude =
-    .git,
+extend-exclude =
     migrations,
     static,
     staticfiles,
     templates,
+max-line-length = 79
diff --git a/Pipfile b/Pipfile
@@ -4,9 +4,10 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-black = "==19.10b0"
+black = "==20.8b1"
 flake8 = "*"
 factory-boy = "*"
+isort = "*"
 
 [packages]
 django = "~=3.0"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -140,8 +140,9 @@ After made code changes and before commit, check code style from main directory
 
 After making changes in code and before commit, check code style.
 ```shell
+pipenv run isort .
 pipenv run black .
-pipenv run flake8
+pipenv run flake8 .
 ```
 
 
diff --git a/caselaw/asgi.py b/caselaw/asgi.py
@@ -7,8 +7,10 @@
 https://docs.djangoproject.com/en/3.0/howto/deployment/asgi/
 """
 
+# Standard library
 import os
 
+# Third-party
 from django.core.asgi import get_asgi_application
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "caselaw.settings")
diff --git a/caselaw/settings.py b/caselaw/settings.py
@@ -10,10 +10,13 @@
 https://docs.djangoproject.com/en/3.0/ref/settings/
 """
 
+# Standard library
 import os
-import django_heroku
 from distutils.util import strtobool
 
+# Third-party
+import django_heroku
+
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
@@ -25,7 +28,9 @@
 SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY")
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = bool(strtobool(str(os.environ.get("DJANGO_DEBUG_ENABLED", default=False))))
+DEBUG = bool(
+    strtobool(str(os.environ.get("DJANGO_DEBUG_ENABLED", default=False)))
+)
 
 ALLOWED_HOSTS = ["localhost", "127.0.0.1"]
 
@@ -95,7 +100,7 @@
     }
 }
 
-# See https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables
+# See https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables  # noqa: E501
 
 if "GITHUB_WORKFLOW" in os.environ:
     SECRET_KEY = "cbo9e7%1c^ijxoit37^!kbfyikaet%z&*pm&4k(3#h*k%irylt"
@@ -115,13 +120,12 @@
 # Password validation
 # https://docs.djangoproject.com/en/3.0/ref/settings/#auth-password-validators
 
+_auth_pass_valid = "django.contrib.auth.password_validation"
 AUTH_PASSWORD_VALIDATORS = [
-    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
-    },
-    {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
-    {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
-    {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
+    {"NAME": f"{_auth_pass_valid}.UserAttributeSimilarityValidator"},
+    {"NAME": f"{_auth_pass_valid}.MinimumLengthValidator"},
+    {"NAME": f"{_auth_pass_valid}.CommonPasswordValidator"},
+    {"NAME": f"{_auth_pass_valid}.NumericPasswordValidator"},
 ]
 
 
@@ -149,7 +153,11 @@
         },
     },
     "loggers": {
-        "django": {"handlers": ["console"], "level": "DEBUG", "propagate": True},
+        "django": {
+            "handlers": ["console"],
+            "level": "DEBUG",
+            "propagate": True,
+        },
         "django.request": {
             "handlers": ["console"],
             "level": "DEBUG",
@@ -190,9 +198,13 @@
 
 COMPRESS_PRECOMPILERS = (("text/x-scss", "django_libsass.SassCompiler"),)
 
-COMPRESS_ENABLED = bool(strtobool(str(os.environ.get("DJANGO_COMPRESS_ENABLED", True))))
+COMPRESS_ENABLED = bool(
+    strtobool(str(os.environ.get("DJANGO_COMPRESS_ENABLED", True)))
+)
 
-COMPRESS_OFFLINE = bool(strtobool(str(os.environ.get("DJANGO_COMPRESS_OFFLINE", True))))
+COMPRESS_OFFLINE = bool(
+    strtobool(str(os.environ.get("DJANGO_COMPRESS_OFFLINE", True)))
+)
 
 LIBSASS_OUTPUT_STYLE = os.environ.get("DJANGO_LIBSASS_STYLE", "compressed")
 
diff --git a/caselaw/urls.py b/caselaw/urls.py
@@ -13,6 +13,7 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+# Third-party
 from django.conf.urls import url
 from django.contrib import admin
 from django.urls import include, path
diff --git a/caselaw/wsgi.py b/caselaw/wsgi.py
@@ -7,8 +7,10 @@
 https://docs.djangoproject.com/en/3.0/howto/deployment/wsgi/
 """
 
+# Standard library
 import os
 
+# Third-party
 from django.core.wsgi import get_wsgi_application
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "caselaw.settings")
diff --git a/legal_db/admin.py b/legal_db/admin.py
@@ -1,8 +1,8 @@
+# Third-party
 from django.contrib import admin
-
 from ordered_model.admin import OrderedModelAdmin
 
-from .models import Case, FAQ, Link, Scholarship
+from .models import FAQ, Case, Link, Scholarship
 
 
 class CaseAdmin(admin.ModelAdmin):
@@ -27,7 +27,13 @@ class CaseAdmin(admin.ModelAdmin):
     # Customize the list
     list_display = ("name", "license", "status", "updated_at")
     list_filter = ["status", "license"]
-    search_fields = ("name", "courts", "related_cases", "background", "summary")
+    search_fields = (
+        "name",
+        "courts",
+        "related_cases",
+        "background",
+        "summary",
+    )
 
 
 class LinkAdmin(admin.ModelAdmin):
diff --git a/legal_db/apps.py b/legal_db/apps.py
@@ -1,3 +1,4 @@
+# Third-party
 from django.apps import AppConfig
 
 
diff --git a/legal_db/factories.py b/legal_db/factories.py
@@ -1,3 +1,4 @@
+# Third-party
 import factory
 from factory.django import DjangoModelFactory
 
diff --git a/legal_db/forms.py b/legal_db/forms.py
@@ -1,3 +1,4 @@
+# Third-party
 from django.forms import (
     BooleanField,
     CharField,
diff --git a/legal_db/migrations/0001_initial.py b/legal_db/migrations/0001_initial.py
@@ -1,10 +1,11 @@
 # Generated by Django 3.0.8 on 2020-07-31 20:35
 
-from django.db import migrations, models
+# Third-party
 import django.db.models.deletion
 import django_countries.fields
 import markdownx.models
 import taggit.managers
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
diff --git a/legal_db/models.py b/legal_db/models.py
@@ -1,6 +1,6 @@
+# Third-party
 from django.db import models
 from django.utils.translation import gettext_lazy as _
-
 from django_countries.fields import CountryField
 from markdownx.models import MarkdownxField
 from ordered_model.models import OrderedModel
@@ -12,7 +12,8 @@ class BaseModel(models.Model):
         blank=True, null=True, help_text="Internal notes or description."
     )
     created_at = models.DateTimeField(
-        auto_now_add=True, help_text="A timestamp of when the object is first created."
+        auto_now_add=True,
+        help_text="A timestamp of when the object is first created.",
     )
     updated_at = models.DateTimeField(
         auto_now=True,
@@ -24,13 +25,16 @@ class Meta:
 
 
 class LegalResource(BaseModel):
-    """Abstract Class to contain the commons attributes of Cases and Scholarship"""
+    """
+    Abstract Class to contain the commons attributes of Cases and Scholarship
+    """
 
     license = models.CharField(
         max_length=50,
         blank=True,
         null=True,
-        help_text="The Creative Commons licence associated to the legal resource.",
+        help_text="The Creative Commons licence associated to the legal"
+        " resource.",
     )
     contributor_name = models.CharField(max_length=120)
     contributor_email = models.EmailField()
@@ -67,42 +71,47 @@ class Case(LegalResource):
         max_length=200,
         blank=True,
         null=True,
-        help_text="If there are multiple lawsuits between the parties, please just "
-        "include one here and note the others in the related cases field.",
+        help_text="If there are multiple lawsuits between the parties, please"
+        " just include one here and note the others in the related cases"
+        " field.",
     )
     related_cases = models.CharField(
         max_length=255,
         blank=True,
         null=True,
-        help_text="If there are multiple lawsuits between the parties in this dispute, "
-        "please note additional cases here.",
+        help_text="If there are multiple lawsuits between the parties in this"
+        " dispute, please note additional cases here.",
+    )
+    country = CountryField(
+        blank_label="Select a country", blank=True, null=True
     )
-    country = CountryField(blank_label="Select a country", blank=True, null=True)
     courts = models.CharField(
         max_length=255,
         blank=True,
         null=True,
-        help_text="The original court name and/or English translation. If the lawsuit "
-        "was filed in one court and then went to another court on appeal, please note "
-        "all relevant courts here.",
+        help_text="The original court name and/or English translation. If the"
+        " lawsuit was filed in one court and then went to another court on"
+        " appeal, please note all relevant courts here.",
     )
     background = models.TextField(
         blank=True,
         null=True,
-        help_text="Describe the factual information that led to the lawsuit "
-        "being filed, and explain what claims were filed in the lawsuit.",
+        help_text="Describe the factual information that led to the lawsuit"
+        " being filed, and explain what claims were filed in the lawsuit.",
     )
     decision_year = models.PositiveSmallIntegerField(
         blank=True, null=True, help_text="Year of case resolution."
     )
     is_pending = models.BooleanField(
-        blank=True, null=True, help_text="Indicate if is an ongoing case or not."
+        blank=True,
+        null=True,
+        help_text="Indicate if is an ongoing case or not.",
     )
     links = models.ManyToManyField(
         Link,
-        help_text="Include any links to pleadings, briefs, and opinions in the "
-        "lawsuit, as well as blog posts, academic articles, or other relevant "
-        "materials.",
+        help_text="Include any links to pleadings, briefs, and opinions in the"
+        " lawsuit, as well as blog posts, academic articles, or other relevant"
+        " materials.",
     )
 
     def __str__(self):
diff --git a/legal_db/templatetags/markdown_extras.py b/legal_db/templatetags/markdown_extras.py
@@ -1,8 +1,8 @@
+# Third-party
+import markdown as md
 from django import template
 from django.template.defaultfilters import stringfilter
 
-import markdown as md
-
 register = template.Library()
 
 
diff --git a/legal_db/tests.py b/legal_db/tests.py
diff --git a/legal_db/urls.py b/legal_db/urls.py
diff --git a/legal_db/views.py b/legal_db/views.py
diff --git a/manage.py b/manage.py
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# Third-party`
`1`	`2`	`from django.apps import AppConfig`
`2`	`3`
`3`	`4`