Chore: add isort for devcontainer, pre-commit

.devcontainer/devcontainer.json

@@ -30,9 +30,10 @@
         "mhutchie.git-graph",
         "monosans.djlint",
         "mrorz.language-gettext",
-        "ms-python.python",
         "ms-python.black-formatter",
+        "ms-python.isort",
         "ms-python.flake8",
+        "ms-python.python",
         "qwtel.sqlite-viewer",
         "tamasfe.even-better-toml"
       ]

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# sort imports with isort
+6e1d32e50a54d1436de91383c3f003fb373ce49c

.github/workflows/check-metadata.py

@@ -1,8 +1,8 @@
+import json
+import sys
 from datetime import datetime, timezone
 from functools import cache
-import json
 from pathlib import Path
-import sys
 
 import requests
 

.pre-commit-config.yaml

@@ -39,19 +39,25 @@ repos:
         types:
           - python
 
-  - repo: https://github.com/PyCQA/flake8
+  - repo: https://github.com/pycqa/bandit
+    rev: 1.8.6
+    hooks:
+      - id: bandit
+        args: ["-ll"]
+        files: .py$
+
+  - repo: https://github.com/pycqa/flake8
     rev: 7.3.0
     hooks:
       - id: flake8
         types:
           - python
 
-  - repo: https://github.com/pycqa/bandit
-    rev: 1.8.6
+  - repo: https://github.com/pycqa/isort
+    rev: 7.0.0
     hooks:
-      - id: bandit
-        args: ["-ll"]
-        files: .py$
+      - id: isort
+        args: ["--profile", "black"]
 
   # esbenp.prettier-vscode defaults to using prettier@2.8.8. this mirror is the closest equivalent
   # another option would be to 'npm install prettier' explicitly in the Dockerfile, as the VS Code plugin will use it

benefits/__init__.py

@@ -1,4 +1,4 @@
-from importlib.metadata import version, PackageNotFoundError
+from importlib.metadata import PackageNotFoundError, version
 
 try:
     __version__ = version("benefits")

benefits/admin.py

@@ -1,15 +1,14 @@
 from django.conf import settings
 from django.contrib.admin import AdminSite
-
 from django.contrib.admin.forms import AdminAuthenticationForm
 from django.contrib.auth.models import Group
 from django.template.response import TemplateResponse
-from django.utils.decorators import method_decorator, decorator_from_middleware
+from django.utils.decorators import decorator_from_middleware, method_decorator
 
-from benefits.core.middleware import RecaptchaEnabled
-from benefits.core.models import TransitAgency
 from benefits.core import session
+from benefits.core.middleware import RecaptchaEnabled
 from benefits.core.mixins import ValidateRecaptchaMixin
+from benefits.core.models import TransitAgency
 
 
 class BenefitsAdminLoginForm(ValidateRecaptchaMixin, AdminAuthenticationForm):

benefits/core/admin/__init__.py

