Add ruff as a linter with basic rules

.github/workflows/ruff.yml

@@ -0,0 +1,18 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - master
+  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

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.269
+    hooks:
+    -   id: ruff
+        files: ^oioioi/
+        args: [ --fix, --exit-non-zero-on-fix ]

easy_toolbox.py

@@ -3,7 +3,7 @@
 # pip requirements:
 #   python ^3.6
 #   inquirer     (only for GUI)
-# 
+#
 # system:
 #   docker
 #   docker-compose
@@ -19,8 +19,9 @@
 import os
 
 
-BASE_DOCKER_COMMAND = "OIOIOI_UID=$(id -u) docker-compose" + \
-                      " -f docker-compose-dev.yml"
+BASE_DOCKER_COMMAND = (
+    "OIOIOI_UID=$(id -u) docker-compose" + " -f docker-compose-dev.yml"
+)
 
 RAW_COMMANDS = [
     ("build", "Build OIOIOI container from source.", "build", True),
@@ -31,17 +32,38 @@
     ("bash", "Open command prompt on web container.", "{exec} web bash"),
     ("bash-db", "Open command prompt on database container.", "{exec} db bash"),
     # This one CLEARS the database. Use wisely.
-    ("flush-db", "Clear database.", "{exec} web python manage.py flush --noinput", True),
-    ("add-superuser", "Create admin_admin.",
-     "{exec} web python manage.py loaddata ../oioioi/oioioi_cypress/cypress/fixtures/admin_admin.json"),
+    (
+        "flush-db",
+        "Clear database.",
+        "{exec} web python manage.py flush --noinput",
+        True,
+    ),
+    (
+        "add-superuser",
+        "Create admin_admin.",
+        "{exec} web python manage.py loaddata ../oioioi/oioioi_cypress/cypress/fixtures/admin_admin.json",
+    ),
     ("test", "Run unit tests.", "{exec} web ../oioioi/test.sh"),
-    ("test-slow", "Run unit tests. (--runslow)", "{exec} web ../oioioi/test.sh --runslow"),
-    ("test-abc", "Run specific test file. (edit the toolbox)",
-     "{exec} web ../oioioi/test.sh -v oioioi/problems/tests/test_task_archive.py"),
-    ("test-coverage", "Run coverage tests.",
-     "{exec} 'web' ../oioioi/test.sh oioioi/problems --cov-report term --cov-report xml:coverage.xml --cov=oioioi"),
-    ("cypress-apply-settings", "Apply settings for CyPress.",
-     "{exec} web bash -c \"echo CAPTCHA_TEST_MODE=True >> settings.py\""),
+    (
+        "test-slow",
+        "Run unit tests. (--runslow)",
+        "{exec} web ../oioioi/test.sh --runslow",
+    ),
+    (
+        "test-abc",
+        "Run specific test file. (edit the toolbox)",
+        "{exec} web ../oioioi/test.sh -v oioioi/problems/tests/test_task_archive.py",
+    ),
+    (
+        "test-coverage",
+        "Run coverage tests.",
+        "{exec} 'web' ../oioioi/test.sh oioioi/problems --cov-report term --cov-report xml:coverage.xml --cov=oioioi",
+    ),
+    (
+        "cypress-apply-settings",
+        "Apply settings for CyPress.",
+        "{exec} web bash -c \"echo CAPTCHA_TEST_MODE=True >> settings.py\"",
+    ),
 ]
 
 longest_command_arg = max([len(command[0]) for command in RAW_COMMANDS])
@@ -63,7 +85,9 @@ def fill_tty(self, disable=False):
         self.command = self.command.format(exec="exec -T" if disable else "exec")
 
     def long_str(self) -> str:
-        return f"Option({self.arg}, Description='{self.help}', Command='{self.command}')"
+        return (
+            f"Option({self.arg}, Description='{self.help}', Command='{self.command}')"
+        )
 
     def __str__(self) -> str:
         spaces = longest_command_arg - len(self.arg)
@@ -75,7 +99,9 @@ def __str__(self) -> str:
 
 def check_commands() -> None:
     if len(set([opt.arg for opt in COMMANDS])) != len(COMMANDS):
