Django integration (#4)

* Add django integration

* Remove debug

* Add tests

* Reformat

* Bugfixes, refactor

* Fix tests

* Fix workflows

* Formatter and test setup

* Chmod manage.py

* Python 3.10

* Fix workflows

* Remove arch

---------

Co-authored-by: Tomasz Kwiatkowski <[email protected]>

.github/workflows/check_migrations.yml

@@ -0,0 +1,23 @@
+name: migrations
+run-name: Check if all migrations are created
+on:
+  push:
+    branches: 'main'
+  pull_request:
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+    name: migrations-ubuntu
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      - name: Install dependencies
+        run: |
+          pip3 install .[django]
+      - name: Check migrations
+        run: |
+          python3 tests/test_django/manage.py makemigrations --dry-run --check

.github/workflows/formatter.yml

@@ -1,9 +1,9 @@
 name: Python Formatter (isort & black)
 
 on:
+  push:
+    branches: 'main'
   pull_request:
-    branches: [main]
-
 jobs:
   formatting:
     runs-on: ubuntu-latest
@@ -12,7 +12,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - name: Install isort and black
         run: |
           python -m pip install --upgrade pip

.github/workflows/macOS.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: macos-latest
     strategy:
         matrix:
-            python-version: ["3.9", "3.13"]
+            python-version: ["3.10", "3.13"]
     name: pytest-macos-python-${{ matrix.python-version }}
     steps:
       - name: Checkout
@@ -30,10 +30,18 @@ jobs:
         run: |
           python3 -m venv .venv
           source .venv/bin/activate
-          pip install .[tests]
-      - name: Run pytest
+          pip install -e .[tests]
+      - name: Run pytest without Django
         env:
           PYTEST_ADDOPTS: "--color=yes"
         run: |
           source .venv/bin/activate
           pytest -v -n auto
+      - name: Run pytest with Django
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: |
+          source .venv/bin/activate
+          pip install -e .[tests,django_tests,django]
+          ./tests/test_django/manage.py migrate
+          pytest -v -n auto

.github/workflows/ubuntu.yml

@@ -6,10 +6,10 @@ on:
   pull_request:
 jobs:
   pytest:
-    runs-on: ubuntu:latest
+    runs-on: ubuntu-latest
     strategy:
         matrix:
-            python-version: ["3.9", "3.13"]
+            python-version: ["3.10", "3.13"]
     name: pytest-ubuntu-python-${{ matrix.python-version }}
     steps:
       - name: Checkout
@@ -20,9 +20,16 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          pip3 install .[tests]
-      - name: Run pytest
+          pip3 install -e .[tests]
+      - name: Run pytest without Django
         env:
           PYTEST_ADDOPTS: "--color=yes"
         run: |
           python3 -m pytest -v -n auto
+      - name: Run pytest with Django
+        env:
+          PYTEST_ADDOPTS: "--color=yes"
+        run: |
+          pip3 install -e .[tests,django_tests,django]
+          ./tests/test_django/manage.py migrate
+          python3 -m pytest -v -n auto

.gitignore

@@ -5,6 +5,7 @@ build
 .vscode
 .idea
 __pycache__
+tests/test_django/db.sqlite3
 
 # pytest-cov
 .coverage*

pyproject.toml

@@ -9,3 +9,4 @@ include_trailing_comma = true
 
 [tool.black]
 line_length = 120
+exclude = "migrations/"

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = test_django.settings
+pythonpath = ./tests/test_django
+markers =
+    no_django: marks tests that should be run without Django

setup.cfg

@@ -32,6 +32,10 @@ tests =
     pytest
     pytest-cov
     pytest-xdist
+django_tests =
+    pytest-django
+django =
+    django
 
 [tool:pytest]
 testpaths =

src/sio3pack/__init__.py

@@ -1,6 +1,7 @@
 __version__ = "0.0.1"
 
 from sio3pack.files import LocalFile
+from sio3pack.packages.exceptions import ImproperlyConfigured, PackageAlreadyExists
 from sio3pack.packages.package import Package
 
 
@@ -14,3 +15,19 @@ def from_file(file: str | LocalFile, django_settings=None) -> Package:
     if isinstance(file, str):
         file = LocalFile(file)
     return Package.from_file(file, django_settings=django_settings)
+
+
+def from_db(problem_id: int) -> Package:
+    """
+    Initialize a package object from the database.
+    If sio3pack isn't installed with Django support, it should raise an ImproperlyConfigured exception.
+    If there is no package with the given problem_id, it should raise an UnknownPackageType exception.
+    :param problem_id: The problem id.
+    :return: The package object.
+    """
+    try:
+        import django
+
+        return Package.from_db(problem_id)
+    except ImportError:
+        raise ImproperlyConfigured("sio3pack is not installed with Django support.")

src/sio3pack/django/sinolpack/handler.py

@@ -0,0 +1,17 @@
+from sio3pack.django.sinolpack.models import SinolpackPackage
+from sio3pack.packages.exceptions import PackageAlreadyExists
+from sio3pack.packages.package.django.handler import DjangoHandler
+
+
+class SinolpackDjangoHandler(DjangoHandler):
+    def save_to_db(self):
+        """
+        Save the package to the database.
+        """
+        if SinolpackPackage.objects.filter(problem_id=self.problem_id).exists():
+            raise PackageAlreadyExists(self.problem_id)
+
+        SinolpackPackage.objects.create(
+            problem_id=self.problem_id,
+            short_name=self.package.short_name,
+        )

src/sio3pack/django/sinolpack/migrations/0001_initial.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.1.3 on 2024-12-01 17:22
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="SinolpackPackage",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("problem_id", models.IntegerField()),
+                ("short_name", models.CharField(max_length=100)),
+            ],
+        ),
+    ]

