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.
51
from bzrlib import registry
50
53
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
60
56
class CommandInfo(object):
109
89
previous = self.get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
91
previous = _builtin_commands().get(k_unsquished)
117
92
info = CommandInfo.from_command(cmd)
119
94
registry.Registry.register(self, k_unsquished, cmd,
120
95
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
97
trace.log_error('Two plugins defined the same command: %r' % k)
98
trace.log_error('Not loading the one in %r' %
99
sys.modules[cmd.__module__])
100
trace.log_error('Previously this command was registered from %r' %
101
sys.modules[previous.__module__])
131
104
def register_lazy(self, command_name, aliases, module_name):
164
129
return cmd[4:].replace('_','-')
167
def _register_builtin_commands():
168
if builtin_command_registry.keys():
132
def _builtin_commands():
171
133
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():
135
builtins = bzrlib.builtins.__dict__
136
for name in builtins:
180
137
if name.startswith("cmd_"):
181
138
real_name = _unsquish_command_name(name)
139
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
143
def builtin_command_names():
209
"""Return list of builtin command names.
144
"""Return list of builtin command names."""
145
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
148
def plugin_command_names():
219
"""Returns command names from commands registered by plugins."""
220
149
return plugin_cmds.keys()
152
def _get_cmd_dict(plugins_override=True):
153
"""Return name->class mapping for all commands."""
154
d = _builtin_commands()
156
d.update(plugin_cmds.iteritems())
160
def get_all_cmds(plugins_override=True):
161
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
223
166
def get_cmd_object(cmd_name, plugins_override=True):
224
"""Return the command object for a command.
167
"""Return the canonical name and command class for a command.
227
170
If true, plugin commands can override builtins.
230
173
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.
175
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
178
def _get_cmd_object(cmd_name, plugins_override=True):
179
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
180
from bzrlib.externalcommand import ExternalCommand
245
182
# We want only 'ascii' command names, but the user may have typed
246
183
# in a Unicode name. In that case, they should just get a
247
184
# 'command not found' error later.
248
185
# 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:
187
# first look up this command under the specified name
293
return provider.plugin_for_command(cmd_name), provider
294
except errors.NoPluginAvailable:
190
return plugin_cmds.get(cmd_name)()
296
raise errors.NoPluginAvailable(cmd_name)
299
def _get_bzr_command(cmd_or_None, cmd_name):
300
"""Get a command from bzr's core."""
193
cmds = _get_cmd_dict(plugins_override=False)
302
cmd_class = builtin_command_registry.get(cmd_name)
195
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
199
for key in plugin_cmds.keys():
200
info = plugin_cmds.get_info(key)
201
if cmd_name in info.aliases:
202
return plugin_cmds.get(key)()
203
# look for any command which claims this as an alias
204
for real_cmd_name, cmd_class in cmds.iteritems():
205
if cmd_name in cmd_class.aliases:
316
208
cmd_obj = ExternalCommand.find_command(cmd_name)
212
# look for plugins that provide this command but aren't installed
213
for provider in command_providers_registry:
215
plugin_metadata = provider.plugin_for_command(cmd_name)
216
except errors.NoPluginAvailable:
219
raise errors.CommandAvailableInPlugin(cmd_name,
220
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)()
334
225
class Command(object):
349
240
summary, then a complete description of the command. A grammar
350
241
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
244
Other accepted names for this command.
247
List of argument forms, marked with whether they are optional,
252
['to_location', 'from_branch?', 'file*']
254
'to_location' is required
255
'from_branch' is optional
256
'file' can be specified 0 or more times
259
List of options that may be given for this command. These can
260
be either strings, referring to globally-defined options,
261
or option objects. Retrieve through options().
264
If true, this command isn't advertised. This is typically
368
265
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"
268
Command objects will get a 'outf' attribute, which has been
269
setup to properly handle encoding of unicode strings.
270
encoding_type determines what will happen when characters cannot
272
strict - abort if we cannot decode
273
replace - put in a bogus character (typically '?')
274
exact - do not encode sys.stdout
276
NOTE: by default on Windows, sys.stdout is opened as a text
277
stream, therefore LF line-endings are converted to CRLF.
278
When a command uses encoding_type = 'exact', then
279
sys.stdout is forced to be a binary stream, and line-endings
400
285
takes_options = []
401
286
encoding_type = 'strict'
407
290
def __init__(self):
408
291
"""Construct an instance of this command."""
292
if self.__doc__ == Command.__doc__:
293
warn("No help message set for %r" % self)
409
294
# List of standard options directly supported
410
295
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()
297
def _maybe_expand_globs(self, file_list):
298
"""Glob expand file_list if the platform does not do that itself.
300
:return: A possibly empty list of unicode paths.
302
Introduced in bzrlib 0.18.
306
if sys.platform == 'win32':
307
file_list = win32utils.glob_expand(file_list)
308
return list(file_list)
435
310
def _usage(self):
436
311
"""Return single-line grammar for this command.
453
328
def get_help_text(self, additional_see_also=None, plain=True,
454
see_also_as_links=False, verbose=True):
329
see_also_as_links=False):
455
330
"""Return a text string with help for this command.
457
332
:param additional_see_also: Additional help topics to be
458
333
cross-referenced.
459
334
:param plain: if False, raw help (reStructuredText) is
460
335
returned instead of plain text.
461
336
:param see_also_as_links: if True, convert items in 'See also'
462
337
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
339
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.")
341
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
481
343
# Extract the summary (purpose) and sections out from the text
482
purpose,sections,order = self._get_help_parts(doc)
344
purpose,sections = self._get_help_parts(doc)
484
346
# If a custom usage section was provided, use it
485
347
if sections.has_key('Usage'):
490
352
# The header is the purpose and usage
492
result += gettext(':Purpose: %s\n') % (purpose,)
354
result += ':Purpose: %s\n' % purpose
493
355
if usage.find('\n') >= 0:
494
result += gettext(':Usage:\n%s\n') % (usage,)
356
result += ':Usage:\n%s\n' % usage
496
result += gettext(':Usage: %s\n') % (usage,)
358
result += ':Usage: %s\n' % usage
499
361
# Add the options
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)
362
options = option.get_optparser(self.options()).format_option_help()
514
363
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
364
result += ':' + options
365
elif options.startswith('options:'):
366
# Python 2.4 version of optparse
367
result += ':Options:' + options[len('options:'):]
517
369
result += 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,)
372
# Add the description, indenting it 2 spaces
373
# to match the indentation of the options
374
if sections.has_key(None):
375
text = sections.pop(None)
376
text = '\n '.join(text.splitlines())
377
result += ':%s:\n %s\n\n' % ('Description',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")
379
# Add the custom sections (e.g. Examples). Note that there's no need
380
# to indent these as they must be indented already in the source.
382
labels = sorted(sections.keys())
384
result += ':%s:\n%s\n\n' % (label,sections[label])
539
386
# Add the aliases, source (plug-in) and see also links, if any
541
result += gettext(':Aliases: ')
388
result += ':Aliases: '
542
389
result += ', '.join(self.aliases) + '\n'
543
390
plugin_name = self.plugin_name()
544
391
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
392
result += ':From: plugin "%s"\n' % plugin_name
546
393
see_also = self.get_see_also(additional_see_also)
548
395
if not plain and see_also_as_links:
570
416
def _get_help_parts(text):
571
417
"""Split help text into a summary and named sections.
573
:return: (summary,sections,order) where summary is the top line and
419
:return: (summary,sections) where summary is the top line and
574
420
sections is a dictionary of the rest indexed by section name.
575
order is the order the section appear in the text.
576
421
A section starts with a heading line of the form ":xxx:".
577
422
Indented text on following lines is the section value.
578
423
All text found outside a named section is assigned to the
579
424
default section which is given the key of None.
581
def save_section(sections, order, label, section):
426
def save_section(sections, label, section):
582
427
if len(section) > 0:
583
428
if sections.has_key(label):
584
429
sections[label] += '\n' + section
587
431
sections[label] = section
589
433
lines = text.rstrip().splitlines()
590
434
summary = lines.pop(0)
593
436
label,section = None,''
594
437
for line in lines:
595
438
if line.startswith(':') and line.endswith(':') and len(line) > 2:
596
save_section(sections, order, label, section)
439
save_section(sections, label, section)
597
440
label,section = line[1:-1],''
598
441
elif (label is not None) and len(line) > 1 and not line[0].isspace():
599
save_section(sections, order, label, section)
442
save_section(sections, label, section)
600
443
label,section = None,line
602
445
if len(section) > 0:
603
446
section += '\n' + line
606
save_section(sections, order, label, section)
607
return summary, sections, order
449
save_section(sections, label, section)
450
return summary, sections
609
452
def get_help_topic(self):
610
453
"""Return the commands help topic - its name."""
640
483
def _setup_outf(self):
641
484
"""Return a file linked to stdout, which has proper encoding."""
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
485
# Originally I was using self.stdout, but that looks
486
# *way* too much like sys.stdout
487
if self.encoding_type == 'exact':
488
# force sys.stdout to be binary stream on win32
489
if sys.platform == 'win32':
490
fileno = getattr(sys.stdout, 'fileno', None)
493
msvcrt.setmode(fileno(), os.O_BINARY)
494
self.outf = sys.stdout
497
output_encoding = osutils.get_terminal_encoding()
499
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
500
errors=self.encoding_type)
501
# For whatever reason codecs.getwriter() does not advertise its encoding
502
# it just returns the encoding of the wrapped file, which is completely
503
# bogus. So set the attribute, so we can find the correct encoding later.
504
self.outf.encoding = output_encoding
645
506
def run_argv_aliases(self, argv, alias_argv=None):
646
507
"""Parse the command line and run with extra aliases in alias_argv."""
509
warn("Passing None for [] is deprecated from bzrlib 0.10",
510
DeprecationWarning, stacklevel=2)
647
512
args, opts = parse_args(self, argv, alias_argv)
650
514
# Process the standard options
651
515
if 'help' in opts: # e.g. bzr add --help
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))
516
sys.stdout.write(self.get_help_text())
657
518
trace.set_verbosity_level(option._verbosity_level)
658
519
if 'verbose' in self.supported_std_options:
673
534
all_cmd_args = cmdargs.copy()
674
535
all_cmd_args.update(cmdopts)
677
return self.run(**all_cmd_args)
679
# reset it, so that other commands run in the same process won't
680
# inherit state. Before we reset it, log any activity, so that it
681
# gets properly tracked.
682
ui.ui_factory.log_transport_activity(
683
display=('bytes' in debug.debug_flags))
684
trace.set_verbosity_level(0)
686
def _setup_run(self):
687
"""Wrap the defined run method on self with a cleanup.
689
This is called by __init__ to make the Command be able to be run
690
by just calling run(), as it could be before cleanups were added.
692
If a different form of cleanups are in use by your Command subclass,
693
you can override this method.
696
def run(*args, **kwargs):
697
self._operation = cleanup.OperationWithCleanups(class_run)
699
return self._operation.run_simple(*args, **kwargs)
539
return self.run(**all_cmd_args)
705
542
"""Actually run the command.
762
class CommandHooks(Hooks):
763
"""Hooks related to Command object creation/enumeration."""
766
"""Create the default hooks.
768
These are all empty initially, because by default nothing should get
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.",
796
Command.hooks = CommandHooks()
799
576
def parse_args(command, argv, alias_argv=None):
800
577
"""Parse command line.
802
579
Arguments and options are parsed at this level before being passed
803
580
down to specific command handlers. This routine knows, from a
804
581
lookup table, something about the available options, what optargs
840
611
argdict[argname + '_list'] = None
841
612
elif ap[-1] == '+':
843
raise errors.BzrCommandError(gettext(
844
"command {0!r} needs one or more {1}").format(
845
cmd, argname.upper()))
614
raise errors.BzrCommandError("command %r needs one or more %s"
615
% (cmd, argname.upper()))
847
617
argdict[argname + '_list'] = args[:]
849
619
elif ap[-1] == '$': # all but one
850
620
if len(args) < 2:
851
raise errors.BzrCommandError(
852
gettext("command {0!r} needs one or more {1}").format(
853
cmd, argname.upper()))
621
raise errors.BzrCommandError("command %r needs one or more %s"
622
% (cmd, argname.upper()))
854
623
argdict[argname + '_list'] = args[:-1]
857
626
# just a plain arg
860
raise errors.BzrCommandError(
861
gettext("command {0!r} requires argument {1}").format(
862
cmd, argname.upper()))
629
raise errors.BzrCommandError("command %r requires argument %s"
630
% (cmd, argname.upper()))
864
632
argdict[argname] = args.pop(0)
867
raise errors.BzrCommandError( gettext(
868
"extra argument to command {0}: {1}").format(
635
raise errors.BzrCommandError("extra argument to command %s: %s"
912
676
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])
956
679
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
957
680
from bzrlib.lsprof import profile
958
ret, stats = profile(exception_to_return_code, the_callable,
681
ret, stats = profile(the_callable, *args, **kwargs)
961
683
if filename is None:
964
686
stats.save(filename)
965
trace.note(gettext('Profile data written to "%s".'), filename)
687
trace.note('Profile data written to "%s".', filename)
691
def shlex_split_unicode(unsplit):
693
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
969
696
def get_alias(cmd, config=None):
970
697
"""Return an expanded alias, or None if no alias exists.
981
708
config = bzrlib.config.GlobalConfig()
982
709
alias = config.get_alias(cmd)
984
return cmdline.split(alias)
711
return shlex_split_unicode(alias)
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
989
716
"""Execute a command.
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.
719
The command-line arguments, without the program name from argv[0]
720
These should already be decoded. All library/test code calling
721
run_bzr should be passing valid strings (don't need decoding).
723
Returns a command status or raises an exception.
1004
725
Special master options: these must come before the command because
1005
726
they control how the command is interpreted.
1054
771
opt_no_plugins = True
1055
772
elif a == '--no-aliases':
1056
773
opt_no_aliases = True
1057
elif a == '--no-l10n':
1059
774
elif a == '--builtin':
1060
775
opt_builtin = True
1061
elif a == '--concurrency':
1062
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1064
776
elif a == '--coverage':
1065
777
opt_coverage_dir = argv[i + 1]
1067
elif a == '--profile-imports':
1068
pass # already handled in startup script Bug #588277
1069
779
elif a.startswith('-D'):
1070
780
debug.debug_flags.add(a[2:])
1072
782
argv_copy.append(a)
1075
debug.set_debug_flags_from_config()
787
from bzrlib.builtins import cmd_help
788
cmd_help().run_argv_aliases([])
791
if argv[0] == '--version':
792
from bzrlib.builtins import cmd_version
793
cmd_version().run_argv_aliases([])
1077
796
if not opt_no_plugins:
797
from bzrlib.plugin import load_plugins
800
from bzrlib.plugin import disable_plugins
1080
801
disable_plugins()
1084
get_cmd_object('help').run_argv_aliases([])
1087
if argv[0] == '--version':
1088
get_cmd_object('version').run_argv_aliases([])
1091
803
alias_argv = None
1093
805
if not opt_no_aliases:
1094
806
alias_argv = get_alias(argv[0])
808
user_encoding = osutils.get_user_encoding()
809
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1096
810
argv[0] = alias_argv.pop(0)
1098
812
cmd = argv.pop(0)
813
# We want only 'ascii' command names, but the user may have typed
814
# in a Unicode name. In that case, they should just get a
815
# 'command not found' error later.
1099
817
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1102
818
run = cmd_obj.run_argv_aliases
1103
819
run_argv = [argv, alias_argv]
1151
866
return ignore_pipe
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()
871
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
872
sys.stdin, sys.stdout, sys.stderr)
874
# Is this a final release version? If so, we should suppress warnings
875
if bzrlib.version_info[3] == 'final':
876
from bzrlib import symbol_versioning
877
symbol_versioning.suppress_deprecation_warnings(override=False)
879
user_encoding = osutils.get_user_encoding()
880
argv = [a.decode(user_encoding) for a in argv[1:]]
881
except UnicodeDecodeError:
882
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1205
884
ret = run_bzr_catch_errors(argv)
1206
885
trace.mutter("return code %d", ret)
1210
889
def run_bzr_catch_errors(argv):
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)
890
# Note: The except clause logic below should be kept in sync with the
891
# profile() routine in lsprof.py.
894
except (KeyboardInterrupt, Exception), e:
895
# used to handle AssertionError and KeyboardInterrupt
896
# specially here, but hopefully they're handled ok by the logger now
897
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
898
if os.environ.get('BZR_PDB'):
899
print '**** entering debugger'
901
pdb.post_mortem(sys.exc_traceback)
1221
905
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
