Create basic ruff linter configuration

Author: maclick

.github/workflows/ruff.yml

@@ -0,0 +1,18 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1
+        with:
+          src: "./oioioi"
+          version: 0.0.265

oioioi/__init__.py

@@ -1,2 +1,2 @@
 # apply monkey patch
-from oioioi.contests import current_contest
+from oioioi.contests import current_contest  # noqa

oioioi/base/forms.py

@@ -7,18 +7,19 @@
 from django.contrib.auth import get_user_model
 from django.contrib.auth.forms import (
     PasswordResetForm,
-    UserChangeForm,
     UserCreationForm,
 )
 from django.contrib.auth.models import User
 from django.core.validators import RegexValidator
 from django.forms import BooleanField, ChoiceField
-from django.forms import ChoiceField
 from django.utils.translation import gettext_lazy as _
 from registration.forms import RegistrationForm
 
 from oioioi.base.models import Consents, PreferencesSaved
-from oioioi.base.preferences import PreferencesFactory, ensure_preferences_exist_for_user
+from oioioi.base.preferences import (
+    PreferencesFactory,
+    ensure_preferences_exist_for_user,
+)
 from oioioi.base.utils.user import UNICODE_CATEGORY_LIST, USERNAME_REGEX
 from oioioi.base.utils.validators import UnicodeValidator, ValidationError
 
@@ -68,6 +69,7 @@ def _maybe_add_field(label, *args, **kwargs):
         kwargs.setdefault('label', label)
         PreferencesFactory.add_field(*args, **kwargs)
 
+
 def adjust_preferences_factory_fields():
     choices_not_translated = [("", "None")] + list(settings.LANGUAGES)
     choices = [(k, _(v)) for k, v in choices_not_translated]
@@ -84,7 +86,7 @@ def handle_preferred_language(user):
         lambda name, user: handle_preferred_language(user),
         label=_("Preferred language"),
         choices=choices,
-        required=False
+        required=False,
     )
 
     def handle_enable_editor(user):
@@ -100,9 +102,10 @@ def handle_enable_editor(user):
             lambda name, user: handle_enable_editor(user),
             label=_("Enable editor"),
             order=0,
-            required=False
+            required=False,
         )
 
+
 def handle_new_preference_fields(request, user):
     changed = False
     ensure_preferences_exist_for_user(user)
@@ -127,6 +130,7 @@ def handle_new_preference_fields(request, user):
     if changed:
         user.userpreferences.save()
 
+
 _maybe_add_field(
     settings.REGISTRATION_RULES_CONSENT,
     'terms_accepted',
@@ -153,6 +157,7 @@ def handle_new_preference_fields(request, user):
 
 adjust_preferences_factory_fields()
 
+
 def save_consents(sender, user, **kwargs):
     form = sender
     consents = None
@@ -232,14 +237,14 @@ def save(self, *args, **kwargs):
         PreferencesSaved.send(self, user=instance)
         return instance
 
+
 class UserChangeForm(UserForm):
     confirm_password = forms.CharField(widget=forms.PasswordInput(), required=False)
 
     class Media(object):
         js = ('js/email-change.js',)
 
-    def __init__(self,  *args, **kwargs):
-
+    def __init__(self, *args, **kwargs):
         super(UserChangeForm, self).__init__(*args, **kwargs)
         self.user = kwargs.pop('instance', None)
 
@@ -253,7 +258,10 @@ def clean_confirm_password(self):
             return confirm_password
 
         if not self.user.check_password(confirm_password):
-            raise forms.ValidationError(_("Password incorrect."), code='password_incorrect', )
+            raise forms.ValidationError(
+                _("Password incorrect."),
+                code='password_incorrect',
+            )
         return confirm_password
 
 

oioioi/base/models.py

@@ -6,7 +6,7 @@
 
 # pylint: disable=unused-import
 # Important. This import is to register signal handlers. Do not remove it.
-import oioioi.base.signal_handlers
+import oioioi.base.signal_handlers  # noqa: F401
 from oioioi.base.captcha_check import captcha_check
 from oioioi.base.setup_check import setup_check
 
@@ -60,7 +60,7 @@ class UserPreferences(models.Model):
         _("preferred_language"),
         max_length=2,
         choices=list(settings.LANGUAGES) + [("", _("None"))],
-        default=""
+        default="",
     )
 
     enable_editor = models.BooleanField(

oioioi/base/registration_backend.py

@@ -1,10 +1,9 @@
 import logging
 
-import registration.backends.default.urls
-import registration.views
+import registration.backends.default.urls as default_urls
 from django.conf import settings
 from django.contrib.auth.models import User
-from django.contrib.auth.views import PasswordResetView, PasswordResetDoneView
+from django.contrib.auth.views import PasswordResetView
 from django.contrib.sites.requests import RequestSite
 from django.urls import re_path, reverse_lazy
 from django.views.generic import TemplateView
@@ -89,4 +88,4 @@ def register(self, form):
     ),
 ]
 
