Cleans up deprecation warnings, and always display them in celery programs

celery/app/base.py

@@ -23,7 +23,7 @@ from threading import Lock
 from .. import datastructures
 from ..utils import cached_property, instantiate, lpmerge
 
-from .defaults import DEFAULTS
+from .defaults import DEFAULTS, find_deprecated_settings
 
 import kombu
 if kombu.VERSION < (1, 1, 0):
@@ -315,6 +315,7 @@ class BaseApp(object):
 
     def prepare_config(self, c):
         """Prepare configuration before it is merged with the defaults."""
+        find_deprecated_settings(c)
         return c
 
     def mail_admins(self, subject, body, fail_silently=False):

celery/app/defaults.py

@@ -1,5 +1,6 @@
 import sys
 
+from collections import deque
 from datetime import timedelta
 
 is_jython = sys.platform.startswith("java")
@@ -32,12 +33,17 @@ def str_to_bool(term, table={"false": False, "no": False, "0": False,
 
 
 class Option(object):
+    alt = None
+    deprecate_by = None
+    remove_by = None
     typemap = dict(string=str, int=int, float=float, any=lambda v: v,
                    bool=str_to_bool, dict=dict, tuple=tuple)
 
     def __init__(self, default=None, *args, **kwargs):
         self.default = default
         self.type = kwargs.get("type") or "string"
+        for attr, value in kwargs.iteritems():
+            setattr(self, attr, value)
 
     def to_python(self, value):
         return self.typemap[self.type](value)
@@ -174,13 +180,25 @@ NAMESPACES = {
 }
 
 
-def _flatten(d, ns=""):
-    acc = []
-    for key, value in d.iteritems():
-        if isinstance(value, dict):
-            acc.extend(_flatten(value, ns=key + '_'))
-        else:
-            acc.append((ns + key, value.default))
-    return acc
+def flatten(d, ns=""):
+    stack = deque([(ns, d)])
+    while stack:
+        name, space = stack.popleft()
+        for key, value in space.iteritems():
+            if isinstance(value, dict):
+                stack.append((name + key + '_', value))
+            else:
+                yield name + key, value
 
-DEFAULTS = dict(_flatten(NAMESPACES))
+
+def find_deprecated_settings(source):
+    from celery.utils import warn_deprecated
+    for name, opt in flatten(NAMESPACES):
+        if (opt.deprecate_by or opt.remove_by) and getattr(source, name, None):
+            warn_deprecated(description="The %r setting" % (name, ),
+                            deprecation=opt.deprecate_by,
+                            removal=opt.remove_by,
+                            alternative=opt.alt)
+
+
+DEFAULTS = dict((key, value.default) for key, value in flatten(NAMESPACES))

celery/backends/mongodb.py

@@ -14,6 +14,7 @@ from ..utils.timeutils import maybe_timedelta
 
 from .base import BaseDictBackend
 
+
 class Bunch:
 
     def __init__(self, **kw):

celery/bin/base.py

@@ -2,10 +2,17 @@ from __future__ import absolute_import
 
 import os
 import sys
+import warnings
 
 from optparse import OptionParser, make_option as Option
 
 from .. import __version__, Celery
+from ..exceptions import CDeprecationWarning, CPendingDeprecationWarning
+
+
+# always enable DeprecationWarnings, so our users can see them.
+for warning in (CDeprecationWarning, CPendingDeprecationWarning):
+    warnings.simplefilter("once", warning, 0)
 
 
 class Command(object):

celery/decorators.py

@@ -17,9 +17,10 @@ from __future__ import absolute_import
 import warnings
 
 from . import task as _task
+from .exceptions import CDeprecationWarning
 
 
-warnings.warn(PendingDeprecationWarning("""
+warnings.warn(CDeprecationWarning("""
 The `celery.decorators` module and the magic keyword arguments
 are pending deprecation and will be deprecated in 2.4, then removed
 in 3.0.

celery/exceptions.py

@@ -61,3 +61,11 @@ class TaskRevokedError(Exception):
 
 class NotConfigured(UserWarning):
     """Celery has not been configured, as no config module has been found."""
+
+
+class CPendingDeprecationWarning(PendingDeprecationWarning):
+    pass
+
+
+class CDeprecationWarning(DeprecationWarning):
+    pass

celery/loaders/__init__.py

@@ -1,7 +1,5 @@
 from __future__ import absolute_import
 
-import os
-
 from .. import current_app
 from ..utils import deprecated, get_cls_by_name
 

celery/task/__init__.py

@@ -4,6 +4,7 @@ from __future__ import absolute_import
 import warnings
 
 from ..app import app_or_default
+from ..exceptions import CDeprecationWarning
 
 from .base import Task, PeriodicTask
 from .sets import TaskSet, subtask
@@ -98,7 +99,7 @@ def ping():  # ✞
     Please use :meth:`celery.task.control.ping` instead.
 
     """
-    warnings.warn(DeprecationWarning(
+    warnings.warn(CDeprecationWarning(
         "The ping task has been deprecated and will be removed in Celery "
         "v2.3.  Please use inspect.ping instead."))
     return PingTask.apply_async().get()

celery/task/schedules.py

@@ -2,8 +2,9 @@ from __future__ import absolute_import
 
 import warnings
 from ..schedules import schedule, crontab_parser, crontab
+from ..exceptions import CDeprecationWarning
 
 __all__ = ["schedule", "crontab_parser", "crontab"]
 
-warnings.warn(DeprecationWarning(
+warnings.warn(CDeprecationWarning(
     "celery.task.schedules is deprecated and renamed to celery.schedules"))

celery/task/sets.py

@@ -6,6 +6,7 @@ import warnings
 from .. import registry
 from ..app import app_or_default
 from ..datastructures import AttributeDict
+from ..exceptions import CDeprecationWarning
 from ..utils import cached_property, reprcall, uuid
 from ..utils.compat import UserList
 
@@ -138,7 +139,7 @@ class TaskSet(UserList):
                 self._task_name = task.name
                 warnings.warn(TASKSET_DEPRECATION_TEXT % {
                                 "cls": task.__class__.__name__},
-                              DeprecationWarning)
+                              CDeprecationWarning)
         self.data = list(tasks or [])
         self.total = len(self.tasks)
         self.Publisher = Publisher or self.app.amqp.TaskPublisher
@@ -182,12 +183,12 @@ class TaskSet(UserList):
     def task(self):
         warnings.warn(
             "TaskSet.task is deprecated and will be removed in 1.4",
-            DeprecationWarning)
+            CDeprecationWarning)
         return self._task
 
     @property
     def task_name(self):
         warnings.warn(
             "TaskSet.task_name is deprecated and will be removed in 1.4",
-            DeprecationWarning)
+            CDeprecationWarning)
         return self._task_name

celery/tests/test_app/test_loaders.py

@@ -12,7 +12,7 @@ from celery.loaders import default
 from celery.loaders.app import AppLoader
 
 from celery.tests.compat import catch_warnings
-from celery.tests.utils import unittest, AppCase, with_environ
+from celery.tests.utils import unittest, AppCase
 
 
 class ObjectConfig(object):

celery/tests/test_task/test_task_builtins.py

@@ -3,6 +3,7 @@ from __future__ import with_statement
 import warnings
 
 from celery.task import ping, PingTask, backend_cleanup
+from celery.exceptions import CDeprecationWarning
 from celery.tests.compat import catch_warnings
 from celery.tests.utils import unittest
 
@@ -23,7 +24,7 @@ class test_deprecated(unittest.TestCase):
                 pong = ping()
                 warning = log[0].message
                 self.assertEqual(pong, "pong")
-                self.assertIsInstance(warning, DeprecationWarning)
+                self.assertIsInstance(warning, CDeprecationWarning)
                 self.assertIn("ping task has been deprecated",
                               warning.args[0])
             finally:
@@ -37,7 +38,7 @@ class test_deprecated(unittest.TestCase):
             TaskSet()
             subtask(PingTask)
             for w in (log[0].message, log[1].message):
-                self.assertIsInstance(w, DeprecationWarning)
+                self.assertIsInstance(w, CDeprecationWarning)
                 self.assertIn("is deprecated", w.args[0])
 
 

celery/utils/__init__.py

@@ -20,6 +20,8 @@ from pprint import pprint
 from kombu.utils import cached_property, gen_unique_id  # noqa
 uuid = gen_unique_id
 
+from ..exceptions import CPendingDeprecationWarning, CDeprecationWarning
+
 from .compat import StringIO
 from .encoding import safe_repr as _safe_repr
 
@@ -39,6 +41,18 @@ DEPRECATION_FMT = """
 """
 
 
+def warn_deprecated(description=None, deprecation=None, removal=None,
+        alternative=None):
+    ctx = {"description": description,
+           "deprecation": deprecation, "removal": removal,
+           "alternative": alternative}
+    if deprecation is not None:
+        w = CPendingDeprecationWarning(PENDING_DEPRECATION_FMT % ctx)
+    else:
+        w = CDeprecationWarning(DEPRECATION_FMT % ctx)
+    warnings.warn(w)
+
+
 def deprecated(description=None, deprecation=None, removal=None,
         alternative=None):
 
@@ -46,14 +60,10 @@ def deprecated(description=None, deprecation=None, removal=None,
 
         @wraps(fun)
         def __inner(*args, **kwargs):
-            ctx = {"description": description or get_full_cls_name(fun),
-                   "deprecation": deprecation, "removal": removal,
-                   "alternative": alternative}
-            if deprecation is not None:
-                w = PendingDeprecationWarning(PENDING_DEPRECATION_FMT % ctx)
-            else:
-                w = DeprecationWarning(DEPRECATION_FMT % ctx)
-            warnings.warn(w)
+            warn_deprecated(description=description or get_full_cls_name(fun),
+                            deprecation=deprecation,
+                            removal=removal,
+                            alternative=alternative)
             return fun(*args, **kwargs)
         return __inner
     return _inner

celery/worker/control/__init__.py

@@ -6,4 +6,3 @@ from . import registry
 from . import builtins  # noqa
 
 Panel = registry.Panel
-