Updates for TokenAdmin.

- Respect USERNAME_FIELD of the user model.
- Default ordering by username.
- Filter by creation date.

Author: m000

rest_framework/authtoken/admin.py

@@ -23,10 +23,11 @@ def url_for_result(self, result):
 
 class TokenAdmin(admin.ModelAdmin):
     list_display = ('key', 'user', 'created')
+    list_filter = ('created',)
     fields = ('user',)
-    search_fields = ('user__username',)
+    search_fields = ('user__%s' % User.USERNAME_FIELD,)
     search_help_text = _('Username')
-    ordering = ('-created',)
+    ordering = ('user__%s' % User.USERNAME_FIELD,)
     actions = None  # Actions not compatible with mapped IDs.
 
     def get_changelist(self, request, **kwargs):

tests/test_authtoken.py

@@ -1,5 +1,6 @@
 import importlib
 from io import StringIO
+from unittest.mock import patch
 
 import pytest
 from django.contrib.admin import site
@@ -11,11 +12,10 @@
 from rest_framework.authtoken.admin import TokenAdmin
 from rest_framework.authtoken.management.commands.drf_create_token import \
     Command as AuthTokenCommand
-from rest_framework.authtoken.models import Token
+from rest_framework.authtoken.models import Token, TokenProxy
 from rest_framework.authtoken.serializers import AuthTokenSerializer
 from rest_framework.exceptions import ValidationError
 
-
 class AuthTokenTests(TestCase):
 
     def setUp(self):
@@ -36,6 +36,28 @@ def test_model_admin_displayed_fields(self):
         token_admin = TokenAdmin(self.token, self.site)
         assert token_admin.get_fields(mock_request) == ('user',)
 
+    def test_model_admin__username_field(self):
+        import rest_framework.authtoken.admin as authtoken_admin_m
+
+        class EmailUser(User):
+            USERNAME_FIELD = 'email'
+            username = None
+
+        with patch('django.contrib.admin.site.register'):  # avoid duplicate registrations
+            for user_model in (User, EmailUser):
+                with (
+                    self.subTest(user_model=user_model),
+                    patch('django.contrib.auth.get_user_model', return_value=user_model) as get_user_model
+                ):
+                    importlib.reload(authtoken_admin_m)  # reload after patching
+                    assert get_user_model.call_count == 1
+
+                    mock_request = object()
+                    token_admin = authtoken_admin_m.TokenAdmin(TokenProxy, self.site)
+                    assert token_admin.get_search_fields(mock_request) == (f'user__{user_model.USERNAME_FIELD}',)
+                    assert token_admin.get_ordering(mock_request) == (f'user__{user_model.USERNAME_FIELD}',)
+            importlib.reload(authtoken_admin_m)  # restore after testing
+
     def test_token_string_representation(self):
         assert str(self.token) == 'test token'