merge
authorSylvain Thenault <sylvain.thenault@logilab.fr>
Tue, 06 Jan 2009 18:22:39 +0100
changeset 334 f75b6d4e3ff1
parent 332 86b8d58664eb (current diff)
parent 333 c65eccf85895 (diff)
child 338 25aae8a15532
merge
--- a/__init__.py	Tue Jan 06 18:21:03 2009 +0100
+++ b/__init__.py	Tue Jan 06 18:22:39 2009 +0100
@@ -23,33 +23,11 @@
 
 from logilab.common.decorators import cached
 
-
-LLDEBUG = 5
-logging.addLevelName(LLDEBUG, 'LLDEBUG')
-
-class CubicWebLogger(logging.Logger):
-
-    def lldebug(self, msg, *args, **kwargs):
-        """
-        Log 'msg % args' with severity 'DEBUG'.
-
-        To pass exception information, use the keyword argument exc_info with
-        a true value, e.g.
-
-        logger.debug("Houston, we have a %s", "thorny problem", exc_info=1)
-        """
-        if self.manager.disable >= LLDEBUG:
-            return
-        if LLDEBUG >= self.getEffectiveLevel():
-            self._log(LLDEBUG, msg, args, **kwargs)
-
-logging.setLoggerClass(CubicWebLogger)
-
 def set_log_methods(cls, logger):
     """bind standart logger's methods as static methods on the class
     """
     cls._logger = logger
-    for attr in ('lldebug', 'debug', 'info', 'warning', 'error', 'critical', 'exception'):
+    for attr in ('debug', 'info', 'warning', 'error', 'critical', 'exception'):
         setattr(cls, attr, getattr(logger, attr))
 
 if os.environ.get('APYCOT_ROOT'):
--- a/common/selectors.py	Tue Jan 06 18:21:03 2009 +0100
+++ b/common/selectors.py	Tue Jan 06 18:22:39 2009 +0100
@@ -3,6 +3,35 @@
 A selector is responsible to score how well an object may be used with a
 given result set (publishing time selection)
 
+If you have trouble with selectors, especially if the objet (typically
+a view or a component) you want to use is not selected and you want to
+know which one(s) of its selectors fail (e.g. returns 0), you can use
+`traced_selection` or even direclty `TRACED_OIDS`.
+
+`TRACED_OIDS` is a tuple of traced object ids. The special value
+'all' may be used to log selectors for all objects.
+
+For instance, say that the following code yields a `NoSelectableObject`
+exception::
+
+    self.view('calendar', myrset)
+
+You can log the selectors involved for *calendar* by replacing the line
+above by::
+
+    # in Python2.5
+    from cubicweb.selectors import traced_selection
+    with traced_selection():
+        self.view('calendar', myrset)
+
+    # in Python2.4
+    from cubicweb import selectors
+    selectors.TRACED_OIDS = ('calendar',)
+    self.view('calendar', myrset)
+    selectors.TRACED_OIDS = ()
+ 
+
+
 :organization: Logilab
 :copyright: 2001-2008 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
 :contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
@@ -10,6 +39,8 @@
 
 __docformat__ = "restructuredtext en"
 
+import logging
+
 from logilab.common.compat import all
 from logilab.common.deprecation import deprecated_function
 
@@ -20,16 +51,49 @@
 from cubicweb.schema import split_expression
 
 
+# helpers for debugging selectors
+SELECTOR_LOGGER = logging.getLogger('cubicweb.selectors')
+TRACED_OIDS = ()
+
 def lltrace(selector):
     # don't wrap selectors if not in development mode
     if CubicWebConfiguration.mode == 'installed':
         return selector
     def traced(cls, *args, **kwargs):
         ret = selector(cls, *args, **kwargs)
-        cls.lldebug('selector %s returned %s for %s', selector.__name__, ret, cls)
+        if TRACED_OIDS == 'all' or cls.id in TRACED_OIDS:
+            SELECTOR_LOGGER.warning('selector %s returned %s for %s', selector.__name__, ret, cls)
         return ret
     return traced
+
+class traced_selection(object):
+    """selector debugging helper.
+
+    Typical usage is :
+
+    >>> with traced_selection():
+    ...     # some code in which you want to debug selectors
+    ...     # for all objects
+
+    or
+
+    >>> with traced_selection( ('oid1', 'oid2') ):
+    ...     # some code in which you want to debug selectors
+    ...     # for objects with id 'oid1' and 'oid2'
     
+    """
+    def __init__(self, traced='all'):
+        self.traced = traced
+        
+    def __enter__(self):
+        global TRACED_OIDS
+        TRACED_OIDS = self.traced
+
+    def __exit__(self, exctype, exc, traceback):
+        global TRACED_OIDS
+        TRACED_OIDS = ()
+        return traceback is None
+
 # very basic selectors ########################################################
 
 def yes(cls, *args, **kwargs):