Merge pull request #295 from bjester/merge-up

bjester · web-flow · commit d27cbc49c963 · 2026-03-19T13:13:57.000-07:00
Merge up release-v0.8.x
diff --git a/.editorconfig b/.editorconfig
@@ -10,6 +10,9 @@ insert_final_newline = true
 charset = utf-8
 end_of_line = lf
 
+[*.{yaml,yml}]
+indent_size = 2
+
 [*.bat]
 indent_style = tab
 end_of_line = crlf
diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml
@@ -20,7 +20,7 @@ jobs:
     strategy:
       max-parallel: 5
       matrix:
-        python-version: [3.9, '3.10', '3.11', '3.12', '3.13']
+        python-version: [3.9, '3.10', '3.11', '3.12', '3.13', '3.14']
     steps:
       - uses: actions/checkout@v6
       - name: Set up Python ${{ matrix.python-version }}
@@ -77,7 +77,7 @@ jobs:
     strategy:
       max-parallel: 5
       matrix:
-        python-version: [3.9, '3.10', '3.11', '3.12', '3.13']
+        python-version: [3.9, '3.10', '3.11', '3.12', '3.13', '3.14']
     steps:
       - uses: actions/checkout@v6
       - name: Set up Python ${{ matrix.python-version }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,6 +9,11 @@ repos:
       - id: debug-statements
       - id: end-of-file-fixer
         exclude: '^.+?\.json$'
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.2
+    hooks:
+      - id: flake8
+        additional_dependencies: ['flake8-print==5.0.0']
   - repo: https://github.com/asottile/reorder_python_imports
     rev: v1.4.0
     hooks:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 List of the most important changes for each release.
 
+## 0.8.9
+- Removes debugging print statements
+- Adds flake8 linting
+
+## 0.8.8
+- Adds support for Python 3.14
+
 ## 0.8.7
 - Adds flexibility for customizing deserialization behavior using sync filter to `SyncableModel` methods
 
diff --git a/morango/__init__.py b/morango/__init__.py
@@ -1 +1 @@
-__version__ = "0.8.7"
+__version__ = "0.8.9"
diff --git a/morango/models/core.py b/morango/models/core.py
@@ -483,8 +483,6 @@ def _deserialize_store_model(self, fk_cache, defer_fks=False, sync_filter=None):
                 klass_model.syncing_objects.filter(id=self.id).delete()
             return None, deferred_fks
         else:
-            if sync_filter:
-                print("Has filter", sync_filter)
             # load model into memory
             app_model = klass_model.deserialize(json.loads(self.serialized), sync_filter=sync_filter)
             app_model._morango_source_id = self.source_id
diff --git a/morango/sync/operations.py b/morango/sync/operations.py
@@ -262,7 +262,6 @@ def _deserialize_from_store(profile, skip_erroring=False, filter=None):
                     lambda x, y: x | y,
                     [Q(partition__startswith=prefix) for prefix in filter],
                 )
-                print("prefix_condition: ", prefix_condition)
                 store_models = store_models.filter(prefix_condition)
 
             # if requested, skip any records that previously errored, to be faster
diff --git a/morango/sync/stream/serialize.py b/morango/sync/stream/serialize.py
@@ -9,7 +9,6 @@
 
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db.models import Q
-from typing_extensions import Literal
 
 from morango.models.certificates import Filter
 from morango.models.core import DatabaseMaxCounter
@@ -71,8 +70,14 @@ def __init__(
         profile: str,
         sync_filter: Optional[Filter] = None,
         dirty_only: bool = True,
-        partition_order: Literal["asc", "desc"] = "asc",
+        partition_order: str = "asc",
     ):
+        """
+        :param profile: The Morango model profile
+        :param sync_filter: The Filter object for this sync
+        :param dirty_only: Whether to filter on dirty records only
+        :param partition_order: Controls how the filter specificity is applied, "asc" or "desc"
+        """
         self.profile = profile
         self.sync_filter = sync_filter
         self.dirty_only = dirty_only
diff --git a/requirements/test.txt b/requirements/test.txt
@@ -1,8 +1,6 @@
 # These are for testing
-factory-boy==2.7.0
-fake-factory==0.5.7
-mock==2.0.0
-pytest==6.2.5
+factory-boy>=3.0,<4
+mock>=4.0,<6
+pytest>=6.2.5,<8
 pytest-django==4.5.2
-more-itertools<=8.10.0
-typing
+more-itertools<=10.0.0
diff --git a/setup.py b/setup.py
@@ -29,7 +29,6 @@
         "djangorestframework>3.10",
         "django-ipware==4.0.2",
         "requests",
