29
35
lazy_import(globals(), """
33
38
from warnings import warn
36
41
from bzrlib import (
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
50
from bzrlib.symbol_versioning import (
55
51
deprecated_function,
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
57
from bzrlib.option import Option
151
63
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
64
"""Utility function to help register a command
154
Should generally be avoided in favor of lazy registration.
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
156
71
global plugin_cmds
157
return plugin_cmds.register(cmd, decorate)
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
160
91
def _squish_command_name(cmd):
164
95
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
165
97
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
100
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
101
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
191
105
if name.startswith("cmd_"):
192
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
111
def builtin_command_names():
220
"""Return list of builtin command names.
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
116
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
134
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
135
"""Return the canonical name and command class for a command.
237
138
If true, plugin commands can override builtins.
242
143
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
146
def _get_cmd_object(cmd_name, plugins_override=True):
147
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
148
from bzrlib.externalcommand import ExternalCommand
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
150
# We want only 'ascii' command names, but the user may have typed
256
151
# in a Unicode name. In that case, they should just get a
257
152
# 'command not found' error later.
258
153
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
155
# first look up this command under the specified name
156
cmds = _get_cmd_dict(plugins_override=plugins_override)
158
return cmds[cmd_name]()
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
162
# look for any command which claims this as an alias
163
for real_cmd_name, cmd_class in cmds.iteritems():
164
if cmd_name in cmd_class.aliases:
324
167
cmd_obj = ExternalCommand.find_command(cmd_name)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
342
173
class Command(object):
410
234
encoding_type = 'strict'
414
238
def __init__(self):
415
239
"""Construct an instance of this command."""
416
# List of standard options directly supported
417
self.supported_std_options = []
420
def add_cleanup(self, cleanup_func, *args, **kwargs):
421
"""Register a function to call after self.run returns or raises.
423
Functions will be called in LIFO order.
425
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
def cleanup_now(self):
428
"""Execute and empty pending cleanup functions immediately.
430
After cleanup_now all registered cleanups are forgotten. add_cleanup
431
may be called again after cleanup_now; these cleanups will be called
432
after self.run returns or raises (or when cleanup_now is next called).
434
This is useful for releasing expensive or contentious resources (such
435
as write locks) before doing further work that does not require those
436
resources (such as writing results to self.outf). Note though, that
437
as it releases all resources, this may release locks that the command
438
wants to hold, so use should be done with care.
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
443
def _maybe_expand_globs(self, file_list):
444
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
449
:return: A possibly empty list of unicode paths.
451
Introduced in bzrlib 0.18.
240
if self.__doc__ == Command.__doc__:
241
warn("No help message set for %r" % self)
455
243
def _usage(self):
456
244
"""Return single-line grammar for this command.
467
255
elif aname[-1] == '*':
468
256
aname = '[' + aname[:-1] + '...]'
470
s = s[:-1] # remove last space
473
def get_help_text(self, additional_see_also=None, plain=True,
474
see_also_as_links=False, verbose=True):
263
def get_help_text(self, additional_see_also=None):
475
264
"""Return a text string with help for this command.
477
266
:param additional_see_also: Additional help topics to be
478
267
cross-referenced.
479
:param plain: if False, raw help (reStructuredText) is
480
returned instead of plain text.
481
:param see_also_as_links: if True, convert items in 'See also'
482
list to internal links (used by bzr_man rstx generator)
483
:param verbose: if True, display the full help, otherwise
484
leave out the descriptive sections and just display
485
usage help (e.g. Purpose, Usage, Options) with a
486
message explaining how to obtain full help.
488
269
doc = self.help()
490
doc = "No help for this command."
492
# Extract the summary (purpose) and sections out from the text
493
purpose,sections,order = self._get_help_parts(doc)
495
# If a custom usage section was provided, use it
496
if sections.has_key('Usage'):
497
usage = sections.pop('Usage')
499
usage = self._usage()
501
# The header is the purpose and usage
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
503
result += ':Purpose: %s\n' % purpose
504
if usage.find('\n') >= 0:
505
result += ':Usage:\n%s\n' % usage
507
result += ':Usage: %s\n' % usage
512
# XXX: optparse implicitly rewraps the help, and not always perfectly,
513
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
515
options = option.get_optparser(self.options()).format_option_help()
516
# XXX: According to the spec, ReST option lists actually don't support
517
# options like --1.9 so that causes syntax errors (in Sphinx at least).
518
# As that pattern always appears in the commands that break, we trap
519
# on that and then format that block of 'format' options as a literal
521
if not plain and options.find(' --1.9 ') != -1:
522
options = options.replace(' format:\n', ' format::\n\n', 1)
523
if options.startswith('Options:'):
524
result += ':' + options
525
elif options.startswith('options:'):
526
# Python 2.4 version of optparse
527
result += ':Options:' + options[len('options:'):]
533
# Add the description, indenting it 2 spaces
534
# to match the indentation of the options
535
if sections.has_key(None):
536
text = sections.pop(None)
537
text = '\n '.join(text.splitlines())
538
result += ':%s:\n %s\n\n' % ('Description',text)
540
# Add the custom sections (e.g. Examples). Note that there's no need
541
# to indent these as they must be indented already in the source.
544
if sections.has_key(label):
545
result += ':%s:\n%s\n' % (label,sections[label])
548
result += ("See bzr help %s for more details and examples.\n\n"
551
# Add the aliases, source (plug-in) and see also links, if any
274
result += 'usage: %s\n' % self._usage()
553
result += ':Aliases: '
277
result += 'aliases: '
554
278
result += ', '.join(self.aliases) + '\n'
555
282
plugin_name = self.plugin_name()
556
283
if plugin_name is not None:
557
result += ':From: plugin "%s"\n' % plugin_name
284
result += '(From plugin "%s")' % plugin_name
288
if result[-1] != '\n':
291
result += option.get_optparser(self.options()).format_option_help()
558
292
see_also = self.get_see_also(additional_see_also)
560
if not plain and see_also_as_links:
562
for item in see_also:
564
# topics doesn't have an independent section
565
# so don't create a real link
566
see_also_links.append(item)
568
# Use a Sphinx link for this entry
569
link_text = ":doc:`%s <%s-help>`" % (item, item)
570
see_also_links.append(link_text)
571
see_also = see_also_links
572
result += ':See also: '
573
result += ', '.join(see_also) + '\n'
575
# If this will be rendered as plain text, convert it
577
import bzrlib.help_topics
578
result = bzrlib.help_topics.help_as_plain_text(result)
294
result += '\nSee also: '
295
result += ', '.join(see_also)
582
def _get_help_parts(text):
583
"""Split help text into a summary and named sections.
585
:return: (summary,sections,order) where summary is the top line and
586
sections is a dictionary of the rest indexed by section name.
587
order is the order the section appear in the text.
588
A section starts with a heading line of the form ":xxx:".
589
Indented text on following lines is the section value.
590
All text found outside a named section is assigned to the
591
default section which is given the key of None.
593
def save_section(sections, order, label, section):
595
if sections.has_key(label):
596
sections[label] += '\n' + section
599
sections[label] = section
601
lines = text.rstrip().splitlines()
602
summary = lines.pop(0)
605
label,section = None,''
607
if line.startswith(':') and line.endswith(':') and len(line) > 2:
608
save_section(sections, order, label, section)
609
label,section = line[1:-1],''
610
elif (label is not None) and len(line) > 1 and not line[0].isspace():
611
save_section(sections, order, label, section)
612
label,section = None,line
615
section += '\n' + line
618
save_section(sections, order, label, section)
619
return summary, sections, order
621
299
def get_help_topic(self):
622
300
"""Return the commands help topic - its name."""
623
301
return self.name()
625
303
def get_see_also(self, additional_terms=None):
626
"""Return a list of help topics that are related to this command.
304
"""Return a list of help topics that are related to this ommand.
628
306
The list is derived from the content of the _see_also attribute. Any
629
307
duplicates are removed and the result is in lexical order.
630
308
:param additional_terms: Additional help topics to cross-reference.
639
317
"""Return dict of valid options for this command.
641
319
Maps from long option name to option object."""
642
r = Option.STD_OPTIONS.copy()
321
r['help'] = option.Option.OPTIONS['help']
644
322
for o in self.takes_options:
645
323
if isinstance(o, basestring):
646
324
o = option.Option.OPTIONS[o]
648
if o.name in std_names:
649
self.supported_std_options.append(o.name)
652
328
def _setup_outf(self):
653
329
"""Return a file linked to stdout, which has proper encoding."""
654
self.outf = ui.ui_factory.make_output_stream(
655
encoding_type=self.encoding_type)
330
assert self.encoding_type in ['strict', 'exact', 'replace']
332
# Originally I was using self.stdout, but that looks
333
# *way* too much like sys.stdout
334
if self.encoding_type == 'exact':
335
# force sys.stdout to be binary stream on win32
336
if sys.platform == 'win32':
337
fileno = getattr(sys.stdout, 'fileno', None)
340
msvcrt.setmode(fileno(), os.O_BINARY)
341
self.outf = sys.stdout
344
output_encoding = osutils.get_terminal_encoding()
346
# use 'replace' so that we don't abort if trying to write out
347
# in e.g. the default C locale.
348
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
349
# For whatever reason codecs.getwriter() does not advertise its encoding
350
# it just returns the encoding of the wrapped file, which is completely
351
# bogus. So set the attribute, so we can find the correct encoding later.
352
self.outf.encoding = output_encoding
657
354
def run_argv_aliases(self, argv, alias_argv=None):
658
355
"""Parse the command line and run with extra aliases in alias_argv."""
357
warn("Passing None for [] is deprecated from bzrlib 0.10",
358
DeprecationWarning, stacklevel=2)
659
360
args, opts = parse_args(self, argv, alias_argv)
661
# Process the standard options
662
361
if 'help' in opts: # e.g. bzr add --help
663
362
sys.stdout.write(self.get_help_text())
665
if 'usage' in opts: # e.g. bzr add --usage
666
sys.stdout.write(self.get_help_text(verbose=False))
668
trace.set_verbosity_level(option._verbosity_level)
669
if 'verbose' in self.supported_std_options:
670
opts['verbose'] = trace.is_verbose()
671
elif opts.has_key('verbose'):
673
if 'quiet' in self.supported_std_options:
674
opts['quiet'] = trace.is_quiet()
675
elif opts.has_key('quiet'):
678
364
# mix arguments and options into one dictionary
679
365
cmdargs = _match_argform(self.name(), self.takes_args, args)
760
class CommandHooks(Hooks):
761
"""Hooks related to Command object creation/enumeration."""
764
"""Create the default hooks.
766
These are all empty initially, because by default nothing should get
770
self.create_hook(HookPoint('extend_command',
771
"Called after creating a command object to allow modifications "
772
"such as adding or removing options, docs etc. Called with the "
773
"new bzrlib.commands.Command object.", (1, 13), None))
774
self.create_hook(HookPoint('get_command',
775
"Called when creating a single command. Called with "
776
"(cmd_or_None, command_name). get_command should either return "
777
"the cmd_or_None parameter, or a replacement Command object that "
778
"should be used for the command. Note that the Command.hooks "
779
"hooks are core infrastructure. Many users will prefer to use "
780
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
782
self.create_hook(HookPoint('get_missing_command',
783
"Called when creating a single command if no command could be "
784
"found. Called with (command_name). get_missing_command should "
785
"either return None, or a Command object to be used for the "
786
"command.", (1, 17), None))
787
self.create_hook(HookPoint('list_commands',
788
"Called when enumerating commands. Called with a set of "
789
"cmd_name strings for all the commands found so far. This set "
790
" is safe to mutate - e.g. to remove a command. "
791
"list_commands should return the updated set of command names.",
794
Command.hooks = CommandHooks()
412
# Technically, this function hasn't been use in a *really* long time
413
# but we are only deprecating it now.
414
@deprecated_function(zero_eleven)
415
def parse_spec(spec):
421
>>> parse_spec("../@")
423
>>> parse_spec("../f/@35")
425
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
426
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
431
parsed = spec.split('/@')
432
assert len(parsed) == 2
437
parsed[1] = int(parsed[1])
439
pass # We can allow stuff like ./@revid:blahblahblah
443
parsed = [spec, None]
797
446
def parse_args(command, argv, alias_argv=None):
798
447
"""Parse command line.
800
449
Arguments and options are parsed at this level before being passed
801
450
down to specific command handlers. This routine knows, from a
802
451
lookup table, something about the available options, what optargs
900
532
os.remove(pfname)
903
def exception_to_return_code(the_callable, *args, **kwargs):
904
"""UI level helper for profiling and coverage.
906
This transforms exceptions into a return value of 3. As such its only
907
relevant to the UI layer, and should never be called where catching
908
exceptions may be desirable.
911
return the_callable(*args, **kwargs)
912
except (KeyboardInterrupt, Exception), e:
913
# used to handle AssertionError and KeyboardInterrupt
914
# specially here, but hopefully they're handled ok by the logger now
915
exc_info = sys.exc_info()
916
exitcode = trace.report_exception(exc_info, sys.stderr)
917
if os.environ.get('BZR_PDB'):
918
print '**** entering debugger'
921
if sys.version_info[:2] < (2, 6):
923
# pdb.post_mortem(tb)
924
# but because pdb.post_mortem gives bad results for tracebacks
925
# from inside generators, we do it manually.
926
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
928
# Setup pdb on the traceback
931
p.setup(tb.tb_frame, tb)
932
# Point the debugger at the deepest frame of the stack
933
p.curindex = len(p.stack) - 1
934
p.curframe = p.stack[p.curindex][0]
935
# Start the pdb prompt.
936
p.print_stack_entry(p.stack[p.curindex])
944
535
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
945
536
from bzrlib.lsprof import profile
946
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
538
ret, stats = profile(the_callable, *args, **kwargs)
948
540
if filename is None:
952
trace.note('Profile data written to "%s".', filename)
544
cPickle.dump(stats, open(filename, 'w'), 2)
545
print 'Profile data written to %r.' % filename
956
@deprecated_function(deprecated_in((2, 2, 0)))
957
def shlex_split_unicode(unsplit):
958
return cmdline.split(unsplit)
961
549
def get_alias(cmd, config=None):
962
550
"""Return an expanded alias, or None if no alias exists.
973
561
config = bzrlib.config.GlobalConfig()
974
562
alias = config.get_alias(cmd)
976
return cmdline.split(alias)
565
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
980
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
981
570
"""Execute a command.
983
:param argv: The command-line arguments, without the program name from
984
argv[0] These should already be decoded. All library/test code calling
985
run_bzr should be passing valid strings (don't need decoding).
986
:param load_plugins: What function to call when triggering plugin loading.
987
This function should take no arguments and cause all plugins to be
989
:param disable_plugins: What function to call when disabling plugin
990
loading. This function should take no arguments and cause all plugin
991
loading to be prohibited (so that code paths in your application that
992
know about some plugins possibly being present will fail to import
993
those plugins even if they are installed.)
994
:return: Returns a command exit code or raises an exception.
572
This is similar to main(), but without all the trappings for
573
logging and error handling.
576
The command-line arguments, without the program name from argv[0]
577
These should already be decoded. All library/test code calling
578
run_bzr should be passing valid strings (don't need decoding).
580
Returns a command status or raises an exception.
996
582
Special master options: these must come before the command because
997
583
they control how the command is interpreted.
1048
627
opt_no_aliases = True
1049
628
elif a == '--builtin':
1050
629
opt_builtin = True
1051
elif a == '--concurrency':
1052
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1054
elif a == '--coverage':
1055
opt_coverage_dir = argv[i + 1]
630
elif a in ('--quiet', '-q'):
1057
632
elif a.startswith('-D'):
1058
633
debug.debug_flags.add(a[2:])
1060
635
argv_copy.append(a)
1063
debug.set_debug_flags_from_config()
640
from bzrlib.builtins import cmd_help
641
cmd_help().run_argv_aliases([])
644
if argv[0] == '--version':
645
from bzrlib.version import show_version
1065
649
if not opt_no_plugins:
650
from bzrlib.plugin import load_plugins
653
from bzrlib.plugin import disable_plugins
1068
654
disable_plugins()
1072
get_cmd_object('help').run_argv_aliases([])
1075
if argv[0] == '--version':
1076
get_cmd_object('version').run_argv_aliases([])
1079
656
alias_argv = None
1081
658
if not opt_no_aliases:
1082
659
alias_argv = get_alias(argv[0])
661
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1084
662
argv[0] = alias_argv.pop(0)
1086
664
cmd = argv.pop(0)
665
# We want only 'ascii' command names, but the user may have typed
666
# in a Unicode name. In that case, they should just get a
667
# 'command not found' error later.
1087
669
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1088
670
run = cmd_obj.run_argv_aliases
1089
671
run_argv = [argv, alias_argv]
1092
# We can be called recursively (tests for example), but we don't want
1093
# the verbosity level to propagate.
1094
saved_verbosity_level = option._verbosity_level
1095
option._verbosity_level = 0
1097
if opt_coverage_dir:
1099
'--coverage ignored, because --lsprof is in use.')
1100
675
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1101
676
elif opt_profile:
1102
if opt_coverage_dir:
1104
'--coverage ignored, because --profile is in use.')
1105
677
ret = apply_profiled(run, *run_argv)
1106
elif opt_coverage_dir:
1107
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1109
679
ret = run(*run_argv)
1112
# reset, in case we may do other commands later within the same
1113
# process. Commands that want to execute sub-commands must propagate
1114
# --verbose in their own way.
1115
if 'memory' in debug.debug_flags:
1116
trace.debug_memory('Process status after command:', short=False)
1117
option._verbosity_level = saved_verbosity_level
682
# reset, in case we may do other commands later within the same process
683
trace.be_quiet(False)
1120
685
def display_command(func):
1121
686
"""Decorator that suppresses pipe/interrupt errors."""
1137
702
return ignore_pipe
1140
def install_bzr_command_hooks():
1141
"""Install the hooks to supply bzr's own commands."""
1142
if _list_bzr_commands in Command.hooks["list_commands"]:
1144
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1146
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1148
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1149
"bzr plugin commands")
1150
Command.hooks.install_named_hook("get_command", _get_external_command,
1151
"bzr external command lookup")
1152
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1153
"bzr plugin-provider-db check")
1157
def _specified_or_unicode_argv(argv):
1158
# For internal or testing use, argv can be passed. Otherwise, get it from
1159
# the process arguments in a unicode-safe way.
1161
return osutils.get_unicode_argv()
1165
# ensure all arguments are unicode strings
1167
if isinstance(a, unicode):
1170
new_argv.append(a.decode('ascii'))
1171
except UnicodeDecodeError:
1172
raise errors.BzrError("argv should be list of unicode strings.")
1176
def main(argv=None):
1177
"""Main entry point of command-line interface.
1179
Typically `bzrlib.initialize` should be called first.
1181
:param argv: list of unicode command-line arguments similar to sys.argv.
1182
argv[0] is script name usually, it will be ignored.
1183
Don't pass here sys.argv because this list contains plain strings
1184
and not unicode; pass None instead.
1186
:return: exit code of bzr command.
1188
argv = _specified_or_unicode_argv(argv)
1189
_register_builtin_commands()
707
from bzrlib.ui.text import TextUIFactory
708
bzrlib.ui.ui_factory = TextUIFactory()
709
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1190
710
ret = run_bzr_catch_errors(argv)
1191
bzrlib.ui.ui_factory.log_transport_activity(
1192
display=('bytes' in debug.debug_flags))
1193
711
trace.mutter("return code %d", ret)
1197
715
def run_bzr_catch_errors(argv):
1198
"""Run a bzr command with parameters as described by argv.
1200
This function assumed that that UI layer is setup, that symbol deprecations
1201
are already applied, and that unicode decoding has already been performed on argv.
1203
# done here so that they're covered for every test run
1204
install_bzr_command_hooks()
1205
return exception_to_return_code(run_bzr, argv)
1208
def run_bzr_catch_user_errors(argv):
1209
"""Run bzr and report user errors, but let internal errors propagate.
1211
This is used for the test suite, and might be useful for other programs
1212
that want to wrap the commandline interface.
1214
# done here so that they're covered for every test run
1215
install_bzr_command_hooks()
1217
return run_bzr(argv)
1218
except Exception, e:
1219
if (isinstance(e, (OSError, IOError))
1220
or not getattr(e, 'internal_error', True)):
1221
trace.report_exception(sys.exc_info(), sys.stderr)
720
# do this here inside the exception wrappers to catch EPIPE
722
except (KeyboardInterrupt, Exception), e:
723
# used to handle AssertionError and KeyboardInterrupt
724
# specially here, but hopefully they're handled ok by the logger now
725
trace.report_exception(sys.exc_info(), sys.stderr)
726
if os.environ.get('BZR_PDB'):
727
print '**** entering debugger'
729
pdb.post_mortem(sys.exc_traceback)
1227
733
class HelpCommandIndex(object):
added
removed
bzrlib/commands.py
