1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
23
21
# TODO: Define arguments by objects, rather than just using names.
24
22
# Those objects can specify the expected type of the argument, which
25
# would help with validation and shell completion.
23
# would help with validation and shell completion. They could also provide
24
# help/explanation for that argument in a structured way.
26
# TODO: Specific "examples" property on commands for consistent formatting.
27
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
28
29
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
32
39
from warnings import warn
33
from inspect import getdoc
37
from bzrlib.trace import mutter, note, log_error, warning
38
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError, NotBranchError
39
from bzrlib.revisionspec import RevisionSpec
40
from bzrlib import BZRDIR
45
def register_command(cmd):
46
"Utility function to help register a command"
55
from bzrlib.hooks import HookPoint, Hooks
56
# Compatibility - Option used to be in commands.
57
from bzrlib.option import Option
58
from bzrlib import registry
59
from bzrlib.symbol_versioning import (
66
class CommandInfo(object):
67
"""Information about a command."""
69
def __init__(self, aliases):
70
"""The list of aliases for the command."""
71
self.aliases = aliases
74
def from_command(klass, command):
75
"""Factory to construct a CommandInfo from a command."""
76
return klass(command.aliases)
79
class CommandRegistry(registry.Registry):
82
def _get_name(command_name):
83
if command_name.startswith("cmd_"):
84
return _unsquish_command_name(command_name)
88
def register(self, cmd, decorate=False):
89
"""Utility function to help register a command
91
:param cmd: Command subclass to register
92
:param decorate: If true, allow overriding an existing command
93
of the same name; the old command is returned by this function.
94
Otherwise it is an error to try to override an existing command.
97
k_unsquished = self._get_name(k)
99
previous = self.get(k_unsquished)
101
previous = _builtin_commands().get(k_unsquished)
102
info = CommandInfo.from_command(cmd)
104
registry.Registry.register(self, k_unsquished, cmd,
105
override_existing=decorate, info=info)
107
trace.warning('Two plugins defined the same command: %r' % k)
108
trace.warning('Not loading the one in %r' %
109
sys.modules[cmd.__module__])
110
trace.warning('Previously this command was registered from %r' %
111
sys.modules[previous.__module__])
114
def register_lazy(self, command_name, aliases, module_name):
115
"""Register a command without loading its module.
117
:param command_name: The primary name of the command.
118
:param aliases: A list of aliases for the command.
119
:module_name: The module that the command lives in.
121
key = self._get_name(command_name)
122
registry.Registry.register_lazy(self, key, module_name, command_name,
123
info=CommandInfo(aliases))
126
plugin_cmds = CommandRegistry()
129
def register_command(cmd, decorate=False):
47
130
global plugin_cmds
49
if k.startswith("cmd_"):
50
k_unsquished = _unsquish_command_name(k)
53
if not plugin_cmds.has_key(k_unsquished):
54
plugin_cmds[k_unsquished] = cmd
55
mutter('registered plugin command %s', k_unsquished)
57
log_error('Two plugins defined the same command: %r' % k)
58
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
131
return plugin_cmds.register(cmd, decorate)
61
134
def _squish_command_name(cmd):
65
138
def _unsquish_command_name(cmd):
66
assert cmd.startswith("cmd_")
67
139
return cmd[4:].replace('_','-')
70
def _parse_revision_str(revstr):
71
"""This handles a revision string -> revno.
73
This always returns a list. The list will have one element for
76
>>> _parse_revision_str('234')
77
[<RevisionSpec_int 234>]
78
>>> _parse_revision_str('234..567')
79
[<RevisionSpec_int 234>, <RevisionSpec_int 567>]
80
>>> _parse_revision_str('..')
81
[<RevisionSpec None>, <RevisionSpec None>]
82
>>> _parse_revision_str('..234')
83
[<RevisionSpec None>, <RevisionSpec_int 234>]
84
>>> _parse_revision_str('234..')
85
[<RevisionSpec_int 234>, <RevisionSpec None>]
86
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
87
[<RevisionSpec_int 234>, <RevisionSpec_int 456>, <RevisionSpec_int 789>]
88
>>> _parse_revision_str('234....789') # Error?
89
[<RevisionSpec_int 234>, <RevisionSpec None>, <RevisionSpec_int 789>]
90
>>> _parse_revision_str('revid:test@other.com-234234')
91
[<RevisionSpec_revid revid:test@other.com-234234>]
92
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
93
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
94
>>> _parse_revision_str('revid:test@other.com-234234..23')
95
[<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_int 23>]
96
>>> _parse_revision_str('date:2005-04-12')
97
[<RevisionSpec_date date:2005-04-12>]
98
>>> _parse_revision_str('date:2005-04-12 12:24:33')
99
[<RevisionSpec_date date:2005-04-12 12:24:33>]
100
>>> _parse_revision_str('date:2005-04-12T12:24:33')
101
[<RevisionSpec_date date:2005-04-12T12:24:33>]
102
>>> _parse_revision_str('date:2005-04-12,12:24:33')
103
[<RevisionSpec_date date:2005-04-12,12:24:33>]
104
>>> _parse_revision_str('-5..23')
105
[<RevisionSpec_int -5>, <RevisionSpec_int 23>]
106
>>> _parse_revision_str('-5')
107
[<RevisionSpec_int -5>]
108
>>> _parse_revision_str('123a')
109
Traceback (most recent call last):
111
BzrError: No namespace registered for string: '123a'
112
>>> _parse_revision_str('abc')
113
Traceback (most recent call last):
115
BzrError: No namespace registered for string: 'abc'
118
old_format_re = re.compile('\d*:\d*')
119
m = old_format_re.match(revstr)
122
warning('Colon separator for revision numbers is deprecated.'
124
for rev in revstr.split(':'):
126
revs.append(RevisionSpec(int(rev)))
128
revs.append(RevisionSpec(None))
130
for x in revstr.split('..'):
132
revs.append(RevisionSpec(None))
134
revs.append(RevisionSpec(x))
138
142
def _builtin_commands():
139
143
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
141
builtins = bzrlib.builtins.__dict__
142
for name in builtins:
149
for name, obj in module.__dict__.iteritems():
143
150
if name.startswith("cmd_"):
144
real_name = _unsquish_command_name(name)
145
r[real_name] = builtins[name]
151
real_name = _unsquish_command_name(name)
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
150
175
def builtin_command_names():
151
"""Return list of builtin command names."""
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
152
181
return _builtin_commands().keys()
155
184
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
156
186
return plugin_cmds.keys()
159
def _get_cmd_dict(plugins_override=True):
160
"""Return name->class mapping for all commands."""
161
d = _builtin_commands()
163
d.update(plugin_cmds)
167
def get_all_cmds(plugins_override=True):
168
"""Return canonical name and class for all registered commands."""
169
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
173
189
def get_cmd_object(cmd_name, plugins_override=True):
174
"""Return the canonical name and command class for a command.
190
"""Return the command object for a command.
177
193
If true, plugin commands can override builtins.
179
from bzrlib.externalcommand import ExternalCommand
181
cmd_name = str(cmd_name) # not unicode
183
# first look up this command under the specified name
184
cmds = _get_cmd_dict(plugins_override=plugins_override)
196
return _get_cmd_object(cmd_name, plugins_override)
198
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
201
def _get_cmd_object(cmd_name, plugins_override=True):
202
"""Get a command object.
204
:param cmd_name: The name of the command.
205
:param plugins_override: Allow plugins to override builtins.
206
:return: A Command object instance
207
:raises KeyError: If no command is found.
209
# We want only 'ascii' command names, but the user may have typed
210
# in a Unicode name. In that case, they should just get a
211
# 'command not found' error later.
212
# In the future, we may actually support Unicode command names.
215
for hook in Command.hooks['get_command']:
216
cmd = hook(cmd, cmd_name)
217
if cmd is not None and not plugins_override and not cmd.plugin_name():
218
# We've found a non-plugin command, don't permit it to be
222
for hook in Command.hooks['get_missing_command']:
229
# Allow plugins to extend commands
230
for hook in Command.hooks['extend_command']:
235
def _try_plugin_provider(cmd_name):
236
"""Probe for a plugin provider having cmd_name."""
238
plugin_metadata, provider = probe_for_provider(cmd_name)
239
raise errors.CommandAvailableInPlugin(cmd_name,
240
plugin_metadata, provider)
241
except errors.NoPluginAvailable:
245
def probe_for_provider(cmd_name):
246
"""Look for a provider for cmd_name.
248
:param cmd_name: The command name.
249
:return: plugin_metadata, provider for getting cmd_name.
250
:raises NoPluginAvailable: When no provider can supply the plugin.
252
# look for providers that provide this command but aren't installed
253
for provider in command_providers_registry:
255
return provider.plugin_for_command(cmd_name), provider
256
except errors.NoPluginAvailable:
258
raise errors.NoPluginAvailable(cmd_name)
261
def _get_bzr_command(cmd_or_None, cmd_name):
262
"""Get a command from bzr's core."""
263
cmds = _builtin_commands()
186
265
return cmds[cmd_name]()
190
268
# look for any command which claims this as an alias
191
269
for real_cmd_name, cmd_class in cmds.iteritems():
192
270
if cmd_name in cmd_class.aliases:
193
271
return cmd_class()
275
def _get_external_command(cmd_or_None, cmd_name):
276
"""Lookup a command that is a shell script."""
277
# Only do external command lookups when no command is found so far.
278
if cmd_or_None is not None:
280
from bzrlib.externalcommand import ExternalCommand
195
281
cmd_obj = ExternalCommand.find_command(cmd_name)
199
raise BzrCommandError("unknown command %r" % cmd_name)
286
def _get_plugin_command(cmd_or_None, cmd_name):
287
"""Get a command from bzr's plugins."""
289
return plugin_cmds.get(cmd_name)()
292
for key in plugin_cmds.keys():
293
info = plugin_cmds.get_info(key)
294
if cmd_name in info.aliases:
295
return plugin_cmds.get(key)()
202
299
class Command(object):
224
321
List of argument forms, marked with whether they are optional,
326
['to_location', 'from_branch?', 'file*']
328
'to_location' is required
329
'from_branch' is optional
330
'file' can be specified 0 or more times
228
List of options that may be given for this command.
333
List of options that may be given for this command. These can
334
be either strings, referring to globally-defined options,
335
or option objects. Retrieve through options().
231
338
If true, this command isn't advertised. This is typically
232
339
for commands intended for expert users.
342
Command objects will get a 'outf' attribute, which has been
343
setup to properly handle encoding of unicode strings.
344
encoding_type determines what will happen when characters cannot
346
strict - abort if we cannot decode
347
replace - put in a bogus character (typically '?')
348
exact - do not encode sys.stdout
350
NOTE: by default on Windows, sys.stdout is opened as a text
351
stream, therefore LF line-endings are converted to CRLF.
352
When a command uses encoding_type = 'exact', then
353
sys.stdout is forced to be a binary stream, and line-endings
356
:cvar hooks: An instance of CommandHooks.
237
360
takes_options = []
361
encoding_type = 'strict'
241
365
def __init__(self):
242
366
"""Construct an instance of this command."""
243
367
if self.__doc__ == Command.__doc__:
244
368
warn("No help message set for %r" % self)
247
def run_argv(self, argv):
248
"""Parse command line and run."""
249
args, opts = parse_args(argv)
369
# List of standard options directly supported
370
self.supported_std_options = []
371
self._operation = cleanup.OperationWithCleanups(self.run)
373
def add_cleanup(self, cleanup_func, *args, **kwargs):
374
"""Register a function to call after self.run returns or raises.
376
Functions will be called in LIFO order.
378
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
380
def cleanup_now(self):
381
"""Execute and empty pending cleanup functions immediately.
383
After cleanup_now all registered cleanups are forgotten. add_cleanup
384
may be called again after cleanup_now; these cleanups will be called
385
after self.run returns or raises (or when cleanup_now is next called).
387
This is useful for releasing expensive or contentious resources (such
388
as write locks) before doing further work that does not require those
389
resources (such as writing results to self.outf).
391
self._operation.cleanup_now()
393
@deprecated_method(deprecated_in((2, 1, 0)))
394
def _maybe_expand_globs(self, file_list):
395
"""Glob expand file_list if the platform does not do that itself.
397
Not used anymore, now that the bzr command-line parser globs on
400
:return: A possibly empty list of unicode paths.
402
Introduced in bzrlib 0.18.
407
"""Return single-line grammar for this command.
409
Only describes arguments, not options.
411
s = 'bzr ' + self.name() + ' '
412
for aname in self.takes_args:
413
aname = aname.upper()
414
if aname[-1] in ['$', '+']:
415
aname = aname[:-1] + '...'
416
elif aname[-1] == '?':
417
aname = '[' + aname[:-1] + ']'
418
elif aname[-1] == '*':
419
aname = '[' + aname[:-1] + '...]'
421
s = s[:-1] # remove last space
424
def get_help_text(self, additional_see_also=None, plain=True,
425
see_also_as_links=False, verbose=True):
426
"""Return a text string with help for this command.
428
:param additional_see_also: Additional help topics to be
430
:param plain: if False, raw help (reStructuredText) is
431
returned instead of plain text.
432
:param see_also_as_links: if True, convert items in 'See also'
433
list to internal links (used by bzr_man rstx generator)
434
:param verbose: if True, display the full help, otherwise
435
leave out the descriptive sections and just display
436
usage help (e.g. Purpose, Usage, Options) with a
437
message explaining how to obtain full help.
441
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
443
# Extract the summary (purpose) and sections out from the text
444
purpose,sections,order = self._get_help_parts(doc)
446
# If a custom usage section was provided, use it
447
if sections.has_key('Usage'):
448
usage = sections.pop('Usage')
450
usage = self._usage()
452
# The header is the purpose and usage
454
result += ':Purpose: %s\n' % purpose
455
if usage.find('\n') >= 0:
456
result += ':Usage:\n%s\n' % usage
458
result += ':Usage: %s\n' % usage
463
# XXX: optparse implicitly rewraps the help, and not always perfectly,
464
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
466
options = option.get_optparser(self.options()).format_option_help()
467
# XXX: According to the spec, ReST option lists actually don't support
468
# options like --1.9 so that causes syntax errors (in Sphinx at least).
469
# As that pattern always appears in the commands that break, we trap
470
# on that and then format that block of 'format' options as a literal
472
if not plain and options.find(' --1.9 ') != -1:
473
options = options.replace(' format:\n', ' format::\n\n', 1)
474
if options.startswith('Options:'):
475
result += ':' + options
476
elif options.startswith('options:'):
477
# Python 2.4 version of optparse
478
result += ':Options:' + options[len('options:'):]
484
# Add the description, indenting it 2 spaces
485
# to match the indentation of the options
486
if sections.has_key(None):
487
text = sections.pop(None)
488
text = '\n '.join(text.splitlines())
489
result += ':%s:\n %s\n\n' % ('Description',text)
491
# Add the custom sections (e.g. Examples). Note that there's no need
492
# to indent these as they must be indented already in the source.
495
if sections.has_key(label):
496
result += ':%s:\n%s\n' % (label,sections[label])
499
result += ("See bzr help %s for more details and examples.\n\n"
502
# Add the aliases, source (plug-in) and see also links, if any
504
result += ':Aliases: '
505
result += ', '.join(self.aliases) + '\n'
506
plugin_name = self.plugin_name()
507
if plugin_name is not None:
508
result += ':From: plugin "%s"\n' % plugin_name
509
see_also = self.get_see_also(additional_see_also)
511
if not plain and see_also_as_links:
513
for item in see_also:
515
# topics doesn't have an independent section
516
# so don't create a real link
517
see_also_links.append(item)
519
# Use a Sphinx link for this entry
520
link_text = ":doc:`%s <%s-help>`" % (item, item)
521
see_also_links.append(link_text)
522
see_also = see_also_links
523
result += ':See also: '
524
result += ', '.join(see_also) + '\n'
526
# If this will be rendered as plain text, convert it
528
import bzrlib.help_topics
529
result = bzrlib.help_topics.help_as_plain_text(result)
533
def _get_help_parts(text):
534
"""Split help text into a summary and named sections.
536
:return: (summary,sections,order) where summary is the top line and
537
sections is a dictionary of the rest indexed by section name.
538
order is the order the section appear in the text.
539
A section starts with a heading line of the form ":xxx:".
540
Indented text on following lines is the section value.
541
All text found outside a named section is assigned to the
542
default section which is given the key of None.
544
def save_section(sections, order, label, section):
546
if sections.has_key(label):
547
sections[label] += '\n' + section
550
sections[label] = section
552
lines = text.rstrip().splitlines()
553
summary = lines.pop(0)
556
label,section = None,''
558
if line.startswith(':') and line.endswith(':') and len(line) > 2:
559
save_section(sections, order, label, section)
560
label,section = line[1:-1],''
561
elif (label is not None) and len(line) > 1 and not line[0].isspace():
562
save_section(sections, order, label, section)
563
label,section = None,line
566
section += '\n' + line
569
save_section(sections, order, label, section)
570
return summary, sections, order
572
def get_help_topic(self):
573
"""Return the commands help topic - its name."""
576
def get_see_also(self, additional_terms=None):
577
"""Return a list of help topics that are related to this command.
579
The list is derived from the content of the _see_also attribute. Any
580
duplicates are removed and the result is in lexical order.
581
:param additional_terms: Additional help topics to cross-reference.
582
:return: A list of help topics.
584
see_also = set(getattr(self, '_see_also', []))
586
see_also.update(additional_terms)
587
return sorted(see_also)
590
"""Return dict of valid options for this command.
592
Maps from long option name to option object."""
593
r = Option.STD_OPTIONS.copy()
595
for o in self.takes_options:
596
if isinstance(o, basestring):
597
o = option.Option.OPTIONS[o]
599
if o.name in std_names:
600
self.supported_std_options.append(o.name)
603
def _setup_outf(self):
604
"""Return a file linked to stdout, which has proper encoding."""
605
self.outf = ui.ui_factory.make_output_stream(
606
encoding_type=self.encoding_type)
608
def run_argv_aliases(self, argv, alias_argv=None):
609
"""Parse the command line and run with extra aliases in alias_argv."""
610
args, opts = parse_args(self, argv, alias_argv)
612
# Process the standard options
251
613
if 'help' in opts: # e.g. bzr add --help
252
from bzrlib.help import help_on_command
253
help_on_command(self.name())
256
# check options are reasonable
257
allowed = self.takes_options
259
if oname not in allowed:
260
raise BzrCommandError("option '--%s' is not allowed for command %r"
261
% (oname, self.name()))
614
sys.stdout.write(self.get_help_text())
616
if 'usage' in opts: # e.g. bzr add --usage
617
sys.stdout.write(self.get_help_text(verbose=False))
619
trace.set_verbosity_level(option._verbosity_level)
620
if 'verbose' in self.supported_std_options:
621
opts['verbose'] = trace.is_verbose()
622
elif opts.has_key('verbose'):
624
if 'quiet' in self.supported_std_options:
625
opts['quiet'] = trace.is_quiet()
626
elif opts.has_key('quiet'):
263
629
# mix arguments and options into one dictionary
264
630
cmdargs = _match_argform(self.name(), self.takes_args, args)
295
667
return _unsquish_command_name(self.__class__.__name__)
669
def plugin_name(self):
670
"""Get the name of the plugin that provides this command.
298
def parse_spec(spec):
304
>>> parse_spec("../@")
306
>>> parse_spec("../f/@35")
308
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
309
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
314
parsed = spec.split('/@')
315
assert len(parsed) == 2
672
:return: The name of the plugin or None if the command is builtin.
674
mod_parts = self.__module__.split('.')
675
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
320
parsed[1] = int(parsed[1])
322
pass # We can allow stuff like ./@revid:blahblahblah
326
parsed = [spec, None]
330
# list of all available options; the rhs can be either None for an
331
# option that takes no argument, or a constructor function that checks
345
'revision': _parse_revision_str,
371
def parse_args(argv):
681
class CommandHooks(Hooks):
682
"""Hooks related to Command object creation/enumeration."""
685
"""Create the default hooks.
687
These are all empty initially, because by default nothing should get
691
self.create_hook(HookPoint('extend_command',
692
"Called after creating a command object to allow modifications "
693
"such as adding or removing options, docs etc. Called with the "
694
"new bzrlib.commands.Command object.", (1, 13), None))
695
self.create_hook(HookPoint('get_command',
696
"Called when creating a single command. Called with "
697
"(cmd_or_None, command_name). get_command should either return "
698
"the cmd_or_None parameter, or a replacement Command object that "
699
"should be used for the command. Note that the Command.hooks "
700
"hooks are core infrastructure. Many users will prefer to use "
701
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
703
self.create_hook(HookPoint('get_missing_command',
704
"Called when creating a single command if no command could be "
705
"found. Called with (command_name). get_missing_command should "
706
"either return None, or a Command object to be used for the "
707
"command.", (1, 17), None))
708
self.create_hook(HookPoint('list_commands',
709
"Called when enumerating commands. Called with a set of "
710
"cmd_name strings for all the commands found so far. This set "
711
" is safe to mutate - e.g. to remove a command. "
712
"list_commands should return the updated set of command names.",
715
Command.hooks = CommandHooks()
718
def parse_args(command, argv, alias_argv=None):
372
719
"""Parse command line.
374
721
Arguments and options are parsed at this level before being passed
375
722
down to specific command handlers. This routine knows, from a
376
723
lookup table, something about the available options, what optargs
377
724
they take, and which commands will accept them.
379
>>> parse_args('--help'.split())
381
>>> parse_args('help -- --invalidcmd'.split())
382
(['help', '--invalidcmd'], {})
383
>>> parse_args('--version'.split())
384
([], {'version': True})
385
>>> parse_args('status --all'.split())
386
(['status'], {'all': True})
387
>>> parse_args('commit --message=biter'.split())
388
(['commit'], {'message': u'biter'})
389
>>> parse_args('log -r 500'.split())
390
(['log'], {'revision': [<RevisionSpec_int 500>]})
391
>>> parse_args('log -r500..600'.split())
392
(['log'], {'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
393
>>> parse_args('log -vr500..600'.split())
394
(['log'], {'verbose': True, 'revision': [<RevisionSpec_int 500>, <RevisionSpec_int 600>]})
395
>>> parse_args('log -rrevno:500..600'.split()) #the r takes an argument
396
(['log'], {'revision': [<RevisionSpec_revno revno:500>, <RevisionSpec_int 600>]})
404
if not argsover and a[0] == '-':
405
# option names must not be unicode
410
# We've received a standalone -- No more flags
413
mutter(" got option %r" % a)
415
optname, optarg = a[2:].split('=', 1)
418
if optname not in OPTIONS:
419
raise BzrError('unknown long option %r' % a)
422
if shortopt in SHORT_OPTIONS:
423
# Multi-character options must have a space to delimit
425
optname = SHORT_OPTIONS[shortopt]
427
# Single character short options, can be chained,
428
# and have their value appended to their name
430
if shortopt not in SHORT_OPTIONS:
431
# We didn't find the multi-character name, and we
432
# didn't find the single char name
433
raise BzrError('unknown short option %r' % a)
434
optname = SHORT_OPTIONS[shortopt]
437
# There are extra things on this option
438
# see if it is the value, or if it is another
440
optargfn = OPTIONS[optname]
442
# This option does not take an argument, so the
443
# next entry is another short option, pack it back
445
argv.insert(0, '-' + a[2:])
447
# This option takes an argument, so pack it
452
# XXX: Do we ever want to support this, e.g. for -r?
453
raise BzrError('repeated option %r' % a)
455
optargfn = OPTIONS[optname]
459
raise BzrError('option %r needs an argument' % a)
462
opts[optname] = optargfn(optarg)
465
raise BzrError('option %r takes no argument' % optname)
726
# TODO: make it a method of the Command?
727
parser = option.get_optparser(command.options())
728
if alias_argv is not None:
729
args = alias_argv + argv
733
options, args = parser.parse_args(args)
734
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
735
v is not option.OptionParser.DEFAULT_VALUE])
470
736
return args, opts
475
739
def _match_argform(cmd, takes_args, args):
540
821
os.remove(pfname)
824
def exception_to_return_code(the_callable, *args, **kwargs):
825
"""UI level helper for profiling and coverage.
827
This transforms exceptions into a return value of 3. As such its only
828
relevant to the UI layer, and should never be called where catching
829
exceptions may be desirable.
832
return the_callable(*args, **kwargs)
833
except (KeyboardInterrupt, Exception), e:
834
# used to handle AssertionError and KeyboardInterrupt
835
# specially here, but hopefully they're handled ok by the logger now
836
exc_info = sys.exc_info()
837
exitcode = trace.report_exception(exc_info, sys.stderr)
838
if os.environ.get('BZR_PDB'):
839
print '**** entering debugger'
842
if sys.version_info[:2] < (2, 6):
844
# pdb.post_mortem(tb)
845
# but because pdb.post_mortem gives bad results for tracebacks
846
# from inside generators, we do it manually.
847
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
849
# Setup pdb on the traceback
852
p.setup(tb.tb_frame, tb)
853
# Point the debugger at the deepest frame of the stack
854
p.curindex = len(p.stack) - 1
855
p.curframe = p.stack[p.curindex][0]
856
# Start the pdb prompt.
857
p.print_stack_entry(p.stack[p.curindex])
865
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
866
from bzrlib.lsprof import profile
867
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
873
trace.note('Profile data written to "%s".', filename)
877
def get_alias(cmd, config=None):
878
"""Return an expanded alias, or None if no alias exists.
881
Command to be checked for an alias.
883
Used to specify an alternative config to use,
884
which is especially useful for testing.
885
If it is unspecified, the global config will be used.
889
config = bzrlib.config.GlobalConfig()
890
alias = config.get_alias(cmd)
892
return cmdline.split(alias)
543
896
def run_bzr(argv):
544
897
"""Execute a command.
546
This is similar to main(), but without all the trappings for
547
logging and error handling.
550
900
The command-line arguments, without the program name from argv[0]
901
These should already be decoded. All library/test code calling
902
run_bzr should be passing valid strings (don't need decoding).
552
904
Returns a command status or raises an exception.
554
906
Special master options: these must come before the command because
558
910
Do not load plugin modules at all
561
916
Only use builtin commands. (Plugins are still allowed to change
562
917
other behaviour.)
565
Run under the Python profiler.
920
Run under the Python hotshot profiler.
923
Run under the Python lsprof profiler.
926
Generate line coverage report in the specified directory.
929
Specify the number of processes that can be run concurrently (selftest).
567
# Load all of the transport methods
568
import bzrlib.transport.local, bzrlib.transport.http
570
argv = [a.decode(bzrlib.user_encoding) for a in argv]
931
trace.mutter("bazaar version: " + bzrlib.__version__)
933
trace.mutter("bzr arguments: %r", argv)
572
opt_profile = opt_no_plugins = opt_builtin = False
935
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
936
opt_no_aliases = False
937
opt_lsprof_file = opt_coverage_dir = None
574
939
# --no-plugins is handled specially at a very early stage. We need
575
940
# to load plugins before doing other command parsing so that they
576
941
# can override commands, but this needs to happen first.
579
947
if a == '--profile':
580
948
opt_profile = True
949
elif a == '--lsprof':
951
elif a == '--lsprof-file':
953
opt_lsprof_file = argv[i + 1]
581
955
elif a == '--no-plugins':
582
956
opt_no_plugins = True
957
elif a == '--no-aliases':
958
opt_no_aliases = True
583
959
elif a == '--builtin':
584
960
opt_builtin = True
589
if (not argv) or (argv[0] == '--help'):
590
from bzrlib.help import help
961
elif a == '--concurrency':
962
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
964
elif a == '--coverage':
965
opt_coverage_dir = argv[i + 1]
967
elif a.startswith('-D'):
968
debug.debug_flags.add(a[2:])
973
debug.set_debug_flags_from_config()
977
from bzrlib.builtins import cmd_help
978
cmd_help().run_argv_aliases([])
597
981
if argv[0] == '--version':
598
from bzrlib.builtins import show_version
982
from bzrlib.builtins import cmd_version
983
cmd_version().run_argv_aliases([])
602
986
if not opt_no_plugins:
603
987
from bzrlib.plugin import load_plugins
606
cmd = str(argv.pop(0))
990
from bzrlib.plugin import disable_plugins
995
if not opt_no_aliases:
996
alias_argv = get_alias(argv[0])
998
user_encoding = osutils.get_user_encoding()
999
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1000
argv[0] = alias_argv.pop(0)
1003
# We want only 'ascii' command names, but the user may have typed
1004
# in a Unicode name. In that case, they should just get a
1005
# 'command not found' error later.
608
1007
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
611
ret = apply_profiled(cmd_obj.run_argv, argv)
1008
run = cmd_obj.run_argv_aliases
1009
run_argv = [argv, alias_argv]
1012
# We can be called recursively (tests for example), but we don't want
1013
# the verbosity level to propagate.
1014
saved_verbosity_level = option._verbosity_level
1015
option._verbosity_level = 0
1017
if opt_coverage_dir:
1019
'--coverage ignored, because --lsprof is in use.')
1020
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1022
if opt_coverage_dir:
1024
'--coverage ignored, because --profile is in use.')
1025
ret = apply_profiled(run, *run_argv)
1026
elif opt_coverage_dir:
1027
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1029
ret = run(*run_argv)
1032
# reset, in case we may do other commands later within the same
1033
# process. Commands that want to execute sub-commands must propagate
1034
# --verbose in their own way.
1035
if 'memory' in debug.debug_flags:
1036
trace.debug_memory('Process status after command:', short=False)
1037
option._verbosity_level = saved_verbosity_level
1040
def display_command(func):
1041
"""Decorator that suppresses pipe/interrupt errors."""
1042
def ignore_pipe(*args, **kwargs):
1044
result = func(*args, **kwargs)
1048
if getattr(e, 'errno', None) is None:
1050
if e.errno != errno.EPIPE:
1051
# Win32 raises IOError with errno=0 on a broken pipe
1052
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1055
except KeyboardInterrupt:
1060
def install_bzr_command_hooks():
1061
"""Install the hooks to supply bzr's own commands."""
1062
if _list_bzr_commands in Command.hooks["list_commands"]:
1064
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1066
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1068
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1069
"bzr plugin commands")
1070
Command.hooks.install_named_hook("get_command", _get_external_command,
1071
"bzr external command lookup")
1072
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1073
"bzr plugin-provider-db check")
1077
def _specified_or_unicode_argv(argv):
1078
# For internal or testing use, argv can be passed. Otherwise, get it from
1079
# the process arguments in a unicode-safe way.
1081
return osutils.get_unicode_argv()
613
ret = cmd_obj.run_argv(argv)
619
bzrlib.trace.log_startup(argv)
620
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
622
return run_bzr_catch_errors(argv[1:])
1085
# ensure all arguments are unicode strings
1087
if isinstance(a, unicode):
1090
new_argv.append(a.decode('ascii'))
1091
except UnicodeDecodeError:
1092
raise errors.BzrError("argv should be list of unicode strings.")
1096
def main(argv=None):
1097
"""Main entry point of command-line interface.
1099
Typically `bzrlib.initialize` should be called first.
1101
:param argv: list of unicode command-line arguments similar to sys.argv.
1102
argv[0] is script name usually, it will be ignored.
1103
Don't pass here sys.argv because this list contains plain strings
1104
and not unicode; pass None instead.
1106
:return: exit code of bzr command.
1108
argv = _specified_or_unicode_argv(argv)
1109
ret = run_bzr_catch_errors(argv)
1110
bzrlib.ui.ui_factory.log_transport_activity(
1111
display=('bytes' in debug.debug_flags))
1112
trace.mutter("return code %d", ret)
625
1116
def run_bzr_catch_errors(argv):
1117
"""Run a bzr command with parameters as described by argv.
1119
This function assumed that that UI layer is setup, that symbol deprecations
1120
are already applied, and that unicode decoding has already been performed on argv.
1122
# done here so that they're covered for every test run
1123
install_bzr_command_hooks()
1124
return exception_to_return_code(run_bzr, argv)
1127
def run_bzr_catch_user_errors(argv):
1128
"""Run bzr and report user errors, but let internal errors propagate.
1130
This is used for the test suite, and might be useful for other programs
1131
that want to wrap the commandline interface.
1133
# done here so that they're covered for every test run
1134
install_bzr_command_hooks()
630
# do this here inside the exception wrappers to catch EPIPE
632
except BzrCommandError, e:
633
# command line syntax error, etc
637
bzrlib.trace.log_exception()
639
except AssertionError, e:
640
bzrlib.trace.log_exception('assertion failed: ' + str(e))
642
except KeyboardInterrupt, e:
643
bzrlib.trace.log_exception('interrupted')
1136
return run_bzr(argv)
645
1137
except Exception, e:
647
if (isinstance(e, IOError)
648
and hasattr(e, 'errno')
649
and e.errno == errno.EPIPE):
650
bzrlib.trace.note('broken pipe')
655
bzrlib.trace.log_exception()
658
if __name__ == '__main__':
659
sys.exit(main(sys.argv))
1138
if (isinstance(e, (OSError, IOError))
1139
or not getattr(e, 'internal_error', True)):
1140
trace.report_exception(sys.exc_info(), sys.stderr)
1146
class HelpCommandIndex(object):
1147
"""A index for bzr help that returns commands."""
1150
self.prefix = 'commands/'
1152
def get_topics(self, topic):
1153
"""Search for topic amongst commands.
1155
:param topic: A topic to search for.
1156
:return: A list which is either empty or contains a single
1159
if topic and topic.startswith(self.prefix):
1160
topic = topic[len(self.prefix):]
1162
cmd = _get_cmd_object(topic)
1169
class Provider(object):
1170
'''Generic class to be overriden by plugins'''
1172
def plugin_for_command(self, cmd_name):
1173
'''Takes a command and returns the information for that plugin
1175
:return: A dictionary with all the available information
1176
for the requested plugin
1178
raise NotImplementedError
1181
class ProvidersRegistry(registry.Registry):
1182
'''This registry exists to allow other providers to exist'''
1185
for key, provider in self.iteritems():
1188
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
