Lint: run prospector and fix code manually

Author: humitos

readthedocs/api/v3/serializers.py

@@ -128,7 +128,7 @@ class BuildConfigSerializer(FlexFieldsSerializerMixin, serializers.Serializer):
        which may produce incompatible changes in the API.
     """
 
-    def to_representation(self, instance):  # pylint: disable=arguments-differ
+    def to_representation(self, instance):
         # For now, we want to return the ``config`` object as it is without
         # manipulating it.
         return instance
@@ -504,7 +504,7 @@ def validate_name(self, value):
             )
         return value
 
-    def validate(self, data):  # pylint: disable=arguments-differ
+    def validate(self, data):  # pylint: disable=arguments-renamed
         repo = data.get("repo")
         try:
             # We are looking for an exact match of the repository URL entered
@@ -730,8 +730,7 @@ def validate_alias(self, value):
             )
         return value
 
-    # pylint: disable=arguments-differ
-    def validate(self, data):
+    def validate(self, data):  # pylint: disable=arguments-renamed
         self.parent_project.is_valid_as_superproject(serializers.ValidationError)
         return data
 

readthedocs/api/v3/urls.py

@@ -18,7 +18,6 @@
 # allows /api/v3/projects/
 # allows /api/v3/projects/pip/
 # allows /api/v3/projects/pip/superproject/
-# pylint: disable=assignment-from-no-return
 projects = router.register(
     r"projects",
     ProjectsViewSet,

readthedocs/audit/serializers.py

@@ -62,7 +62,6 @@ class Meta:
             "from_user",
         ]
 
-    # pylint: disable=no-self-use
     def get_object(self, obj):
         # The type of obj depends on the invitation,
         # a different serializer is used for each type.

readthedocs/builds/version_slug.py

@@ -74,7 +74,6 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def get_queryset(self, model_cls, slug_field):
-        # pylint: disable=protected-access
         for field, model in get_fields_with_model(model_cls):
             if model and field == slug_field:
                 return model._default_manager.all()
@@ -154,7 +153,6 @@ def uniquifying_suffix(self, iteration):
 
     def create_slug(self, model_instance):
         """Generate a unique slug for a model instance."""
-        # pylint: disable=protected-access
 
         # get fields to populate from and slug field to set
         slug_field = model_instance._meta.get_field(self.attname)
@@ -197,6 +195,7 @@ def create_slug(self, model_instance):
 
         is_slug_valid = self.test_pattern.match(slug)
         if not is_slug_valid:
+            # pylint: disable=broad-exception-raised
             raise Exception("Invalid generated slug: {slug}".format(slug=slug))
         return slug
 

readthedocs/builds/views.py

@@ -123,7 +123,7 @@ def _get_versions(self, project):
 
 
 class BuildList(BuildBase, BuildTriggerMixin, ListView):
-    def get_context_data(self, **kwargs):  # pylint: disable=arguments-differ
+    def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
 
         active_builds = (

readthedocs/core/logs.py

@@ -23,7 +23,8 @@ class ReadTheDocsRequestMiddleware(RequestMiddleware):
 
     """
 
-    def format_request(self, request):
+    @staticmethod
+    def format_request(request):
         return request.build_absolute_uri()
 
 

readthedocs/core/utils/extend.py

@@ -24,7 +24,6 @@ def get_override_class(proxy_class, default_class=None):
         ]
     )
     class_path = settings.CLASS_OVERRIDES.get(class_id)
-    # pylint: disable=protected-access
     if class_path is None and proxy_class._override_setting is not None:
         class_path = getattr(settings, proxy_class._override_setting, None)
     if class_path is not None:

readthedocs/embed/v3/views.py

@@ -41,7 +41,6 @@ def has_permission(self, request, view):
 
 class EmbedAPIBase(EmbedAPIMixin, CDNCacheTagsMixin, APIView):
     # pylint: disable=line-too-long