@@ -3,6 +3,7 @@
 """
 
 from .common import PemDataAdmin
+from .enrollment import EnrollmentEventAdmin, SortableEnrollmentFlowAdmin
 from .mixins import (
     ProdReadOnlyPermissionMixin,
     StaffPermissionMixin,
@@ -11,13 +12,12 @@
     is_staff_member_or_superuser,
 )
 from .transit import TransitAgencyAdmin
-from .enrollment import EnrollmentEventAdmin, SortableEnrollmentFlowAdmin
 from .users import (
     GOOGLE_USER_INFO_URL,
     GroupAdmin,
     UserAdmin,
-    add_staff_user_to_group,
     add_google_sso_userinfo,
+    add_staff_user_to_group,
     pre_login_user,
 )
 

benefits/core/admin/common.py

@@ -1,6 +1,7 @@
 from django.contrib import admin
 
 from benefits.core import models
+
 from .mixins import SuperuserPermissionMixin
 
 

benefits/core/admin/enrollment.py

@@ -1,10 +1,10 @@
+from adminsortable2.admin import SortableAdminMixin
 from django import forms
-from django.core.exceptions import ValidationError
 from django.contrib import admin
-
-from adminsortable2.admin import SortableAdminMixin
+from django.core.exceptions import ValidationError
 
 from benefits.core import models
+
 from .mixins import ProdReadOnlyPermissionMixin, StaffPermissionMixin, SuperuserPermissionMixin
 
 

benefits/core/admin/transit.py

@@ -2,6 +2,7 @@
 from django.contrib.auth.models import Group
 
 from benefits.core import models
+
 from .mixins import StaffPermissionMixin, SuperuserPermissionMixin
 
 

benefits/core/admin/users.py

@@ -1,15 +1,13 @@
 import logging
 
+import requests
 from django.conf import settings
 from django.contrib import admin
-from django.contrib.auth.models import Group, User
 from django.contrib.auth.admin import GroupAdmin as BaseGroupAdmin, UserAdmin as BaseUserAdmin
-
-import requests
+from django.contrib.auth.models import Group, User
 
 from benefits.core.admin.mixins import StaffPermissionMixin
 
-
 logger = logging.getLogger(__name__)
 
 

benefits/core/admin/views.py

@@ -1,7 +1,7 @@
 from urllib.parse import quote
 
-from django.contrib.auth.views import PasswordResetView, PasswordResetDoneView, PasswordResetConfirmView
 from django.contrib import messages
+from django.contrib.auth.views import PasswordResetConfirmView, PasswordResetDoneView, PasswordResetView
 from django.urls import reverse_lazy
 
 from benefits.core.admin.forms import BenefitsPasswordResetForm, BenefitsSetPasswordForm

benefits/core/analytics.py

@@ -9,12 +9,12 @@
 import time
 import uuid
 
-from django.conf import settings
 import requests
+from django.conf import settings
 
 from benefits import VERSION
-from . import models, session
 
+from . import models, session
 
 logger = logging.getLogger(__name__)
 

benefits/core/context/agency.py

@@ -1,4 +1,4 @@
-from dataclasses import dataclass, asdict
+from dataclasses import asdict, dataclass
 
 from django.db import models
 from django.utils.translation import gettext_lazy as _

benefits/core/middleware.py

@@ -13,8 +13,8 @@
 from django.views import i18n
 
 from benefits.routes import routes
-from . import analytics, recaptcha, session
 
+from . import analytics, recaptcha, session
 
 logger = logging.getLogger(__name__)
 

benefits/core/migrations/0001_initial.py

@@ -1,10 +1,11 @@
 # Generated by Django 5.0.1 on 2024-02-06 18:09
 
-import benefits.core.models
-import benefits.secrets
 import django.db.models.deletion
 from django.db import migrations, models
 
+import benefits.core.models
+import benefits.secrets
+
 
 class Migration(migrations.Migration):
 

benefits/core/migrations/0002_paymentprocessor_backoffice_api.py

@@ -1,8 +1,9 @@
 # Generated by Django 5.0.2 on 2024-03-07 21:38
 
+from django.db import migrations, models
+
 import benefits.core.models
 import benefits.secrets
-from django.db import migrations, models
 
 
 class Migration(migrations.Migration):

benefits/core/migrations/0010_alter_secret_name_field_blank.py

@@ -1,8 +1,9 @@
 # Generated by Django 5.0.3 on 2024-05-13 19:57
 
+from django.db import migrations
+
 import benefits.core.models
 import benefits.secrets
-from django.db import migrations
 
 
 class Migration(migrations.Migration):

benefits/core/migrations/0016_refactor_paymentprocessor_transitprocessor.py

@@ -2,9 +2,9 @@
 
 from django.db import migrations, models
 
-from benefits.core.migrations import create_all_permissions
 import benefits.core.models
 import benefits.secrets
+from benefits.core.migrations import create_all_permissions
 
 
 def update_permissions(apps, schema_editor):

benefits/core/migrations/0017_refactor_authprovider_claimsprovider.py

@@ -2,9 +2,9 @@
 
 from django.db import migrations, models
 
-from benefits.core.migrations import create_all_permissions
 import benefits.core.models
 import benefits.secrets
+from benefits.core.migrations import create_all_permissions
 
 
 def update_permissions(apps, schema_editor):

benefits/core/migrations/0026_enrollmentevent.py

@@ -1,9 +1,10 @@
 # Generated by Django 5.1 on 2024-09-13 04:55
 
 import uuid
-from django.db import migrations, models
+
 import django.db.models.deletion
 import django.utils.timezone
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):

benefits/core/migrations/0033_pemdata_helptext.py

@@ -1,8 +1,9 @@
 # Generated by Django 5.1.4 on 2025-01-03 01:59
 
+from django.db import migrations, models
+
 import benefits.core.models.common
 import benefits.secrets
-from django.db import migrations, models
 
 
 class Migration(migrations.Migration):

benefits/core/migrations/0041_oauth_refactor_identitygatewayconfig.py

@@ -2,6 +2,7 @@
 
 import django.db.models.deletion
 from django.db import migrations, models
+
 from benefits.secrets import get_secret_by_name
 
 

benefits/core/migrations/0046_littlepayconfig.py

@@ -1,8 +1,9 @@
 # Generated by Django 5.1.7 on 2025-04-18 13:52
 
+from django.db import migrations, models
+
 import benefits.core.models.common
 import benefits.secrets
-from django.db import migrations, models
 
 
 def migrate_littlepay_config(apps, schema_editor):

benefits/core/migrations/0047_switchioconfig.py

@@ -1,10 +1,11 @@
 # Generated by Django 5.1.7 on 2025-04-24 17:57
 
-import benefits.core.models.common
-import benefits.secrets
 import django.db.models.deletion
 from django.db import migrations, models
 
+import benefits.core.models.common
+import benefits.secrets
+
 
 class Migration(migrations.Migration):
 

benefits/core/migrations/0066_consolidate_transitagency_logo_columns.py

@@ -1,8 +1,9 @@
 # Generated by Django 5.2.7 on 2025-10-30 15:22
 
-import benefits.core.models.transit
 from django.db import migrations, models
 
+import benefits.core.models.transit
+
 
 class Migration(migrations.Migration):
 

benefits/core/migrations/0069_refactor_eligibilityapiverificationrequest.py

@@ -1,10 +1,11 @@
 # Generated by Django 5.2.7 on 2025-10-08 17:40
 
-import benefits.core.models.common
-import benefits.secrets
 import django.db.models.deletion
 from django.db import migrations, models
 
+import benefits.core.models.common
+import benefits.secrets
+
 
 def migrate_agency_data(apps, schema_editor):
     TransitAgency = apps.get_model("core", "TransitAgency")

benefits/core/models/__init__.py

@@ -1,12 +1,6 @@
-from .common import template_path, SecretNameField, PemData, Environment
-from .transit import (
-    agency_logo,
-    CardSchemes,
-    TransitProcessorConfig,
-    EligibilityApiConfig,
-    TransitAgency,
-)
-from .enrollment import EnrollmentMethods, EligibilityApiVerificationRequest, EnrollmentFlow, EnrollmentGroup, EnrollmentEvent
+from .common import Environment, PemData, SecretNameField, template_path
+from .enrollment import EligibilityApiVerificationRequest, EnrollmentEvent, EnrollmentFlow, EnrollmentGroup, EnrollmentMethods
+from .transit import CardSchemes, EligibilityApiConfig, TransitAgency, TransitProcessorConfig, agency_logo
 
 __all__ = [
     "agency_logo",

benefits/core/models/common.py

@@ -1,13 +1,12 @@
-from functools import cached_property
 import logging
+from functools import cached_property
 from pathlib import Path
 
+import requests
 from django import template
 from django.conf import settings
 from django.db import models
 
-import requests
-
 from benefits.secrets import NAME_VALIDATOR, get_secret_by_name
 
 logger = logging.getLogger(__name__)

benefits/core/models/enrollment.py

@@ -1,19 +1,20 @@
 import logging
 import uuid
 
-from cdt_identity.models import IdentityGatewayConfig, ClaimsVerificationRequest
+from cdt_identity.models import ClaimsVerificationRequest, IdentityGatewayConfig
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.utils import timezone
 from multiselectfield import MultiSelectField
 
-from .common import PemData, SecretNameField, template_path
-from .transit import TransitAgency
 from benefits.core import context as core_context
 from benefits.eligibility import context as eligibility_context
 from benefits.enrollment import context as enrollment_context
 from benefits.in_person import context as in_person_context
 
+from .common import PemData, SecretNameField, template_path
+from .transit import TransitAgency
+
 logger = logging.getLogger(__name__)