Ticket #16568: ticket_16568.patch

django/conf/__init__.py

@@ -199 +199 @@
         while filter_name in filters:
             filter_name = filter_name + "_"
 
-        def _callback(record):
-            from django.conf import settings
-            return not settings.DEBUG
-
         filters[filter_name] = {
-            "()": "django.utils.log.CallbackFilter",
-            "callback": _callback
-            }
+            "()": "django.utils.log.RequireDebugFalse",
+        }
 
         logging_config["handlers"]["mail_admins"]["filters"] = [filter_name]

django/conf/global_settings.py

@@ -522 +522 @@
 # The default logging configuration. This sends an email to
 # the site admins on every HTTP 500 error. All other log
 # records are sent to the bit bucket.
+
 LOGGING = {
     'version': 1,
     'disable_existing_loggers': False,
     'filters': {
         'require_debug_false': {
-            '()': 'django.utils.log.CallbackFilter',
-            'callback': lambda r: not DEBUG
+            '()': 'django.utils.log.RequireDebugFalse',
         }
     },
     'handlers': {

django/conf/project_template/settings.py

@@ -128 +128 @@
     'disable_existing_loggers': False,
     'filters': {
         'require_debug_false': {
-            '()': 'django.utils.log.CallbackFilter',
-            'callback': lambda r: not DEBUG
+            '()': 'django.utils.log.RequireDebugFalse'
         }
     },
     'handlers': {

django/utils/log.py

@@ -30 +30 @@
 if not logger.handlers:
     logger.addHandler(NullHandler())
 
+
 class AdminEmailHandler(logging.Handler):
     def __init__(self, include_html=False):
         logging.Handler.__init__(self)
@@ -81 +82 @@
     def __init__(self, callback):
         self.callback = callback
 
-
     def filter(self, record):
         if self.callback(record):
             return 1
         return 0
+
+
+class RequireDebugFalse(logging.Filter):
+    def filter(self, record):
+        return not settings.DEBUG

docs/releases/1.4.txt

@@ -485 +485 @@
 
    'filters': {
         'require_debug_false': {
-            '()': 'django.utils.log.CallbackFilter',
-            'callback': lambda r: not DEBUG
+            '()': 'django.utils.log.RequireDebugFalse'
         }
     },
     'handlers': {

docs/topics/logging.txt

@@ -506 +506 @@
 Filters
 -------
 
-Django provides one log filter in addition to those provided by the
+Django provides two log filter in addition to those provided by the
 Python logging module.
 
 .. class:: CallbackFilter(callback)
@@ -518 +518 @@
    through the filter. Handling of that record will not proceed if the callback
    returns False.
 
+.. class:: RequireDebugFalse()
+
+   .. versionadded:: 1.4
+
+   This filter will only proceed records when settings.DEBUG is False.
+
    This filter is used as follows in the default :setting:`LOGGING`
    configuration to ensure that the :class:`AdminEmailHandler` only sends error
    emails to admins when :setting:`DEBUG` is `False`::
 
        'filters': {
             'require_debug_false': {
-                '()': 'django.utils.log.CallbackFilter',
-                'callback': lambda r: not DEBUG
+                '()': 'django.utils.log.RequireDebugFalse',
             }
         },
         'handlers': {

tests/regressiontests/logging_tests/tests.py

@@ -2 +2 @@
 
 import copy
 
-from django.conf import compat_patch_logging_config
+from django.conf import compat_patch_logging_config, settings, global_settings
 from django.test import TestCase
-from django.utils.log import CallbackFilter
+from django.utils.log import CallbackFilter, RequireDebugFalse
 
 
 # logging config prior to using filter with mail_admins
@@ -27 +27 @@
 }
 
 
-
 class PatchLoggingConfigTest(TestCase):
     """
     Tests for backward-compat shim for #16288. These tests should be removed in
@@ -47 +46 @@
             config["handlers"]["mail_admins"]["filters"],
             ['require_debug_false'])
 
-
     def test_filter_configuration(self):
         """
-        Test that the debug-false filter is a CallbackFilter with a callback
-        that works as expected (returns ``not DEBUG``).
+        Test that the require_debug_false filter (RequireDebugFalse) is added
+        to the settings when not explicitly specified in the settings.
 
         """
         config = copy.deepcopy(OLD_LOGGING)
         compat_patch_logging_config(config)
 
         flt = config["filters"]["require_debug_false"]
+        self.assertEqual(flt["()"], "django.utils.log.RequireDebugFalse")
 
-        self.assertEqual(flt["()"], "django.utils.log.CallbackFilter")
-
-        callback = flt["callback"]
+    def test_require_debug_false_filter(self):
+        """Test the RequireDebugFalse filter"""
+        filter_ = RequireDebugFalse()
 
         with self.settings(DEBUG=True):
-            self.assertEqual(callback("record is not used"), False)
+            self.assertEqual(filter_.filter("record is not used"), False)
 
         with self.settings(DEBUG=False):
-            self.assertEqual(callback("record is not used"), True)
-
+            self.assertEqual(filter_.filter("record is not used"), True)
 
     def test_no_patch_if_filters_key_exists(self):
         """
@@ -97 +95 @@
         self.assertEqual(config, new_config)
 
 
+class TestRequireDebugFalseNoLoggingSetting(TestCase):
+    """
+    Test that RequireDebugFalse works as excpected when LOGGING is not
+    specified in the project settings. See #16568.
+    """
+    def setUp(self):
+        self.old_logging = settings.LOGGING
+        settings.LOGGING = global_settings.LOGGING
+
+    def tearDown(self):
+        settings.LOGGING = self.old_logging
+
+    def test_require_debug_no_logging_setting(self):
+        filter_ = RequireDebugFalse()
+
+        with self.settings(DEBUG=True):
+            self.assertEqual(filter_.filter("record is not used"), False)
+
+        with self.settings(DEBUG=False):
+            self.assertEqual(filter_.filter("record is not used"), True)
+
+
 class CallbackFilterTest(TestCase):
     def test_sense(self):
         f_false = CallbackFilter(lambda r: False)
@@ -107 +127 @@
 
     def test_passes_on_record(self):
         collector = []
+
         def _callback(record):
             collector.append(record)
             return True