Merge remote-tracking branch 'upstream/master' into devel

Author: diegocastrum

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.3.0
+current_version = 2.3.1
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?P<releaselevel>[a-z]+)?

.github/workflows/test.yaml

@@ -13,13 +13,9 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                python-version: [ 3.7, 3.8, 3.9, "3.10" ]
-                django: [ 22, 32, 40 ]
-                exclude:
-                    - python-version: "3.10"
-                      django: 22
-                    - python-version: 3.7
-                      django: 40
+                python-version: [ 3.8, 3.9, "3.10" ]
+                django: [ 32, 40 ]
+                
         services:
             postgres:
                 image: postgres

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.32.0
+    rev: v2.32.1
     hooks:
       - id: pyupgrade
         args: ["--py36-plus"]

Changelog

@@ -4,6 +4,28 @@
  Change history
 ================
 
+.. _version-2.4.0:
+
+2.4.0
+=====
+:release-date: NA
+:release-by: NA
+
+- Fix [#315](https://github.com/celery/django-celery-results/issues/315) Save args, kwargs and other extended props only when result_extended config is set to True
+
+
+.. _version-2.3.1:
+
+2.3.1
+=====
+:release-date: 2022-04-17 12:50 P.M. UTC+6:00
+:release-by: Asif Saif Uddin
+
+- Remove hard dependency on psycopg2.  
+- Fix #296 Stop producing a universal wheel, python 2 is unspported.
+- fix: The description content type for setuptools needs to be rst to markdown.
+
+
 .. _version-2.3.0:
 
 2.3.0

README.rst

@@ -4,7 +4,7 @@
 
 |build-status| |coverage| |license| |wheel| |pyversion| |pyimp|
 
-:Version: 2.3.0
+:Version: 2.3.1
 :Web: http://django-celery-results.readthedocs.io/
 :Download: http://pypi.python.org/pypi/django-celery-results
 :Source: http://github.com/celery/django-celery-results
@@ -114,7 +114,7 @@ max_length of **191** seems to work for MySQL.
     :target: http://pypi.python.org/pypi/django-celery-results/
 
 django-celery-results as part of the Tidelift Subscription
------------------
+----------------------------------------------------------
 
 The maintainers of django-celery-results and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/pypi-django-celery-results?utm_source=pypi-django-celery-results&utm_medium=referral&utm_campaign=readme&utm_term=repo)
 

django_celery_results/__init__.py

@@ -8,7 +8,7 @@
 
 import django
 
-__version__ = '2.3.0'
+__version__ = '2.3.1'
 __author__ = 'Asif Saif Uddin, Ask Solem'
 __contact__ = '[email protected], [email protected]'
 __homepage__ = 'https://github.com/celery/django-celery-results'

django_celery_results/backends/database.py

@@ -54,6 +54,51 @@ def exception_safe_to_retry(self, exc):
                 return True
         return False
 