-        "typing-extensions==4.1.1",
         "ifcfg",
     ],
     license="MIT",
@@ -48,6 +47,7 @@
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
         'Programming Language :: Python :: 3.13',
+        'Programming Language :: Python :: 3.14',
     ],
-    python_requires=">=3.6,  <3.14",
+    python_requires=">=3.6,  <3.15",
 )
diff --git a/tests/testapp/tests/compat.py b/tests/testapp/tests/compat.py
@@ -1,11 +1,21 @@
-try:
-    # In the Python EOL GH workflows, we have to install backported version
-    # as the Docker container images we use does not have the test module installed.
-    from backports.test.support import EnvironmentVarGuard # noqa F401
-except ImportError:
-    try:
-        # For python >3.8 and <3.10
-        from test.support import EnvironmentVarGuard # noqa F401
-    except ImportError:
-        # In Python 3.10, this has been moved to test.support.os_helper
-        from test.support.os_helper import EnvironmentVarGuard # noqa F401
+import os
+from unittest.mock import patch as _patch
+
+
+class EnvironmentVarGuard:
+    """
+    Vendored replacement for the removed test.support EnvironmentVarGuard.
+    Uses unittest.mock.patch.dict(os.environ) under the hood.
+    Supports the context-manager-with-dict-assignment pattern:
+        with EnvironmentVarGuard() as env: env[k] = v
+    """
+
+    def __init__(self):
+        self._patcher = _patch.dict(os.environ)
+
+    def __enter__(self):
+        self._patcher.start()
+        return os.environ
+
+    def __exit__(self, *args):
+        self._patcher.stop()
diff --git a/tests/testapp/tests/helpers.py b/tests/testapp/tests/helpers.py
@@ -36,14 +36,14 @@
 from morango.sync.syncsession import TransferClient
 
 
-class FacilityFactory(factory.DjangoModelFactory):
+class FacilityModelFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Facility
 
     name = factory.Sequence(lambda n: "Fac %d" % n)
 
 
-class AbstractStoreFactory(factory.DjangoModelFactory):
+class AbstractStoreFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = AbstractStore
 
@@ -61,12 +61,12 @@ class Meta:
         model = Store
 
 
-class RecordMaxCounterBufferFactory(factory.DjangoModelFactory):
+class RecordMaxCounterBufferFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = RecordMaxCounterBuffer
 
 
-class RecordMaxCounterFactory(factory.DjangoModelFactory):
+class RecordMaxCounterFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = RecordMaxCounter
 
@@ -102,11 +102,11 @@ def create_dummy_store_data():
 
     data["mc"].serialize_into_store()  # counter is at 1
     # create group of facilities and first serialization
-    data["group1_c1"] = [FacilityFactory() for _ in range(5)]
+    data["group1_c1"] = [FacilityModelFactory() for _ in range(5)]
     data["mc"].serialize_into_store()  # counter is at 2
 
     # create group of facilities and second serialization
-    data["group1_c2"] = [FacilityFactory() for _ in range(5)]
+    data["group1_c2"] = [FacilityModelFactory() for _ in range(5)]
 
     # create users and logs associated with user
     data["user1"] = MyUser.objects.create(username="bob")
@@ -127,7 +127,7 @@ def create_dummy_store_data():
         ]  # new counter is at 0
 
         data["mc"].serialize_into_store()  # new counter is at 1
-        data["group2_c1"] = [FacilityFactory() for _ in range(5)]
+        data["group2_c1"] = [FacilityModelFactory() for _ in range(5)]
 
         # create users and logs associated with user
         data["user2"] = MyUser.objects.create(username="rob")
diff --git a/tests/testapp/tests/integration/test_signals.py b/tests/testapp/tests/integration/test_signals.py
@@ -1,20 +1,12 @@
-import factory
 from django.test import TestCase
 from facility_profile.models import Facility
 
+from ..helpers import FacilityModelFactory
 from morango.models.core import DeletedModels
 from morango.models.core import InstanceIDModel
 from morango.sync.controller import MorangoProfileController
 
 
-class FacilityModelFactory(factory.DjangoModelFactory):
-
-    class Meta:
-        model = Facility
-
-    name = factory.Sequence(lambda n: "Fac %d" % n)
-
-
 class PostDeleteSignalsTestCase(TestCase):
 
     def setUp(self):
diff --git a/tests/testapp/tests/models/test_core.py b/tests/testapp/tests/models/test_core.py
@@ -20,7 +20,7 @@
 from morango.sync.controller import MorangoProfileController
 
 
-class DatabaseMaxCounterFactory(factory.DjangoModelFactory):
+class DatabaseMaxCounterFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = DatabaseMaxCounter
 