-urlpatterns += registration.backends.default.urls.urlpatterns
+urlpatterns += default_urls.urlpatterns

oioioi/base/signal_handlers.py

@@ -1,4 +1,3 @@
-import django
 from django.contrib.auth.signals import user_logged_in
 from django.db.backends.signals import connection_created
 from django.dispatch import receiver

oioioi/base/tests/__init__.py

@@ -4,11 +4,10 @@
 
 import pytest
 import urllib.parse
-from django.contrib.auth.models import AnonymousUser, User
+from django.contrib.auth.models import User
 from django.core.cache import cache
 from django.core.exceptions import ImproperlyConfigured
 from django.db import DEFAULT_DB_ALIAS, connections
-from django.template.loaders.cached import Loader as CachedLoader
 from django.test import TestCase as DjangoTestCase
 from django.test.utils import CaptureQueriesContext
 from django.urls import reverse
@@ -42,7 +41,6 @@ def __exit__(self, exc_type, exc_value, traceback):
 
 
 class TestCase(DjangoTestCase):
-
     # Based on: https://github.com/revsys/django-test-plus/blob/master/test_plus/test.py#L236
     def assertNumQueriesLessThan(self, num, *args, **kwargs):
         func = kwargs.pop('func', None)

oioioi/base/tests/tests.py

@@ -723,7 +723,7 @@ def test_registration_form_fields(self):
         self.assertIn('last_name', form.fields)
 
     def _register_user(self, terms_accepted=True, pass_captcha=True):
-        response = self.client.get(reverse('registration_register'))
+        self.client.get(reverse('registration_register'))
         captcha_count = CaptchaStore.objects.count()
         self.assertEqual(captcha_count, 1)
         captcha = CaptchaStore.objects.all()[0]
@@ -778,7 +778,6 @@ def test_registration_captcha_not_passed(self):
         self.assertEqual(User.objects.filter(username='test_foo').count(), 0)
 
 
-
 class TestArchive(TestCase):
     good_files = ['archive.tgz', 'archive.zip']
     bad_files = ['archive-with-symlink.tgz', 'archive-with-hardlink.tgz']
@@ -884,7 +883,7 @@ def test_edit_profile_view(self):
         self.assertEqual(user.last_name, 'ln')
 
     def test_edit_email(self):
-        #Trying to use incorrect email.
+        # Trying to use incorrect email.
         self.data['email'] = 'a@a'
         self.data['first_name'] = 'fn_new'
         self.data['last_name'] = 'ln_new'
@@ -905,7 +904,6 @@ def test_edit_email(self):
         self.assertEqual(self.user.first_name, self.first_name)
         self.assertEqual(self.user.last_name, self.last_name)
 
-
         # Trying to change email with wrong password.
         self.data['confirm_password'] = 'not-the-password'
         response = self.client.post(self.url_edit_profile, self.data, follow=True)
@@ -940,7 +938,6 @@ def test_terms_not_accepted(self):
         # and that the user sees an error
         self.assertContains(response, 'field is required')
 
-
         self.data.pop('terms_accepted')
         response = self.client.post(self.url_edit_profile, self.data, follow=True)
         self.assertEqual(response.status_code, 200)
@@ -978,8 +975,8 @@ def test_unicode_wrong_last_name(self):
         self.assertEqual(self.user.last_name, self.last_name)
 
     def test_names_with_valid_spaces(self):
-        self.data['first_name'] =  u'Jan Maria',
-        self.data['last_name'] = u'Le Guien',
+        self.data['first_name'] = (u'Jan Maria',)
+        self.data['last_name'] = (u'Le Guien',)
         response = self.client.post(self.url_edit_profile, self.data, follow=True)
         self.assertEqual(response.status_code, 200)
         self.user.refresh_from_db()