-    # pylint: disable=no-self-use
 
     """
     Embed a section of content from any Read the Docs page.
@@ -154,7 +153,7 @@ def _find_main_node(self, html):
             return first_header.parent
 
     def _parse_based_on_doctool(self, page_content, fragment, doctool, doctoolversion):
-        # pylint: disable=unused-argument disable=too-many-branches disable=too-many-nested-blocks
+        # pylint: disable=unused-argument disable=too-many-nested-blocks
         if not page_content:
             return
 

readthedocs/gold/models.py

@@ -55,6 +55,6 @@ def __str__(self):
 
     @property
     def num_supported_projects(self):
-        dollars = int(self.level.split("-")[-1])
+        dollars = int(self.level.rsplit("-", maxsplit=1)[-1])
         num_projects = int(math.floor(dollars // DOLLARS_PER_PROJECT))
         return num_projects

readthedocs/gold/views.py

@@ -107,7 +107,6 @@ class GoldProjectRemove(GoldProjectsMixin, GenericView):
     http_method_names = ["post"]
 
     def post(self, request, *args, **kwargs):
-        # pylint: disable=unused-argument
         gold_user = self.get_gold_user()
 
         project = get_object_or_404(

readthedocs/integrations/models.py

@@ -125,8 +125,8 @@ def delete_limit(self, related_object, limit=10):
 
         queryset = self.filter(
             content_type=ContentType.objects.get(
-                app_label=model._meta.app_label,  # pylint: disable=protected-access
-                model=model._meta.model_name,  # pylint: disable=protected-access
+                app_label=model._meta.app_label,
+                model=model._meta.model_name,
             ),
             object_id=related_object.pk,
         )
@@ -377,7 +377,7 @@ class GenericAPIWebhook(Integration):
     class Meta:
         proxy = True
 
-    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
+    def save(self, *args, **kwargs):
         """Ensure model has token data before saving."""
         try:
             token = self.provider_data.get("token")

readthedocs/notifications/notification.py

@@ -64,7 +64,7 @@ def get_context_data(self):
     def get_template_names(self, backend_name, source_format=constants.HTML):
         names = []
         if self.object and isinstance(self.object, models.Model):
-            meta = self.object._meta  # pylint: disable=protected-access
+            meta = self.object._meta
             names.append(
                 "{app}/notifications/{name}_{backend}.{source_format}".format(
                     app=self.app_templates or meta.app_label,
@@ -160,7 +160,7 @@ def get_message(self, success):
         msg = ""  # default message in case of error
         if isinstance(message, dict):
             if self.reason:
-                if self.reason in message:
+                if self.reason in message.keys():
                     msg = message.get(self.reason)
                 else:
                     # log the error but not crash
@@ -181,5 +181,5 @@ def get_message(self, success):
 
         return Template(msg).render(context=Context(self.get_context_data()))
 
-    def render(self, *args, **kwargs):  # pylint: disable=arguments-differ
+    def render(self, *args, **kwargs):
         return self.get_message(self.success)

readthedocs/oauth/management/commands/sync_vcs_data.py

@@ -99,6 +99,7 @@ def handle(self, *args, **options):
         if skip_revoked_users:
             # `revoked-users.json` was created by a script pullig down data from Sentry
             # https://gist.github.com/humitos/aba1a004abeb3552fd8ef9a741f5dce1
+            # pylint: disable=consider-using-with disable=unspecified-encoding
             revoked_users = json.load(open("revoked-users.json", "r"))
             users = users.exclude(username__in=revoked_users)
             self.stdout.write(

readthedocs/projects/management/commands/import_project_from_live.py

@@ -53,6 +53,7 @@ def handle(self, *args, **options):
                 "https://readthedocs.org/api/v2/project/",
                 params={"slug": slug},
                 auth=auth,
+                timeout=3,
             )
             resp.raise_for_status()  # This should only fail if RTD is having issues
             response_data = resp.json()

readthedocs/projects/tag_utils.py

@@ -78,7 +78,7 @@ def import_tags(project):
         "client_secret": provider.secret,
     }
 
-    resp = requests.get(url, headers=headers, params=params)
+    resp = requests.get(url, headers=headers, params=params, timeout=3)
     if resp.ok:
         tags = resp.json()["names"]
         if tags:

readthedocs/projects/views/public.py

@@ -63,7 +63,7 @@ def get_queryset(self):
 
         return queryset
 
-    def get_context_data(self, **kwargs):  # pylint: disable=arguments-differ
+    def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context["tag"] = self.tag
         return context
@@ -232,6 +232,7 @@ def serve_badge(self, request, status):
         )
 
         try:
+            # pylint: disable=unspecified-encoding
             with open(badge_path) as fd:
                 return HttpResponse(
                     fd.read(),

readthedocs/redirects/models.py

@@ -42,7 +42,7 @@
     "Example: <b>/docs/</b>  or <b>/install.html</b>",
 )
 to_url_helptext = _(
-    "Absolute or relative URL. Example: " "<b>/tutorial/install.html</b>",
+    "Absolute or relative URL. Example: <b>/tutorial/install.html</b>",
 )
 redirect_type_helptext = _("The type of redirect you wish to use.")
 
@@ -114,7 +114,7 @@ class Meta:
         verbose_name_plural = _("redirects")
         ordering = ("-update_dt",)
 
-    def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
+    def save(self, *args, **kwargs):
         if self.redirect_type == "exact" and "$rest" in self.from_url:
             self.from_url_without_rest = self.from_url.replace("$rest", "")
         super().save(*args, **kwargs)
@@ -209,7 +209,7 @@ def redirect_exact(self, path, full_path, language=None, version_slug=None):
             return self.to_url
         # Handle full sub-level redirects
         if "$rest" in self.from_url:
-            match = self.from_url.split("$rest")[0]
+            match = self.from_url.split("$rest", maxsplit=1)[0]
             if full_path.startswith(match):
                 cut_path = full_path.replace(match, self.to_url, 1)
                 return cut_path

readthedocs/search/signals.py

@@ -11,7 +11,6 @@
 log = structlog.get_logger(__name__)
 
 
-# pylint: disable=unused-argument
 @receiver(post_save, sender=Project)
 def index_project_save(instance, *args, **kwargs):
     """

readthedocs/storage/s3_storage.py

@@ -41,7 +41,6 @@ def _rclone(self):
         )
 
 
-# pylint: disable=too-many-ancestors
 class S3BuildMediaStorage(OverrideHostnameMixin, S3BuildMediaStorageMixin):
 
     """An AWS S3 Storage backend for build artifacts."""

readthedocs/subscriptions/apps.py

@@ -17,7 +17,6 @@ def ready(self):
 
         self._add_custom_manager()
 
-    # pylint: disable=no-self-use
     def _add_custom_manager(self):
         """
         Add a custom manager to the djstripe Subscription model.

readthedocs/worker.py

@@ -71,4 +71,4 @@ def register_renamed_tasks(application, renamed_tasks):
     return application
 
 
-app = create_application()  # pylint: disable=invalid-name
+app = create_application()