23
26
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
28
34
from bzrlib.lazy_import import lazy_import
29
35
lazy_import(globals(), """
38
from warnings import warn
34
41
from bzrlib import (
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
49
# Compatibility - Option used to be in commands.
50
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
from bzrlib import registry
53
51
from bzrlib.symbol_versioning import (
54
52
deprecated_function,
60
class CommandInfo(object):
61
"""Information about a command."""
63
def __init__(self, aliases):
64
"""The list of aliases for the command."""
65
self.aliases = aliases
68
def from_command(klass, command):
69
"""Factory to construct a CommandInfo from a command."""
70
return klass(command.aliases)
73
class CommandRegistry(registry.Registry):
74
"""Special registry mapping command names to command classes.
76
:ivar overridden_registry: Look in this registry for commands being
77
overridden by this registry. This can be used to tell plugin commands
78
about the builtin they're decorating.
82
registry.Registry.__init__(self)
83
self.overridden_registry = None
84
# map from aliases to the real command that implements the name
87
def get(self, command_name):
88
real_name = self._alias_dict.get(command_name, command_name)
89
return registry.Registry.get(self, real_name)
92
def _get_name(command_name):
93
if command_name.startswith("cmd_"):
94
return _unsquish_command_name(command_name)
98
def register(self, cmd, decorate=False):
99
"""Utility function to help register a command
101
:param cmd: Command subclass to register
102
:param decorate: If true, allow overriding an existing command
103
of the same name; the old command is returned by this function.
104
Otherwise it is an error to try to override an existing command.
107
k_unsquished = self._get_name(k)
109
previous = self.get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
117
info = CommandInfo.from_command(cmd)
119
registry.Registry.register(self, k_unsquished, cmd,
120
override_existing=decorate, info=info)
122
trace.warning('Two plugins defined the same command: %r' % k)
123
trace.warning('Not loading the one in %r' %
124
sys.modules[cmd.__module__])
125
trace.warning('Previously this command was registered from %r' %
126
sys.modules[previous.__module__])
127
for a in cmd.aliases:
128
self._alias_dict[a] = k_unsquished
131
def register_lazy(self, command_name, aliases, module_name):
132
"""Register a command without loading its module.
134
:param command_name: The primary name of the command.
135
:param aliases: A list of aliases for the command.
136
:module_name: The module that the command lives in.
138
key = self._get_name(command_name)
139
registry.Registry.register_lazy(self, key, module_name, command_name,
140
info=CommandInfo(aliases))
142
self._alias_dict[a] = key
145
plugin_cmds = CommandRegistry()
146
builtin_command_registry = CommandRegistry()
147
plugin_cmds.overridden_registry = builtin_command_registry
58
from bzrlib.option import Option
150
64
def register_command(cmd, decorate=False):
151
"""Register a plugin command.
65
"""Utility function to help register a command
153
Should generally be avoided in favor of lazy registration.
67
:param cmd: Command subclass to register
68
:param decorate: If true, allow overriding an existing command
69
of the same name; the old command is returned by this function.
70
Otherwise it is an error to try to override an existing command.
155
72
global plugin_cmds
156
return plugin_cmds.register(cmd, decorate)
74
if k.startswith("cmd_"):
75
k_unsquished = _unsquish_command_name(k)
78
if k_unsquished not in plugin_cmds:
79
plugin_cmds[k_unsquished] = cmd
80
## trace.mutter('registered plugin command %s', k_unsquished)
81
if decorate and k_unsquished in builtin_command_names():
82
return _builtin_commands()[k_unsquished]
84
result = plugin_cmds[k_unsquished]
85
plugin_cmds[k_unsquished] = cmd
88
trace.log_error('Two plugins defined the same command: %r' % k)
89
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
159
92
def _squish_command_name(cmd):
163
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
164
98
return cmd[4:].replace('_','-')
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
101
def _builtin_commands():
171
102
import bzrlib.builtins
172
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
builtin_command_registry.register(cmd_class)
174
bzrlib.builtins._register_lazy_builtins()
177
def _scan_module_for_commands(module):
179
for name, obj in module.__dict__.iteritems():
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
180
106
if name.startswith("cmd_"):
181
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
186
def _list_bzr_commands(names):
187
"""Find commands from bzr's core and plugins.
189
This is not the public interface, just the default hook called by all_command_names.
191
# to eliminate duplicates
192
names.update(builtin_command_names())
193
names.update(plugin_command_names())
197
def all_command_names():
198
"""Return a set of all command names."""
200
for hook in Command.hooks['list_commands']:
203
raise AssertionError(
204
'hook %s returned None' % Command.hooks.get_hook_name(hook))
208
112
def builtin_command_names():
209
"""Return list of builtin command names.
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
211
Use of all_command_names() is encouraged rather than builtin_command_names
212
and/or plugin_command_names.
214
_register_builtin_commands()
215
return builtin_command_registry.keys()
218
117
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
220
118
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
223
135
def get_cmd_object(cmd_name, plugins_override=True):
224
"""Return the command object for a command.
136
"""Return the canonical name and command class for a command.
227
139
If true, plugin commands can override builtins.
232
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
235
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
236
"""Get a command object.
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
238
:param cmd_name: The name of the command.
239
:param plugins_override: Allow plugins to override builtins.
240
:param check_missing: Look up commands not found in the regular index via
241
the get_missing_command hook.
242
:return: A Command object instance
243
:raises KeyError: If no command is found.
245
151
# We want only 'ascii' command names, but the user may have typed
246
152
# in a Unicode name. In that case, they should just get a
247
153
# 'command not found' error later.
248
154
# In the future, we may actually support Unicode command names.
251
for hook in Command.hooks['get_command']:
252
cmd = hook(cmd, cmd_name)
253
if cmd is not None and not plugins_override and not cmd.plugin_name():
254
# We've found a non-plugin command, don't permit it to be
257
if cmd is None and check_missing:
258
for hook in Command.hooks['get_missing_command']:
265
# Allow plugins to extend commands
266
for hook in Command.hooks['extend_command']:
268
if getattr(cmd, 'invoked_as', None) is None:
269
cmd.invoked_as = cmd_name
273
def _try_plugin_provider(cmd_name):
274
"""Probe for a plugin provider having cmd_name."""
276
plugin_metadata, provider = probe_for_provider(cmd_name)
277
raise errors.CommandAvailableInPlugin(cmd_name,
278
plugin_metadata, provider)
279
except errors.NoPluginAvailable:
283
def probe_for_provider(cmd_name):
284
"""Look for a provider for cmd_name.
286
:param cmd_name: The command name.
287
:return: plugin_metadata, provider for getting cmd_name.
288
:raises NoPluginAvailable: When no provider can supply the plugin.
290
# look for providers that provide this command but aren't installed
291
for provider in command_providers_registry:
293
return provider.plugin_for_command(cmd_name), provider
294
except errors.NoPluginAvailable:
296
raise errors.NoPluginAvailable(cmd_name)
299
def _get_bzr_command(cmd_or_None, cmd_name):
300
"""Get a command from bzr's core."""
302
cmd_class = builtin_command_registry.get(cmd_name)
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
310
def _get_external_command(cmd_or_None, cmd_name):
311
"""Lookup a command that is a shell script."""
312
# Only do external command lookups when no command is found so far.
313
if cmd_or_None is not None:
315
from bzrlib.externalcommand import ExternalCommand
163
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
316
168
cmd_obj = ExternalCommand.find_command(cmd_name)
321
def _get_plugin_command(cmd_or_None, cmd_name):
322
"""Get a command from bzr's plugins."""
324
return plugin_cmds.get(cmd_name)()
327
for key in plugin_cmds.keys():
328
info = plugin_cmds.get_info(key)
329
if cmd_name in info.aliases:
330
return plugin_cmds.get(key)()
334
174
class Command(object):
349
189
summary, then a complete description of the command. A grammar
350
190
description will be inserted.
352
:cvar aliases: Other accepted names for this command.
354
:cvar takes_args: List of argument forms, marked with whether they are
355
optional, repeated, etc. Examples::
357
['to_location', 'from_branch?', 'file*']
359
* 'to_location' is required
360
* 'from_branch' is optional
361
* 'file' can be specified 0 or more times
363
:cvar takes_options: List of options that may be given for this command.
364
These can be either strings, referring to globally-defined options, or
365
option objects. Retrieve through options().
367
:cvar hidden: If true, this command isn't advertised. This is typically
193
Other accepted names for this command.
196
List of argument forms, marked with whether they are optional,
201
['to_location', 'from_branch?', 'file*']
203
'to_location' is required
204
'from_branch' is optional
205
'file' can be specified 0 or more times
208
List of options that may be given for this command. These can
209
be either strings, referring to globally-defined options,
210
or option objects. Retrieve through options().
213
If true, this command isn't advertised. This is typically
368
214
for commands intended for expert users.
370
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
been setup to properly handle encoding of unicode strings.
372
encoding_type determines what will happen when characters cannot be
375
* strict - abort if we cannot decode
376
* replace - put in a bogus character (typically '?')
377
* exact - do not encode sys.stdout
379
NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
therefore LF line-endings are converted to CRLF. When a command uses
381
encoding_type = 'exact', then sys.stdout is forced to be a binary
382
stream, and line-endings will not mangled.
385
A string indicating the real name under which this command was
386
invoked, before expansion of aliases.
387
(This may be None if the command was constructed and run in-process.)
389
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'bzr help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
217
Command objects will get a 'outf' attribute, which has been
218
setup to properly handle encoding of unicode strings.
219
encoding_type determines what will happen when characters cannot
221
strict - abort if we cannot decode
222
replace - put in a bogus character (typically '?')
223
exact - do not encode sys.stdout
225
NOTE: by default on Windows, sys.stdout is opened as a text
226
stream, therefore LF line-endings are converted to CRLF.
227
When a command uses encoding_type = 'exact', then
228
sys.stdout is forced to be a binary stream, and line-endings
400
234
takes_options = []
401
235
encoding_type = 'strict'
407
239
def __init__(self):
408
240
"""Construct an instance of this command."""
409
# List of standard options directly supported
410
self.supported_std_options = []
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
244
def _maybe_expand_globs(self, file_list):
245
"""Glob expand file_list if the platform does not do that itself.
247
:return: A possibly empty list of unicode paths.
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
435
257
def _usage(self):
436
258
"""Return single-line grammar for this command.
447
269
elif aname[-1] == '*':
448
270
aname = '[' + aname[:-1] + '...]'
450
s = s[:-1] # remove last space
453
def get_help_text(self, additional_see_also=None, plain=True,
454
see_also_as_links=False, verbose=True):
277
def get_help_text(self, additional_see_also=None):
455
278
"""Return a text string with help for this command.
457
280
:param additional_see_also: Additional help topics to be
458
281
cross-referenced.
459
:param plain: if False, raw help (reStructuredText) is
460
returned instead of plain text.
461
:param see_also_as_links: if True, convert items in 'See also'
462
list to internal links (used by bzr_man rstx generator)
463
:param verbose: if True, display the full help, otherwise
464
leave out the descriptive sections and just display
465
usage help (e.g. Purpose, Usage, Options) with a
466
message explaining how to obtain full help.
469
i18n.install() # Install i18n only for get_help_text for now.
470
283
doc = self.help()
472
# Note: If self.gettext() translates ':Usage:\n', the section will
473
# be shown after "Description" section and we don't want to
474
# translate the usage string.
475
# Though, bzr export-pot don't exports :Usage: section and it must
477
doc = self.gettext(doc)
479
doc = gettext("No help for this command.")
481
# Extract the summary (purpose) and sections out from the text
482
purpose,sections,order = self._get_help_parts(doc)
484
# If a custom usage section was provided, use it
485
if sections.has_key('Usage'):
486
usage = sections.pop('Usage')
488
usage = self._usage()
490
# The header is the purpose and usage
285
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
492
result += gettext(':Purpose: %s\n') % (purpose,)
493
if usage.find('\n') >= 0:
494
result += gettext(':Usage:\n%s\n') % (usage,)
496
result += gettext(':Usage: %s\n') % (usage,)
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
504
parser = option.get_optparser(self.options())
505
options = parser.format_option_help()
506
# FIXME: According to the spec, ReST option lists actually don't
507
# support options like --1.14 so that causes syntax errors (in Sphinx
508
# at least). As that pattern always appears in the commands that
509
# break, we trap on that and then format that block of 'format' options
510
# as a literal block. We use the most recent format still listed so we
511
# don't have to do that too often -- vila 20110514
512
if not plain and options.find(' --1.14 ') != -1:
513
options = options.replace(' format:\n', ' format::\n\n', 1)
514
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
521
# Add the description, indenting it 2 spaces
522
# to match the indentation of the options
523
if sections.has_key(None):
524
text = sections.pop(None)
525
text = '\n '.join(text.splitlines())
526
result += gettext(':Description:\n %s\n\n') % (text,)
528
# Add the custom sections (e.g. Examples). Note that there's no need
529
# to indent these as they must be indented already in the source.
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
539
# Add the aliases, source (plug-in) and see also links, if any
288
result += 'usage: %s\n' % self._usage()
541
result += gettext(':Aliases: ')
291
result += 'aliases: '
542
292
result += ', '.join(self.aliases) + '\n'
543
296
plugin_name = self.plugin_name()
544
297
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
298
result += '(From plugin "%s")' % plugin_name
302
if result[-1] != '\n':
305
result += option.get_optparser(self.options()).format_option_help()
546
306
see_also = self.get_see_also(additional_see_also)
548
if not plain and see_also_as_links:
550
for item in see_also:
552
# topics doesn't have an independent section
553
# so don't create a real link
554
see_also_links.append(item)
556
# Use a Sphinx link for this entry
557
link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
558
see_also_links.append(link_text)
559
see_also = see_also_links
560
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
562
# If this will be rendered as plain text, convert it
564
import bzrlib.help_topics
565
result = bzrlib.help_topics.help_as_plain_text(result)
308
result += '\nSee also: '
309
result += ', '.join(see_also)
569
def _get_help_parts(text):
570
"""Split help text into a summary and named sections.
572
:return: (summary,sections,order) where summary is the top line and
573
sections is a dictionary of the rest indexed by section name.
574
order is the order the section appear in the text.
575
A section starts with a heading line of the form ":xxx:".
576
Indented text on following lines is the section value.
577
All text found outside a named section is assigned to the
578
default section which is given the key of None.
580
def save_section(sections, order, label, section):
582
if sections.has_key(label):
583
sections[label] += '\n' + section
586
sections[label] = section
588
lines = text.rstrip().splitlines()
589
summary = lines.pop(0)
592
label,section = None,''
594
if line.startswith(':') and line.endswith(':') and len(line) > 2:
595
save_section(sections, order, label, section)
596
label,section = line[1:-1],''
597
elif (label is not None) and len(line) > 1 and not line[0].isspace():
598
save_section(sections, order, label, section)
599
label,section = None,line
602
section += '\n' + line
605
save_section(sections, order, label, section)
606
return summary, sections, order
608
313
def get_help_topic(self):
609
314
"""Return the commands help topic - its name."""
610
315
return self.name()
612
317
def get_see_also(self, additional_terms=None):
613
"""Return a list of help topics that are related to this command.
318
"""Return a list of help topics that are related to this ommand.
615
320
The list is derived from the content of the _see_also attribute. Any
616
321
duplicates are removed and the result is in lexical order.
617
322
:param additional_terms: Additional help topics to cross-reference.
626
331
"""Return dict of valid options for this command.
628
333
Maps from long option name to option object."""
629
r = Option.STD_OPTIONS.copy()
335
r['help'] = option.Option.OPTIONS['help']
631
336
for o in self.takes_options:
632
337
if isinstance(o, basestring):
633
338
o = option.Option.OPTIONS[o]
635
if o.name in std_names:
636
self.supported_std_options.append(o.name)
639
342
def _setup_outf(self):
640
343
"""Return a file linked to stdout, which has proper encoding."""
641
self.outf = ui.ui_factory.make_output_stream(
642
encoding_type=self.encoding_type)
344
assert self.encoding_type in ['strict', 'exact', 'replace']
346
# Originally I was using self.stdout, but that looks
347
# *way* too much like sys.stdout
348
if self.encoding_type == 'exact':
349
# force sys.stdout to be binary stream on win32
350
if sys.platform == 'win32':
351
fileno = getattr(sys.stdout, 'fileno', None)
354
msvcrt.setmode(fileno(), os.O_BINARY)
355
self.outf = sys.stdout
358
output_encoding = osutils.get_terminal_encoding()
360
# use 'replace' so that we don't abort if trying to write out
361
# in e.g. the default C locale.
362
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
363
# For whatever reason codecs.getwriter() does not advertise its encoding
364
# it just returns the encoding of the wrapped file, which is completely
365
# bogus. So set the attribute, so we can find the correct encoding later.
366
self.outf.encoding = output_encoding
644
368
def run_argv_aliases(self, argv, alias_argv=None):
645
369
"""Parse the command line and run with extra aliases in alias_argv."""
371
warn("Passing None for [] is deprecated from bzrlib 0.10",
372
DeprecationWarning, stacklevel=2)
646
374
args, opts = parse_args(self, argv, alias_argv)
649
# Process the standard options
650
375
if 'help' in opts: # e.g. bzr add --help
651
self.outf.write(self.get_help_text())
653
if 'usage' in opts: # e.g. bzr add --usage
654
self.outf.write(self.get_help_text(verbose=False))
656
trace.set_verbosity_level(option._verbosity_level)
657
if 'verbose' in self.supported_std_options:
658
opts['verbose'] = trace.is_verbose()
659
elif opts.has_key('verbose'):
661
if 'quiet' in self.supported_std_options:
662
opts['quiet'] = trace.is_quiet()
663
elif opts.has_key('quiet'):
376
sys.stdout.write(self.get_help_text())
666
378
# mix arguments and options into one dictionary
667
379
cmdargs = _match_argform(self.name(), self.takes_args, args)
761
class CommandHooks(Hooks):
762
"""Hooks related to Command object creation/enumeration."""
765
"""Create the default hooks.
767
These are all empty initially, because by default nothing should get
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.add_hook('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
788
self.add_hook('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
795
Command.hooks = CommandHooks()
426
# Technically, this function hasn't been use in a *really* long time
427
# but we are only deprecating it now.
428
@deprecated_function(zero_eleven)
429
def parse_spec(spec):
435
>>> parse_spec("../@")
437
>>> parse_spec("../f/@35")
439
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
440
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
445
parsed = spec.split('/@')
446
assert len(parsed) == 2
451
parsed[1] = int(parsed[1])
453
pass # We can allow stuff like ./@revid:blahblahblah
457
parsed = [spec, None]
798
460
def parse_args(command, argv, alias_argv=None):
799
461
"""Parse command line.
801
463
Arguments and options are parsed at this level before being passed
802
464
down to specific command handlers. This routine knows, from a
803
465
lookup table, something about the available options, what optargs
907
546
os.remove(pfname)
910
def exception_to_return_code(the_callable, *args, **kwargs):
911
"""UI level helper for profiling and coverage.
913
This transforms exceptions into a return value of 3. As such its only
914
relevant to the UI layer, and should never be called where catching
915
exceptions may be desirable.
918
return the_callable(*args, **kwargs)
919
except (KeyboardInterrupt, Exception), e:
920
# used to handle AssertionError and KeyboardInterrupt
921
# specially here, but hopefully they're handled ok by the logger now
922
exc_info = sys.exc_info()
923
exitcode = trace.report_exception(exc_info, sys.stderr)
924
if os.environ.get('BZR_PDB'):
925
print '**** entering debugger'
928
if sys.version_info[:2] < (2, 6):
930
# pdb.post_mortem(tb)
931
# but because pdb.post_mortem gives bad results for tracebacks
932
# from inside generators, we do it manually.
933
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
935
# Setup pdb on the traceback
938
p.setup(tb.tb_frame, tb)
939
# Point the debugger at the deepest frame of the stack
940
p.curindex = len(p.stack) - 1
941
p.curframe = p.stack[p.curindex][0]
942
# Start the pdb prompt.
943
p.print_stack_entry(p.stack[p.curindex])
951
549
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
952
550
from bzrlib.lsprof import profile
953
ret, stats = profile(exception_to_return_code, the_callable,
551
ret, stats = profile(the_callable, *args, **kwargs)
956
553
if filename is None:
976
573
config = bzrlib.config.GlobalConfig()
977
574
alias = config.get_alias(cmd)
979
return cmdline.split(alias)
577
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
983
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
984
582
"""Execute a command.
986
:param argv: The command-line arguments, without the program name from
987
argv[0] These should already be decoded. All library/test code calling
988
run_bzr should be passing valid strings (don't need decoding).
989
:param load_plugins: What function to call when triggering plugin loading.
990
This function should take no arguments and cause all plugins to be
992
:param disable_plugins: What function to call when disabling plugin
993
loading. This function should take no arguments and cause all plugin
994
loading to be prohibited (so that code paths in your application that
995
know about some plugins possibly being present will fail to import
996
those plugins even if they are installed.)
997
:return: Returns a command exit code or raises an exception.
584
This is similar to main(), but without all the trappings for
585
logging and error handling.
588
The command-line arguments, without the program name from argv[0]
589
These should already be decoded. All library/test code calling
590
run_bzr should be passing valid strings (don't need decoding).
592
Returns a command status or raises an exception.
999
594
Special master options: these must come before the command because
1000
595
they control how the command is interpreted.
1049
637
opt_no_plugins = True
1050
638
elif a == '--no-aliases':
1051
639
opt_no_aliases = True
1052
elif a == '--no-l10n':
1054
640
elif a == '--builtin':
1055
641
opt_builtin = True
1056
elif a == '--concurrency':
1057
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1059
elif a == '--coverage':
1060
opt_coverage_dir = argv[i + 1]
1062
elif a == '--profile-imports':
1063
pass # already handled in startup script Bug #588277
642
elif a in ('--quiet', '-q'):
1064
644
elif a.startswith('-D'):
1065
645
debug.debug_flags.add(a[2:])
1067
647
argv_copy.append(a)
1070
debug.set_debug_flags_from_config()
652
from bzrlib.builtins import cmd_help
653
cmd_help().run_argv_aliases([])
656
if argv[0] == '--version':
657
from bzrlib.version import show_version
1072
661
if not opt_no_plugins:
662
from bzrlib.plugin import load_plugins
665
from bzrlib.plugin import disable_plugins
1075
666
disable_plugins()
1079
get_cmd_object('help').run_argv_aliases([])
1082
if argv[0] == '--version':
1083
get_cmd_object('version').run_argv_aliases([])
1086
668
alias_argv = None
1088
670
if not opt_no_aliases:
1089
671
alias_argv = get_alias(argv[0])
673
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1091
674
argv[0] = alias_argv.pop(0)
1093
676
cmd = argv.pop(0)
677
# We want only 'ascii' command names, but the user may have typed
678
# in a Unicode name. In that case, they should just get a
679
# 'command not found' error later.
1094
681
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1097
682
run = cmd_obj.run_argv_aliases
1098
683
run_argv = [argv, alias_argv]
1101
# We can be called recursively (tests for example), but we don't want
1102
# the verbosity level to propagate.
1103
saved_verbosity_level = option._verbosity_level
1104
option._verbosity_level = 0
1106
if opt_coverage_dir:
1108
'--coverage ignored, because --lsprof is in use.')
1109
687
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1110
688
elif opt_profile:
1111
if opt_coverage_dir:
1113
'--coverage ignored, because --profile is in use.')
1114
689
ret = apply_profiled(run, *run_argv)
1115
elif opt_coverage_dir:
1116
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1118
691
ret = run(*run_argv)
1121
# reset, in case we may do other commands later within the same
1122
# process. Commands that want to execute sub-commands must propagate
1123
# --verbose in their own way.
1124
if 'memory' in debug.debug_flags:
1125
trace.debug_memory('Process status after command:', short=False)
1126
option._verbosity_level = saved_verbosity_level
694
# reset, in case we may do other commands later within the same process
695
trace.be_quiet(False)
1129
697
def display_command(func):
1130
698
"""Decorator that suppresses pipe/interrupt errors."""
1146
714
return ignore_pipe
1149
def install_bzr_command_hooks():
1150
"""Install the hooks to supply bzr's own commands."""
1151
if _list_bzr_commands in Command.hooks["list_commands"]:
1153
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1155
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1157
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1158
"bzr plugin commands")
1159
Command.hooks.install_named_hook("get_command", _get_external_command,
1160
"bzr external command lookup")
1161
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1162
"bzr plugin-provider-db check")
1166
def _specified_or_unicode_argv(argv):
1167
# For internal or testing use, argv can be passed. Otherwise, get it from
1168
# the process arguments in a unicode-safe way.
1170
return osutils.get_unicode_argv()
1174
# ensure all arguments are unicode strings
1176
if isinstance(a, unicode):
1179
new_argv.append(a.decode('ascii'))
1180
except UnicodeDecodeError:
1181
raise errors.BzrError("argv should be list of unicode strings.")
1185
def main(argv=None):
1186
"""Main entry point of command-line interface.
1188
Typically `bzrlib.initialize` should be called first.
1190
:param argv: list of unicode command-line arguments similar to sys.argv.
1191
argv[0] is script name usually, it will be ignored.
1192
Don't pass here sys.argv because this list contains plain strings
1193
and not unicode; pass None instead.
1195
:return: exit code of bzr command.
1197
if argv is not None:
1199
_register_builtin_commands()
719
from bzrlib.ui.text import TextUIFactory
720
bzrlib.ui.ui_factory = TextUIFactory()
721
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1200
722
ret = run_bzr_catch_errors(argv)
1201
723
trace.mutter("return code %d", ret)
1205
727
def run_bzr_catch_errors(argv):
1206
"""Run a bzr command with parameters as described by argv.
1208
This function assumed that that UI layer is setup, that symbol deprecations
1209
are already applied, and that unicode decoding has already been performed on argv.
1211
# done here so that they're covered for every test run
1212
install_bzr_command_hooks()
1213
return exception_to_return_code(run_bzr, argv)
1216
def run_bzr_catch_user_errors(argv):
1217
"""Run bzr and report user errors, but let internal errors propagate.
1219
This is used for the test suite, and might be useful for other programs
1220
that want to wrap the commandline interface.
1222
# done here so that they're covered for every test run
1223
install_bzr_command_hooks()
1225
729
return run_bzr(argv)
1226
except Exception, e:
1227
if (isinstance(e, (OSError, IOError))
1228
or not getattr(e, 'internal_error', True)):
1229
trace.report_exception(sys.exc_info(), sys.stderr)
730
except (KeyboardInterrupt, Exception), e:
731
# used to handle AssertionError and KeyboardInterrupt
732
# specially here, but hopefully they're handled ok by the logger now
733
trace.report_exception(sys.exc_info(), sys.stderr)
734
if os.environ.get('BZR_PDB'):
735
print '**** entering debugger'
737
pdb.post_mortem(sys.exc_traceback)
1235
741
class HelpCommandIndex(object):
added
removed
bzrlib/commands.py