diff --git a/tests/testapp/tests/sync/test_controller.py b/tests/testapp/tests/sync/test_controller.py
@@ -12,6 +12,7 @@
 from facility_profile.models import SummaryLog
 
 from ..compat import EnvironmentVarGuard
+from ..helpers import FacilityModelFactory
 from ..helpers import serialized_facility_factory
 from ..helpers import TestSessionContext
 from morango.constants import transfer_stages
@@ -25,14 +26,7 @@
 from morango.sync.controller import SessionController
 
 
-class FacilityModelFactory(factory.DjangoModelFactory):
-    class Meta:
-        model = Facility
-
-    name = factory.Sequence(lambda n: "Fac %d" % n)
-
-
-class StoreModelFacilityFactory(factory.DjangoModelFactory):
+class StoreModelFacilityFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Store
 
diff --git a/tests/testapp/tests/sync/test_operations.py b/tests/testapp/tests/sync/test_operations.py
@@ -1,7 +1,6 @@
 import json
 import uuid
 
-import factory
 import mock
 from django.db import connection
 from django.test import override_settings
@@ -47,13 +46,6 @@
 DBBackend = load_backend(connection)
 
 
-class FacilityModelFactory(factory.DjangoModelFactory):
-    class Meta:
-        model = Facility
-
-    name = factory.Sequence(lambda n: "Fac %d" % n)
-
-
 def assertRecordsBuffered(records):
     buffer_ids = Buffer.objects.values_list("model_uuid", flat=True)
     rmcb_ids = RecordMaxCounterBuffer.objects.values_list("model_uuid", flat=True)
diff --git a/tests/testapp/tests/test_compat.py b/tests/testapp/tests/test_compat.py
@@ -0,0 +1,37 @@
+import os
+import uuid
+
+from django.test import SimpleTestCase
+
+from .compat import EnvironmentVarGuard
+
+
+class EnvironmentVarGuardTestCase(SimpleTestCase):
+    """Tests for the vendored EnvironmentVarGuard."""
+
+    def test_sets_env_var_inside_context(self):
+        key = "MORANGO_TEST_" + uuid.uuid4().hex[:8]
+        with EnvironmentVarGuard() as env:
+            env[key] = "test_value"
+            self.assertEqual(os.environ[key], "test_value")
+
+    def test_reverts_env_var_on_exit(self):
+        key = "MORANGO_TEST_" + uuid.uuid4().hex[:8]
+        with EnvironmentVarGuard() as env:
+            env[key] = "test_value"
+        self.assertNotIn(key, os.environ)
+
+    def test_reverts_modified_env_var_on_exit(self):
+        key = "MORANGO_TEST_" + uuid.uuid4().hex[:8]
+        os.environ[key] = "original"
+        try:
+            with EnvironmentVarGuard() as env:
+                env[key] = "modified"
+                self.assertEqual(os.environ[key], "modified")
+            self.assertEqual(os.environ[key], "original")
+        finally:
+            os.environ.pop(key, None)
+
+    def test_returns_os_environ(self):
+        with EnvironmentVarGuard() as env:
+            self.assertIs(env, os.environ)
diff --git a/tox.ini b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
 envlist =
-  py{3.6,3.7,3.8,3.9,3.10,3.11,3.12,3.13}-cryptography{40.0.2}
+  py{3.6,3.7,3.8,3.9,3.10,3.11,3.12,3.13,3.14}-cryptography{40.0.2}
   postgres
   windows
 
@@ -21,15 +21,13 @@ basepython =
   py3.11: python3.11
   py3.12: python3.12
   py3.13: python3.13
+  py3.14: python3.14
   postgres: python3.9
   windows: python3.8
 
 deps =
   -r{toxinidir}/requirements/test.txt
   cryptography40.0.2: cryptography==40.0.2
-  py3.6: backports.test.support==0.1.1
-  py3.7: backports.test.support==0.1.1
-  py3.8: backports.test.support==0.1.1
 commands =
   sh -c 'tests/testapp/manage.py makemigrations --check'
   python -O -m pytest {posargs: --color=no}

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.8.7"`
	`1`	`+__version__ = "0.8.9"`
Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,6 @@ def _deserialize_from_store(profile, skip_erroring=False, filter=None):`
`262`	`262`	`lambda x, y: x \| y,`
`263`	`263`	`[Q(partition__startswith=prefix) for prefix in filter],`
`264`	`264`	`)`
`265`		`- print("prefix_condition: ", prefix_condition)`
`266`	`265`	`store_models = store_models.filter(prefix_condition)`
`267`	`266`
`268`	`267`	`# if requested, skip any records that previously errored, to be faster`