Support models with primary keys not named "id" (#17)

* Support models with PK field not named "id"
* isChoicesFilter is no longer needed, we always use the desired field name
* Add a test model with renamed PK
* They just released 0.11.0 (pre-commit)

Author: sterliakov

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.3
+    rev: v0.11.0
     hooks:
       - id: ruff
   - repo: local
@@ -9,4 +9,5 @@ repos:
         name: pytest
         entry: pytest -s tests/testproject/testapp -c tests/testproject/pytest.ini
         language: system
-        types: [python]
+        pass_filenames: false
+        types_or: [python, html]

src/dalf/admin.py

@@ -1,17 +1,16 @@
 # ruff: noqa: PLR0913,ARG002,SLF001
-import json
 
 from django import forms
 from django.contrib import admin
 from django.contrib.admin.widgets import get_select2_language
 from django.urls import reverse
 
 __all__ = [
+    'DALFChoicesField',
     'DALFModelAdmin',
     'DALFRelatedField',
-    'DALFRelatedOnlyField',
-    'DALFChoicesField',
     'DALFRelatedFieldAjax',
+    'DALFRelatedOnlyField',
 ]
 
 
@@ -47,7 +46,7 @@ def __init__(self, field, request, params, model, model_admin, field_path):
             'app_label': model._meta.app_label,
             'model_name': model._meta.model_name,
             'field_name': field_path,
-            'is_choices_filter': json.dumps(obj=False),
+            'lookup_kwarg': self.lookup_kwarg,
         }
 
     def choices(self, changelist):
@@ -66,9 +65,7 @@ class DALFRelatedOnlyField(DALFMixin, admin.RelatedOnlyFieldListFilter):
 
 
 class DALFChoicesField(DALFMixin, admin.ChoicesFieldListFilter):
-    def __init__(self, field, request, params, model, model_admin, field_path):
-        super().__init__(field, request, params, model, model_admin, field_path)
-        self.custom_template_params.update({'is_choices_filter': json.dumps(obj=True)})
+    pass
 
 
 class DALFRelatedFieldAjax(admin.RelatedFieldListFilter):
@@ -83,6 +80,7 @@ def __init__(self, field, request, params, model, model_admin, field_path):
             'model_name': model._meta.model_name,
             'field_name': field_path,
             'ajax_url': reverse('admin:autocomplete'),
+            'lookup_kwarg': self.lookup_kwarg,
         }
         selected_value = originial_params.get(self.lookup_kwarg, [])
         self.selected_value = selected_value[0] if selected_value else None

src/dalf/static/admin/js/django_admin_list_filter.js

@@ -8,8 +8,9 @@
             const appLabel = element.dataset.appLabel;
             const modelName = element.dataset.modelName;
             const fieldName = element.dataset.fieldName;
+            const lookupKwarg = element.dataset.lookupKwarg;
             const selectedValue = $(element).prev('.djal-selected-value').val();
-            
+
             $(element).select2({
                 ajax: {
                     data: (params) => {
@@ -25,17 +26,15 @@
             }).on('select2:select', function(e){
                var data = e.params.data;
                var navURL = new URL(window.location.href);
-               var queryParam = fieldName + "__id__exact";
 
-               navURL.searchParams.set(queryParam, decodeURIComponent(data.id));
+               navURL.searchParams.set(lookupKwarg, decodeURIComponent(data.id));
                window.location.href = navURL.href;
             }).on("select2:unselect", function(e){
                 var navURL = new URL(window.location.href);
-                var queryParam = fieldName + "__id__exact";
-                navURL.searchParams.delete(queryParam);
+                navURL.searchParams.delete(lookupKwarg);
                 window.location.href = navURL.href;
             });
-            
+
             if (selectedValue){
                 $.ajax({
                     url: ajaxURL,
@@ -57,14 +56,13 @@
                     }
                 });
             }
-            
+
         });
         return this;
     };
