← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/debug.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/debug.py
 
1
# Copyright (C) 2005, 2006, 2009 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Set of flags that enable different debug behaviour.
 
18
 
 
19
These are set with eg ``-Dlock`` on the bzr command line or in
 
20
~/.bazaar/bazaar.conf debug_flags.
 
21
 
 
22
See `bzr help debug-flags` or `bzrlib/help_topics/en/debug-flags.txt`
 
23
for a list of the available options.
 
24
"""
 
25
 
 
26
from __future__ import absolute_import
 
27
 
 
28
debug_flags = set()
 
29
 
 
30
 
 
31
def set_debug_flags_from_config():
 
32
    """Turn on debug flags based on the global configuration"""
 
33
 
 
34
    from bzrlib import config
 
35
 
 
36
    c = config.GlobalStack()
 
37
    for f in c.get('debug_flags'):
 
38
        debug_flags.add(f)
 
39
 
 
40
 
 
41
def set_trace():
 
42
    """Pdb using original stdin and stdout.
 
43
 
 
44
    When debugging blackbox tests, sys.stdin and sys.stdout are captured for
 
45
    test purposes and cannot be used for interactive debugging. This class uses
 
46
    the origianl stdin/stdout to allow such use.
 
47
 
 
48
    Instead of doing:
 
49
 
 
50
       import pdb; pdb.set_trace()
 
51
 
 
52
    you can do:
 
53
 
 
54
       from bzrlib import debug; debug.set_trace()
 
55
    """
 
56
    import pdb
 
57
    import sys
 
58
    pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
 
59
            ).set_trace(sys._getframe().f_back)