Remove pk alias and auto fields in favor of a single automatic id PrimaryKeyField

Author: davegaeddert

demos/full/app/users/migrations/0001_initial.py

@@ -15,7 +15,7 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name="User",
             fields=[
-                ("id", models.BigAutoField(auto_created=True, primary_key=True)),
+                ("id", models.PrimaryKeyField()),
                 ("email", models.EmailField(max_length=254)),
                 (
                     "password",

plain-admin/plain/admin/assets/admin/list.js

@@ -1,18 +1,18 @@
 jQuery(($) => {
   const $actionCheckbox = $("[data-action-checkbox]");
-  const $actionPks = $('[name="action_pks"]');
+  const $actionIds = $('[name="action_ids"]');
   const $actionSelect = $('[name="action_name"]');
   const $actionSubmit = $('[data-actions-form] [type="submit"]');
   let $lastActionCheckboxChecked = null;
 
   $actionCheckbox.on("change", () => {
-    const pks = [];
+    const ids = [];
     $actionCheckbox.each(function () {
       if ($(this).is(":checked")) {
-        pks.push($(this).attr("name"));
+        ids.push($(this).attr("name"));
       }
     });
-    $actionPks.val(pks.join(","));
+    $actionIds.val(ids.join(","));
 
     updateActionSubmit();
   });
@@ -22,7 +22,7 @@ jQuery(($) => {
   });
 
   function updateActionSubmit() {
-    if ($actionPks.val() && $actionSelect.val()) {
+    if ($actionIds.val() && $actionSelect.val()) {
       // We've chosen an action
       $actionSubmit.prop("disabled", false);
     } else {

plain-admin/plain/admin/impersonate/middleware.py

@@ -5,11 +5,11 @@
 from .views import IMPERSONATE_KEY
 
 
-def get_user_by_pk(pk):
+def get_user_by_id(id):
     UserModel = get_user_model()
 
     try:
-        return UserModel.objects.get(pk=pk)
+        return UserModel.objects.get(id=id)
     except UserModel.DoesNotExist:
         return None
 
@@ -24,7 +24,7 @@ def __call__(self, request):
             and request.user
             and can_be_impersonator(request.user)
         ):
-            user_to_impersonate = get_user_by_pk(request.session[IMPERSONATE_KEY])
+            user_to_impersonate = get_user_by_id(request.session[IMPERSONATE_KEY])
             if user_to_impersonate:
                 if not can_impersonate_user(request.user, user_to_impersonate):
                     # Can't impersonate this user, remove it and show an error

plain-admin/plain/admin/impersonate/urls.py

@@ -7,5 +7,5 @@ class ImpersonateRouter(Router):
     namespace = "impersonate"
     urls = [
         path("stop/", ImpersonateStopView, name="stop"),
-        path("start/<pk>/", ImpersonateStartView, name="start"),
+        path("start/<id>/", ImpersonateStartView, name="start"),
     ]

plain-admin/plain/admin/impersonate/views.py

@@ -11,7 +11,7 @@ def get(self):
         # We *could* already be impersonating, so need to consider that
         impersonator = getattr(self.request, "impersonator", self.request.user)
         if impersonator and can_be_impersonator(impersonator):
-            self.request.session[IMPERSONATE_KEY] = self.url_kwargs["pk"]
+            self.request.session[IMPERSONATE_KEY] = self.url_kwargs["id"]
             return ResponseRedirect(self.request.query_params.get("next", "/"))
 
         return ResponseForbidden()

plain-admin/plain/admin/templates/admin/list.html

@@ -33,7 +33,7 @@
                 <option>{{ action }}</option>
                 {% endfor %}
             </select>
-            <input type="hidden" name="action_pks" value="" />
+            <input type="hidden" name="action_ids" value="" />
             <button type="submit" disabled>Apply</button>
         </form>
         {% endif %}
@@ -119,7 +119,7 @@
 
                 {% if table_style != "simple" and actions %}
                 <td class="p-0 pl-1">
-                    <input data-action-checkbox class="rounded-sm bg-white/10" type="checkbox" name="{{ get_object_pk(object) }}" />
+                    <input data-action-checkbox class="rounded-sm bg-white/10" type="checkbox" name="{{ get_object_id(object) }}" />
                 </td>
                 {% endif %}
 

plain-admin/plain/admin/templates/toolbar/request.html

@@ -42,7 +42,7 @@
 
     {% if object|default(false) %}
     <dt>Primary object</dt>
-    <dd class="text-sm text-white/50 inline-flex items-center" title="PK: {{ object.pk|default('unknown') }}">
+    <dd class="text-sm text-white/50 inline-flex items-center" title="ID: {{ object.id|default('unknown') }}">
         <pre><code>{{ object.__repr__() }}</code></pre>
         {% if object|get_admin_model_detail_url %}
         <a class="ml-2 inline-flex items-center p-1 text-blue-500 hover:text-blue-400" href="{{ object|get_admin_model_detail_url }}">

plain-admin/plain/admin/views/base.py

@@ -118,7 +118,7 @@ def get_nav_title(cls) -> str:
     @classmethod
     def get_view_url(cls, obj=None) -> str:
         if obj:
-            return reverse(f"{URL_NAMESPACE}:" + cls.view_name(), pk=obj.pk)
+            return reverse(f"{URL_NAMESPACE}:" + cls.view_name(), id=obj.id)
         else:
             return reverse(f"{URL_NAMESPACE}:" + cls.view_name())
 

plain-admin/plain/admin/views/models.py

@@ -48,9 +48,9 @@ class AdminModelListView(AdminListView):
 
     model: "models.Model"
 
-    fields: list = ["pk"]
+    fields: list = ["id"]
     queryset_order = []
-    search_fields: list = ["pk"]
+    search_fields: list = ["id"]
 
     def get_title(self) -> str:
         if title := super().get_title():
@@ -162,7 +162,7 @@ def get_path(cls) -> str:
         if path := super().get_path():
             return path
 
-        return f"{cls.model._meta.model_name}/<int:pk>/"
+        return f"{cls.model._meta.model_name}/<int:id>/"
 
     def get_fields(self):
         if fields := super().get_fields():
@@ -177,7 +177,7 @@ def get_field_value(self, obj, field: str):
             return get_model_field(obj, field)
 
     def get_object(self):
-        return self.model.objects.get(pk=self.url_kwargs["pk"])
+        return self.model.objects.get(id=self.url_kwargs["id"])
 
 
 class AdminModelCreateView(AdminCreateView):
@@ -214,10 +214,10 @@ def get_path(cls) -> str:
         if path := super().get_path():
             return path
 
-        return f"{cls.model._meta.model_name}/<int:pk>/update/"
+        return f"{cls.model._meta.model_name}/<int:id>/update/"
 
     def get_object(self):
-        return self.model.objects.get(pk=self.url_kwargs["pk"])
+        return self.model.objects.get(id=self.url_kwargs["id"])
 
 
 class AdminModelDeleteView(AdminDeleteView):
@@ -231,7 +231,7 @@ def get_path(cls) -> str:
         if path := super().get_path():
             return path
 
-        return f"{cls.model._meta.model_name}/<int:pk>/delete/"
+        return f"{cls.model._meta.model_name}/<int:id>/delete/"
 
     def get_object(self):
-        return self.model.objects.get(pk=self.url_kwargs["pk"])
+        return self.model.objects.get(id=self.url_kwargs["id"])

plain-admin/plain/admin/views/objects.py

@@ -49,7 +49,7 @@ def get_template_context(self):
 
         context["table_style"] = getattr(self, "_table_style", "default")
 
-        context["get_object_pk"] = self.get_object_pk
+        context["get_object_id"] = self.get_object_id
         context["get_field_value"] = self.get_field_value
         context["get_field_value_template"] = self.get_field_value_template
 
@@ -81,8 +81,8 @@ def post(self) -> Response:
         action_name = self.request.data.get("action_name")
         actions = self.get_actions()
         if action_name and action_name in actions:
-            target_pks = self.request.data["action_pks"].split(",")
-            response = self.perform_action(action_name, target_pks)
+            target_ids = self.request.data["action_ids"].split(",")
+            response = self.perform_action(action_name, target_ids)
             if response:
                 return response
             else:
@@ -91,7 +91,7 @@ def post(self) -> Response:
 
         raise ValueError("Invalid action")
 
-    def perform_action(self, action: str, target_pks: list) -> Response | None:
+    def perform_action(self, action: str, target_ids: list) -> Response | None:
         raise NotImplementedError
 
     def get_objects(self) -> list:
@@ -130,11 +130,8 @@ def get_field_value(self, obj, field: str):
         else:
             return attr
 
-    def get_object_pk(self, obj):
-        try:
-            return self.get_field_value(obj, "pk")
-        except AttributeError:
-            return self.get_field_value(obj, "id")
+    def get_object_id(self, obj):
+        return self.get_field_value(obj, "id")
 
     def get_field_value_template(self, obj, field: str, value):
         type_str = type(value).__name__.lower()