-    
-    function getQueryParams(e, isChoicesFilter) {
-        var fieldName = e.target.name;
-        var fieldQueryParam = isChoicesFilter ? `${fieldName}__exact` : `${fieldName}__id__exact`;
+
+    function getQueryParams(e) {
+        var fieldQueryParam = $(e.target).data('lookupKwarg');
         var data = e.params.data;
         var selected = data.id.replace(/\?/, "");
         var queryParams = selected.split("&");
@@ -96,7 +94,7 @@
             placeholder: getTextSafe("Filter")
         }).on("select2:select", function(e){
             var navURL = new URL(window.location.href);
-            let [fieldQueryParam, queryParams] = getQueryParams(e, $(this).data("isChoicesFilter"));
+            let [fieldQueryParam, queryParams] = getQueryParams(e);
             var isAllorEmptyChoice = true;
 
             queryParams.forEach(function(item){
@@ -113,7 +111,7 @@
 
         }).on("select2:unselect", function(e){
             var navURL = new URL(window.location.href);
-            let [fieldQueryParam, queryParams] = getQueryParams(e, $(this).data("isChoicesFilter"));
+            let [fieldQueryParam, queryParams] = getQueryParams(e);
 
             queryParams.forEach(function(item){
                 var [field, value] = item.split("=");

src/dalf/templates/admin/filter/django_admin_list_filter.html

@@ -7,7 +7,12 @@
         <ul>
             <li>
                 {% with params=choices|last %}
-                    <select class="django-admin-list-filter admin-autocomplete" name="{{ params.field_name }}" data-is-choices-filter="{{ params.is_choices_filter }}" data-theme="admin-autocomplete">
+                    <select
+                        class="django-admin-list-filter admin-autocomplete"
+                        name="{{ params.field_name }}"
+                        data-lookup-kwarg="{{ params.lookup_kwarg }}"
+                        data-theme="admin-autocomplete"
+                    >
                     {% for choice in choices %}
                         {% if choice.display %}<option value="{{ choice.query_string|iriencode }}"{% if choice.selected %} selected{% endif %}>{{ choice.display }}</option>{% endif %}
                     {% endfor %}

src/dalf/templates/admin/filter/django_admin_list_filter_ajax.html

@@ -18,6 +18,7 @@
                       data-allow-clear="true"
                       data-app-label="{{ params.app_label }}"
                       data-model-name="{{ params.model_name }}"
+                      data-lookup-kwarg="{{ params.lookup_kwarg }}"
                       data-theme="admin-autocomplete"
                       data-field-name="{{ params.field_name }}"></select>
                 {% endwith %}

tests/testproject/testapp/admin.py

@@ -8,7 +8,7 @@
     DALFRelatedOnlyField,
 )
 
-from .models import Category, Post, Tag
+from .models import Category, CategoryRenamed, Post, Tag
 
 
 @admin.register(Post)
@@ -18,6 +18,7 @@ class PostAdmin(DALFModelAdmin):
         ('author', DALFRelatedField),
         ('audience', DALFChoicesField),
         ('category', DALFRelatedFieldAjax),
+        ('category_renamed', DALFRelatedFieldAjax),
         ('tags', DALFRelatedOnlyField),
     )
 
@@ -28,6 +29,12 @@ class CategoryAdmin(admin.ModelAdmin):
     ordering = ('name',)
 
 
+@admin.register(CategoryRenamed)
+class CategoryRenamedAdmin(admin.ModelAdmin):
+    search_fields = ('name',)
+    ordering = ('name',)
+
+
 @admin.register(Tag)
 class TagAdmin(admin.ModelAdmin):
     search_fields = ('name',)

tests/testproject/testapp/conftest.py

@@ -10,3 +10,7 @@
 @pytest.fixture
 def posts():
     return PostFactory.create_batch(10)
+
+@pytest.fixture
+def unused_tag():
+    return TagFactory(name='Unused')

tests/testproject/testapp/factories.py

@@ -2,7 +2,7 @@
 from django.contrib.auth import get_user_model
 from factory import fuzzy
 
-from .models import AudienceChoices, Category, Post, Tag
+from .models import AudienceChoices, Category, CategoryRenamed, Post, Tag
 
 FAKE_USERNAMES = [
     'vigo',
@@ -47,6 +47,14 @@ class Meta:
     name = factory.Iterator(FAKE_CATEGORIES)
 
 
+class CategoryRenamedFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = CategoryRenamed
+        django_get_or_create = ('name',)
+
+    name = factory.Iterator(FAKE_CATEGORIES)
+
+
 class TagFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Tag
@@ -62,6 +70,7 @@ class Meta:
 
     author = factory.SubFactory(UserFactory)
     category = factory.SubFactory(CategoryFactory)
+    category_renamed = factory.SubFactory(CategoryRenamedFactory)
     title = factory.Sequence(lambda n: f'Book about {FAKE_CATEGORIES[n % len(FAKE_CATEGORIES)]} - {n}')
     audience = fuzzy.FuzzyChoice(AudienceChoices.choices, getter=lambda c: c[0])
 

tests/testproject/testapp/models.py

@@ -1,3 +1,5 @@
+import uuid
+
 from django.conf import settings
 from django.db import models
 
@@ -9,6 +11,14 @@ def __str__(self):
         return self.name
 
 
+class CategoryRenamed(models.Model):
+    renamed_id = models.UUIDField(default=uuid.uuid4, primary_key=True)
+    name = models.CharField(max_length=255)
+
+    def __str__(self):
+        return self.name
+
+
 class Tag(models.Model):
     name = models.CharField(max_length=255)
 
@@ -33,6 +43,11 @@ class Post(models.Model):
         on_delete=models.CASCADE,
         related_name='posts',
     )
+    category_renamed = models.ForeignKey(
+        to='CategoryRenamed',
+        on_delete=models.CASCADE,
+        related_name='posts',
+    )
     tags = models.ManyToManyField(to='Tag', blank=True)
     audience = models.CharField(
         max_length=100,