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
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
33
from warnings import warn
46
from bzrlib.hooks import Hooks
47
# Compatibility - Option used to be in commands.
38
from bzrlib.errors import (BzrError,
48
43
from bzrlib.option import Option
49
from bzrlib.plugin import disable_plugins, load_plugins
50
from bzrlib import registry
51
from bzrlib.symbol_versioning import (
58
class CommandInfo(object):
59
"""Information about a command."""
61
def __init__(self, aliases):
62
"""The list of aliases for the command."""
63
self.aliases = aliases
66
def from_command(klass, command):
67
"""Factory to construct a CommandInfo from a command."""
68
return klass(command.aliases)
71
class CommandRegistry(registry.Registry):
72
"""Special registry mapping command names to command classes.
74
:ivar overridden_registry: Look in this registry for commands being
75
overridden by this registry. This can be used to tell plugin commands
76
about the builtin they're decorating.
80
registry.Registry.__init__(self)
81
self.overridden_registry = None
82
# map from aliases to the real command that implements the name
85
def get(self, command_name):
86
real_name = self._alias_dict.get(command_name, command_name)
87
return registry.Registry.get(self, real_name)
90
def _get_name(command_name):
91
if command_name.startswith("cmd_"):
92
return _unsquish_command_name(command_name)
96
def register(self, cmd, decorate=False):
97
"""Utility function to help register a command
99
:param cmd: Command subclass to register
100
:param decorate: If true, allow overriding an existing command
101
of the same name; the old command is returned by this function.
102
Otherwise it is an error to try to override an existing command.
105
k_unsquished = self._get_name(k)
107
previous = self.get(k_unsquished)
110
if self.overridden_registry:
112
previous = self.overridden_registry.get(k_unsquished)
115
info = CommandInfo.from_command(cmd)
117
registry.Registry.register(self, k_unsquished, cmd,
118
override_existing=decorate, info=info)
120
trace.warning('Two plugins defined the same command: %r' % k)
121
trace.warning('Not loading the one in %r' %
122
sys.modules[cmd.__module__])
123
trace.warning('Previously this command was registered from %r' %
124
sys.modules[previous.__module__])
125
for a in cmd.aliases:
126
self._alias_dict[a] = k_unsquished
129
def register_lazy(self, command_name, aliases, module_name):
130
"""Register a command without loading its module.
132
:param command_name: The primary name of the command.
133
:param aliases: A list of aliases for the command.
134
:module_name: The module that the command lives in.
136
key = self._get_name(command_name)
137
registry.Registry.register_lazy(self, key, module_name, command_name,
138
info=CommandInfo(aliases))
140
self._alias_dict[a] = key
143
plugin_cmds = CommandRegistry()
144
builtin_command_registry = CommandRegistry()
145
plugin_cmds.overridden_registry = builtin_command_registry
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib.symbol_versioning import *
47
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
148
52
def register_command(cmd, decorate=False):
149
"""Register a plugin command.
53
"""Utility function to help register a command
151
Should generally be avoided in favor of lazy registration.
55
:param cmd: Command subclass to register
56
:param decorate: If true, allow overriding an existing command
57
of the same name; the old command is returned by this function.
58
Otherwise it is an error to try to override an existing command.
153
60
global plugin_cmds
154
return plugin_cmds.register(cmd, decorate)
62
if k.startswith("cmd_"):
63
k_unsquished = _unsquish_command_name(k)
66
if not plugin_cmds.has_key(k_unsquished):
67
plugin_cmds[k_unsquished] = cmd
68
mutter('registered plugin command %s', k_unsquished)
69
if decorate and k_unsquished in builtin_command_names():
70
return _builtin_commands()[k_unsquished]
72
result = plugin_cmds[k_unsquished]
73
plugin_cmds[k_unsquished] = cmd
76
log_error('Two plugins defined the same command: %r' % k)
77
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
157
80
def _squish_command_name(cmd):
161
84
def _unsquish_command_name(cmd):
85
assert cmd.startswith("cmd_")
162
86
return cmd[4:].replace('_','-')
165
@deprecated_function(deprecated_in((2, 2, 0)))
166
89
def _builtin_commands():
167
"""Return a dict of {name: cmd_class} for builtin commands.
169
:deprecated: Use the builtin_command_registry registry instead
171
# return dict(name: cmd_class)
172
return dict(builtin_command_registry.items())
175
def _register_builtin_commands():
176
if builtin_command_registry.keys():
179
90
import bzrlib.builtins
180
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
181
builtin_command_registry.register(cmd_class)
182
bzrlib.builtins._register_lazy_builtins()
185
def _scan_module_for_commands(module):
187
for name, obj in module.__dict__.iteritems():
92
builtins = bzrlib.builtins.__dict__
188
94
if name.startswith("cmd_"):
189
95
real_name = _unsquish_command_name(name)
96
r[real_name] = builtins[name]
194
def _list_bzr_commands(names):
195
"""Find commands from bzr's core and plugins.
197
This is not the public interface, just the default hook called by all_command_names.
199
# to eliminate duplicates
200
names.update(builtin_command_names())
201
names.update(plugin_command_names())
205
def all_command_names():
206
"""Return a set of all command names."""
208
for hook in Command.hooks['list_commands']:
211
raise AssertionError(
212
'hook %s returned None' % Command.hooks.get_hook_name(hook))
216
100
def builtin_command_names():
217
"""Return list of builtin command names.
101
"""Return list of builtin command names."""
102
return _builtin_commands().keys()
219
Use of all_command_names() is encouraged rather than builtin_command_names
220
and/or plugin_command_names.
222
_register_builtin_commands()
223
return builtin_command_registry.keys()
226
105
def plugin_command_names():
227
"""Returns command names from commands registered by plugins."""
228
106
return plugin_cmds.keys()
109
def _get_cmd_dict(plugins_override=True):
110
"""Return name->class mapping for all commands."""
111
d = _builtin_commands()
113
d.update(plugin_cmds)
117
def get_all_cmds(plugins_override=True):
118
"""Return canonical name and class for all registered commands."""
119
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
231
123
def get_cmd_object(cmd_name, plugins_override=True):
232
"""Return the command object for a command.
124
"""Return the canonical name and command class for a command.
235
127
If true, plugin commands can override builtins.
238
return _get_cmd_object(cmd_name, plugins_override)
240
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
244
"""Get a command object.
246
:param cmd_name: The name of the command.
247
:param plugins_override: Allow plugins to override builtins.
248
:param check_missing: Look up commands not found in the regular index via
249
the get_missing_command hook.
250
:return: A Command object instance
251
:raises KeyError: If no command is found.
253
# We want only 'ascii' command names, but the user may have typed
254
# in a Unicode name. In that case, they should just get a
255
# 'command not found' error later.
256
# In the future, we may actually support Unicode command names.
259
for hook in Command.hooks['get_command']:
260
cmd = hook(cmd, cmd_name)
261
if cmd is not None and not plugins_override and not cmd.plugin_name():
262
# We've found a non-plugin command, don't permit it to be
265
if cmd is None and check_missing:
266
for hook in Command.hooks['get_missing_command']:
273
# Allow plugins to extend commands
274
for hook in Command.hooks['extend_command']:
276
if getattr(cmd, 'invoked_as', None) is None:
277
cmd.invoked_as = cmd_name
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)
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
129
from bzrlib.externalcommand import ExternalCommand
131
cmd_name = str(cmd_name) # not unicode
133
# first look up this command under the specified name
134
cmds = _get_cmd_dict(plugins_override=plugins_override)
136
return cmds[cmd_name]()
140
# look for any command which claims this as an alias
141
for real_cmd_name, cmd_class in cmds.iteritems():
142
if cmd_name in cmd_class.aliases:
324
145
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)()
149
raise BzrCommandError("unknown command %r" % cmd_name)
342
152
class Command(object):
390
200
replace - put in a bogus character (typically '?')
391
201
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
400
A string indicating the real name under which this command was
401
invoked, before expansion of aliases.
402
(This may be None if the command was constructed and run in-process.)
404
:cvar hooks: An instance of CommandHooks.
406
:ivar __doc__: The help shown by 'bzr help command' for this command.
407
This is set by assigning explicitly to __doc__ so that -OO can
411
__doc__ = "My help goes here"
415
206
takes_options = []
416
207
encoding_type = 'strict'
421
211
def __init__(self):
422
212
"""Construct an instance of this command."""
423
# List of standard options directly supported
424
self.supported_std_options = []
427
def add_cleanup(self, cleanup_func, *args, **kwargs):
428
"""Register a function to call after self.run returns or raises.
430
Functions will be called in LIFO order.
432
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
434
def cleanup_now(self):
435
"""Execute and empty pending cleanup functions immediately.
437
After cleanup_now all registered cleanups are forgotten. add_cleanup
438
may be called again after cleanup_now; these cleanups will be called
439
after self.run returns or raises (or when cleanup_now is next called).
441
This is useful for releasing expensive or contentious resources (such
442
as write locks) before doing further work that does not require those
443
resources (such as writing results to self.outf). Note though, that
444
as it releases all resources, this may release locks that the command
445
wants to hold, so use should be done with care.
447
self._operation.cleanup_now()
449
@deprecated_method(deprecated_in((2, 1, 0)))
450
def _maybe_expand_globs(self, file_list):
451
"""Glob expand file_list if the platform does not do that itself.
453
Not used anymore, now that the bzr command-line parser globs on
456
:return: A possibly empty list of unicode paths.
458
Introduced in bzrlib 0.18.
463
"""Return single-line grammar for this command.
465
Only describes arguments, not options.
467
s = 'bzr ' + self.name() + ' '
468
for aname in self.takes_args:
469
aname = aname.upper()
470
if aname[-1] in ['$', '+']:
471
aname = aname[:-1] + '...'
472
elif aname[-1] == '?':
473
aname = '[' + aname[:-1] + ']'
474
elif aname[-1] == '*':
475
aname = '[' + aname[:-1] + '...]'
477
s = s[:-1] # remove last space
480
def get_help_text(self, additional_see_also=None, plain=True,
481
see_also_as_links=False, verbose=True):
482
"""Return a text string with help for this command.
484
:param additional_see_also: Additional help topics to be
486
:param plain: if False, raw help (reStructuredText) is
487
returned instead of plain text.
488
:param see_also_as_links: if True, convert items in 'See also'
489
list to internal links (used by bzr_man rstx generator)
490
:param verbose: if True, display the full help, otherwise
491
leave out the descriptive sections and just display
492
usage help (e.g. Purpose, Usage, Options) with a
493
message explaining how to obtain full help.
497
doc = "No help for this command."
499
# Extract the summary (purpose) and sections out from the text
500
purpose,sections,order = self._get_help_parts(doc)
502
# If a custom usage section was provided, use it
503
if sections.has_key('Usage'):
504
usage = sections.pop('Usage')
506
usage = self._usage()
508
# The header is the purpose and usage
510
result += ':Purpose: %s\n' % purpose
511
if usage.find('\n') >= 0:
512
result += ':Usage:\n%s\n' % usage
514
result += ':Usage: %s\n' % usage
519
# XXX: optparse implicitly rewraps the help, and not always perfectly,
520
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
522
options = option.get_optparser(self.options()).format_option_help()
523
# XXX: According to the spec, ReST option lists actually don't support
524
# options like --1.9 so that causes syntax errors (in Sphinx at least).
525
# As that pattern always appears in the commands that break, we trap
526
# on that and then format that block of 'format' options as a literal
528
if not plain and options.find(' --1.9 ') != -1:
529
options = options.replace(' format:\n', ' format::\n\n', 1)
530
if options.startswith('Options:'):
531
result += ':' + options
532
elif options.startswith('options:'):
533
# Python 2.4 version of optparse
534
result += ':Options:' + options[len('options:'):]
540
# Add the description, indenting it 2 spaces
541
# to match the indentation of the options
542
if sections.has_key(None):
543
text = sections.pop(None)
544
text = '\n '.join(text.splitlines())
545
result += ':%s:\n %s\n\n' % ('Description',text)
547
# Add the custom sections (e.g. Examples). Note that there's no need
548
# to indent these as they must be indented already in the source.
551
if sections.has_key(label):
552
result += ':%s:\n%s\n' % (label,sections[label])
555
result += ("See bzr help %s for more details and examples.\n\n"
558
# Add the aliases, source (plug-in) and see also links, if any
560
result += ':Aliases: '
561
result += ', '.join(self.aliases) + '\n'
562
plugin_name = self.plugin_name()
563
if plugin_name is not None:
564
result += ':From: plugin "%s"\n' % plugin_name
565
see_also = self.get_see_also(additional_see_also)
567
if not plain and see_also_as_links:
569
for item in see_also:
571
# topics doesn't have an independent section
572
# so don't create a real link
573
see_also_links.append(item)
575
# Use a Sphinx link for this entry
576
link_text = ":doc:`%s <%s-help>`" % (item, item)
577
see_also_links.append(link_text)
578
see_also = see_also_links
579
result += ':See also: '
580
result += ', '.join(see_also) + '\n'
582
# If this will be rendered as plain text, convert it
584
import bzrlib.help_topics
585
result = bzrlib.help_topics.help_as_plain_text(result)
589
def _get_help_parts(text):
590
"""Split help text into a summary and named sections.
592
:return: (summary,sections,order) where summary is the top line and
593
sections is a dictionary of the rest indexed by section name.
594
order is the order the section appear in the text.
595
A section starts with a heading line of the form ":xxx:".
596
Indented text on following lines is the section value.
597
All text found outside a named section is assigned to the
598
default section which is given the key of None.
600
def save_section(sections, order, label, section):
602
if sections.has_key(label):
603
sections[label] += '\n' + section
606
sections[label] = section
608
lines = text.rstrip().splitlines()
609
summary = lines.pop(0)
612
label,section = None,''
614
if line.startswith(':') and line.endswith(':') and len(line) > 2:
615
save_section(sections, order, label, section)
616
label,section = line[1:-1],''
617
elif (label is not None) and len(line) > 1 and not line[0].isspace():
618
save_section(sections, order, label, section)
619
label,section = None,line
622
section += '\n' + line
625
save_section(sections, order, label, section)
626
return summary, sections, order
628
def get_help_topic(self):
629
"""Return the commands help topic - its name."""
632
def get_see_also(self, additional_terms=None):
633
"""Return a list of help topics that are related to this command.
635
The list is derived from the content of the _see_also attribute. Any
636
duplicates are removed and the result is in lexical order.
637
:param additional_terms: Additional help topics to cross-reference.
638
:return: A list of help topics.
640
see_also = set(getattr(self, '_see_also', []))
642
see_also.update(additional_terms)
643
return sorted(see_also)
213
if self.__doc__ == Command.__doc__:
214
warn("No help message set for %r" % self)
645
216
def options(self):
646
217
"""Return dict of valid options for this command.
648
219
Maps from long option name to option object."""
649
r = Option.STD_OPTIONS.copy()
221
r['help'] = Option.OPTIONS['help']
651
222
for o in self.takes_options:
652
if isinstance(o, basestring):
653
o = option.Option.OPTIONS[o]
223
if not isinstance(o, Option):
224
o = Option.OPTIONS[o]
655
if o.name in std_names:
656
self.supported_std_options.append(o.name)
659
228
def _setup_outf(self):
660
229
"""Return a file linked to stdout, which has proper encoding."""
661
self.outf = ui.ui_factory.make_output_stream(
662
encoding_type=self.encoding_type)
230
assert self.encoding_type in ['strict', 'exact', 'replace']
232
# Originally I was using self.stdout, but that looks
233
# *way* too much like sys.stdout
234
if self.encoding_type == 'exact':
235
self.outf = sys.stdout
238
output_encoding = getattr(sys.stdout, 'encoding', None)
239
if not output_encoding:
240
output_encoding = bzrlib.user_encoding
241
mutter('encoding stdout bzrlib.user_encoding %r', output_encoding)
243
mutter('encoding stdout log as sys.stdout encoding %r', output_encoding)
245
# use 'replace' so that we don't abort if trying to write out
246
# in e.g. the default C locale.
247
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
249
@deprecated_method(zero_eight)
250
def run_argv(self, argv):
251
"""Parse command line and run.
253
See run_argv_aliases for the 0.8 and beyond api.
255
return self.run_argv_aliases(argv)
664
257
def run_argv_aliases(self, argv, alias_argv=None):
665
258
"""Parse the command line and run with extra aliases in alias_argv."""
666
259
args, opts = parse_args(self, argv, alias_argv)
668
# Process the standard options
669
260
if 'help' in opts: # e.g. bzr add --help
670
sys.stdout.write(self.get_help_text())
672
if 'usage' in opts: # e.g. bzr add --usage
673
sys.stdout.write(self.get_help_text(verbose=False))
675
trace.set_verbosity_level(option._verbosity_level)
676
if 'verbose' in self.supported_std_options:
677
opts['verbose'] = trace.is_verbose()
678
elif opts.has_key('verbose'):
680
if 'quiet' in self.supported_std_options:
681
opts['quiet'] = trace.is_quiet()
682
elif opts.has_key('quiet'):
261
from bzrlib.help import help_on_command
262
help_on_command(self.name())
264
# XXX: This should be handled by the parser
265
allowed_names = self.options().keys()
267
if oname not in allowed_names:
268
raise BzrCommandError("option '--%s' is not allowed for"
269
" command %r" % (oname, self.name()))
685
270
# mix arguments and options into one dictionary
686
271
cmdargs = _match_argform(self.name(), self.takes_args, args)
758
301
return getdoc(self)
761
"""Return the canonical name for this command.
763
The name under which it was actually invoked is available in invoked_as.
765
304
return _unsquish_command_name(self.__class__.__name__)
767
def plugin_name(self):
768
"""Get the name of the plugin that provides this command.
770
:return: The name of the plugin or None if the command is builtin.
772
mod_parts = self.__module__.split('.')
773
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
307
def parse_spec(spec):
313
>>> parse_spec("../@")
315
>>> parse_spec("../f/@35")
317
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
318
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
323
parsed = spec.split('/@')
324
assert len(parsed) == 2
779
class CommandHooks(Hooks):
780
"""Hooks related to Command object creation/enumeration."""
783
"""Create the default hooks.
785
These are all empty initially, because by default nothing should get
788
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
789
self.add_hook('extend_command',
790
"Called after creating a command object to allow modifications "
791
"such as adding or removing options, docs etc. Called with the "
792
"new bzrlib.commands.Command object.", (1, 13))
793
self.add_hook('get_command',
794
"Called when creating a single command. Called with "
795
"(cmd_or_None, command_name). get_command should either return "
796
"the cmd_or_None parameter, or a replacement Command object that "
797
"should be used for the command. Note that the Command.hooks "
798
"hooks are core infrastructure. Many users will prefer to use "
799
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
801
self.add_hook('get_missing_command',
802
"Called when creating a single command if no command could be "
803
"found. Called with (command_name). get_missing_command should "
804
"either return None, or a Command object to be used for the "
806
self.add_hook('list_commands',
807
"Called when enumerating commands. Called with a set of "
808
"cmd_name strings for all the commands found so far. This set "
809
" is safe to mutate - e.g. to remove a command. "
810
"list_commands should return the updated set of command names.",
813
Command.hooks = CommandHooks()
329
parsed[1] = int(parsed[1])
331
pass # We can allow stuff like ./@revid:blahblahblah
335
parsed = [spec, None]
816
338
def parse_args(command, argv, alias_argv=None):
817
339
"""Parse command line.
819
341
Arguments and options are parsed at this level before being passed
820
342
down to specific command handlers. This routine knows, from a
821
343
lookup table, something about the available options, what optargs
822
344
they take, and which commands will accept them.
824
# TODO: make it a method of the Command?
825
parser = option.get_optparser(command.options())
826
if alias_argv is not None:
827
args = alias_argv + argv
831
# for python 2.5 and later, optparse raises this exception if a non-ascii
832
# option name is given. See http://bugs.python.org/issue2931
834
options, args = parser.parse_args(args)
835
except UnicodeEncodeError,e:
836
raise errors.BzrCommandError('Only ASCII permitted in option names')
838
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
839
v is not option.OptionParser.DEFAULT_VALUE])
346
# TODO: chop up this beast; make it a method of the Command
351
cmd_options = command.options()
353
proc_aliasarg = True # Are we processing alias_argv now?
354
for proc_argv in alias_argv, argv:
361
# We've received a standalone -- No more flags
365
# option names must not be unicode
369
mutter(" got option %r", a)
371
optname, optarg = a[2:].split('=', 1)
374
if optname not in cmd_options:
375
raise BzrOptionError('unknown long option %r for'
380
if shortopt in Option.SHORT_OPTIONS:
381
# Multi-character options must have a space to delimit
383
# ^^^ what does this mean? mbp 20051014
384
optname = Option.SHORT_OPTIONS[shortopt].name
386
# Single character short options, can be chained,
387
# and have their value appended to their name
389
if shortopt not in Option.SHORT_OPTIONS:
390
# We didn't find the multi-character name, and we
391
# didn't find the single char name
392
raise BzrError('unknown short option %r' % a)
393
optname = Option.SHORT_OPTIONS[shortopt].name
396
# There are extra things on this option
397
# see if it is the value, or if it is another
399
optargfn = Option.OPTIONS[optname].type
401
# This option does not take an argument, so the
402
# next entry is another short option, pack it
404
proc_argv.insert(0, '-' + a[2:])
406
# This option takes an argument, so pack it
410
if optname not in cmd_options:
411
raise BzrOptionError('unknown short option %r for'
413
(shortopt, command.name()))
415
# XXX: Do we ever want to support this, e.g. for -r?
417
raise BzrError('repeated option %r' % a)
418
elif optname in alias_opts:
419
# Replace what's in the alias with what's in the real
421
del alias_opts[optname]
423
proc_argv.insert(0, a)
426
raise BzrError('repeated option %r' % a)
428
option_obj = cmd_options[optname]
429
optargfn = option_obj.type
433
raise BzrError('option %r needs an argument' % a)
435
optarg = proc_argv.pop(0)
436
opts[optname] = optargfn(optarg)
438
alias_opts[optname] = optargfn(optarg)
441
raise BzrError('option %r takes no argument' % optname)
444
alias_opts[optname] = True
447
proc_aliasarg = False # Done with alias argv
840
448
return args, opts
925
516
os.remove(pfname)
928
def exception_to_return_code(the_callable, *args, **kwargs):
929
"""UI level helper for profiling and coverage.
931
This transforms exceptions into a return value of 3. As such its only
932
relevant to the UI layer, and should never be called where catching
933
exceptions may be desirable.
936
return the_callable(*args, **kwargs)
937
except (KeyboardInterrupt, Exception), e:
938
# used to handle AssertionError and KeyboardInterrupt
939
# specially here, but hopefully they're handled ok by the logger now
940
exc_info = sys.exc_info()
941
exitcode = trace.report_exception(exc_info, sys.stderr)
942
if os.environ.get('BZR_PDB'):
943
print '**** entering debugger'
946
if sys.version_info[:2] < (2, 6):
948
# pdb.post_mortem(tb)
949
# but because pdb.post_mortem gives bad results for tracebacks
950
# from inside generators, we do it manually.
951
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
953
# Setup pdb on the traceback
956
p.setup(tb.tb_frame, tb)
957
# Point the debugger at the deepest frame of the stack
958
p.curindex = len(p.stack) - 1
959
p.curframe = p.stack[p.curindex][0]
960
# Start the pdb prompt.
961
p.print_stack_entry(p.stack[p.curindex])
969
519
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
970
520
from bzrlib.lsprof import profile
971
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
522
ret, stats = profile(the_callable, *args, **kwargs)
973
524
if filename is None:
977
trace.note('Profile data written to "%s".', filename)
528
cPickle.dump(stats, open(filename, 'w'), 2)
529
print 'Profile data written to %r.' % filename
981
@deprecated_function(deprecated_in((2, 2, 0)))
982
def shlex_split_unicode(unsplit):
983
return cmdline.split(unsplit)
986
def get_alias(cmd, config=None):
987
"""Return an expanded alias, or None if no alias exists.
990
Command to be checked for an alias.
992
Used to specify an alternative config to use,
993
which is especially useful for testing.
994
If it is unspecified, the global config will be used.
998
config = bzrlib.config.GlobalConfig()
999
alias = config.get_alias(cmd)
534
"""Return an expanded alias, or None if no alias exists"""
536
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
1001
return cmdline.split(alias)
538
return alias.split(' ')
1005
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1006
543
"""Execute a command.
1008
:param argv: The command-line arguments, without the program name from
1009
argv[0] These should already be decoded. All library/test code calling
1010
run_bzr should be passing valid strings (don't need decoding).
1011
:param load_plugins: What function to call when triggering plugin loading.
1012
This function should take no arguments and cause all plugins to be
1014
:param disable_plugins: What function to call when disabling plugin
1015
loading. This function should take no arguments and cause all plugin
1016
loading to be prohibited (so that code paths in your application that
1017
know about some plugins possibly being present will fail to import
1018
those plugins even if they are installed.)
1019
:return: Returns a command exit code or raises an exception.
545
This is similar to main(), but without all the trappings for
546
logging and error handling.
549
The command-line arguments, without the program name from argv[0]
550
These should already be decoded. All library/test code calling
551
run_bzr should be passing valid strings (don't need decoding).
553
Returns a command status or raises an exception.
1021
555
Special master options: these must come before the command because
1022
556
they control how the command is interpreted.
1073
598
opt_no_aliases = True
1074
599
elif a == '--builtin':
1075
600
opt_builtin = True
1076
elif a == '--concurrency':
1077
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1079
elif a == '--coverage':
1080
opt_coverage_dir = argv[i + 1]
1082
elif a == '--profile-imports':
1083
pass # already handled in startup script Bug #588277
1084
elif a.startswith('-D'):
1085
debug.debug_flags.add(a[2:])
601
elif a in ('--quiet', '-q'):
1087
604
argv_copy.append(a)
1090
debug.set_debug_flags_from_config()
609
from bzrlib.builtins import cmd_help
610
cmd_help().run_argv_aliases([])
613
if argv[0] == '--version':
614
from bzrlib.builtins import show_version
1092
618
if not opt_no_plugins:
619
from bzrlib.plugin import load_plugins
622
from bzrlib.plugin import disable_plugins
1095
623
disable_plugins()
1099
get_cmd_object('help').run_argv_aliases([])
1102
if argv[0] == '--version':
1103
get_cmd_object('version').run_argv_aliases([])
1106
625
alias_argv = None
1108
627
if not opt_no_aliases:
1109
628
alias_argv = get_alias(argv[0])
630
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1111
631
argv[0] = alias_argv.pop(0)
633
cmd = str(argv.pop(0))
1114
635
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1115
run = cmd_obj.run_argv_aliases
1116
run_argv = [argv, alias_argv]
636
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
637
run = cmd_obj.run_argv
640
run = cmd_obj.run_argv_aliases
641
run_argv = [argv, alias_argv]
1119
# We can be called recursively (tests for example), but we don't want
1120
# the verbosity level to propagate.
1121
saved_verbosity_level = option._verbosity_level
1122
option._verbosity_level = 0
1124
if opt_coverage_dir:
1126
'--coverage ignored, because --lsprof is in use.')
1127
645
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1128
646
elif opt_profile:
1129
if opt_coverage_dir:
1131
'--coverage ignored, because --profile is in use.')
1132
647
ret = apply_profiled(run, *run_argv)
1133
elif opt_coverage_dir:
1134
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1136
649
ret = run(*run_argv)
1139
# reset, in case we may do other commands later within the same
1140
# process. Commands that want to execute sub-commands must propagate
1141
# --verbose in their own way.
1142
if 'memory' in debug.debug_flags:
1143
trace.debug_memory('Process status after command:', short=False)
1144
option._verbosity_level = saved_verbosity_level
652
# reset, in case we may do other commands later within the same process
1147
655
def display_command(func):
1148
656
"""Decorator that suppresses pipe/interrupt errors."""
1152
660
sys.stdout.flush()
1154
662
except IOError, e:
1155
if getattr(e, 'errno', None) is None:
663
if not hasattr(e, 'errno'):
1157
665
if e.errno != errno.EPIPE:
1158
# Win32 raises IOError with errno=0 on a broken pipe
1159
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1162
668
except KeyboardInterrupt:
1164
670
return ignore_pipe
1167
def install_bzr_command_hooks():
1168
"""Install the hooks to supply bzr's own commands."""
1169
if _list_bzr_commands in Command.hooks["list_commands"]:
1171
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1173
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1175
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1176
"bzr plugin commands")
1177
Command.hooks.install_named_hook("get_command", _get_external_command,
1178
"bzr external command lookup")
1179
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1180
"bzr plugin-provider-db check")
1184
def _specified_or_unicode_argv(argv):
1185
# For internal or testing use, argv can be passed. Otherwise, get it from
1186
# the process arguments in a unicode-safe way.
1188
return osutils.get_unicode_argv()
1192
# ensure all arguments are unicode strings
1194
if isinstance(a, unicode):
1197
new_argv.append(a.decode('ascii'))
1198
except UnicodeDecodeError:
1199
raise errors.BzrError("argv should be list of unicode strings.")
1203
def main(argv=None):
1204
"""Main entry point of command-line interface.
1206
Typically `bzrlib.initialize` should be called first.
1208
:param argv: list of unicode command-line arguments similar to sys.argv.
1209
argv[0] is script name usually, it will be ignored.
1210
Don't pass here sys.argv because this list contains plain strings
1211
and not unicode; pass None instead.
1213
:return: exit code of bzr command.
1215
if argv is not None:
1217
_register_builtin_commands()
675
from bzrlib.ui.text import TextUIFactory
676
## bzrlib.trace.enable_default_logging()
677
bzrlib.trace.log_startup(argv)
678
bzrlib.ui.ui_factory = TextUIFactory()
680
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
1218
681
ret = run_bzr_catch_errors(argv)
1219
trace.mutter("return code %d", ret)
682
mutter("return code %d", ret)
1223
686
def run_bzr_catch_errors(argv):
1224
"""Run a bzr command with parameters as described by argv.
1226
This function assumed that that UI layer is setup, that symbol deprecations
1227
are already applied, and that unicode decoding has already been performed on argv.
1229
# done here so that they're covered for every test run
1230
install_bzr_command_hooks()
1231
return exception_to_return_code(run_bzr, argv)
1234
def run_bzr_catch_user_errors(argv):
1235
"""Run bzr and report user errors, but let internal errors propagate.
1237
This is used for the test suite, and might be useful for other programs
1238
that want to wrap the commandline interface.
1240
# done here so that they're covered for every test run
1241
install_bzr_command_hooks()
1243
return run_bzr(argv)
691
# do this here inside the exception wrappers to catch EPIPE
1244
693
except Exception, e:
1245
if (isinstance(e, (OSError, IOError))
1246
or not getattr(e, 'internal_error', True)):
1247
trace.report_exception(sys.exc_info(), sys.stderr)
1253
class HelpCommandIndex(object):
1254
"""A index for bzr help that returns commands."""
1257
self.prefix = 'commands/'
1259
def get_topics(self, topic):
1260
"""Search for topic amongst commands.
1262
:param topic: A topic to search for.
1263
:return: A list which is either empty or contains a single
1266
if topic and topic.startswith(self.prefix):
1267
topic = topic[len(self.prefix):]
1269
cmd = _get_cmd_object(topic, check_missing=False)
1276
class Provider(object):
1277
'''Generic class to be overriden by plugins'''
1279
def plugin_for_command(self, cmd_name):
1280
'''Takes a command and returns the information for that plugin
1282
:return: A dictionary with all the available information
1283
for the requested plugin
1285
raise NotImplementedError
1288
class ProvidersRegistry(registry.Registry):
1289
'''This registry exists to allow other providers to exist'''
1292
for key, provider in self.iteritems():
1295
command_providers_registry = ProvidersRegistry()
694
# used to handle AssertionError and KeyboardInterrupt
695
# specially here, but hopefully they're handled ok by the logger now
697
if (isinstance(e, IOError)
698
and hasattr(e, 'errno')
699
and e.errno == errno.EPIPE):
700
bzrlib.trace.note('broken pipe')
703
bzrlib.trace.log_exception()
704
if os.environ.get('BZR_PDB'):
705
print '**** entering debugger'
707
pdb.post_mortem(sys.exc_traceback)
710
if __name__ == '__main__':
711
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
