Merge branch 'release/2.5'

* release/2.5:
  lint
  updates github action config
  updates tox config
  bump version
  fixes check() implementation
  updates
  dj41
  Update __init__.py
  test package with tox
  use markdown for README
  updates

Author: saxix

.github/workflows/tests.yaml

@@ -26,8 +26,8 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                python-version: [ "3.8", "3.9", "3.10"]
-                django-version: [ "2.2", "3.2", "4.0"]
+                python-version: [ "3.9", "3.11"]
+                django-version: [ "3.2", "4.2"]
                 db-engine: ["pg", "mysql"]
         env:
             PY_VER: ${{ matrix.python-version}}

.gitignore

@@ -1,26 +1,20 @@
-˜*
-.appveyor.yml
-.coverage
+~*
+.*
+!.github
+!.gitignore
+!.editorconfig
+!.pre-commit-config.yaml
 coverage.xml
-~build
-.idea
-.tox
-.DS_Store
-.cache
 notes.txt
-docs/build/
+build/
+dist/
 __pycache__
-/dist
-/build
-/MANIFEST
 /.eggs
 *.egg-info
 *.pyc
 *.log
 *.pot
 *.mo
-*.pyc
-*.egg-info
 *.sqlite
 .testmondata
 Pipfile.lock

CHANGES

@@ -1,3 +1,11 @@
+Release 2.5
+-----------
+* BUG FIX: fixes check() implementation
+* removes deprecatd MANUAL_TRIGGERS
+* drop support Django 2.x
+* drop support python 3.8
+
+
 Release 2.4
 -----------
 * add support Django 4

Pipfile

@@ -6,22 +6,21 @@ name = "pypi"
 [packages]
 
 [dev-packages]
+check-manifest = "*"
 django = "*"
-pre-commit = "*"
 django-reversion = "*"
 django-webtest = "*"
 mock = "*"
+pre-commit = "*"
+psycopg2-binary = "*"
 pytest = "*"
 pytest-cov = "*"
 pytest-django = "*"
 pytest-echo = "*"
-pytest-pythonpath = "*"
 tox = "*"
-"psycopg2-binary" = "*"
-check-manifest = "*"
+twine="*"
 sphinx = "*"
 sphinx-issues = "*"
-twine="*"
 
 [requires]
 python_version = "3.8"

README.md