@@ -1032,12 +1029,14 @@ def callback_func(sender, **kwargs):
             for text in ['Doggy', 'Andrzej', '72', 'The answer to everything']:
                 self.assertContains(response, text)
 
-            self.data.update({
-                'first_name': 'fn',
-                'last_name': 'ln',
-                'dog': 'Janusz',
-                'answer': '42',
-            })
+            self.data.update(
+                {
+                    'first_name': 'fn',
+                    'last_name': 'ln',
+                    'dog': 'Janusz',
+                    'answer': '42',
+                }
+            )
 
             self.client.post(self.url_edit_profile, self.data, follow=True)
             # callback_func should be called already
@@ -1242,7 +1241,11 @@ def test_can_change_login_from_invalid(self):
 
             self.client.post(
                 self.url_edit_profile,
-                {'username': 'valid_user', 'terms_accepted': True, 'email': "[email protected]"},
+                {
+                    'username': 'valid_user',
+                    'terms_accepted': True,
+                    'email': "[email protected]",
+                },
                 follow=True,
             )
             self.assertEqual(self.user.username, l)
@@ -1395,7 +1398,7 @@ def test_strip_num_or_hash(self):
             'a_1_2.pdf': 'a_1.pdf',
         }
 
-        for (before, after) in cases.items():
+        for before, after in cases.items():
             self.assertEqual(strip_num_or_hash(before), after)
 
 
@@ -1461,7 +1464,6 @@ def test_api_token_regeneration(self):
 
 
 class TestDocsEndpoints(APITestCase):
-
     def test_docs(self):
         response = self.client.get('/api/docs', follow=True)
         self.assertContains(response, "OIOIOI API")
@@ -1508,15 +1510,16 @@ class TestPasswordReset(TestCase):
     fixtures = ['test_users']
 
     def setUp(self):
-        self.user = User.objects.create_user('test_email_user', '[email protected]', 'test1234')
+        self.user = User.objects.create_user(
+            'test_email_user', '[email protected]', 'test1234'
+        )
 
     def test_reset_password_email_send_existing(self):
-        response = self.client.post(reverse('auth_password_reset'), data={'email': self.user.email})
-        self.assertEqual(len(mail.outbox), 1)
-        self.assertRedirects(
-            response,
-            reverse('auth_password_reset_done')
+        response = self.client.post(
+            reverse('auth_password_reset'), data={'email': self.user.email}
         )
+        self.assertEqual(len(mail.outbox), 1)
+        self.assertRedirects(response, reverse('auth_password_reset_done'))
 
 
 class TestAccountDeletion(TestCase):
@@ -1551,7 +1554,6 @@ def test_account_deletion_no_password(self):
 
 
 class TestJsCatalog(TestCase):
-
     def test_javascript_catalog(self):
         response = self.client.get(reverse('javascript_catalog'))
         self.assertContains(response, 'jsi18n_initialized')

oioioi/base/utils/__init__.py

@@ -14,8 +14,6 @@
 import urllib.parse
 from django.forms.utils import flatatt
 from django.http import Http404, HttpResponse, HttpResponseRedirect
-from django.shortcuts import render
-from django.template import Template
 from django.template.loader import render_to_string
 from django.template.response import TemplateResponse
 from django.utils.encoding import force_str
@@ -438,9 +436,7 @@ def tabbed_view(request, template, context, tabs, tab_kwargs, link_builder):
             raise Http404
         qs = request.GET.dict()
         qs['key'] = next(iter(tabs)).key
-        return HttpResponseRedirect(
-            request.path + '?' + urllib.parse.urlencode(qs)
-        )
+        return HttpResponseRedirect(request.path + '?' + urllib.parse.urlencode(qs))
     key = request.GET['key']
     for tab in tabs:
         if tab.key == key:

oioioi/base/utils/archive.py

@@ -22,7 +22,6 @@
 # THE SOFTWARE.
 
 import os
-import sys
 import tarfile
 import tempfile
 import zipfile
@@ -77,11 +76,7 @@ def __del__(self):
 
     @staticmethod
     def _resolve_streamed_files(file, ext):
-        if (
-            isinstance(file, str)
-            or hasattr(file, 'seek')
-            or hasattr(file, 'tell')
-        ):
+        if isinstance(file, str) or hasattr(file, 'seek') or hasattr(file, 'tell'):
             return file, False
         lookup_filename = file.name + ext
         base, tail_ext = os.path.splitext(lookup_filename.lower())