Merge pull request #82 from Aristotle-Metadata-Enterprises/2026-bump

liutuo368 · web-flow · commit 7b3a931c6eee · 2026-01-05T13:04:51.000+11:00
New version to support django 6.0, drops support for unsupported django
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -7,7 +7,4 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
       - uses: psf/black@stable
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -26,15 +26,15 @@ jobs:
           --health-retries 5
       mariadb:
         # Docker Hub image
-        image: mariadb:10
+        image: mariadb:12
         env:
           MYSQL_DATABASE: test
           MYSQL_ALLOW_EMPTY_PASSWORD: yes
         ports:
           - 13306:3306
         # Set health checks to wait until mariadb has started
         options: >-
-          --health-cmd="mysqladmin ping"
+          --health-cmd="healthcheck.sh --connect --innodb_initialized"
           --health-interval 10s
           --health-timeout 5s
           --health-retries 10
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Want to help maintain this library?
+
+There is a `/dev/` directory with a docker-compose stack you can use to bring up a database and clean development environment.
+
+## Running tests
+
+Django Garnett is tested using a docker-compose environment so tests can be easily run locally against MariaDB, Postgres and SQLite.
+
+To run tests:
+*  ``cd ./dev`` 
+* Start the docker environment - ``docker-compose up``
+* Start a development shell - ``docker-compose exec dev bash``
+* Run tests - ``tox``
+
+## Code formating
+
+This library uses [python-black][python-black] for formating, you can format your code so it passes linting by:
+*  ``cd ./dev`` 
+* Start the docker environment - ``docker-compose up``
+* Start a development shell - ``docker-compose exec dev bash``
+* Run tests - ``black .``
+
+Then review and recommit your code and its ready to go.
+
+[python-black]: https://github.com/psf/black
diff --git a/README.md b/README.md
@@ -357,7 +357,7 @@ TranslatedFields will list the history and changes in json, but it does do compa
 * Searching for "Famous Translators" will tell you about [Constance Garnett](https://en.wikipedia.org/wiki/Constance_Garnett).
 * Searching for "Django Garnett" showed there was no python library with this name.
 * It did however talk about [Garnet Clark](https://en.wikipedia.org/wiki/Garnet_Clark) (also spelled Garnett), a jazz pianist who played with Django Reinhart - the namesake of the Django Web Framework.
-* Voila - a nice name
+* Voilà - a nice name
 
 ## Warnings
 
@@ -367,10 +367,6 @@ TranslatedFields will list the history and changes in json, but it does do compa
   `AdminTextAreaWidget` on translated fields in the django admin site by default. They can however
   be specified explicitly on the corresponding admin model form.
 
-## Want to help maintain this library?
-
-There is a `/dev/` directory with a docker-compose stack you can ues to bring up a database and clean development environment.
-
 ## Want other options?
 
 There are a few good options for adding translatable strings to Django that may meet other use cases. We've included a few other options here, their strengths and why we didn't go with them.
@@ -391,8 +387,6 @@ There are a few good options for adding translatable strings to Django that may
    
    **Cons:** Languages are stored in a separate table and can't be altered by users later. Translated fields are specified in model meta, away from the fields definition which makes complex lookups harder.
 
-
-
 [term-language-code]: https://docs.djangoproject.com/en/3.1/topics/i18n/#term-language-code
 [django-how]: https://docs.djangoproject.com/en/3.1/topics/i18n/translation/#how-django-discovers-language-preference
 [dunder-html]: https://code.djangoproject.com/ticket/7261
diff --git a/dev/docker-compose.yml b/dev/docker-compose.yml
@@ -4,7 +4,7 @@ version: '3'
 
 services:
   maria_db:
-    image: mariadb:10
+    image: mariadb:12
     environment:
       - MYSQL_ROOT_PASSWORD=changeme
   postgres_db:
diff --git a/dev/local-test.sh b/dev/local-test.sh
@@ -23,7 +23,7 @@ fi
 if [ $RUN_MARIA -eq 1 ]
 then
     echo "Testing with MariaDB"
-    DATABASE_URL=mysql://root:@maria_db:13306/test tox -e ${TOX_ENV}
+    DATABASE_URL=mysql://root:changeme@maria_db:3306/test tox -e ${TOX_ENV}
 fi
 
 if [ $RUN_PG -eq 1 ]
diff --git a/garnett/fields.py b/garnett/fields.py
@@ -51,7 +51,7 @@ def validator(values: dict):
 
 
 def translatable_default(
-    inner_default: Union[str, Callable[[], str]]
+    inner_default: Union[str, Callable[[], str]],
 ) -> Dict[str, str]:
     """Return default from inner field as dict with current language"""
     lang = get_current_language_code()
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-garnett"
-version = "0.5.3"
+version = "0.5.4"
 description = "Simple translatable Django fields"
 authors = ["Aristotle Metadata Enterprises"]
 license = "BSD-3-Clause"
@@ -11,7 +11,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.12"
-django = ">=4.1"
+django = ">=4.2"
 langcodes = "~3.3.0"
 language-data = "~1.0.1"
 
diff --git a/tests/library_app/settings.py b/tests/library_app/settings.py
@@ -30,6 +30,8 @@
 
 ALLOWED_HOSTS = ["localhost", "127.0.0.1", "django-garnett.herokuapp.com"]
 
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
 SERIALIZATION_MODULES = {"json": "garnett.serializers.json"}
 
 # Application definition
diff --git a/tests/tests/test_database_lookups.py b/tests/tests/test_database_lookups.py
@@ -56,7 +56,7 @@ def setUp(self):
         )
         Book.objects.create(**self.book_data)
 
-    @skipIf(connection.vendor == "mysql", "MariaDB uses case insensitive matching here")
+    # @skipIf(connection.vendor == "mysql", "MariaDB uses case insensitive matching here")
     def test_exact(self):
         books = Book.objects.all()
         with set_field_language("en"):
@@ -75,22 +75,6 @@ def test_exact(self):
             self.assertFalse(books.filter(title=self.book_data["title"]["en"]).exists())
             self.assertTrue(books.filter(title=self.book_data["title"]["de"]).exists())
 
-    @skipUnless(connection.vendor == "mysql", "Provide some coverage for MariaDB")
-    def test_exact_mysql(self):
-        books = Book.objects.all()
-        with set_field_language("en"):
-            self.assertTrue(books.filter(title=self.book_data["title"]["en"]).exists())
-            self.assertFalse(books.filter(title=self.book_data["title"]["de"]).exists())
-            # An inexact match shouldn't be returned as true, but is
-            # We have this test so if this changes we will know.
-            self.assertTrue(
-                books.filter(title=self.book_data["title"]["en"].upper()).exists()
-            )
-
-        with set_field_language("de"):
-            self.assertFalse(books.filter(title=self.book_data["title"]["en"]).exists())
-            self.assertTrue(books.filter(title=self.book_data["title"]["de"]).exists())
-
     def test_iexact(self):
         books = Book.objects.all()
         with set_field_language("en"):
diff --git a/tox.ini b/tox.ini
@@ -2,7 +2,7 @@
 toxworkdir=/tmp/tox
 skipsdist = True
 envlist =
-    dj-{42,50,51} #-db-{pg,sqlite,maria}
+    dj-{42,52,60} #-db-{pg,sqlite,maria}
 
 [testenv]
 passenv =
@@ -11,17 +11,17 @@ passenv =
 setenv =
     DJANGO_SETTINGS_MODULE = library_app.settings
 
-    dj-42: DJANGO_VERSION="==4.2.0"
+    dj-42: DJANGO_VERSION="~=4.2.0"
     dj-42: DJANGO_REVERSION_VERSION=">=5.1"
     dj-42: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
 
-    dj-50: DJANGO_VERSION="~=5.0.0"
-    dj-50: DJANGO_REVERSION_VERSION=">=5.1"
-    dj-50: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
+    dj-52: DJANGO_VERSION="~=5.2.0"
+    dj-52: DJANGO_REVERSION_VERSION=">=5.1"
+    dj-52: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
 
-    dj-51: DJANGO_VERSION="~=5.1.0"
-    dj-51: DJANGO_REVERSION_VERSION=">=5.1"
-    dj-51: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
+    dj-60: DJANGO_VERSION="~=6.0.0"
+    dj-60: DJANGO_REVERSION_VERSION=">=5.1"
+    dj-60: DJANGO_REVERSION_COMPARE_VERSION=">=0.18.1"
 
 deps =
     -e .