@@ -0,0 +1,79 @@
+Django Concurrency
+==================
+
+
+[![Pypi](https://badge.fury.io/py/django-concurrency.svg)](https://badge.fury.io/py/django-concurrency)
+[![coverage](https://codecov.io/github/saxix/django-concurrency/coverage.svg?branch=develop)](https://codecov.io/github/saxix/django-concurrency?branch=develop)
+[![Test](https://github.com/saxix/django-concurrency/actions/workflows/tests.yaml/badge.svg)](https://github.com/saxix/django-concurrency/actions/workflows/tests.yaml)
+[![Docs](https://readthedocs.org/projects/django-concurrency/badge/?version=stable)](http://django-concurrency.readthedocs.io/en/stable/)
+
+
+django-concurrency is an [optimistic lock][1] implementation for Django.
+
+It prevents users from doing concurrent editing in Django both from UI and from a
+django command.
+
+
+How it works
+------------
+
+```python
+
+from django.db import models
+from concurrency.fields import IntegerVersionField
+
+class ConcurrentModel( models.Model ):
+    version = IntegerVersionField( )
+    name = models.CharField(max_length=100)
+```
+
+Now if you try::
+
+```python
+
+a = ConcurrentModel.objects.get(pk=1)
+a.name = '1'
+
+b = ConcurrentModel.objects.get(pk=1)
+b.name = '2'
+
+a.save()
+b.save()
+
+```
+
+you will get a ``RecordModifiedError`` on ``b.save()``
+
+
+Similar projects
+----------------
+
+Other projects that handle concurrent editing are [django-optimistic-lock][10] 
+and [django-locking][11] anyway concurrency is "a batteries included" optimistic 
+lock management system, here some features not available elsewhere:
+
+ * can be applied to any model; not only your code (ie. django.contrib.auth.Group)
+ * handle [list-editable][2] ChangeList. (handle `#11313 <https://code.djangoproject.com/ticket/11313>`_)
+ * manage concurrency conflicts in admin's actions
+ * can intercept changes performend out of the django app (ie using pgAdmin, phpMyAdmin, Toads) (using [TriggerVersionField][6])
+ * can be disabled if needed (see [disable_concurrency][3])
+ * [ConditionalVersionField][4] to handle complex business rules
+
+
+
+Project Links
+------------
+
+- Code: https://github.com/saxix/django-concurrency
+- Documentation: https://django-concurrency.readthedocs.org/en/latest/
+- Issue Tracker: https://github.com/saxix/django-concurrency/issues
+- Download Package: http://pypi.python.org/pypi/django-concurrency/
+
+
+[10]:https://github.com/gavinwahl/django-optimistic-lock
+[11]:https://github.com/stdbrouw/django-locking
+[1]:http://en.wikipedia.org/wiki/Optimistic_concurrency_control
+[2]:https://django-concurrency.readthedocs.org/en/latest/admin.html#list-editable
+[3]:https://django-concurrency.readthedocs.org/en/latest/api.html?#disable-concurrency
+[4]:https://django-concurrency.readthedocs.org/en/latest/fields.html#conditionalversionfield
+[6]:https://django-concurrency.readthedocs.org/en/latest/fields.html#triggerversionfield

README.rst

@@ -2,14 +2,15 @@
 combine_as_imports = true
 default_section = THIRDPARTY
 include_trailing_comma = true
-line_length = 80
-known_future_library = future,pies
-known_standard_library =
-known_third_party = django
-known_first_party = sos
-multi_line_output = 0
+known_tests = pytest,unittest,factory
+known_demo = demo
+known_django = django
+sections = FUTURE,STDLIB,DJANGO,THIRDPARTY,TESTS,FIRSTPARTY,DEMO,LOCALFOLDER
+known_first_party = etools_validator
+multi_line_output = 3
+line_length = 120
 balanced_wrapping = true
-sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
+order_by_type = false
 
 [flake8]
 max-complexity = 12

setup.cfg

@@ -47,7 +47,8 @@ def run_tests(self):
     packages=find_packages('src'),
     include_package_data=True,
     description='Optimistic lock implementation for Django. Prevents users from doing concurrent editing.',
-    long_description=open('README.rst').read(),
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
     license='MIT License',
     keywords='django, concurrency, optimistic lock, locking, concurrent editing',
     setup_requires=['pytest-runner', ],
@@ -62,6 +63,7 @@ def run_tests(self):
         'Framework :: Django :: 3.1',
         'Framework :: Django :: 3.2',
         'Framework :: Django :: 4.0',
+        'Framework :: Django :: 4.1',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',

setup.py

@@ -1,5 +1,4 @@
 __author__ = 'sax'
-default_app_config = 'concurrency.apps.ConcurrencyConfig'
 
-VERSION = __version__ = "2.4"
+VERSION = __version__ = "2.5"
 NAME = 'django-concurrency'

src/concurrency/__init__.py

@@ -7,9 +7,9 @@
 from django.contrib.admin import helpers
 from django.core.checks import Error
 from django.core.exceptions import ImproperlyConfigured, ValidationError
+from django.db import transaction
 from django.db.models import Q
-from django.forms.formsets import (INITIAL_FORM_COUNT, MAX_NUM_FORM_COUNT,
-                                   TOTAL_FORM_COUNT, ManagementForm,)
+from django.forms.formsets import INITIAL_FORM_COUNT, ManagementForm, MAX_NUM_FORM_COUNT, TOTAL_FORM_COUNT
 from django.forms.models import BaseModelFormSet
 from django.http import HttpResponse, HttpResponseRedirect
 from django.utils.encoding import force_str
@@ -198,6 +198,7 @@ def _get_conflicts(self, request):
         else:
             return []
 
+    @transaction.atomic()
     def save_model(self, request, obj, form, change):
         try:
             if change:
@@ -266,7 +267,7 @@ class ConcurrentModelAdmin(ConcurrencyActionMixin,
     formfield_overrides = {forms.VersionField: {'widget': VersionWidget}}
 
     def check(self, **kwargs):
-        errors = []
+        errors = super().check(**kwargs)
         if self.fields:
             version_field = self.model._concurrencymeta.field
             if version_field.name not in self.fields:

src/concurrency/admin.py

@@ -1,14 +1,12 @@
-import warnings
-
 from django.core.exceptions import ImproperlyConfigured
 from django.test.signals import setting_changed
 from django.utils.module_loading import import_string
 
 from .compat import get_callable
 
 # List Editable Policy
-# 0 do not save updated records, save others, show message to the user
-# 1 abort whole transaction
+# 1 do not save updated records, save others, show message to the user
+# 2 abort whole transaction
 CONCURRENCY_LIST_EDITABLE_POLICY_SILENT = 1
 CONCURRENCY_LIST_EDITABLE_POLICY_ABORT_ALL = 2
 CONCURRENCY_POLICY_RAISE = 4
@@ -21,7 +19,6 @@ class AppSettings:
     defaults = {
         'ENABLED': True,
         'AUTO_CREATE_TRIGGERS': True,
-        'MANUAL_TRIGGERS': False,  # deprecated: use AUTO_CREATE_TRIGGERS
         'FIELD_SIGNER': 'concurrency.forms.VersionFieldSigner',
         'POLICY': CONCURRENCY_LIST_EDITABLE_POLICY_SILENT,
         'CALLBACK': 'concurrency.views.callback',
@@ -67,10 +64,6 @@ def _set_attr(self, prefix_name, value):
                     "{} is not a valid value for `CALLBACK`. It must be a callable or a fullpath to callable. ".format(
                         value))
             self._callback = func
-        elif name == "MANUAL_TRIGGERS":
-            warnings.warn("MANUAL_TRIGGERS is deprecated and will be removed in 2.5. Use AUTO_CREATE_TRIGGERS",
-                          category=DeprecationWarning)
-            self.AUTO_CREATE_TRIGGERS = not value
         elif name == "TRIGGERS_FACTORY":
             original = dict(value)
             for k, v in original.items():