+    def _get_extended_properties(self, request, traceback):
+        extended_props = {
+            'periodic_task_name': None,
+            'task_args': None,
+            'task_kwargs': None,
+            'task_name': None,
+            'traceback': None,
+            'worker': None,
+        }
+        if request and self.app.conf.find_value_for_key('extended', 'result'):
+
+            if getattr(request, 'argsrepr', None) is not None:
+                # task protocol 2
+                task_args = request.argsrepr
+            else:
+                # task protocol 1
+                task_args = getattr(request, 'args', None)
+
+            if getattr(request, 'kwargsrepr', None) is not None:
+                # task protocol 2
+                task_kwargs = request.kwargsrepr
+            else:
+                # task protocol 1
+                task_kwargs = getattr(request, 'kwargs', None)
+
+            # Encode input arguments
+            if task_args is not None:
+                _, _, task_args = self.encode_content(task_args)
+
+            if task_kwargs is not None:
+                _, _, task_kwargs = self.encode_content(task_kwargs)
+
+            properties = getattr(request, 'properties', {}) or {}
+            periodic_task_name = properties.get('periodic_task_name', None)
+            extended_props.update({
+                'periodic_task_name': periodic_task_name,
+                'task_args': task_args,
+                'task_kwargs': task_kwargs,
+                'task_name': getattr(request, 'task', None),
+                'traceback': traceback,
+                'worker': getattr(request, 'hostname', None),
+            })
+
+        return extended_props
+
     def _store_result(
             self,
             task_id,
@@ -69,48 +114,22 @@ def _store_result(
             {'children': self.current_task_children(request)}
         )
 
-        task_name = getattr(request, 'task', None)
-        properties = getattr(request, 'properties', {}) or {}
-        periodic_task_name = properties.get('periodic_task_name', None)
-        worker = getattr(request, 'hostname', None)
-
-        # Get input arguments
-        if getattr(request, 'argsrepr', None) is not None:
-            # task protocol 2
-            task_args = request.argsrepr
-        else:
-            # task protocol 1
-            task_args = getattr(request, 'args', None)
-
-        if getattr(request, 'kwargsrepr', None) is not None:
-            # task protocol 2
-            task_kwargs = request.kwargsrepr
-        else:
-            # task protocol 1
-            task_kwargs = getattr(request, 'kwargs', None)
-
-        # Encode input arguments
-        if task_args is not None:
-            _, _, task_args = self.encode_content(task_args)
-
-        if task_kwargs is not None:
-            _, _, task_kwargs = self.encode_content(task_kwargs)
-
-        self.TaskModel._default_manager.store_result(
-            content_type,
-            content_encoding,
-            task_id,
-            result,
-            status,
-            traceback=traceback,
-            meta=meta,
-            periodic_task_name=periodic_task_name,
-            task_name=task_name,
-            task_args=task_args,
-            task_kwargs=task_kwargs,
-            worker=worker,
-            using=using,
+        task_props = {
+            'content_encoding': content_encoding,
+            'content_type': content_type,
+            'meta': meta,
+            'result': result,
+            'status': status,
+            'task_id': task_id,
+            'traceback': traceback,
+            'using': using,
+        }
+
+        task_props.update(
+            self._get_extended_properties(request, traceback)
         )
+
+        self.TaskModel._default_manager.store_result(**task_props)
         return result
 
     def _get_task_meta_for(self, task_id):

docs/includes/introduction.txt

@@ -1,4 +1,4 @@
-:Version: 2.3.0
+:Version: 2.3.1
 :Web: http://django-celery-results.readthedocs.io/
 :Download: http://pypi.python.org/pypi/django-celery-results
 :Source: http://github.com/celery/django-celery-results

t/unit/backends/test_database.py

@@ -31,6 +31,7 @@ def setup_backend(self):
         self.app.conf.result_serializer = 'json'
         self.app.conf.result_backend = (
             'django_celery_results.backends:DatabaseBackend')
+        self.app.conf.result_extended = True
         self.b = DatabaseBackend(app=self.app)
 
     def _create_request(self, task_id, name, args, kwargs,
@@ -859,3 +860,30 @@ def test_groupresult_save_restore_nested(self):
         restored_group = self.b.restore_group(group_id=group_id)
 
         assert restored_group == group
+
+    def test_backend_result_extended_is_false(self):
+        self.app.conf.result_extended = False
+        self.b = DatabaseBackend(app=self.app)
+        tid2 = uuid()
+        request = self._create_request(
+            task_id=tid2,
+            name='my_task',
+            args=['a', 1, True],
+            kwargs={'c': 6, 'd': 'e', 'f': False},
+        )
+        result = 'foo'
+
+        self.b.mark_as_done(tid2, result, request=request)
+
+        mindb = self.b.get_task_meta(tid2)
+
+        # check meta data
+        assert mindb.get('result') == 'foo'
+        assert mindb.get('task_name') is None
+        assert mindb.get('task_args') is None
+        assert mindb.get('task_kwargs') is None
+
+        # check task_result object
+        tr = TaskResult.objects.get(task_id=tid2)
+        assert tr.task_args is None
+        assert tr.task_kwargs is None