← Back to branch summary

~ubuntu-branches/ubuntu/natty/miro/natty

« back to all changes in this revision

Viewing changes to lib/debugutil.py

  • Committer: Bazaar Package Importer
  • Author(s): Bryce Harrington
  • Date: 2011-01-22 02:46:33 UTC
  • mfrom: (1.4.10 upstream) (1.7.5 experimental)
  • Revision ID: james.westby@ubuntu.com-20110122024633-kjme8u93y2il5nmf
Tags: 3.5.1-1ubuntu1
* Merge from debian.  Remaining ubuntu changes:
  - Use python 2.7 instead of python 2.6
  - Relax dependency on python-dbus to >= 0.83.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/debugutil.py
 
1
# Miro - an RSS based video player application
 
2
# Copyright (C) 2010 Participatory Culture Foundation
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 
17
#
 
18
# In addition, as a special exception, the copyright holders give
 
19
# permission to link the code of portions of this program with the OpenSSL
 
20
# library.
 
21
#
 
22
# You must obey the GNU General Public License in all respects for all of
 
23
# the code used other than OpenSSL. If you modify file(s) with this
 
24
# exception, you may extend this exception to your version of the file(s),
 
25
# but you are not obligated to do so. If you do not wish to do so, delete
 
26
# this exception statement from your version. If you delete this exception
 
27
# statement from all source files in the program, then also delete it here.
 
28
 
 
29
"""
 
30
This module contains a series of debugging functions that I keep
 
31
writing and finally got around to persisting to the code-base.
 
32
 
 
33
.. Note::
 
34
 
 
35
   These are literally thrown together based on what I needed at the
 
36
   time.  Feel free to adjust them for better functionality.
 
37
"""
 
38
 
 
39
import logging
 
40
import traceback
 
41
 
 
42
def logwrap(fun):
 
43
    """Function decorator that wraps a function and logs when it
 
44
    starts and when it ends.
 
45
 
 
46
    Example::
 
47
 
 
48
        @logwrap
 
49
        def foo():
 
50
            pass
 
51
    """
 
52
    # don't wrap a wrapped function
 
53
    if fun.__name__ == "_wrapped_fun":
 
54
        return fun
 
55
    def _wrapped_fun(*args, **kwargs):
 
56
        name = "%s %s" % (fun.__module__, fun.__name__)
 
57
        try:
 
58
            logging.info("START: %s", name)
 
59
            return fun(*args, **kwargs)
 
60
        finally:
 
61
            logging.info("END:   %s", name)
 
62
    return _wrapped_fun
 
63
 
 
64
def instrument_class(klass):
 
65
    """Instruments a class wrapping all methods with logwrap.
 
66
 
 
67
    Example::
 
68
 
 
69
        class Foo:
 
70
            def bar(self):
 
71
                pass
 
72
 
 
73
        instrument_class(Foo)
 
74
    """
 
75
    for name in dir(klass):
 
76
        try:
 
77
            mem = klass.__dict__[name]
 
78
        except KeyError:
 
79
            continue
 
80
        if not callable(mem):
 
81
            continue
 
82
        setattr(klass, name, logwrap(mem))