← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/debug.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/debug.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
# NOTE: If update these, please also update the help for global-options in
19
 
#       bzrlib/help_topics.py.
20
 
 
21
 
debug_flags = set()
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
22
17
"""Set of flags that enable different debug behaviour.
23
18
 
24
 
These are set with eg ``-Dlock`` on the bzr command line.
25
 
 
26
 
Options include:
27
 
 
28
 
 * auth - show authentication sections used
29
 
 * error - show stack traces for all top level exceptions
30
 
 * evil - capture call sites that do expensive or badly-scaling operations.
31
 
 * fetch - trace history copying between repositories
32
 
 * hooks - trace hook execution
33
 
 * hpss - trace smart protocol requests and responses
34
 
 * index - trace major index operations
35
 
 * lock - trace when lockdir locks are taken or released
36
 
 
 
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.
37
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)