Fix pre commit + cleanup old compatibility code (#10)

Author: pfouque

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: django-fsm linting
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-python@v2
+      with:
+        python-version: '3.11'
+    - uses: pre-commit/action@v3.0.0

.github/workflows/tests.yml

@@ -1,8 +1,9 @@
 name: django-fsm testing
 
 on:
-  - push
-  - pull_request
+  pull_request:
+  push:
+    branches: [main]
 
 jobs:
   build:

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+default_language_version:
+  python: python3.11
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+        args: ["--maxkb=700"]
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - "--py38-plus"
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.15.0
+    hooks:
+      - id: django-upgrade
+        args: [--target-version, "3.2"]
+
+
+  - repo: https://github.com/python-poetry/poetry
+    rev: 1.6.1
+    hooks:
+    -   id: poetry-check
+    -   id: poetry-lock
+    -   id: poetry-export
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.291
+    hooks:
+      - id: ruff-format
+      - id: ruff

CHANGELOG.rst

@@ -11,6 +11,7 @@ django-fsm unreleased
 - Add support for django 4.2
 - Add support for django 5.0
 - Enable Github actions for testing
+- Remove South support...if exists
 
 django-fsm 2.8.1 2022-08-15
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

django_fsm/__init__.py

@@ -5,22 +5,13 @@
 from functools import partialmethod, wraps
 
 import django
+from django.apps import apps as django_apps
 from django.db import models
 from django.db.models import Field
 from django.db.models.query_utils import DeferredAttribute
 from django.db.models.signals import class_prepared
-from django_fsm.signals import pre_transition, post_transition
-
-try:
-    from django.apps import apps as django_apps
-
-    def get_model(app_label, model_name):
-        app = django_apps.get_app_config(app_label)
-        return app.get_model(model_name)
 
-
-except ImportError:
-    from django.db.models.loading import get_model
+from django_fsm.signals import pre_transition, post_transition
 
 
 __all__ = [
@@ -38,16 +29,6 @@ def get_model(app_label, model_name):
     "RETURN_VALUE",
 ]
 
-# South support; see http://south.aeracode.org/docs/tutorial/part4.html#simple-inheritance
-try:
-    from south.modelsinspector import add_introspection_rules
-except ImportError:
-    pass
-else:
-    add_introspection_rules([], [r"^django_fsm\.FSMField"])
-    add_introspection_rules([], [r"^django_fsm\.FSMIntegerField"])
-    add_introspection_rules([], [r"^django_fsm\.FSMKeyField"])
-
 
 class TransitionNotAllowed(Exception):
     """Raised when a transition is not allowed"""
@@ -308,7 +289,8 @@ def set_proxy(self, instance, state):
                 app_label = instance._meta.app_label
                 model_name = state_proxy
 
-            model = get_model(app_label, model_name)
+            model = django_apps.get_app_config(app_label).get_model(model_name)
+
             if model is None:
                 raise ValueError(f"No model found {state_proxy}")
 
@@ -385,9 +367,7 @@ def contribute_to_class(self, cls, name, **kwargs):
         super().contribute_to_class(cls, name, **kwargs)
         setattr(cls, self.name, self.descriptor_class(self))
         setattr(cls, f"get_all_{self.name}_transitions", partialmethod(get_all_FIELD_transitions, field=self))
-        setattr(
-            cls, f"get_available_{self.name}_transitions", partialmethod(get_available_FIELD_transitions, field=self)
-        )
+        setattr(cls, f"get_available_{self.name}_transitions", partialmethod(get_available_FIELD_transitions, field=self))
         setattr(
             cls,
             f"get_available_user_{self.name}_transitions",

django_fsm/management/commands/graph_transitions.py

@@ -1,37 +1,15 @@
 import graphviz
-from optparse import make_option
 from itertools import chain
 
+from django.apps import apps
 from django.core.management.base import BaseCommand
-try:
-    from django.utils.encoding import force_str
-    _requires_system_checks = True
-except ImportError:  # Django >= 4.0
-    from django.utils.encoding import force_str
-    from django.core.management.base import ALL_CHECKS
-    _requires_system_checks = ALL_CHECKS
+from django.utils.encoding import force_str
 
 from django_fsm import FSMFieldMixin, GET_STATE, RETURN_VALUE
 
-try:
-    from django.db.models import get_apps, get_app, get_models, get_model
-
-    NEW_META_API = False
-except ImportError:
-    from django.apps import apps
-
-    NEW_META_API = True
-
-from django import VERSION
-
-HAS_ARGPARSE = VERSION >= (1, 10)
-
 
 def all_fsm_fields_data(model):
-    if NEW_META_API:
-        return [(field, model) for field in model._meta.get_fields() if isinstance(field, FSMFieldMixin)]
-    else:
-        return [(field, model) for field in model._meta.fields if isinstance(field, FSMFieldMixin)]
+    return [(field, model) for field in model._meta.get_fields() if isinstance(field, FSMFieldMixin)]
 
 
 def node_name(field, state):
@@ -40,7 +18,7 @@ def node_name(field, state):
 
 
 def node_label(field, state):
-    if type(state) == int or (type(state) == bool and hasattr(field, "choices")):
+    if isinstance(state, int) or (isinstance(state, bool) and hasattr(field, "choices")):
         return force_str(dict(field.choices).get(state))
     else:
         return state
@@ -137,54 +115,26 @@ def get_graphviz_layouts():
 
 
 class Command(BaseCommand):
-    requires_system_checks = _requires_system_checks
-
-    if not HAS_ARGPARSE:
-        option_list = BaseCommand.option_list + (
-            make_option(
-                "--output",
-                "-o",
-                action="store",
-                dest="outputfile",
-                help=(
-                    "Render output file. Type of output dependent on file extensions. " "Use png or jpg to render graph to image."
-                ),
-            ),
-            # NOQA
-            make_option(
-                "--layout",
-                "-l",
-                action="store",
-                dest="layout",
-                default="dot",
-                help=("Layout to be used by GraphViz for visualization. " "Layouts: %s." % " ".join(get_graphviz_layouts())),
-            ),
-        )
-        args = "[appname[.model[.field]]]"
-    else:
-
-        def add_arguments(self, parser):
-            parser.add_argument(
-                "--output",
-                "-o",
-                action="store",
-                dest="outputfile",
-                help=(
-                    "Render output file. Type of output dependent on file extensions. " "Use png or jpg to render graph to image."
-                ),
-            )
-            parser.add_argument(
-                "--layout",
-                "-l",
-                action="store",
-                dest="layout",
-                default="dot",
-                help=("Layout to be used by GraphViz for visualization. " "Layouts: %s." % " ".join(get_graphviz_layouts())),
-            )
-            parser.add_argument("args", nargs="*", help=("[appname[.model[.field]]]"))
-
     help = "Creates a GraphViz dot file with transitions for selected fields"
 
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--output",
+            "-o",
+            action="store",
+            dest="outputfile",
+            help=("Render output file. Type of output dependent on file extensions. " "Use png or jpg to render graph to image."),
+        )
+        parser.add_argument(
+            "--layout",
+            "-l",
+            action="store",
+            dest="layout",
+            default="dot",
+            help=("Layout to be used by GraphViz for visualization. " "Layouts: %s." % " ".join(get_graphviz_layouts())),
+        )
+        parser.add_argument("args", nargs="*", help=("[appname[.model[.field]]]"))
+
     def render_output(self, graph, **options):
         filename, format = options["outputfile"].rsplit(".", 1)
 
@@ -199,35 +149,19 @@ def handle(self, *args, **options):
                 field_spec = arg.split(".")
 
                 if len(field_spec) == 1:
-                    if NEW_META_API:
-                        app = apps.get_app(field_spec[0])
-                        models = apps.get_models(app)
-                    else:
-                        app = get_app(field_spec[0])
-                        models = get_models(app)
+                    app = apps.get_app(field_spec[0])
+                    models = apps.get_models(app)
                     for model in models:
                         fields_data += all_fsm_fields_data(model)
                 elif len(field_spec) == 2:
-                    if NEW_META_API:
-                        model = apps.get_model(field_spec[0], field_spec[1])
-                    else:
-                        model = get_model(field_spec[0], field_spec[1])
+                    model = apps.get_model(field_spec[0], field_spec[1])
                     fields_data += all_fsm_fields_data(model)
                 elif len(field_spec) == 3:
-                    if NEW_META_API:
-                        model = apps.get_model(field_spec[0], field_spec[1])
-                    else:
-                        model = get_model(field_spec[0], field_spec[1])
+                    model = apps.get_model(field_spec[0], field_spec[1])
                     fields_data += all_fsm_fields_data(model)
         else:
-            if NEW_META_API:
-                for model in apps.get_models():
-                    fields_data += all_fsm_fields_data(model)
-            else:
-                for app in get_apps():
-                    for model in get_models(app):
-                        fields_data += all_fsm_fields_data(model)
-
+            for model in apps.get_models():
+                fields_data += all_fsm_fields_data(model)
         dotdata = generate_dot(fields_data)
 
         if options["outputfile"]:

django_fsm/tests/test_abstract_inheritance.py

@@ -21,6 +21,7 @@ class AnotherFromAbstractModel(BaseAbstractModel):
     inherit from a shared abstract class (example: BaseAbstractModel).
     Don't try to remove it.
     """
+
     @transition(field="state", source="published", target="sticked")
     def stick(self):
         pass
@@ -53,6 +54,4 @@ def test_field_available_transitions_works(self):
 
     def test_field_all_transitions_works(self):
         transitions = self.model.get_all_state_transitions()
-        self.assertEqual(
-            {("new", "published"), ("published", "sticked")}, {(data.source, data.target) for data in transitions}
-        )
+        self.assertEqual({("new", "published"), ("published", "sticked")}, {(data.source, data.target) for data in transitions})

django_fsm/tests/test_basic_transitions.py

@@ -177,12 +177,12 @@ def test_available_conditions_from_published(self):
         transitions = self.model.get_available_state_transitions()
         actual = {(transition.source, transition.target) for transition in transitions}
         expected = {
-                ("*", "moderated"),
-                ("published", None),
-                ("published", "hidden"),
-                ("published", "stolen"),
-                ("*", ""),
-                ("+", "blocked"),
+            ("*", "moderated"),
+            ("published", None),
+            ("published", "hidden"),
+            ("published", "stolen"),
+            ("*", ""),
+            ("+", "blocked"),
         }
         self.assertEqual(actual, expected)
 
@@ -221,14 +221,14 @@ def test_all_conditions(self):
 
         actual = {(transition.source, transition.target) for transition in transitions}
         expected = {
-                ("*", "moderated"),
-                ("new", "published"),
-                ("new", "removed"),
-                ("published", None),
-                ("published", "hidden"),
-                ("published", "stolen"),
-                ("hidden", "stolen"),
-                ("*", ""),
-                ("+", "blocked"),
+            ("*", "moderated"),
+            ("new", "published"),
+            ("new", "removed"),
+            ("published", None),
+            ("published", "hidden"),
+            ("published", "stolen"),
+            ("hidden", "stolen"),
+            ("*", ""),
+            ("+", "blocked"),
         }
         self.assertEqual(actual, expected)

django_fsm/tests/test_proxy_inheritance.py

@@ -46,6 +46,4 @@ def test_field_all_transitions_base_model(self):
 
     def test_field_all_transitions_works(self):
         transitions = self.model.get_all_state_transitions()
-        self.assertEqual(
-            {("new", "published"), ("published", "sticked")}, {(data.source, data.target) for data in transitions}
-        )
+        self.assertEqual({("new", "published"), ("published", "sticked")}, {(data.source, data.target) for data in transitions})