130
164
return cmd[4:].replace('_','-')
133
def _builtin_commands():
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
134
171
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):
136
builtins = bzrlib.builtins.__dict__
137
for name in builtins:
179
for name, obj in module.__dict__.iteritems():
138
180
if name.startswith("cmd_"):
139
181
real_name = _unsquish_command_name(name)
140
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))
144
208
def builtin_command_names():
145
"""Return list of builtin command names."""
146
return _builtin_commands().keys()
209
"""Return list of builtin command names.
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()
149
218
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
150
220
return plugin_cmds.keys()
153
def _get_cmd_dict(plugins_override=True):
154
"""Return name->class mapping for all commands."""
155
d = _builtin_commands()
157
d.update(plugin_cmds.iteritems())
161
def get_all_cmds(plugins_override=True):
162
"""Return canonical name and class for all registered commands."""
163
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
167
223
def get_cmd_object(cmd_name, plugins_override=True):
168
"""Return the canonical name and command class for a command.
224
"""Return the command object for a command.
171
227
If true, plugin commands can override builtins.
174
cmd = _get_cmd_object(cmd_name, plugins_override)
175
# Allow plugins to extend commands
176
for hook in Command.hooks['extend_command']:
180
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
183
def _get_cmd_object(cmd_name, plugins_override=True):
184
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
230
return _get_cmd_object(cmd_name, plugins_override)
232
raise errors.BzrCommandError(gettext('unknown command "%s"') % cmd_name)
235
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
236
"""Get a command object.
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
# We want only 'ascii' command names, but the user may have typed
246
# in a Unicode name. In that case, they should just get a
247
# 'command not found' error later.
248
# 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)
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:
185
315
from bzrlib.externalcommand import ExternalCommand
187
# We want only 'ascii' command names, but the user may have typed
188
# in a Unicode name. In that case, they should just get a
189
# 'command not found' error later.
190
# In the future, we may actually support Unicode command names.
192
# first look up this command under the specified name
195
return plugin_cmds.get(cmd_name)()
198
cmds = _get_cmd_dict(plugins_override=False)
200
return cmds[cmd_name]()
204
for key in plugin_cmds.keys():
205
info = plugin_cmds.get_info(key)
206
if cmd_name in info.aliases:
207
return plugin_cmds.get(key)()
208
# look for any command which claims this as an alias
209
for real_cmd_name, cmd_class in cmds.iteritems():
210
if cmd_name in cmd_class.aliases:
213
316
cmd_obj = ExternalCommand.find_command(cmd_name)
217
# look for plugins that provide this command but aren't installed
218
for provider in command_providers_registry:
220
plugin_metadata = provider.plugin_for_command(cmd_name)
221
except errors.NoPluginAvailable:
224
raise errors.CommandAvailableInPlugin(cmd_name,
225
plugin_metadata, provider)
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)()
229
334
class Command(object):
244
349
summary, then a complete description of the command. A grammar
245
350
description will be inserted.
248
Other accepted names for this command.
251
List of argument forms, marked with whether they are optional,
256
['to_location', 'from_branch?', 'file*']
258
'to_location' is required
259
'from_branch' is optional
260
'file' can be specified 0 or more times
263
List of options that may be given for this command. These can
264
be either strings, referring to globally-defined options,
265
or option objects. Retrieve through options().
268
If true, this command isn't advertised. This is typically
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
269
368
for commands intended for expert users.
272
Command objects will get a 'outf' attribute, which has been
273
setup to properly handle encoding of unicode strings.
274
encoding_type determines what will happen when characters cannot
276
strict - abort if we cannot decode
277
replace - put in a bogus character (typically '?')
278
exact - do not encode sys.stdout
280
NOTE: by default on Windows, sys.stdout is opened as a text
281
stream, therefore LF line-endings are converted to CRLF.
282
When a command uses encoding_type = 'exact', then
283
sys.stdout is forced to be a binary stream, and line-endings
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.)
286
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"
290
400
takes_options = []
291
401
encoding_type = 'strict'
295
407
def __init__(self):
296
408
"""Construct an instance of this command."""
297
if self.__doc__ == Command.__doc__:
298
warn("No help message set for %r" % self)
299
409
# List of standard options directly supported
300
410
self.supported_std_options = []
302
def _maybe_expand_globs(self, file_list):
303
"""Glob expand file_list if the platform does not do that itself.
305
:return: A possibly empty list of unicode paths.
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
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()
315
435
def _usage(self):
316
436
"""Return single-line grammar for this command.
333
453
def get_help_text(self, additional_see_also=None, plain=True,
334
see_also_as_links=False):
454
see_also_as_links=False, verbose=True):
335
455
"""Return a text string with help for this command.
337
457
:param additional_see_also: Additional help topics to be
338
458
cross-referenced.
339
459
:param plain: if False, raw help (reStructuredText) is
340
460
returned instead of plain text.
341
461
:param see_also_as_links: if True, convert items in 'See also'
342
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.
344
470
doc = self.help()
346
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
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.")
348
481
# Extract the summary (purpose) and sections out from the text
349
purpose,sections = self._get_help_parts(doc)
482
purpose,sections,order = self._get_help_parts(doc)
351
484
# If a custom usage section was provided, use it
352
485
if sections.has_key('Usage'):
357
490
# The header is the purpose and usage
359
result += ':Purpose: %s\n' % purpose
492
result += gettext(':Purpose: %s\n') % (purpose,)
360
493
if usage.find('\n') >= 0:
361
result += ':Usage:\n%s\n' % usage
494
result += gettext(':Usage:\n%s\n') % (usage,)
363
result += ':Usage: %s\n' % usage
496
result += gettext(':Usage: %s\n') % (usage,)
366
499
# Add the options
367
options = option.get_optparser(self.options()).format_option_help()
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)
368
514
if options.startswith('Options:'):
369
result += ':' + options
370
elif options.startswith('options:'):
371
# Python 2.4 version of optparse
372
result += ':Options:' + options[len('options:'):]
515
result += gettext(':Options:%s') % (options[len('options:'):],)
374
517
result += options
377
# Add the description, indenting it 2 spaces
378
# to match the indentation of the options
379
if sections.has_key(None):
380
text = sections.pop(None)
381
text = '\n '.join(text.splitlines())
382
result += ':%s:\n %s\n\n' % ('Description',text)
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,)
384
# Add the custom sections (e.g. Examples). Note that there's no need
385
# to indent these as they must be indented already in the source.
387
labels = sorted(sections.keys())
389
result += ':%s:\n%s\n\n' % (label,sections[label])
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")
391
539
# Add the aliases, source (plug-in) and see also links, if any
393
result += ':Aliases: '
541
result += gettext(':Aliases: ')
394
542
result += ', '.join(self.aliases) + '\n'
395
543
plugin_name = self.plugin_name()
396
544
if plugin_name is not None:
397
result += ':From: plugin "%s"\n' % plugin_name
545
result += gettext(':From: plugin "%s"\n') % plugin_name
398
546
see_also = self.get_see_also(additional_see_also)
400
548
if not plain and see_also_as_links:
421
570
def _get_help_parts(text):
422
571
"""Split help text into a summary and named sections.
424
:return: (summary,sections) where summary is the top line and
573
:return: (summary,sections,order) where summary is the top line and
425
574
sections is a dictionary of the rest indexed by section name.
575
order is the order the section appear in the text.
426
576
A section starts with a heading line of the form ":xxx:".
427
577
Indented text on following lines is the section value.
428
578
All text found outside a named section is assigned to the
429
579
default section which is given the key of None.
431
def save_section(sections, label, section):
581
def save_section(sections, order, label, section):
432
582
if len(section) > 0:
433
583
if sections.has_key(label):
434
584
sections[label] += '\n' + section
436
587
sections[label] = section
438
589
lines = text.rstrip().splitlines()
439
590
summary = lines.pop(0)
441
593
label,section = None,''
442
594
for line in lines:
443
595
if line.startswith(':') and line.endswith(':') and len(line) > 2:
444
save_section(sections, label, section)
596
save_section(sections, order, label, section)
445
597
label,section = line[1:-1],''
446
598
elif (label is not None) and len(line) > 1 and not line[0].isspace():
447
save_section(sections, label, section)
599
save_section(sections, order, label, section)
448
600
label,section = None,line
450
602
if len(section) > 0:
451
603
section += '\n' + line
454
save_section(sections, label, section)
455
return summary, sections
606
save_section(sections, order, label, section)
607
return summary, sections, order
457
609
def get_help_topic(self):
458
610
"""Return the commands help topic - its name."""
488
640
def _setup_outf(self):
489
641
"""Return a file linked to stdout, which has proper encoding."""
490
# Originally I was using self.stdout, but that looks
491
# *way* too much like sys.stdout
492
if self.encoding_type == 'exact':
493
# force sys.stdout to be binary stream on win32
494
if sys.platform == 'win32':
495
fileno = getattr(sys.stdout, 'fileno', None)
498
msvcrt.setmode(fileno(), os.O_BINARY)
499
self.outf = sys.stdout
502
output_encoding = osutils.get_terminal_encoding()
504
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
505
errors=self.encoding_type)
506
# For whatever reason codecs.getwriter() does not advertise its encoding
507
# it just returns the encoding of the wrapped file, which is completely
508
# bogus. So set the attribute, so we can find the correct encoding later.
509
self.outf.encoding = output_encoding
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
511
645
def run_argv_aliases(self, argv, alias_argv=None):
512
646
"""Parse the command line and run with extra aliases in alias_argv."""
514
warn("Passing None for [] is deprecated from bzrlib 0.10",
515
DeprecationWarning, stacklevel=2)
517
647
args, opts = parse_args(self, argv, alias_argv)
519
650
# Process the standard options
520
651
if 'help' in opts: # e.g. bzr add --help
521
sys.stdout.write(self.get_help_text())
652
self.outf.write(self.get_help_text())
654
if 'usage' in opts: # e.g. bzr add --usage
655
self.outf.write(self.get_help_text(verbose=False))
523
657
trace.set_verbosity_level(option._verbosity_level)
524
658
if 'verbose' in self.supported_std_options:
587
768
These are all empty initially, because by default nothing should get
591
# Introduced in 1.13:
592
# invoked after creating a command object to allow modifications such
593
# as adding or removing options, docs etc. Invoked with the command
595
self['extend_command'] = []
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
773
"Called after creating a command object to allow modifications "
774
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
777
"Called when creating a single command. Called with "
778
"(cmd_or_None, command_name). get_command should either return "
779
"the cmd_or_None parameter, or a replacement Command object that "
780
"should be used for the command. Note that the Command.hooks "
781
"hooks are core infrastructure. Many users will prefer to use "
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
785
"Called when creating a single command if no command could be "
786
"found. Called with (command_name). get_missing_command should "
787
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
790
"Called when enumerating commands. Called with a set of "
791
"cmd_name strings for all the commands found so far. This set "
792
" is safe to mutate - e.g. to remove a command. "
793
"list_commands should return the updated set of command names.",
597
796
Command.hooks = CommandHooks()
600
799
def parse_args(command, argv, alias_argv=None):
601
800
"""Parse command line.
603
802
Arguments and options are parsed at this level before being passed
604
803
down to specific command handlers. This routine knows, from a
605
804
lookup table, something about the available options, what optargs
700
912
os.remove(pfname)
915
def exception_to_return_code(the_callable, *args, **kwargs):
916
"""UI level helper for profiling and coverage.
918
This transforms exceptions into a return value of 3. As such its only
919
relevant to the UI layer, and should never be called where catching
920
exceptions may be desirable.
923
return the_callable(*args, **kwargs)
924
except (KeyboardInterrupt, Exception), e:
925
# used to handle AssertionError and KeyboardInterrupt
926
# specially here, but hopefully they're handled ok by the logger now
927
exc_info = sys.exc_info()
928
exitcode = trace.report_exception(exc_info, sys.stderr)
929
if os.environ.get('BZR_PDB'):
930
print '**** entering debugger'
933
if sys.version_info[:2] < (2, 6):
935
# pdb.post_mortem(tb)
936
# but because pdb.post_mortem gives bad results for tracebacks
937
# from inside generators, we do it manually.
938
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
940
# Setup pdb on the traceback
943
p.setup(tb.tb_frame, tb)
944
# Point the debugger at the deepest frame of the stack
945
p.curindex = len(p.stack) - 1
946
p.curframe = p.stack[p.curindex][0]
947
# Start the pdb prompt.
948
p.print_stack_entry(p.stack[p.curindex])
703
956
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
704
957
from bzrlib.lsprof import profile
705
ret, stats = profile(the_callable, *args, **kwargs)
958
ret, stats = profile(exception_to_return_code, the_callable,
707
961
if filename is None:
710
964
stats.save(filename)
711
trace.note('Profile data written to "%s".', filename)
965
trace.note(gettext('Profile data written to "%s".'), filename)
715
def shlex_split_unicode(unsplit):
717
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
720
969
def get_alias(cmd, config=None):
721
970
"""Return an expanded alias, or None if no alias exists.
732
981
config = bzrlib.config.GlobalConfig()
733
982
alias = config.get_alias(cmd)
735
return shlex_split_unicode(alias)
984
return cmdline.split(alias)
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
740
989
"""Execute a command.
743
The command-line arguments, without the program name from argv[0]
744
These should already be decoded. All library/test code calling
745
run_bzr should be passing valid strings (don't need decoding).
747
Returns a command status or raises an exception.
991
:param argv: The command-line arguments, without the program name from
992
argv[0] These should already be decoded. All library/test code calling
993
run_bzr should be passing valid strings (don't need decoding).
994
:param load_plugins: What function to call when triggering plugin loading.
995
This function should take no arguments and cause all plugins to be
997
:param disable_plugins: What function to call when disabling plugin
998
loading. This function should take no arguments and cause all plugin
999
loading to be prohibited (so that code paths in your application that
1000
know about some plugins possibly being present will fail to import
1001
those plugins even if they are installed.)
1002
:return: Returns a command exit code or raises an exception.
749
1004
Special master options: these must come before the command because
750
1005
they control how the command is interpreted.
795
1054
opt_no_plugins = True
796
1055
elif a == '--no-aliases':
797
1056
opt_no_aliases = True
1057
elif a == '--no-l10n':
798
1059
elif a == '--builtin':
799
1060
opt_builtin = True
1061
elif a == '--concurrency':
1062
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
800
1064
elif a == '--coverage':
801
1065
opt_coverage_dir = argv[i + 1]
1067
elif a == '--profile-imports':
1068
pass # already handled in startup script Bug #588277
803
1069
elif a.startswith('-D'):
804
1070
debug.debug_flags.add(a[2:])
806
1072
argv_copy.append(a)
1075
debug.set_debug_flags_from_config()
1077
if not opt_no_plugins:
809
1082
argv = argv_copy
811
from bzrlib.builtins import cmd_help
812
cmd_help().run_argv_aliases([])
1084
get_cmd_object('help').run_argv_aliases([])
815
1087
if argv[0] == '--version':
816
from bzrlib.builtins import cmd_version
817
cmd_version().run_argv_aliases([])
1088
get_cmd_object('version').run_argv_aliases([])
820
if not opt_no_plugins:
821
from bzrlib.plugin import load_plugins
824
from bzrlib.plugin import disable_plugins
827
1091
alias_argv = None
829
1093
if not opt_no_aliases:
830
1094
alias_argv = get_alias(argv[0])
832
user_encoding = osutils.get_user_encoding()
833
alias_argv = [a.decode(user_encoding) for a in alias_argv]
834
1096
argv[0] = alias_argv.pop(0)
836
1098
cmd = argv.pop(0)
837
# We want only 'ascii' command names, but the user may have typed
838
# in a Unicode name. In that case, they should just get a
839
# 'command not found' error later.
841
1099
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
842
1102
run = cmd_obj.run_argv_aliases
843
1103
run_argv = [argv, alias_argv]
891
1151
return ignore_pipe
896
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
897
sys.stdin, sys.stdout, sys.stderr)
899
# Is this a final release version? If so, we should suppress warnings
900
if bzrlib.version_info[3] == 'final':
901
from bzrlib import symbol_versioning
902
symbol_versioning.suppress_deprecation_warnings(override=False)
904
user_encoding = osutils.get_user_encoding()
905
argv = [a.decode(user_encoding) for a in argv[1:]]
906
except UnicodeDecodeError:
907
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1154
def install_bzr_command_hooks():
1155
"""Install the hooks to supply bzr's own commands."""
1156
if _list_bzr_commands in Command.hooks["list_commands"]:
1158
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1160
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1162
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1163
"bzr plugin commands")
1164
Command.hooks.install_named_hook("get_command", _get_external_command,
1165
"bzr external command lookup")
1166
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1167
"bzr plugin-provider-db check")
1171
def _specified_or_unicode_argv(argv):
1172
# For internal or testing use, argv can be passed. Otherwise, get it from
1173
# the process arguments in a unicode-safe way.
1175
return osutils.get_unicode_argv()
1179
# ensure all arguments are unicode strings
1181
if isinstance(a, unicode):
1184
new_argv.append(a.decode('ascii'))
1185
except UnicodeDecodeError:
1186
raise errors.BzrError("argv should be list of unicode strings.")
1190
def main(argv=None):
1191
"""Main entry point of command-line interface.
1193
Typically `bzrlib.initialize` should be called first.
1195
:param argv: list of unicode command-line arguments similar to sys.argv.
1196
argv[0] is script name usually, it will be ignored.
1197
Don't pass here sys.argv because this list contains plain strings
1198
and not unicode; pass None instead.
1200
:return: exit code of bzr command.
1202
if argv is not None:
1204
_register_builtin_commands()
909
1205
ret = run_bzr_catch_errors(argv)
910
1206
trace.mutter("return code %d", ret)
914
1210
def run_bzr_catch_errors(argv):
915
# Note: The except clause logic below should be kept in sync with the
916
# profile() routine in lsprof.py.
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]
942
# Start the pdb prompt.
943
p.print_stack_entry(p.stack[p.curindex])
1211
"""Run a bzr command with parameters as described by argv.
1213
This function assumed that that UI layer is setup, that symbol deprecations
1214
are already applied, and that unicode decoding has already been performed on argv.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1218
return exception_to_return_code(run_bzr, argv)
951
1221
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
