Make admin compatible with FSMIntegerField and FSMKeyField

Author: pfouque

CHANGELOG.rst

@@ -4,6 +4,11 @@ Changelog
 Unreleased
 ~~~~~~~~~~
 
+django-fsm-2 4.2.3 2026-03-15
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Make admin compatible with FSMIntegerField and FSMKeyField
+
 
 django-fsm-2 4.2.2 2026-03-14
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

django_fsm/admin.py

@@ -71,9 +71,9 @@ class FSMAdminMixin(_ModelAdmin):
 
     @override
     def __init__(self, model: type[fsm._FSMModel], admin_site: admin.AdminSite) -> None:
-        if not self.fsm_fields:  # pragma: no cover
+        if not self.fsm_fields:
             # django-fsm-admin retro compatibility
-            if hasattr(self, "fsm_field"):
+            if hasattr(self, "fsm_field"):  # pragma: no cover
                 logger.warning(
                     "'fsm_field' declaration is deprecated, please update to 'fsm_fields'"
                 )
@@ -92,14 +92,14 @@ def get_readonly_fields(
         read_only_fields = list(super().get_readonly_fields(request, obj))
 
         for fsm_field_name in self.fsm_fields:
-            if fsm_field_name in read_only_fields:  # pragma: no cover
-                continue
-
             field = self.model._meta.get_field(fsm_field_name)
 
-            if not isinstance(field, fsm.FSMField):  # pragma: no cover
+            if not isinstance(field, fsm.FSMFieldMixin):
                 raise ImproperlyConfigured(f"'{fsm_field_name}' is not an FSMField")
 
+            if fsm_field_name in read_only_fields:  # pragma: no cover
+                continue
+
             if getattr(field, "protected", False):
                 read_only_fields.append(fsm_field_name)
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-fsm-2"
-version = "4.2.2"
+version = "4.2.3"
 description = "Django friendly finite state machine support."
 authors = [{ name = "Mikhail Podgurskiy", email = "kmmbvnr@gmail.com" }]
 requires-python = ">=3.10"

tests/testapp/admin.py

@@ -31,6 +31,7 @@ class AdminBlogPostAdmin(FSMAdminMixin, admin.ModelAdmin[AdminBlogPost]):
     fsm_fields = [
         "state",
         "step",
+        "key_state",
     ]
 
     fsm_forms = {

tests/testapp/models.py

@@ -8,8 +8,6 @@
 import django_fsm as fsm
 from django_fsm import GET_STATE
 from django_fsm import RETURN_VALUE
-from django_fsm import FSMField
-from django_fsm import FSMKeyField
 from django_fsm import transition
 
 
@@ -19,7 +17,7 @@ class Application(models.Model):
     Test workflow
     """
 
-    state = FSMField(default="new")
+    state = fsm.FSMField(default="new")
 
     @transition(field=state, source="new", target="published", on_error="failed")
     def standard(self) -> None:
@@ -106,7 +104,7 @@ class FKApplication(models.Model):
     Test workflow for FSMKeyField
     """
 
-    state = FSMKeyField(DbState, default="new", on_delete=models.CASCADE)
+    state = fsm.FSMKeyField(DbState, default="new", on_delete=models.CASCADE)
 
     @transition(field=state, source="new", target="published")
     def standard(self) -> None:
@@ -175,7 +173,7 @@ def on_error(self) -> None:
 
 
 class MultiStateApplication(Application):
-    another_state = FSMKeyField(DbState, default="new", on_delete=models.CASCADE)
+    another_state = fsm.FSMKeyField(DbState, default="new", on_delete=models.CASCADE)
 
     @transition(field=another_state, source="new", target="published")
     def another_state_standard(self) -> None:
@@ -198,7 +196,7 @@ class BlogPost(models.Model):
     Test workflow
     """
 
-    state = FSMField(choices=BlogPostState.choices, default=BlogPostState.NEW, protected=True)
+    state = fsm.FSMField(choices=BlogPostState.choices, default=BlogPostState.NEW, protected=True)
 
     class Meta:
         permissions = [
@@ -274,27 +272,37 @@ class AdminBlogPostState(models.TextChoices):
     HIDDEN = "hidden", "Hidden"
 
 
-class AdminBlogPostStep(models.TextChoices):
-    STEP_1 = "step1", "Step one"
-    STEP_2 = "step2", "Step two"
-    STEP_3 = "step3", "Step three"
+class AdminBlogPostStep(models.IntegerChoices):
+    STEP_1 = 1, "Step one"
+    STEP_2 = 2, "Step two"
+    STEP_3 = 3, "Step three"
+
+
+class AdminBlogPostDbState(fsm.FSMModelMixin, models.Model):
+    id = models.CharField(primary_key=True)
+    label = models.CharField()
+
+    def __str__(self):
+        return self.label
 
 
 class AdminBlogPost(fsm.FSMModelMixin, models.Model):
     title = models.CharField(max_length=50)
 
-    state = FSMField(
+    state = fsm.FSMField(
         choices=AdminBlogPostState.choices,
         default=AdminBlogPostState.CREATED,
         protected=True,
     )
 
-    step = FSMField(
+    step = fsm.FSMIntegerField(
         choices=AdminBlogPostStep.choices,
         default=AdminBlogPostStep.STEP_1,
         protected=False,
     )
 
+    key_state = fsm.FSMKeyField(DbState, on_delete=models.CASCADE, null=True)
+
     # state transitions
     def __str__(self) -> str:
         return f"{self.title} ({self.state})"