Django: upgrade to 4.2 (#10595)

* Django: upgrade to 4.2

Run `django-upgrade` (https://github.com/adamchainz/django-upgrade) to
automatically upgrade our code to match 4.2.

Note: this commit has no manual manipulation.

* Django: upgrade dependency to 4.2.x

Run `inv requirements.upgrade` after using 4.2.x.

* Django: run `django-upgrade` again after some import changes

* Upgrade comon/ to use latest pre-commit changes

* Django: minor manual changes for 4.2

* Migrations

* pytest ignore messages

* Update tests to make them work on Django 4.2

* Update test to make them all pass 🤞

* Update `common/`

* More work on Mocks

* Update Proxito tests

pytest.ini

@@ -22,7 +22,6 @@ filterwarnings =
     ignore:DateTimeField .* received a naive datetime .* while time zone support is active:RuntimeWarning
     ignore:.*:DeprecationWarning
 
-    ignore:.*:django.utils.deprecation.RemovedInDjango40Warning
-    ignore:.*:django.utils.deprecation.RemovedInDjango41Warning
+    ignore:.*:django.utils.deprecation.RemovedInDjango50Warning
     ignore:.*:elasticsearch.exceptions.ElasticsearchWarning
     ignore:.*:PendingDeprecationWarning

readthedocs/analytics/admin.py

@@ -5,12 +5,10 @@
 from .models import PageView
 
 
+@admin.register(PageView)
 class PageViewAdmin(admin.ModelAdmin):
     raw_id_fields = ('project', 'version')
     list_display = ('project', 'version', 'path', 'view_count', 'date')
     search_fields = ('project__slug', 'version__slug', 'path')
     readonly_fields = ('date',)
     list_select_related = ('project', 'version', 'version__project')
-
-
-admin.site.register(PageView, PageViewAdmin)

readthedocs/api/v2/urls.py

@@ -42,7 +42,7 @@
 )
 
 urlpatterns = [
-    re_path(r'^', include(router.urls)),
+    path("", include(router.urls)),
 ]
 
 urlpatterns += [
@@ -59,8 +59,8 @@
 ]
 
 task_urls = [
-    re_path(
-        r"jobs/status/(?P<task_id>[^/]+)/$",
+    path(
+        "jobs/status/<str:task_id>/",
         task_views.job_status,
         name='api_job_status',
     ),
@@ -122,5 +122,5 @@
     from readthedocsext.donate.restapi.urls import urlpatterns as sustainability_urls
 
     urlpatterns += [
-        re_path(r'^sustainability/', include(sustainability_urls)),
+        path("sustainability/", include(sustainability_urls)),
     ]

readthedocs/builds/admin.py

@@ -21,6 +21,7 @@ class BuildCommandResultInline(admin.TabularInline):
     fields = ("command", "exit_code", "output")
 
 
+@admin.register(Build)
 class BuildAdmin(admin.ModelAdmin):
     fields = (
         "project",
@@ -65,12 +66,13 @@ def project_slug(self, obj):
     def version_slug(self, obj):
         return obj.version.slug
 
+    @admin.display(description="Config File")
     def pretty_config(self, instance):
         return pretty_json_field(instance, "config")
 
-    pretty_config.short_description = "Config File"
 
 
+@admin.register(Version)
 class VersionAdmin(admin.ModelAdmin):
 
     list_display = (
@@ -92,11 +94,11 @@ class VersionAdmin(admin.ModelAdmin):
     def project_slug(self, obj):
         return obj.project.slug
 
+    @admin.display(description="Config File")
     def pretty_config(self, instance):
         return pretty_json_field(instance, "config")
 
-    pretty_config.short_description = "Config File"
-
+    @admin.action(description="Build version")
     def build_version(self, request, queryset):
         """Trigger a build for the project version."""
         total = 0
@@ -112,8 +114,7 @@ def build_version(self, request, queryset):
             "Triggered builds for {} version(s).".format(total),
         )
 
-    build_version.short_description = "Build version"
-
+    @admin.action(description="Reindex version to ES")
     def reindex_version(self, request, queryset):
         """Reindexes all selected versions to ES."""
         html_objs_qs = []
@@ -130,8 +131,7 @@ def reindex_version(self, request, queryset):
 
         self.message_user(request, "Task initiated successfully.", messages.SUCCESS)
 
-    reindex_version.short_description = "Reindex version to ES"
-
+    @admin.action(description="Wipe version from ES")
     def wipe_version_indexes(self, request, queryset):
         """Wipe selected versions from ES."""
         html_objs_qs = []
@@ -152,7 +152,6 @@ def wipe_version_indexes(self, request, queryset):
             messages.SUCCESS,
         )
 
-    wipe_version_indexes.short_description = "Wipe version from ES"
 
 
 @admin.register(RegexAutomationRule)
@@ -176,7 +175,3 @@ class VersionAutomationRuleAdmin(PolymorphicParentModelAdmin, admin.ModelAdmin):
     child_models = (RegexAutomationRule,)
     search_fields = ("project__slug",)
     list_filter = ("action", "version_type")
-
-
-admin.site.register(Build, BuildAdmin)
-admin.site.register(Version, VersionAdmin)

readthedocs/builds/migrations/0052_alter_versionautomationrule_polymorphic_ctype.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.4 on 2023-08-02 10:59
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("builds", "0051_add_addons_field"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="versionautomationrule",
+            name="polymorphic_ctype",
+            field=models.ForeignKey(
+                editable=False,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="polymorphic_%(app_label)s.%(class)s_set+",
+                to="contenttypes.contenttype",
+            ),
+        ),
+    ]

readthedocs/builds/urls.py

@@ -1,6 +1,6 @@
 """URL configuration for builds app."""
 
-from django.conf.urls import re_path
+from django.urls import re_path
 from django.views.generic.base import RedirectView
 
 

readthedocs/core/admin.py

@@ -82,12 +82,14 @@ class UserAdminExtra(ExtraSimpleHistoryAdmin, UserAdmin):
     actions = ["ban_user", "sync_remote_repositories_action"]
     inlines = [UserProjectInline]
 
+    @admin.display(
+        description="Banned",
+        boolean=True,
+    )
     def is_banned(self, obj):
         return hasattr(obj, 'profile') and obj.profile.banned
 
-    is_banned.short_description = 'Banned'
-    is_banned.boolean = True
-
+    @admin.action(description="Ban user")
     def ban_user(self, request, queryset):
         users = []
         for profile in UserProfile.objects.filter(user__in=queryset):
@@ -96,8 +98,7 @@ def ban_user(self, request, queryset):
             users.append(profile.user.username)
         self.message_user(request, 'Banned users: %s' % ', '.join(users))
 
-    ban_user.short_description = 'Ban user'
-
+    @admin.action(description="Sync remote repositories")
     def sync_remote_repositories_action(self, request, queryset):
         formatted_task_urls = []
 
@@ -118,9 +119,9 @@ def sync_remote_repositories_action(self, request, queryset):
             ),
         )
 