src/sio3pack/django/sinolpack/models.py

@@ -0,0 +1,10 @@
+from django.db import models
+
+
+class SinolpackPackage(models.Model):
+    """
+    A package for the sinolpack package type.
+    """
+
+    problem_id = models.IntegerField()
+    short_name = models.CharField(max_length=100)

src/sio3pack/packages/exceptions.py

@@ -1,4 +1,19 @@
 class UnknownPackageType(Exception):
-    def __init__(self, path: str) -> None:
-        self.path = path
-        super().__init__(f"Unknown package type for file {path}.")
+    def __init__(self, arg: str | int) -> None:
+        if isinstance(arg, str):
+            self.path = arg
+            super().__init__(f"Unknown package type for file {arg}.")
+        else:
+            self.problem_id = arg
+            super().__init__(f"Unknown package type for problem with id={arg}.")
+
+
+class ImproperlyConfigured(Exception):
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+
+
+class PackageAlreadyExists(Exception):
+    def __init__(self, problem_id: int) -> None:
+        self.problem_id = problem_id
+        super().__init__(f"A package already exists for problem with id={problem_id}.")

src/sio3pack/packages/package/django/handler.py

@@ -0,0 +1,14 @@
+from typing import Type
+
+from sio3pack.packages.exceptions import ImproperlyConfigured
+
+
+class DjangoHandler:
+    def __init__(self, package: Type["Package"], problem_id: int):
+        self.package = package
+        self.problem_id = problem_id
+
+
+class NoDjangoHandler:
+    def __call__(self, *args, **kwargs):
+        raise ImproperlyConfigured("sio3pack is not installed with Django support.")

src/sio3pack/packages/package/model.py

@@ -1,9 +1,11 @@
+import importlib
 from typing import Any
 
 from sio3pack import LocalFile
 from sio3pack.files import File
 from sio3pack.graph import Graph, GraphOperation
 from sio3pack.packages.exceptions import UnknownPackageType
+from sio3pack.packages.package.django.handler import NoDjangoHandler
 from sio3pack.test import Test
 from sio3pack.utils.archive import Archive
 from sio3pack.utils.classinit import RegisteredSubclassesBase
@@ -19,11 +21,23 @@ class Package(RegisteredSubclassesBase):
     def __init__(self):
         super().__init__()
 
+    @classmethod
+    def identify(cls, file: LocalFile):
+        """
+        Identify if the package is of this type.
+        """
+        raise NotImplementedError()
+
     @classmethod
     def from_file(cls, file: LocalFile, django_settings=None):
+        """
+        Create a package from a file.
+        """
         for subclass in cls.subclasses:
             if subclass.identify(file):
-                return subclass(file, django_settings)
+                package = subclass()
+                package._from_file(file, django_settings)
+                return package
         raise UnknownPackageType(file.path)
 
     def _from_file(self, file: LocalFile):
@@ -34,6 +48,50 @@ def _from_file(self, file: LocalFile):
             else:
                 self.is_archive = False
 
+    @classmethod
+    def identify_db(cls, problem_id: int):
+        """
+        Identify if the package is of this type. Should check if there
+        is a package of this type in the database with the given problem_id.
+        """
+        raise NotImplementedError()
+
+    @classmethod
+    def from_db(cls, problem_id: int):
+        """
+        Create a package from the database. If sio3pack isn't installed with Django
+        support, it should raise an ImproperlyConfigured exception. If there is no
+        package with the given problem_id, it should raise an UnknownPackageType
+        exception.
+        """
+        for subclass in cls.subclasses:
+            if subclass.identify_db(problem_id):
+                package = subclass()
+                package._from_db(problem_id)
+                return package
+        raise UnknownPackageType(problem_id)
+
+    def _from_db(self, problem_id: int):
+        """
+        Internal method to setup the package from the database. If sio3pack
+        isn't installed with Django support, it should raise an ImproperlyConfigured
+        exception.
+        """
+        self.problem_id = problem_id
+
+    def _setup_django_handler(self, problem_id: int):
+        try:
+            import django
+
+            self.django_enabled = True
+            module_path, class_name = self.django_handler.rsplit(".", 1)
+            module = importlib.import_module(module_path)
+            handler = getattr(module, class_name)
+            self.django = handler(package=self, problem_id=problem_id)
+        except ImportError:
+            self.django_enabled = False
+            self.django = NoDjangoHandler()
+
     def get_task_id(self) -> str:
         pass
 
@@ -61,8 +119,15 @@ def get_test(self, test_id: str) -> Test:
     def get_unpack_graph(self) -> GraphOperation | None:
         pass
 
-    def get_run_graph(self, file: File, tests: list[Test] | None = None) -> Graph:
+    def get_run_graph(self, file: File, tests: list[Test] | None = None) -> GraphOperation | None:
+        pass
+
+    def get_save_outs_graph(self, tests: list[Test] | None = None) -> GraphOperation | None:
         pass
 
-    def get_save_outs_graph(self, tests: list[Test] | None = None) -> Graph:
+    def save_to_db(self, problem_id: int):
+        """
+        Save the package to the database. If sio3pack isn't installed with Django
+        support, it should raise an ImproperlyConfigured exception.
+        """
         pass