Use Ruff for linting

.ruff.toml

@@ -0,0 +1 @@
+common/.ruff.toml

docs/_static/css/custom.css

@@ -20,4 +20,4 @@
   text-rendering: auto;
   -webkit-font-smoothing: antialiased;
 
-}
+}

media/css/header.css

@@ -40,4 +40,3 @@
 .ui-autocomplete { background: #fff; text-align: left; border: 1px solid #bfbfbf; }
 .ui-state-hover { background: #eee; }
 .ui-menu-item a { display: block; padding: 3px 10px; }
-

media/javascript/searchtools.js

@@ -512,4 +512,4 @@ var Search = {
 
 $(document).ready(function() {
   Search.init();
-});
+});

readthedocs/__init__.py

@@ -1,4 +1,3 @@
 """Read the Docs."""
 
-
 __version__ = "12.0.0"

readthedocs/allauth/providers/githubapp/urls.py

@@ -4,4 +4,5 @@
 
 from readthedocs.allauth.providers.githubapp.provider import GitHubAppProvider
 
+
 urlpatterns = default_urlpatterns(GitHubAppProvider)

readthedocs/allauth/providers/githubapp/views.py

@@ -1,10 +1,8 @@
 """Copied from allauth.socialaccount.providers.github.views."""
 
 from allauth.socialaccount.providers.github.views import GitHubOAuth2Adapter
-from allauth.socialaccount.providers.oauth2.views import (
-    OAuth2CallbackView,
-    OAuth2LoginView,
-)
+from allauth.socialaccount.providers.oauth2.views import OAuth2CallbackView
+from allauth.socialaccount.providers.oauth2.views import OAuth2LoginView
 
 
 class GitHubAppOAuth2Adapter(GitHubOAuth2Adapter):

readthedocs/analytics/apps.py

@@ -4,7 +4,6 @@
 
 
 class AnalyticsAppConfig(AppConfig):
-
     """Analytics app init code."""
 
     default_auto_field = "django.db.models.BigAutoField"

readthedocs/analytics/migrations/0001_initial.py

@@ -1,11 +1,14 @@
 # Generated by Django 2.2.12 on 2020-05-19 00:45
-
 import datetime
-from django.db import migrations, models
+
 import django.db.models.deletion
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     initial = True
 
     dependencies = [

readthedocs/analytics/migrations/0002_track_status_code.py

@@ -1,10 +1,12 @@
 # Generated by Django 3.2.12 on 2022-03-29 17:51
-
 import django.db.models.deletion
-from django.db import migrations, models
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     dependencies = [
         ("builds", "0041_track_task_id"),
         ("projects", "0087_use_booleanfield_null"),
@@ -25,16 +27,12 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name="pageview",
             name="status",
-            field=models.PositiveIntegerField(
-                default=200, help_text="HTTP status code"
-            ),
+            field=models.PositiveIntegerField(default=200, help_text="HTTP status code"),
         ),
         migrations.AlterField(
             model_name="pageview",
             name="path",
-            field=models.CharField(
-                help_text="Path relative to the version.", max_length=4096
-            ),
+            field=models.CharField(help_text="Path relative to the version.", max_length=4096),
         ),
         migrations.AlterField(
             model_name="pageview",

readthedocs/analytics/migrations/0003_remove_index.py

@@ -1,11 +1,13 @@
 # Generated by Django 3.2.13 on 2022-05-31 15:22
-
 import datetime
 
-from django.db import migrations, models
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     dependencies = [
         ("analytics", "0002_track_status_code"),
     ]

readthedocs/analytics/migrations/0004_merge_duplicate_records.py

@@ -1,7 +1,7 @@
 # Generated by Django 3.2.13 on 2022-07-06 21:11
-
 from django.db import migrations
 from django.db.models import Count
+from django_safemigrate import Safe
 
 
 def forwards_func(apps, schema_editor):
@@ -29,6 +29,7 @@ def forwards_func(apps, schema_editor):
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     dependencies = [
         ("analytics", "0003_remove_index"),
     ]

readthedocs/analytics/migrations/0005_add_unique_constraint.py

@@ -1,9 +1,11 @@
 # Generated by Django 3.2.13 on 2022-07-06 19:29
-
-from django.db import migrations, models
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     dependencies = [
         ("analytics", "0004_merge_duplicate_records"),
     ]

readthedocs/analytics/migrations/0006_alter_pageview_id.py

@@ -1,9 +1,11 @@
 # Generated by Django 3.2.15 on 2022-10-18 15:25
-
-from django.db import migrations, models
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     dependencies = [
         ("analytics", "0005_add_unique_constraint"),
     ]

readthedocs/analytics/migrations/0007_index_on_pageview_date.py

@@ -1,11 +1,13 @@
 # Generated by Django 3.2.19 on 2023-06-13 11:12
-
 import datetime
 
-from django.db import migrations, models
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     dependencies = [
         ("analytics", "0006_alter_pageview_id"),
     ]

readthedocs/analytics/models.py

@@ -1,4 +1,5 @@
 """Analytics modeling to help understand the projects on Read the Docs."""
+
 import datetime
 from collections import namedtuple
 from urllib.parse import urlparse
@@ -10,7 +11,8 @@
 
 from readthedocs.builds.models import Version
 from readthedocs.core.resolver import Resolver
-from readthedocs.projects.models import Feature, Project
+from readthedocs.projects.models import Feature
+from readthedocs.projects.models import Project
 
 
 def _last_30_days_iter():
@@ -22,7 +24,6 @@ def _last_30_days_iter():
 
 
 class PageViewManager(models.Manager):
-
     """Manager for PageView model."""
 
     def register_page_view(self, project, version, filename, path, status):
@@ -53,7 +54,6 @@ def register_page_view(self, project, version, filename, path, status):
 
 
 class PageView(models.Model):
-
     """PageView counts per day for a project, version, and path."""
 
     project = models.ForeignKey(
@@ -103,9 +103,7 @@ class Meta:
         ]
 
     @classmethod
-    def top_viewed_pages(
-        cls, project, since=None, limit=10, status=200, per_version=False
-    ):
+    def top_viewed_pages(cls, project, since=None, limit=10, status=200, per_version=False):
         """
         Returns top pages according to view counts.
 

readthedocs/analytics/proxied_api.py

@@ -1,4 +1,5 @@
 """Analytics views that are served from the same domain as the docs."""
+
 from functools import lru_cache
 from urllib.parse import urlparse
 
@@ -12,16 +13,17 @@
 from readthedocs.analytics.models import PageView
 from readthedocs.api.v2.permissions import IsAuthorizedToViewVersion
 from readthedocs.core.mixins import CDNCacheControlMixin
-from readthedocs.core.unresolver import UnresolverError, unresolve
+from readthedocs.core.unresolver import UnresolverError
+from readthedocs.core.unresolver import unresolve
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.core.utils.requests import is_suspicious_request
 from readthedocs.projects.models import Project
 
+
 log = structlog.get_logger(__name__)  # noqa
 
 
 class BaseAnalyticsView(CDNCacheControlMixin, APIView):
-
     """
     Track page views.
 

readthedocs/analytics/tasks.py

@@ -7,6 +7,7 @@
 import readthedocs
 from readthedocs.worker import app
 
+
 DEFAULT_PARAMETERS = {
     "v": "1",  # analytics version (always 1)
     "aip": "1",  # anonymize IP

readthedocs/analytics/utils.py

@@ -6,9 +6,11 @@
 import structlog
 from django.conf import settings
 from django.utils.crypto import get_random_string
-from django.utils.encoding import force_bytes, force_str
+from django.utils.encoding import force_bytes
+from django.utils.encoding import force_str
 from user_agents import parse
 
+
 log = structlog.get_logger(__name__)  # noqa
 
 

readthedocs/api/mixins.py

@@ -4,15 +4,16 @@
 from django.http import Http404
 from django.utils.functional import cached_property
 
-from readthedocs.core.unresolver import UnresolverError, unresolve
+from readthedocs.core.unresolver import UnresolverError
+from readthedocs.core.unresolver import unresolve
 from readthedocs.core.utils import get_cache_tag
 from readthedocs.proxito.cache import add_cache_tags
 
+
 log = structlog.get_logger(__name__)
 
 
 class CDNCacheTagsMixin:
-
     """
     Add cache tags for project and version to the response of this view.
 
@@ -64,7 +65,6 @@ def _get_cache_tags(self):
 
 
 class EmbedAPIMixin:
-
     """
     Helper for EmbedAPI v2 and v3.
 

readthedocs/api/v2/adapters.py

@@ -3,7 +3,6 @@
 
 
 class TimeoutAdapter:
-
     """
     Adapter to inject ``timeout`` to all the requests.
 

readthedocs/api/v2/client.py

@@ -4,16 +4,18 @@
 import structlog
 from django.conf import settings
 from rest_framework.renderers import JSONRenderer
-from slumber import API, serialize
+from slumber import API
+from slumber import serialize
 from urllib3.util.retry import Retry
 
-from .adapters import TimeoutHostHeaderSSLAdapter, TimeoutHTTPAdapter
+from .adapters import TimeoutHostHeaderSSLAdapter
+from .adapters import TimeoutHTTPAdapter
+
 
 log = structlog.get_logger(__name__)
 
 
 class DrfJsonSerializer(serialize.JsonSerializer):
-
     """Additional serialization help from the DRF renderer."""
 
     key = "json-drf"

readthedocs/api/v2/migrations/0001_initial.py

@@ -1,10 +1,12 @@
 # Generated by Django 3.2.18 on 2023-05-31 20:40
-
 import django.db.models.deletion
-from django.db import migrations, models
+from django.db import migrations
+from django.db import models
+from django_safemigrate import Safe
 
 
 class Migration(migrations.Migration):
+    safe = Safe.after_deploy
     initial = True
 
     dependencies = [

readthedocs/api/v2/models.py

@@ -3,7 +3,8 @@
 from django.db import models
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
-from rest_framework_api_key.models import AbstractAPIKey, BaseAPIKeyManager
+from rest_framework_api_key.models import AbstractAPIKey
+from rest_framework_api_key.models import BaseAPIKeyManager
 
 from readthedocs.projects.models import Project
 
@@ -28,7 +29,6 @@ def create_key(self, project):
 
 
 class BuildAPIKey(AbstractAPIKey):
-
     """
     API key for securely interacting with the API from the builders.