-    sync_remote_repositories_action.short_description = "Sync remote repositories"
 
 
+@admin.register(UserProfile)
 class UserProfileAdmin(ExtraSimpleHistoryAdmin):
     list_display = ('user', 'homepage')
     search_fields = ('user__username', 'homepage')
@@ -153,6 +154,5 @@ def organizations(self, obj):
 
 admin.site.unregister(User)
 admin.site.register(User, UserAdminExtra)
-admin.site.register(UserProfile, UserProfileAdmin)
 admin.site.unregister(Message)
 admin.site.register(Message, MessageAdminExtra)

readthedocs/core/tests/test_history.py

@@ -26,7 +26,7 @@ def test_extra_historical_fields_with_request(self):
                 'repo_type': self.project.repo_type,
                 'language': self.project.language,
             },
-            HTTP_USER_AGENT='Firefox',
+            headers={"user-agent": "Firefox"},
         )
         self.assertEqual(r.status_code, 302)
         self.assertEqual(self.project.history.count(), 2)

readthedocs/gold/admin.py

@@ -6,12 +6,10 @@
 from .models import GoldUser
 
 
+@admin.register(GoldUser)
 class GoldAdmin(admin.ModelAdmin):
     model = GoldUser
     raw_id_fields = ('user', 'projects')
     list_display = ('user', 'level', 'modified_date', 'subscribed')
     list_filter = ('level',)
     search_fields = ('projects__slug', 'user__email', 'user__username', 'stripe_id')
-
-
-admin.site.register(GoldUser, GoldAdmin)

readthedocs/gold/urls.py

@@ -1,28 +1,28 @@
 
 """Gold subscription URLs."""
 
