1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2006, 2008 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.
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?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
31
39
from warnings import warn
32
from inspect import getdoc
36
from bzrlib.trace import mutter, note, log_error, warning
37
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
38
from bzrlib.branch import find_branch
39
from bzrlib import BZRDIR
44
def register_command(cmd):
45
"Utility function to help register a command"
52
from bzrlib.hooks import HookPoint, Hooks
53
# Compatibility - Option used to be in commands.
54
from bzrlib.option import Option
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
59
suppress_deprecation_warnings,
63
class CommandInfo(object):
64
"""Information about a command."""
66
def __init__(self, aliases):
67
"""The list of aliases for the command."""
68
self.aliases = aliases
71
def from_command(klass, command):
72
"""Factory to construct a CommandInfo from a command."""
73
return klass(command.aliases)
76
class CommandRegistry(registry.Registry):
79
def _get_name(command_name):
80
if command_name.startswith("cmd_"):
81
return _unsquish_command_name(command_name)
85
def register(self, cmd, decorate=False):
86
"""Utility function to help register a command
88
:param cmd: Command subclass to register
89
:param decorate: If true, allow overriding an existing command
90
of the same name; the old command is returned by this function.
91
Otherwise it is an error to try to override an existing command.
94
k_unsquished = self._get_name(k)
96
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
99
info = CommandInfo.from_command(cmd)
101
registry.Registry.register(self, k_unsquished, cmd,
102
override_existing=decorate, info=info)
104
trace.log_error('Two plugins defined the same command: %r' % k)
105
trace.log_error('Not loading the one in %r' %
106
sys.modules[cmd.__module__])
107
trace.log_error('Previously this command was registered from %r' %
108
sys.modules[previous.__module__])
111
def register_lazy(self, command_name, aliases, module_name):
112
"""Register a command without loading its module.
114
:param command_name: The primary name of the command.
115
:param aliases: A list of aliases for the command.
116
:module_name: The module that the command lives in.
118
key = self._get_name(command_name)
119
registry.Registry.register_lazy(self, key, module_name, command_name,
120
info=CommandInfo(aliases))
123
plugin_cmds = CommandRegistry()
126
def register_command(cmd, decorate=False):
46
127
global plugin_cmds
48
if k.startswith("cmd_"):
49
k_unsquished = _unsquish_command_name(k)
52
if not plugin_cmds.has_key(k_unsquished):
53
plugin_cmds[k_unsquished] = cmd
54
mutter('registered plugin command %s', k_unsquished)
56
log_error('Two plugins defined the same command: %r' % k)
57
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
128
return plugin_cmds.register(cmd, decorate)
60
131
def _squish_command_name(cmd):
64
135
def _unsquish_command_name(cmd):
65
assert cmd.startswith("cmd_")
66
136
return cmd[4:].replace('_','-')
69
def _parse_revision_str(revstr):
70
"""This handles a revision string -> revno.
72
This always returns a list. The list will have one element for
74
It supports integers directly, but everything else it
75
defers for passing to Branch.get_revision_info()
77
>>> _parse_revision_str('234')
79
>>> _parse_revision_str('234..567')
81
>>> _parse_revision_str('..')
83
>>> _parse_revision_str('..234')
85
>>> _parse_revision_str('234..')
87
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
89
>>> _parse_revision_str('234....789') # Error?
91
>>> _parse_revision_str('revid:test@other.com-234234')
92
['revid:test@other.com-234234']
93
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
94
['revid:test@other.com-234234', 'revid:test@other.com-234235']
95
>>> _parse_revision_str('revid:test@other.com-234234..23')
96
['revid:test@other.com-234234', 23]
97
>>> _parse_revision_str('date:2005-04-12')
99
>>> _parse_revision_str('date:2005-04-12 12:24:33')
100
['date:2005-04-12 12:24:33']
101
>>> _parse_revision_str('date:2005-04-12T12:24:33')
102
['date:2005-04-12T12:24:33']
103
>>> _parse_revision_str('date:2005-04-12,12:24:33')
104
['date:2005-04-12,12:24:33']
105
>>> _parse_revision_str('-5..23')
107
>>> _parse_revision_str('-5')
109
>>> _parse_revision_str('123a')
111
>>> _parse_revision_str('abc')
115
old_format_re = re.compile('\d*:\d*')
116
m = old_format_re.match(revstr)
118
warning('Colon separator for revision numbers is deprecated.'
121
for rev in revstr.split(':'):
123
revs.append(int(rev))
128
for x in revstr.split('..'):
139
def get_merge_type(typestring):
140
"""Attempt to find the merge class/factory associated with a string."""
141
from merge import merge_types
143
return merge_types[typestring][0]
145
templ = '%s%%7s: %%s' % (' '*12)
146
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
147
type_list = '\n'.join(lines)
148
msg = "No known merge type %s. Supported types are:\n%s" %\
149
(typestring, type_list)
150
raise BzrCommandError(msg)
153
139
def _builtin_commands():
154
140
import bzrlib.builtins
141
return _scan_module_for_commands(bzrlib.builtins)
144
def _scan_module_for_commands(module):
156
builtins = bzrlib.builtins.__dict__
157
for name in builtins:
146
for name, obj in module.__dict__.iteritems():
158
147
if name.startswith("cmd_"):
159
real_name = _unsquish_command_name(name)
160
r[real_name] = builtins[name]
148
real_name = _unsquish_command_name(name)
153
def _list_bzr_commands(names):
154
"""Find commands from bzr's core and plugins."""
155
# to eliminate duplicates
156
names.update(builtin_command_names())
157
names.update(plugin_command_names())
161
def all_command_names():
162
"""Return a set of all command names."""
164
for hook in Command.hooks['list_commands']:
167
raise AssertionError(
168
'hook %s returned None' % Command.hooks.get_hook_name(hook))
165
172
def builtin_command_names():
166
"""Return list of builtin command names."""
173
"""Return list of builtin command names.
175
Use of all_command_names() is encouraged rather than builtin_command_names
176
and/or plugin_command_names.
167
178
return _builtin_commands().keys()
170
181
def plugin_command_names():
182
"""Returns command names from commands registered by plugins."""
171
183
return plugin_cmds.keys()
174
def _get_cmd_dict(plugins_override=True):
175
"""Return name->class mapping for all commands."""
186
@deprecated_function(deprecated_in((1, 17, 0)))
187
def get_all_cmds(plugins_override=False):
188
"""Return canonical name and class for most commands.
190
NB: This does not return all commands since the introduction of
191
command hooks, and returning the class is not sufficient to
192
get correctly setup commands, which is why it is deprecated.
194
Use 'all_command_names' + 'get_cmd_object' instead.
176
196
d = _builtin_commands()
177
197
if plugins_override:
178
d.update(plugin_cmds)
182
def get_all_cmds(plugins_override=True):
183
"""Return canonical name and class for all registered commands."""
184
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
198
d.update(plugin_cmds.iteritems())
199
for k, v in d.iteritems():
188
203
def get_cmd_object(cmd_name, plugins_override=True):
189
"""Return the canonical name and command class for a command.
204
"""Return the command object for a command.
192
207
If true, plugin commands can override builtins.
194
from bzrlib.externalcommand import ExternalCommand
196
cmd_name = str(cmd_name) # not unicode
198
# first look up this command under the specified name
199
cmds = _get_cmd_dict(plugins_override=plugins_override)
210
return _get_cmd_object(cmd_name, plugins_override)
212
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
215
def _get_cmd_object(cmd_name, plugins_override=True):
216
"""Get a command object.
218
:param cmd_name: The name of the command.
219
:param plugins_override: Allow plugins to override builtins.
220
:return: A Command object instance
221
:raises KeyError: If no command is found.
223
# We want only 'ascii' command names, but the user may have typed
224
# in a Unicode name. In that case, they should just get a
225
# 'command not found' error later.
226
# In the future, we may actually support Unicode command names.
229
for hook in Command.hooks['get_command']:
230
cmd = hook(cmd, cmd_name)
231
if cmd is not None and not plugins_override and not cmd.plugin_name():
232
# We've found a non-plugin command, don't permit it to be
236
for hook in Command.hooks['get_missing_command']:
243
# Allow plugins to extend commands
244
for hook in Command.hooks['extend_command']:
249
def _try_plugin_provider(cmd_name):
250
"""Probe for a plugin provider having cmd_name."""
252
plugin_metadata, provider = probe_for_provider(cmd_name)
253
raise errors.CommandAvailableInPlugin(cmd_name,
254
plugin_metadata, provider)
255
except errors.NoPluginAvailable:
259
def probe_for_provider(cmd_name):
260
"""Look for a provider for cmd_name.
262
:param cmd_name: The command name.
263
:return: plugin_metadata, provider for getting cmd_name.
264
:raises NoPluginAvailable: When no provider can supply the plugin.
266
# look for providers that provide this command but aren't installed
267
for provider in command_providers_registry:
269
return provider.plugin_for_command(cmd_name), provider
270
except errors.NoPluginAvailable:
272
raise errors.NoPluginAvailable(cmd_name)
275
def _get_bzr_command(cmd_or_None, cmd_name):
276
"""Get a command from bzr's core."""
277
cmds = _builtin_commands()
201
279
return cmds[cmd_name]()
205
282
# look for any command which claims this as an alias
206
283
for real_cmd_name, cmd_class in cmds.iteritems():
207
284
if cmd_name in cmd_class.aliases:
208
285
return cmd_class()
289
def _get_external_command(cmd_or_None, cmd_name):
290
"""Lookup a command that is a shell script."""
291
# Only do external command lookups when no command is found so far.
292
if cmd_or_None is not None:
294
from bzrlib.externalcommand import ExternalCommand
210
295
cmd_obj = ExternalCommand.find_command(cmd_name)
214
raise BzrCommandError("unknown command %r" % cmd_name)
300
def _get_plugin_command(cmd_or_None, cmd_name):
301
"""Get a command from bzr's plugins."""
303
return plugin_cmds.get(cmd_name)()
306
for key in plugin_cmds.keys():
307
info = plugin_cmds.get_info(key)
308
if cmd_name in info.aliases:
309
return plugin_cmds.get(key)()
217
313
class Command(object):
239
335
List of argument forms, marked with whether they are optional,
340
['to_location', 'from_branch?', 'file*']
342
'to_location' is required
343
'from_branch' is optional
344
'file' can be specified 0 or more times
243
List of options that may be given for this command.
347
List of options that may be given for this command. These can
348
be either strings, referring to globally-defined options,
349
or option objects. Retrieve through options().
246
352
If true, this command isn't advertised. This is typically
247
353
for commands intended for expert users.
356
Command objects will get a 'outf' attribute, which has been
357
setup to properly handle encoding of unicode strings.
358
encoding_type determines what will happen when characters cannot
360
strict - abort if we cannot decode
361
replace - put in a bogus character (typically '?')
362
exact - do not encode sys.stdout
364
NOTE: by default on Windows, sys.stdout is opened as a text
365
stream, therefore LF line-endings are converted to CRLF.
366
When a command uses encoding_type = 'exact', then
367
sys.stdout is forced to be a binary stream, and line-endings
370
:cvar hooks: An instance of CommandHooks.
252
374
takes_options = []
375
encoding_type = 'strict'
256
379
def __init__(self):
257
380
"""Construct an instance of this command."""
258
381
if self.__doc__ == Command.__doc__:
259
382
warn("No help message set for %r" % self)
262
def run_argv(self, argv):
263
"""Parse command line and run."""
264
args, opts = parse_args(argv)
383
# List of standard options directly supported
384
self.supported_std_options = []
386
def _maybe_expand_globs(self, file_list):
387
"""Glob expand file_list if the platform does not do that itself.
389
:return: A possibly empty list of unicode paths.
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
400
"""Return single-line grammar for this command.
402
Only describes arguments, not options.
404
s = 'bzr ' + self.name() + ' '
405
for aname in self.takes_args:
406
aname = aname.upper()
407
if aname[-1] in ['$', '+']:
408
aname = aname[:-1] + '...'
409
elif aname[-1] == '?':
410
aname = '[' + aname[:-1] + ']'
411
elif aname[-1] == '*':
412
aname = '[' + aname[:-1] + '...]'
414
s = s[:-1] # remove last space
417
def get_help_text(self, additional_see_also=None, plain=True,
418
see_also_as_links=False, verbose=True):
419
"""Return a text string with help for this command.
421
:param additional_see_also: Additional help topics to be
423
:param plain: if False, raw help (reStructuredText) is
424
returned instead of plain text.
425
:param see_also_as_links: if True, convert items in 'See also'
426
list to internal links (used by bzr_man rstx generator)
427
:param verbose: if True, display the full help, otherwise
428
leave out the descriptive sections and just display
429
usage help (e.g. Purpose, Usage, Options) with a
430
message explaining how to obtain full help.
434
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
436
# Extract the summary (purpose) and sections out from the text
437
purpose,sections,order = self._get_help_parts(doc)
439
# If a custom usage section was provided, use it
440
if sections.has_key('Usage'):
441
usage = sections.pop('Usage')
443
usage = self._usage()
445
# The header is the purpose and usage
447
result += ':Purpose: %s\n' % purpose
448
if usage.find('\n') >= 0:
449
result += ':Usage:\n%s\n' % usage
451
result += ':Usage: %s\n' % usage
455
options = option.get_optparser(self.options()).format_option_help()
456
if options.startswith('Options:'):
457
result += ':' + options
458
elif options.startswith('options:'):
459
# Python 2.4 version of optparse
460
result += ':Options:' + options[len('options:'):]
466
# Add the description, indenting it 2 spaces
467
# to match the indentation of the options
468
if sections.has_key(None):
469
text = sections.pop(None)
470
text = '\n '.join(text.splitlines())
471
result += ':%s:\n %s\n\n' % ('Description',text)
473
# Add the custom sections (e.g. Examples). Note that there's no need
474
# to indent these as they must be indented already in the source.
477
if sections.has_key(label):
478
result += ':%s:\n%s\n' % (label,sections[label])
481
result += ("See bzr help %s for more details and examples.\n\n"
484
# Add the aliases, source (plug-in) and see also links, if any
486
result += ':Aliases: '
487
result += ', '.join(self.aliases) + '\n'
488
plugin_name = self.plugin_name()
489
if plugin_name is not None:
490
result += ':From: plugin "%s"\n' % plugin_name
491
see_also = self.get_see_also(additional_see_also)
493
if not plain and see_also_as_links:
495
for item in see_also:
497
# topics doesn't have an independent section
498
# so don't create a real link
499
see_also_links.append(item)
501
# Use a reST link for this entry
502
see_also_links.append("`%s`_" % (item,))
503
see_also = see_also_links
504
result += ':See also: '
505
result += ', '.join(see_also) + '\n'
507
# If this will be rendered as plain text, convert it
509
import bzrlib.help_topics
510
result = bzrlib.help_topics.help_as_plain_text(result)
514
def _get_help_parts(text):
515
"""Split help text into a summary and named sections.
517
:return: (summary,sections,order) where summary is the top line and
518
sections is a dictionary of the rest indexed by section name.
519
order is the order the section appear in the text.
520
A section starts with a heading line of the form ":xxx:".
521
Indented text on following lines is the section value.
522
All text found outside a named section is assigned to the
523
default section which is given the key of None.
525
def save_section(sections, order, label, section):
527
if sections.has_key(label):
528
sections[label] += '\n' + section
531
sections[label] = section
533
lines = text.rstrip().splitlines()
534
summary = lines.pop(0)
537
label,section = None,''
539
if line.startswith(':') and line.endswith(':') and len(line) > 2:
540
save_section(sections, order, label, section)
541
label,section = line[1:-1],''
542
elif (label is not None) and len(line) > 1 and not line[0].isspace():
543
save_section(sections, order, label, section)
544
label,section = None,line
547
section += '\n' + line
550
save_section(sections, order, label, section)
551
return summary, sections, order
553
def get_help_topic(self):
554
"""Return the commands help topic - its name."""
557
def get_see_also(self, additional_terms=None):
558
"""Return a list of help topics that are related to this command.
560
The list is derived from the content of the _see_also attribute. Any
561
duplicates are removed and the result is in lexical order.
562
:param additional_terms: Additional help topics to cross-reference.
563
:return: A list of help topics.
565
see_also = set(getattr(self, '_see_also', []))
567
see_also.update(additional_terms)
568
return sorted(see_also)
571
"""Return dict of valid options for this command.
573
Maps from long option name to option object."""
574
r = Option.STD_OPTIONS.copy()
576
for o in self.takes_options:
577
if isinstance(o, basestring):
578
o = option.Option.OPTIONS[o]
580
if o.name in std_names:
581
self.supported_std_options.append(o.name)
584
def _setup_outf(self):
585
"""Return a file linked to stdout, which has proper encoding."""
586
# Originally I was using self.stdout, but that looks
587
# *way* too much like sys.stdout
588
if self.encoding_type == 'exact':
589
# force sys.stdout to be binary stream on win32
590
if sys.platform == 'win32':
591
fileno = getattr(sys.stdout, 'fileno', None)
594
msvcrt.setmode(fileno(), os.O_BINARY)
595
self.outf = sys.stdout
598
output_encoding = osutils.get_terminal_encoding()
600
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
601
errors=self.encoding_type)
602
# For whatever reason codecs.getwriter() does not advertise its encoding
603
# it just returns the encoding of the wrapped file, which is completely
604
# bogus. So set the attribute, so we can find the correct encoding later.
605
self.outf.encoding = output_encoding
607
def run_argv_aliases(self, argv, alias_argv=None):
608
"""Parse the command line and run with extra aliases in alias_argv."""
610
warn("Passing None for [] is deprecated from bzrlib 0.10",
611
DeprecationWarning, stacklevel=2)
613
args, opts = parse_args(self, argv, alias_argv)
615
# Process the standard options
266
616
if 'help' in opts: # e.g. bzr add --help
267
from bzrlib.help import help_on_command
268
help_on_command(self.name())
271
# check options are reasonable
272
allowed = self.takes_options
274
if oname not in allowed:
275
raise BzrCommandError("option '--%s' is not allowed for command %r"
276
% (oname, self.name()))
617
sys.stdout.write(self.get_help_text())
619
if 'usage' in opts: # e.g. bzr add --usage
620
sys.stdout.write(self.get_help_text(verbose=False))
622
trace.set_verbosity_level(option._verbosity_level)
623
if 'verbose' in self.supported_std_options:
624
opts['verbose'] = trace.is_verbose()
625
elif opts.has_key('verbose'):
627
if 'quiet' in self.supported_std_options:
628
opts['quiet'] = trace.is_quiet()
629
elif opts.has_key('quiet'):
278
632
# mix arguments and options into one dictionary
279
633
cmdargs = _match_argform(self.name(), self.takes_args, args)
310
666
return _unsquish_command_name(self.__class__.__name__)
668
def plugin_name(self):
669
"""Get the name of the plugin that provides this command.
313
def parse_spec(spec):
319
>>> parse_spec("../@")
321
>>> parse_spec("../f/@35")
323
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
324
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
329
parsed = spec.split('/@')
330
assert len(parsed) == 2
671
:return: The name of the plugin or None if the command is builtin.
673
mod_parts = self.__module__.split('.')
674
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
335
parsed[1] = int(parsed[1])
337
pass # We can allow stuff like ./@revid:blahblahblah
341
parsed = [spec, None]
347
# list of all available options; the rhs can be either None for an
348
# option that takes no argument, or a constructor function that checks
361
'revision': _parse_revision_str,
373
'merge-type': get_merge_type,
387
def parse_args(argv):
680
class CommandHooks(Hooks):
681
"""Hooks related to Command object creation/enumeration."""
684
"""Create the default hooks.
686
These are all empty initially, because by default nothing should get
690
self.create_hook(HookPoint('extend_command',
691
"Called after creating a command object to allow modifications "
692
"such as adding or removing options, docs etc. Called with the "
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
695
"Called when creating a single command. Called with "
696
"(cmd_or_None, command_name). get_command should either return "
697
"the cmd_or_None parameter, or a replacement Command object that "
698
"should be used for the command. Note that the Command.hooks "
699
"hooks are core infrastructure. Many users will prefer to use "
700
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
702
self.create_hook(HookPoint('get_missing_command',
703
"Called when creating a single command if no command could be "
704
"found. Called with (command_name). get_missing_command should "
705
"either return None, or a Command object to be used for the "
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
708
"Called when enumerating commands. Called with a set of "
709
"cmd_name strings for all the commands found so far. This set "
710
" is safe to mutate - e.g. to remove a command. "
711
"list_commands should return the updated set of command names.",
714
Command.hooks = CommandHooks()
717
def parse_args(command, argv, alias_argv=None):
388
718
"""Parse command line.
390
720
Arguments and options are parsed at this level before being passed
391
721
down to specific command handlers. This routine knows, from a
392
722
lookup table, something about the available options, what optargs
393
723
they take, and which commands will accept them.
395
>>> parse_args('--help'.split())
397
>>> parse_args('help -- --invalidcmd'.split())
398
(['help', '--invalidcmd'], {})
399
>>> parse_args('--version'.split())
400
([], {'version': True})
401
>>> parse_args('status --all'.split())
402
(['status'], {'all': True})
403
>>> parse_args('commit --message=biter'.split())
404
(['commit'], {'message': u'biter'})
405
>>> parse_args('log -r 500'.split())
406
(['log'], {'revision': [500]})
407
>>> parse_args('log -r500..600'.split())
408
(['log'], {'revision': [500, 600]})
409
>>> parse_args('log -vr500..600'.split())
410
(['log'], {'verbose': True, 'revision': [500, 600]})
411
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
412
(['log'], {'revision': ['v500', 600]})
420
if not argsover and a[0] == '-':
421
# option names must not be unicode
426
# We've received a standalone -- No more flags
429
mutter(" got option %r" % a)
431
optname, optarg = a[2:].split('=', 1)
434
if optname not in OPTIONS:
435
raise BzrError('unknown long option %r' % a)
438
if shortopt in SHORT_OPTIONS:
439
# Multi-character options must have a space to delimit
441
optname = SHORT_OPTIONS[shortopt]
443
# Single character short options, can be chained,
444
# and have their value appended to their name
446
if shortopt not in SHORT_OPTIONS:
447
# We didn't find the multi-character name, and we
448
# didn't find the single char name
449
raise BzrError('unknown short option %r' % a)
450
optname = SHORT_OPTIONS[shortopt]
453
# There are extra things on this option
454
# see if it is the value, or if it is another
456
optargfn = OPTIONS[optname]
458
# This option does not take an argument, so the
459
# next entry is another short option, pack it back
461
argv.insert(0, '-' + a[2:])
463
# This option takes an argument, so pack it
468
# XXX: Do we ever want to support this, e.g. for -r?
469
raise BzrError('repeated option %r' % a)
471
optargfn = OPTIONS[optname]
475
raise BzrError('option %r needs an argument' % a)
478
opts[optname] = optargfn(optarg)
481
raise BzrError('option %r takes no argument' % optname)
725
# TODO: make it a method of the Command?
726
parser = option.get_optparser(command.options())
727
if alias_argv is not None:
728
args = alias_argv + argv
732
options, args = parser.parse_args(args)
733
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
734
v is not option.OptionParser.DEFAULT_VALUE])
486
735
return args, opts
491
738
def _match_argform(cmd, takes_args, args):
505
752
argdict[argname + '_list'] = None
506
753
elif ap[-1] == '+':
508
raise BzrCommandError("command %r needs one or more %s"
509
% (cmd, argname.upper()))
755
raise errors.BzrCommandError("command %r needs one or more %s"
756
% (cmd, argname.upper()))
511
758
argdict[argname + '_list'] = args[:]
513
760
elif ap[-1] == '$': # all but one
514
761
if len(args) < 2:
515
raise BzrCommandError("command %r needs one or more %s"
516
% (cmd, argname.upper()))
762
raise errors.BzrCommandError("command %r needs one or more %s"
763
% (cmd, argname.upper()))
517
764
argdict[argname + '_list'] = args[:-1]
520
767
# just a plain arg
523
raise BzrCommandError("command %r requires argument %s"
524
% (cmd, argname.upper()))
770
raise errors.BzrCommandError("command %r requires argument %s"
771
% (cmd, argname.upper()))
526
773
argdict[argname] = args.pop(0)
529
raise BzrCommandError("extra argument to command %s: %s"
776
raise errors.BzrCommandError("extra argument to command %s: %s"
781
def apply_coveraged(dirname, the_callable, *args, **kwargs):
782
# Cannot use "import trace", as that would import bzrlib.trace instead of
783
# the standard library's trace.
784
trace = __import__('trace')
786
tracer = trace.Trace(count=1, trace=0)
787
sys.settrace(tracer.globaltrace)
788
threading.settrace(tracer.globaltrace)
791
return exception_to_return_code(the_callable, *args, **kwargs)
794
results = tracer.results()
795
results.write_results(show_missing=1, summary=False,
536
799
def apply_profiled(the_callable, *args, **kwargs):
539
803
pffileno, pfname = tempfile.mkstemp()
541
805
prof = hotshot.Profile(pfname)
543
ret = prof.runcall(the_callable, *args, **kwargs) or 0
807
ret = prof.runcall(exception_to_return_code, the_callable, *args,
548
811
stats = hotshot.stats.load(pfname)
550
stats.sort_stats('time')
813
stats.sort_stats('cum') # 'time'
551
814
## XXX: Might like to write to stderr or the trace file instead but
552
815
## print_stats seems hardcoded to stdout
553
816
stats.print_stats(20)
557
819
os.close(pffileno)
558
820
os.remove(pfname)
823
def exception_to_return_code(the_callable, *args, **kwargs):
824
"""UI level helper for profiling and coverage.
826
This transforms exceptions into a return value of 3. As such its only
827
relevant to the UI layer, and should never be called where catching
828
exceptions may be desirable.
831
return the_callable(*args, **kwargs)
832
except (KeyboardInterrupt, Exception), e:
833
# used to handle AssertionError and KeyboardInterrupt
834
# specially here, but hopefully they're handled ok by the logger now
835
exc_info = sys.exc_info()
836
exitcode = trace.report_exception(exc_info, sys.stderr)
837
if os.environ.get('BZR_PDB'):
838
print '**** entering debugger'
841
if sys.version_info[:2] < (2, 6):
843
# pdb.post_mortem(tb)
844
# but because pdb.post_mortem gives bad results for tracebacks
845
# from inside generators, we do it manually.
846
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
848
# Setup pdb on the traceback
851
p.setup(tb.tb_frame, tb)
852
# Point the debugger at the deepest frame of the stack
853
p.curindex = len(p.stack) - 1
854
p.curframe = p.stack[p.curindex][0]
855
# Start the pdb prompt.
856
p.print_stack_entry(p.stack[p.curindex])
864
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
865
from bzrlib.lsprof import profile
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
872
trace.note('Profile data written to "%s".', filename)
876
def shlex_split_unicode(unsplit):
878
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
881
def get_alias(cmd, config=None):
882
"""Return an expanded alias, or None if no alias exists.
885
Command to be checked for an alias.
887
Used to specify an alternative config to use,
888
which is especially useful for testing.
889
If it is unspecified, the global config will be used.
893
config = bzrlib.config.GlobalConfig()
894
alias = config.get_alias(cmd)
896
return shlex_split_unicode(alias)
561
900
def run_bzr(argv):
562
901
"""Execute a command.
564
This is similar to main(), but without all the trappings for
565
logging and error handling.
568
904
The command-line arguments, without the program name from argv[0]
905
These should already be decoded. All library/test code calling
906
run_bzr should be passing valid strings (don't need decoding).
570
908
Returns a command status or raises an exception.
572
910
Special master options: these must come before the command because
576
914
Do not load plugin modules at all
579
920
Only use builtin commands. (Plugins are still allowed to change
580
921
other behaviour.)
583
Run under the Python profiler.
924
Run under the Python hotshot profiler.
927
Run under the Python lsprof profiler.
930
Generate line coverage report in the specified directory.
586
argv = [a.decode(bzrlib.user_encoding) for a in argv]
933
trace.mutter("bzr arguments: %r", argv)
588
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
590
939
# --no-plugins is handled specially at a very early stage. We need
591
940
# to load plugins before doing other command parsing so that they
592
941
# can override commands, but this needs to happen first.
595
947
if a == '--profile':
596
948
opt_profile = True
949
elif a == '--lsprof':
951
elif a == '--lsprof-file':
953
opt_lsprof_file = argv[i + 1]
597
955
elif a == '--no-plugins':
598
956
opt_no_plugins = True
957
elif a == '--no-aliases':
958
opt_no_aliases = True
599
959
elif a == '--builtin':
600
960
opt_builtin = True
605
if (not argv) or (argv[0] == '--help'):
606
from bzrlib.help import help
961
elif a == '--coverage':
962
opt_coverage_dir = argv[i + 1]
964
elif a.startswith('-D'):
965
debug.debug_flags.add(a[2:])
970
debug.set_debug_flags_from_config()
974
from bzrlib.builtins import cmd_help
975
cmd_help().run_argv_aliases([])
613
978
if argv[0] == '--version':
614
from bzrlib.builtins import show_version
979
from bzrlib.builtins import cmd_version
980
cmd_version().run_argv_aliases([])
618
983
if not opt_no_plugins:
619
984
from bzrlib.plugin import load_plugins
622
cmd = str(argv.pop(0))
987
from bzrlib.plugin import disable_plugins
992
if not opt_no_aliases:
993
alias_argv = get_alias(argv[0])
995
user_encoding = osutils.get_user_encoding()
996
alias_argv = [a.decode(user_encoding) for a in alias_argv]
997
argv[0] = alias_argv.pop(0)
1000
# We want only 'ascii' command names, but the user may have typed
1001
# in a Unicode name. In that case, they should just get a
1002
# 'command not found' error later.
624
1004
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
627
ret = apply_profiled(cmd_obj.run_argv, argv)
629
ret = cmd_obj.run_argv(argv)
1005
run = cmd_obj.run_argv_aliases
1006
run_argv = [argv, alias_argv]
1009
# We can be called recursively (tests for example), but we don't want
1010
# the verbosity level to propagate.
1011
saved_verbosity_level = option._verbosity_level
1012
option._verbosity_level = 0
1014
if opt_coverage_dir:
1016
'--coverage ignored, because --lsprof is in use.')
1017
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1019
if opt_coverage_dir:
1021
'--coverage ignored, because --profile is in use.')
1022
ret = apply_profiled(run, *run_argv)
1023
elif opt_coverage_dir:
1024
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1026
ret = run(*run_argv)
1027
if 'memory' in debug.debug_flags:
1028
trace.debug_memory('Process status after command:', short=False)
1031
# reset, in case we may do other commands later within the same
1032
# process. Commands that want to execute sub-commands must propagate
1033
# --verbose in their own way.
1034
option._verbosity_level = saved_verbosity_level
1037
def display_command(func):
1038
"""Decorator that suppresses pipe/interrupt errors."""
1039
def ignore_pipe(*args, **kwargs):
1041
result = func(*args, **kwargs)
1045
if getattr(e, 'errno', None) is None:
1047
if e.errno != errno.EPIPE:
1048
# Win32 raises IOError with errno=0 on a broken pipe
1049
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1052
except KeyboardInterrupt:
1057
def install_bzr_command_hooks():
1058
"""Install the hooks to supply bzr's own commands."""
1059
if _list_bzr_commands in Command.hooks["list_commands"]:
1061
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1063
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1065
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1066
"bzr plugin commands")
1067
Command.hooks.install_named_hook("get_command", _get_external_command,
1068
"bzr external command lookup")
1069
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1070
"bzr plugin-provider-db check")
1073
def main(argv=None):
1074
"""Main entry point of command-line interface.
1076
:param argv: list of unicode command-line arguments similar to sys.argv.
1077
argv[0] is script name usually, it will be ignored.
1078
Don't pass here sys.argv because this list contains plain strings
1079
and not unicode; pass None instead.
1081
:return: exit code of bzr command.
634
1083
import bzrlib.ui
635
bzrlib.trace.log_startup(argv)
636
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1084
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1085
sys.stdin, sys.stdout, sys.stderr)
1087
# Is this a final release version? If so, we should suppress warnings
1088
if bzrlib.version_info[3] == 'final':
1089
suppress_deprecation_warnings(override=False)
1091
argv = osutils.get_unicode_argv()
1095
# ensure all arguments are unicode strings
1097
if isinstance(a, unicode):
1100
new_argv.append(a.decode('ascii'))
1101
except UnicodeDecodeError:
1102
raise errors.BzrError("argv should be list of unicode strings.")
1104
ret = run_bzr_catch_errors(argv)
1105
trace.mutter("return code %d", ret)
1109
def run_bzr_catch_errors(argv):
1110
"""Run a bzr command with parameters as described by argv.
1112
This function assumed that that UI layer is setup, that symbol deprecations
1113
are already applied, and that unicode decoding has already been performed on argv.
1115
install_bzr_command_hooks()
1116
return exception_to_return_code(run_bzr, argv)
1119
def run_bzr_catch_user_errors(argv):
1120
"""Run bzr and report user errors, but let internal errors propagate.
1122
This is used for the test suite, and might be useful for other programs
1123
that want to wrap the commandline interface.
1125
install_bzr_command_hooks()
640
return run_bzr(argv[1:])
642
# do this here inside the exception wrappers to catch EPIPE
644
except BzrCommandError, e:
645
# command line syntax error, etc
649
bzrlib.trace.log_exception()
651
except AssertionError, e:
652
bzrlib.trace.log_exception('assertion failed: ' + str(e))
654
except KeyboardInterrupt, e:
655
bzrlib.trace.note('interrupted')
1127
return run_bzr(argv)
657
1128
except Exception, e:
659
if (isinstance(e, IOError)
660
and hasattr(e, 'errno')
661
and e.errno == errno.EPIPE):
662
bzrlib.trace.note('broken pipe')
665
bzrlib.trace.log_exception()
1129
if (isinstance(e, (OSError, IOError))
1130
or not getattr(e, 'internal_error', True)):
1131
trace.report_exception(sys.exc_info(), sys.stderr)
1137
class HelpCommandIndex(object):
1138
"""A index for bzr help that returns commands."""
1141
self.prefix = 'commands/'
1143
def get_topics(self, topic):
1144
"""Search for topic amongst commands.
1146
:param topic: A topic to search for.
1147
:return: A list which is either empty or contains a single
1150
if topic and topic.startswith(self.prefix):
1151
topic = topic[len(self.prefix):]
1153
cmd = _get_cmd_object(topic)
1160
class Provider(object):
1161
'''Generic class to be overriden by plugins'''
1163
def plugin_for_command(self, cmd_name):
1164
'''Takes a command and returns the information for that plugin
1166
:return: A dictionary with all the available information
1167
for the requested plugin
1169
raise NotImplementedError
1172
class ProvidersRegistry(registry.Registry):
1173
'''This registry exists to allow other providers to exist'''
1176
for key, provider in self.iteritems():
1179
command_providers_registry = ProvidersRegistry()
669
1182
if __name__ == '__main__':
added
removed
bzrlib/commands.py
