From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Sun, 29 Apr 2007 17:22:50 +0000 (+0000)
Subject: document the 'echo' property
X-Git-Tag: rel_0_3_7~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d5f423fb1948be3cba52c37270dae6ef90be9dbb;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

document the 'echo' property
---

diff --git a/lib/sqlalchemy/logging.py b/lib/sqlalchemy/logging.py
index 665a5cff9c..f02e3f746f 100644
--- a/lib/sqlalchemy/logging.py
+++ b/lib/sqlalchemy/logging.py
@@ -67,15 +67,22 @@ def is_info_enabled(logger):
 class echo_property(object):
     level_map={logging.DEBUG : "debug", logging.INFO:True}
     
-    __doc__ = "when ``True``, enable echoing for this element."
+    __doc__ = """when ``True``, enable log output for this element.
+    
+    This has the effect of setting the Python logging level for the 
+    namespace of this element's class and object reference.  A value
+    of boolean ``True`` indicates that the loglevel ``logging.INFO`` will be 
+    set for the logger, whereas the string value ``debug`` will set the loglevel
+    to ``logging.DEBUG``.
+    """
     
     def __get__(self, instance, owner):
+        if instance is None:
+            return self
         level = logging.getLogger(_get_instance_name(instance)).getEffectiveLevel()
         return echo_property.level_map.get(level, False)
         
     def __set__(self, instance, value):
-        if instance is None:
-            return self
         if value:
             default_logging(_get_instance_name(instance))
             logging.getLogger(_get_instance_name(instance)).setLevel(value == 'debug' and logging.DEBUG or logging.INFO)