Fix.cicd (#5)

Separate `dev` and `not-dev` dependencies. Migrate to pyproject.toml. Use compiled dependencies. Fix linting and formatting. Drop support for old Django(<3.2) and Python(<3.8) versions
Gusakovskiy · Oct 27, 2023 · 8327aa7 · 8327aa7
1 parent 0d0f13d
commit 8327aa7
Show file tree

Hide file tree

Showing 17 changed files with 789 additions and 472 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7.17, 3.8, 3.9]
+        python-version: [3.8, 3.9, 3.10.13, 3.11, 3.12]
 
     steps:
     - uses: actions/checkout@v2
@@ -26,13 +26,13 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements-dev.txt
+        python -m pip install --no-cache-dir --no-deps -r requirements-dev.txt
     - name: Test with pytest
       run: |
         pytest
     - name: Analyze with pylint
       run: |
-        pylint --load-plugins pylint_django liquidb
+         pylint --load-plugins=pylint_django --django-settings-module=liquidb.pylint_settings liquidb
     - name: Analyze with black
       run: |
         black --check .
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -21,11 +21,12 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        python -m pip install --no-cache-dir --no-deps .
         pip install setuptools wheel twine
     - name: Build and publish
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build
         twine upload dist/*
diff --git a/README.rst b/README.rst
@@ -13,8 +13,8 @@ Requirements
 ============
 
 Django Liquidb requires:
-    * Django 2.2 or later;
-    * Python 3.6 or later.
+    * Django 3.2 or later;
+    * Python 3.8 or later.
 
 
 Getting It
@@ -91,6 +91,43 @@ translation in your language. If you have some time to spare and like to help us
 
 - GitHub: https://github.com/Gusakovskiy/django-liquidb
 
+
+Development
+==========
+
+Generating dependencies
+-----------
+
+Main dependencies::
+
+    $ pip-compile --upgrade --resolver backtracking  --output-file requirements.txt pyproject.toml
+
+Dev dependencies::
+
+    $ pip-compile --upgrade --resolver backtracking --extra dev --output-file requirements-dev.txt pyproject.toml
+
+If you see error that you can't figure out try to add `--verbose` flag
+
+
+After generating dependencies remember to change `backports.zoneinfo==0.2.1` to `backports.zoneinfo;python_version<"3.9"`
+this dependency is not supported by Python >= 3.9, it should be deleted after support for those versions is ended.
+
+
+Configure environment
+-----------
+
+In you local machine create virtual environment and activate it or setup docker container and run command::
+
+    $ pip install -r requirements-dev.txt
+
+To run test::
+
+    $ pytest tests
+
+To run linting::
+
+    $ pylint --load-plugins=pylint_django --django-settings-module=liquidb.pylint_settings liquidb
+
 Support
 =======
 

diff --git a/liquidb/admin.py b/liquidb/admin.py
@@ -1,4 +1,4 @@
-from django.conf.urls import url
+from django.urls import re_path
 from django.contrib import admin
 from django.contrib.admin import ModelAdmin
 from django.core.checks import messages
@@ -18,15 +18,16 @@
 
 
 class SnapshotAdminModelForm(ModelForm):
-    def _create_snapshot(self, name: str, dry_run: bool):  # pylint: disable=no-self-use
+    @staticmethod
+    def _create_snapshot(name: str, dry_run: bool):
         handler = SnapshotCreationHandler(
             name,
             False,
         )
         try:
             created = handler.create(dry_run=dry_run)
         except SnapshotHandlerException as error:
-            raise ValidationError(error.error, code="name")
+            raise ValidationError(error.error, code="name") from error
         if not created:
             raise ValidationError(
                 "All migrations saved in currently applied snapshot. Nothing to create",
@@ -82,7 +83,6 @@ def has_delete_permission(self, request, obj=None):
 
 @admin.register(Snapshot)
 class SnapshotAdminView(ModelAdmin):
-
     form = SnapshotAdminModelForm
     readonly_fields = (
         "created",
@@ -123,7 +123,7 @@ def get_urls(self):
         custom_urls = []
         if ADMIN_SNAPSHOT_ACTIONS:
             custom_urls.append(
-                url(
+                re_path(
                     r"^(?P<snapshot_id>.+)/apply/$",
                     self.admin_site.admin_view(self.apply_snapshot),
                     name="apply_snapshot",

diff --git a/liquidb/db_tools.py b/liquidb/db_tools.py
@@ -46,7 +46,7 @@ def _checkout_to_snapshot(self, snapshot: Snapshot):
         executor = MigrationExecutor(connection)
         try:
             _: ProjectState = executor.migrate(targets)
-        except KeyError:
+        except KeyError as error:
             # TODO check exact migration that missing
             message = "\n".join(
                 [
@@ -58,9 +58,9 @@ def _checkout_to_snapshot(self, snapshot: Snapshot):
                 f"\nSome migrations are missing.\n"
                 f'Please make sure all migrations in snapshot: "{snapshot.name}";\n'
                 f"Are present in corresponding apps: \n{message}"
-            )
+            ) from error
         except NodeNotFoundError as error:
-            raise SnapshotHandlerException(error.message)
+            raise SnapshotHandlerException(error.message) from error
 
     @property
     def applied_snapshot_exists(self):

diff --git a/liquidb/management/commands/_private.py b/liquidb/management/commands/_private.py
@@ -5,8 +5,8 @@
 from django.db import connection
 from django.db.migrations.recorder import MigrationRecorder
 
-from ...db_tools import SnapshotCheckoutHandler, SnapshotHandlerException
-from ...models import Snapshot, MigrationState, get_latest_applied_migrations_qs
+from liquidb.db_tools import SnapshotCheckoutHandler, SnapshotHandlerException
+from liquidb.models import Snapshot, MigrationState, get_latest_applied_migrations_qs
 
 
 class BaseLiquidbCommand(BaseCommand, metaclass=ABCMeta):
@@ -68,7 +68,7 @@ def _checkout_snapshot(self, snapshot: Snapshot, force=False):
         try:
             handler.checkout(force=force)
         except SnapshotHandlerException as e:
-            raise CommandError(e.error)
+            raise CommandError(e.error) from e
 
     @abstractmethod
     def _handle(self, *args, **options):

diff --git a/liquidb/management/commands/create_migration_snapshot.py b/liquidb/management/commands/create_migration_snapshot.py
@@ -29,7 +29,7 @@ def _handle(self, *args, **options):
         try:
             created = handler.create()
         except SnapshotHandlerException as e:
-            raise CommandError(e.error)
+            raise CommandError(e.error) from e
         if not created:
             self.stdout.write(
                 "All migrations saved in currently applied snapshot. Nothing to create"

diff --git a/liquidb/management/commands/delete_snapshot_history.py b/liquidb/management/commands/delete_snapshot_history.py
@@ -22,7 +22,7 @@ def _handle(self, *args, **options):
         interactive = options["interactive"]
         if interactive:
             confirm = input(
-                f"""
+                """
                 You have requested to delete snapshot history with all migrations.
                 This action is IRREVERSIBLE.
                 Are you sure you want to do this?
@@ -37,5 +37,6 @@ def _handle(self, *args, **options):
             snapshots = models.get("liquidb.Snapshot", 0)
             migrations_states = models.get("liquidb.MigrationState", 0)
         self.stdout.write(
-            f"Successfully deleted history of {snapshots} snapshots and {migrations_states} migrations"
+            f"Successfully deleted history of {snapshots} "
+            f"snapshots and {migrations_states} migrations"
         )
diff --git a/liquidb/migrations/0001_initial.py b/liquidb/migrations/0001_initial.py
@@ -8,7 +8,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = []

diff --git a/liquidb/pylint_settings.py b/liquidb/pylint_settings.py
@@ -0,0 +1,58 @@
+from pathlib import Path
+
+SECRET_KEY = "fake-key"
+
+INSTALLED_APPS = [
+    # <editor-fold desc="admin part">
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    # </editor-fold>
+    "tests",
+    "liquidb",
+]
+# <editor-fold desc="Needed for Admin Part">
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+MIDDLEWARE = [
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+]
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [BASE_DIR / "templates"],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+ROOT_URLCONF = "tests.test_urls"
+# </editor-fold>
+
+DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}}
+USE_TZ = True
+
+
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "root": {
+        "handlers": ["console"],
+        "level": "WARNING",
+    },
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,7 +8,6 @@


		class Migration(migrations.Migration):

		initial = True

		dependencies = []
Expand Down