-        raise Exception("Error in COMMANDS. Same name was declared for more then one command.")
+        raise Exception(
+            "Error in COMMANDS. Same name was declared for more then one command."
+        )
 
 
 NO_INPUT = False
@@ -110,12 +136,9 @@ def get_action_from_args() -> Option:
 
 def get_action_from_gui() -> Option:
     import inquirer
+
     questions = [
-        inquirer.List(
-            "action",
-            message="Select OIOIOI action",
-            choices=COMMANDS
-        )
+        inquirer.List("action", message="Select OIOIOI action", choices=COMMANDS)
     ]
     answers = inquirer.prompt(questions)
     return answers["action"]
@@ -130,7 +153,9 @@ def run_command(command) -> None:
 
 
 def warn_user(action: Option) -> bool:
-    print(f"You are going to execute command [{action.command}] marked as `dangerous`. Are you sure? [y/N]")
+    print(
+        f"You are going to execute command [{action.command}] marked as `dangerous`. Are you sure? [y/N]"
+    )
     while True:
         choice = input().lower()
         if not choice or "no".startswith(choice):
@@ -152,10 +177,19 @@ def run() -> None:
 
 
 def print_help() -> None:
-    print("OIOIOI helper toolbox", "", "This script allows to control OIOIOI with Docker commands.",
-          f"Commands are always being run with '{BASE_DOCKER_COMMAND}' prefix.",
-          f"Aveliable commands are: ", "",
-          *COMMANDS, "", "Example `build`:", f"{sys.argv[0]} build", sep="\n")
+    print(
+        "OIOIOI helper toolbox",
+        "",
+        "This script allows to control OIOIOI with Docker commands.",
+        f"Commands are always being run with '{BASE_DOCKER_COMMAND}' prefix.",
+        f"Aveliable commands are: ",
+        "",
+        *COMMANDS,
+        "",
+        "Example `build`:",
+        f"{sys.argv[0]} build",
+        sep="\n",
+    )
 
 
 def main() -> None:

oioioi/__init__.py

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

oioioi/_locale/apps.py

@@ -4,4 +4,3 @@
 class LocaleConfig(AppConfig):
     default_auto_field = 'django.db.models.AutoField'
     name = 'oioioi._locale'
-

oioioi/acm/controllers.py

@@ -58,8 +58,9 @@ def fill_evaluation_environ(self, environ, submission):
 
     def update_report_statuses(self, submission, queryset):
         if submission.kind == 'TESTRUN':
-            self._activate_newest_report(submission, queryset,
-                    kind=['TESTRUN', 'FAILURE'])
+            self._activate_newest_report(
+                submission, queryset, kind=['TESTRUN', 'FAILURE']
+            )
             return
 
         self._activate_newest_report(submission, queryset, kind=['FULL', 'FAILURE'])

oioioi/acm/score.py