-from django.conf.urls import re_path
+from django.urls import path, re_path
 
 from readthedocs.gold import views
 from readthedocs.projects.constants import PROJECT_SLUG_REGEX
 
 urlpatterns = [
-    re_path(
-        r'^$',
+    path(
+        "",
         views.GoldSubscription.as_view(),
         name='gold_detail',
     ),
-    re_path(
-        r'^subscription/checkout/create/$',
+    path(
+        "subscription/checkout/create/",
         views.GoldCreateCheckoutSession.as_view(),
         name='gold_checkout_create',
     ),
-    re_path(
-        r'^subscription/portal/$',
+    path(
+        "subscription/portal/",
         views.GoldSubscriptionPortal.as_view(),
         name='gold_subscription_portal',
     ),
-    re_path(r'^projects/$', views.GoldProjectsListCreate.as_view(), name='gold_projects'),
+    path("projects/", views.GoldProjectsListCreate.as_view(), name="gold_projects"),
     re_path(
         (
             r'^projects/remove/(?P<project_slug>{project_slug})/$'.format(

readthedocs/integrations/admin.py

@@ -30,6 +30,7 @@ def inner(_, obj):
     return inner
 
 
+@admin.register(HttpExchange)
 class HttpExchangeAdmin(admin.ModelAdmin):
 
     """
@@ -73,13 +74,16 @@ class HttpExchangeAdmin(admin.ModelAdmin):
         'Response body',
     )
 
+    @admin.display(
+        description="Passed",
+        boolean=True,
+    )
     def failed_icon(self, obj):
         return not obj.failed
 
-    failed_icon.boolean = True
-    failed_icon.short_description = 'Passed'
 
 
+@admin.register(Integration)
 class IntegrationAdmin(admin.ModelAdmin):
 
     """
@@ -94,6 +98,7 @@ class IntegrationAdmin(admin.ModelAdmin):
     readonly_fields = ['exchanges']
 
     # TODO: review this now that we are using official Django's JSONField
+    @admin.display(description="HTTP exchanges")
     def exchanges(self, obj):
         """
         Manually make an inline-ish block.
@@ -103,8 +108,8 @@ def exchanges(self, obj):
         """
         url = urls.reverse(
             'admin:{}_{}_changelist'.format(
-                HttpExchange._meta.app_label,  # pylint: disable=protected-access
-                HttpExchange._meta.model_name,  # pylint: disable=protected-access
+                HttpExchange._meta.app_label,
+                HttpExchange._meta.model_name,
             ),
         )
         return mark_safe(
@@ -115,9 +120,3 @@ def exchanges(self, obj):
                 obj.exchanges.count(),
             ),
         )
-
-    exchanges.short_description = 'HTTP exchanges'
-
-
-admin.site.register(HttpExchange, HttpExchangeAdmin)
-admin.site.register(Integration, IntegrationAdmin)

readthedocs/invitations/views.py

@@ -27,14 +27,14 @@ class RevokeInvitation(PrivateViewMixin, UserPassesTestMixin, DeleteView):
     pk_url_kwarg = "invitation_pk"
     http_method_names = ["post"]
 
-    def delete(self, request, *args, **kwargs):
+    def form_valid(self, form):
         invitation = self.get_object()
         invitation.create_audit_log(
             action=AuditLog.INVITATION_REVOKED,
-            request=request,
-            user=request.user,
+            request=self.request,
+            user=self.request.user,
         )
-        return super().delete(request, *args, **kwargs)
+        return super().form_valid(form)
 
     def test_func(self):
         invitation = self.get_object()
@@ -70,7 +70,6 @@ def get_context_data(self, **kwargs):
         context["target_type"] = invitation.object._meta.verbose_name
         return context
 
-    # pylint: disable=unused-argument
     def post(self, request, *args, **kwargs):
         """
         Accept or decline an invitation.

readthedocs/notifications/urls.py

@@ -1,16 +1,16 @@
 """Renames for messages_extends URLs."""
 
-from django.conf.urls import re_path
+from django.urls import path
 from messages_extends.views import message_mark_all_read, message_mark_read
 
 urlpatterns = [
-    re_path(
-        r'^dismiss/(?P<message_id>\d+)/$',
+    path(
+        "dismiss/<int:message_id>/",
         message_mark_read,
         name='message_mark_read',
     ),
-    re_path(
-        r'^dismiss/all/$',
+    path(
+        "dismiss/all/",
         message_mark_all_read,
         name='message_mark_all_read',
     ),