@@ -163,7 +163,7 @@ def _to_repr(self):
 
            ``penalties_count`` is number of unsuccessful submissions.
         """
-        ordering = 10 ** 10 * (self.problems_solved + 1) - self.total_time
+        ordering = 10**10 * (self.problems_solved + 1) - self.total_time
         return '%020d:%010d:%010d:%010d' % (
             ordering,
             self.problems_solved,

oioioi/acm/utils.py

@@ -8,16 +8,12 @@ def acm_test_scorer(test, result):
 
 
 def acm_group_scorer(test_results):
-    status = aggregate_statuses(
-        [result['status'] for result in test_results.values()]
-    )
+    status = aggregate_statuses([result['status'] for result in test_results.values()])
     return None, None, status
 
 
 def acm_score_aggregator(group_results):
     if not group_results:
         return None, None, 'OK'
-    status = aggregate_statuses(
-        [result['status'] for result in group_results.values()]
-    )
+    status = aggregate_statuses([result['status'] for result in group_results.values()])
     return BinaryScore(status == 'OK'), BinaryScore(True), status

oioioi/balloons/management/commands/import_balloons_displays.py

@@ -1,7 +1,7 @@
 import csv
 import os
-
 import urllib.request
+
 from django.contrib.auth.models import User
 from django.core.exceptions import ValidationError
 from django.core.management.base import BaseCommand, CommandError
@@ -111,6 +111,4 @@ def handle(self, *args, **options):
             if ok:
                 self.stdout.write(_("Processed %d entries") % (all_count))
             else:
-                raise CommandError(
-                    _("There were some errors. Database not changed.\n")
-                )
+                raise CommandError(_("There were some errors. Database not changed.\n"))

oioioi/balloons/models.py

@@ -1,6 +1,5 @@
 from django.contrib.auth.models import User
 from django.db import models
-
 from django.utils.translation import gettext_lazy as _
 
 from oioioi.base.utils import generate_key
@@ -11,7 +10,6 @@
 check_django_app_dependencies(__name__, ['oioioi.participants', 'oioioi.acm'])
 
 
-
 class ProblemBalloonsConfig(models.Model):
     problem_instance = models.OneToOneField(
         ProblemInstance,
@@ -27,13 +25,7 @@ class Meta(object):
         verbose_name_plural = _("balloons colors")
 
     def __str__(self):
-        return (
-            str(self.problem_instance)
-            + u' ('
-            + str(self.color)
-            + u')'
-        )
-
+        return str(self.problem_instance) + u' (' + str(self.color) + u')'
 
 
 class BalloonsDisplay(models.Model):
@@ -55,7 +47,6 @@ def __str__(self):
         return str(self.ip_addr)
 
 
-
 class BalloonDelivery(models.Model):
     user = models.ForeignKey(User, verbose_name=_("user"), on_delete=models.CASCADE)
     problem_instance = models.ForeignKey(

oioioi/base/admin.py

@@ -1,4 +1,5 @@
 import urllib.parse
+
 from django.contrib import admin, messages
 from django.contrib.admin import helpers
 from django.contrib.admin.sites import AdminSite as DjangoAdminSite
@@ -62,10 +63,7 @@ class ModelAdminMeta(admin.ModelAdmin.__class__, ClassInitMeta):
     pass
 
 
-class ModelAdmin(
-    admin.ModelAdmin, ObjectWithMixins, metaclass=ModelAdminMeta
-):
-
+class ModelAdmin(admin.ModelAdmin, ObjectWithMixins, metaclass=ModelAdminMeta):
     # This is handled by AdminSite._reinit_model_admins
     allow_too_late_mixins = True
 
@@ -332,11 +330,7 @@ def get_urls(self):
 
     def login(self, request, extra_context=None):
         next_url = request.GET.get('next', None)
-        suffix = (
-            '?' + urllib.parse.urlencode({'next': next_url})
-            if next_url
-            else ''
-        )
+        suffix = '?' + urllib.parse.urlencode({'next': next_url}) if next_url else ''
         return HttpResponseRedirect(reverse('auth_login') + suffix)
 
 

oioioi/base/api.py

@@ -12,14 +12,14 @@
 
 @api_view()
 def ping(request):
-    """ Test endpoint for unauthorized user. """
+    """Test endpoint for unauthorized user."""
     return Response("pong")
 
 
 @api_view()
 @enforce_condition(not_anonymous, login_redirect=False)
 def auth_ping(request):
-    """ Test endpoint for authorized user. """
+    """Test endpoint for authorized user."""
     return Response("pong " + str(request.user))
 
 

oioioi/base/captcha_check.py

@@ -13,7 +13,6 @@ class CaptchaAudioWarning(Warning):
 
 
 def _check_executable(setting_name, path, expected_code=0):
-
     if not os.path.isfile(path):
         raise ImproperlyConfigured(
             '{}: {} is not a valid path.'.format(setting_name, path)

oioioi/base/fields.py

@@ -178,7 +178,7 @@ def __iter__(self):
         return self.entries.__iter__()
 
     def __getitem__(self, key):
-        for (val, desc) in self:
+        for val, desc in self:
             if val == key:
                 return desc
         raise KeyError(key)
@@ -194,7 +194,7 @@ def register(self, value, description):
     def get(self, value, fallback):
         """Return description for a given value, or fallback if value not in
         registry"""
-        for (val, desc) in self:
+        for val, desc in self:
             if val == value:
                 return desc
         return fallback