1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2004, 2005 by 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
18
23
# TODO: Define arguments by objects, rather than just using names.
19
24
# Those objects can specify the expected type of the argument, which
20
# would help with validation and shell completion. They could also provide
21
# help/explanation for that argument in a structured way.
23
# TODO: Specific "examples" property on commands for consistent formatting.
25
# would help with validation and shell completion.
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
33
31
from warnings import warn
32
from inspect import getdoc
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
151
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
154
Should generally be avoided in favor of lazy registration.
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
45
def register_command(cmd):
46
"Utility function to help register a command"
156
47
global plugin_cmds
157
return plugin_cmds.register(cmd, decorate)
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__])
160
61
def _squish_command_name(cmd):
164
65
def _unsquish_command_name(cmd):
66
assert cmd.startswith("cmd_")
165
67
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
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
75
It supports integers directly, but everything else it
76
defers for passing to Branch.get_revision_info()
78
>>> _parse_revision_str('234')
80
>>> _parse_revision_str('234..567')
82
>>> _parse_revision_str('..')
84
>>> _parse_revision_str('..234')
86
>>> _parse_revision_str('234..')
88
>>> _parse_revision_str('234..456..789') # Maybe this should be an error
90
>>> _parse_revision_str('234....789') # Error?
92
>>> _parse_revision_str('revid:test@other.com-234234')
93
['revid:test@other.com-234234']
94
>>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
95
['revid:test@other.com-234234', 'revid:test@other.com-234235']
96
>>> _parse_revision_str('revid:test@other.com-234234..23')
97
['revid:test@other.com-234234', 23]
98
>>> _parse_revision_str('date:2005-04-12')
100
>>> _parse_revision_str('date:2005-04-12 12:24:33')
101
['date:2005-04-12 12:24:33']
102
>>> _parse_revision_str('date:2005-04-12T12:24:33')
103
['date:2005-04-12T12:24:33']
104
>>> _parse_revision_str('date:2005-04-12,12:24:33')
105
['date:2005-04-12,12:24:33']
106
>>> _parse_revision_str('-5..23')
108
>>> _parse_revision_str('-5')
110
>>> _parse_revision_str('123a')
112
>>> _parse_revision_str('abc')
116
old_format_re = re.compile('\d*:\d*')
117
m = old_format_re.match(revstr)
119
warning('Colon separator for revision numbers is deprecated.'
122
for rev in revstr.split(':'):
124
revs.append(int(rev))
129
for x in revstr.split('..'):
140
def get_merge_type(typestring):
141
"""Attempt to find the merge class/factory associated with a string."""
142
from merge import merge_types
144
return merge_types[typestring][0]
146
templ = '%s%%7s: %%s' % (' '*12)
147
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
148
type_list = '\n'.join(lines)
149
msg = "No known merge type %s. Supported types are:\n%s" %\
150
(typestring, type_list)
151
raise BzrCommandError(msg)
154
def get_merge_type(typestring):
155
"""Attempt to find the merge class/factory associated with a string."""
156
from merge import merge_types
158
return merge_types[typestring][0]
160
templ = '%s%%7s: %%s' % (' '*12)
161
lines = [templ % (f[0], f[1][1]) for f in merge_types.iteritems()]
162
type_list = '\n'.join(lines)
163
msg = "No known merge type %s. Supported types are:\n%s" %\
164
(typestring, type_list)
165
raise BzrCommandError(msg)
169
168
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
169
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
171
builtins = bzrlib.builtins.__dict__
172
for name in builtins:
191
173
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
174
real_name = _unsquish_command_name(name)
175
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
180
def builtin_command_names():
220
"""Return list of builtin command names.
181
"""Return list of builtin command names."""
182
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
return builtin_command_registry.keys()
228
185
def plugin_command_names():
229
"""Returns command names from commands registered by plugins."""
230
186
return plugin_cmds.keys()
189
def _get_cmd_dict(plugins_override=True):
190
"""Return name->class mapping for all commands."""
191
d = _builtin_commands()
193
d.update(plugin_cmds)
197
def get_all_cmds(plugins_override=True):
198
"""Return canonical name and class for all registered commands."""
199
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
233
203
def get_cmd_object(cmd_name, plugins_override=True):
234
"""Return the command object for a command.
204
"""Return the canonical name and command class for a command.
237
207
If true, plugin commands can override builtins.
240
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
245
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
246
"""Get a command object.
248
:param cmd_name: The name of the command.
249
:param plugins_override: Allow plugins to override builtins.
250
:param check_missing: Look up commands not found in the regular index via
251
the get_missing_command hook.
252
:return: A Command object instance
253
:raises KeyError: If no command is found.
255
# We want only 'ascii' command names, but the user may have typed
256
# in a Unicode name. In that case, they should just get a
257
# 'command not found' error later.
258
# In the future, we may actually support Unicode command names.
261
for hook in Command.hooks['get_command']:
262
cmd = hook(cmd, cmd_name)
263
if cmd is not None and not plugins_override and not cmd.plugin_name():
264
# We've found a non-plugin command, don't permit it to be
267
if cmd is None and check_missing:
268
for hook in Command.hooks['get_missing_command']:
275
# Allow plugins to extend commands
276
for hook in Command.hooks['extend_command']:
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
323
from bzrlib.externalcommand import ExternalCommand
209
cmd_name = str(cmd_name) # not unicode
211
# first look up this command under the specified name
212
cmds = _get_cmd_dict(plugins_override=plugins_override)
214
return cmds[cmd_name]()
218
# look for any command which claims this as an alias
219
for real_cmd_name, cmd_class in cmds.iteritems():
220
if cmd_name in cmd_class.aliases:
324
223
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)()
227
raise BzrCommandError("unknown command %r" % cmd_name)
342
230
class Command(object):
364
252
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
256
List of options that may be given for this command.
381
259
If true, this command isn't advertised. This is typically
382
260
for commands intended for expert users.
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
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
399
:cvar hooks: An instance of CommandHooks.
403
265
takes_options = []
404
encoding_type = 'strict'
408
269
def __init__(self):
409
270
"""Construct an instance of this command."""
410
271
if self.__doc__ == Command.__doc__:
411
272
warn("No help message set for %r" % self)
412
# List of standard options directly supported
413
self.supported_std_options = []
416
def add_cleanup(self, cleanup_func, *args, **kwargs):
417
"""Register a function to call after self.run returns or raises.
419
Functions will be called in LIFO order.
421
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
423
def cleanup_now(self):
424
"""Execute and empty pending cleanup functions immediately.
426
After cleanup_now all registered cleanups are forgotten. add_cleanup
427
may be called again after cleanup_now; these cleanups will be called
428
after self.run returns or raises (or when cleanup_now is next called).
430
This is useful for releasing expensive or contentious resources (such
431
as write locks) before doing further work that does not require those
432
resources (such as writing results to self.outf). Note though, that
433
as it releases all resources, this may release locks that the command
434
wants to hold, so use should be done with care.
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
452
"""Return single-line grammar for this command.
454
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
457
for aname in self.takes_args:
458
aname = aname.upper()
459
if aname[-1] in ['$', '+']:
460
aname = aname[:-1] + '...'
461
elif aname[-1] == '?':
462
aname = '[' + aname[:-1] + ']'
463
elif aname[-1] == '*':
464
aname = '[' + aname[:-1] + '...]'
466
s = s[:-1] # remove last space
469
def get_help_text(self, additional_see_also=None, plain=True,
470
see_also_as_links=False, verbose=True):
471
"""Return a text string with help for this command.
473
:param additional_see_also: Additional help topics to be
475
:param plain: if False, raw help (reStructuredText) is
476
returned instead of plain text.
477
:param see_also_as_links: if True, convert items in 'See also'
478
list to internal links (used by bzr_man rstx generator)
479
:param verbose: if True, display the full help, otherwise
480
leave out the descriptive sections and just display
481
usage help (e.g. Purpose, Usage, Options) with a
482
message explaining how to obtain full help.
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
488
# Extract the summary (purpose) and sections out from the text
489
purpose,sections,order = self._get_help_parts(doc)
491
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
493
usage = sections.pop('Usage')
495
usage = self._usage()
497
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
500
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
503
result += ':Usage: %s\n' % usage
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
518
options = options.replace(' format:\n', ' format::\n\n', 1)
519
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
529
# Add the description, indenting it 2 spaces
530
# to match the indentation of the options
531
if sections.has_key(None):
532
text = sections.pop(None)
533
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
536
# Add the custom sections (e.g. Examples). Note that there's no need
537
# to indent these as they must be indented already in the source.
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
547
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
550
result += ', '.join(self.aliases) + '\n'
551
plugin_name = self.plugin_name()
552
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
554
see_also = self.get_see_also(additional_see_also)
556
if not plain and see_also_as_links:
558
for item in see_also:
560
# topics doesn't have an independent section
561
# so don't create a real link
562
see_also_links.append(item)
564
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
566
see_also_links.append(link_text)
567
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
571
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
578
def _get_help_parts(text):
579
"""Split help text into a summary and named sections.
581
:return: (summary,sections,order) where summary is the top line and
582
sections is a dictionary of the rest indexed by section name.
583
order is the order the section appear in the text.
584
A section starts with a heading line of the form ":xxx:".
585
Indented text on following lines is the section value.
586
All text found outside a named section is assigned to the
587
default section which is given the key of None.
589
def save_section(sections, order, label, section):
591
if sections.has_key(label):
592
sections[label] += '\n' + section
595
sections[label] = section
597
lines = text.rstrip().splitlines()
598
summary = lines.pop(0)
601
label,section = None,''
603
if line.startswith(':') and line.endswith(':') and len(line) > 2:
604
save_section(sections, order, label, section)
605
label,section = line[1:-1],''
606
elif (label is not None) and len(line) > 1 and not line[0].isspace():
607
save_section(sections, order, label, section)
608
label,section = None,line
611
section += '\n' + line
614
save_section(sections, order, label, section)
615
return summary, sections, order
617
def get_help_topic(self):
618
"""Return the commands help topic - its name."""
621
def get_see_also(self, additional_terms=None):
622
"""Return a list of help topics that are related to this command.
624
The list is derived from the content of the _see_also attribute. Any
625
duplicates are removed and the result is in lexical order.
626
:param additional_terms: Additional help topics to cross-reference.
627
:return: A list of help topics.
629
see_also = set(getattr(self, '_see_also', []))
631
see_also.update(additional_terms)
632
return sorted(see_also)
635
"""Return dict of valid options for this command.
637
Maps from long option name to option object."""
638
r = Option.STD_OPTIONS.copy()
640
for o in self.takes_options:
641
if isinstance(o, basestring):
642
o = option.Option.OPTIONS[o]
644
if o.name in std_names:
645
self.supported_std_options.append(o.name)
648
def _setup_outf(self):
649
"""Return a file linked to stdout, which has proper encoding."""
650
self.outf = ui.ui_factory.make_output_stream(
651
encoding_type=self.encoding_type)
653
def run_argv_aliases(self, argv, alias_argv=None):
654
"""Parse the command line and run with extra aliases in alias_argv."""
655
args, opts = parse_args(self, argv, alias_argv)
657
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
664
trace.set_verbosity_level(option._verbosity_level)
665
if 'verbose' in self.supported_std_options:
666
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
669
if 'quiet' in self.supported_std_options:
670
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
674
# mix arguments and options into one dictionary
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
677
for k, v in opts.items():
678
cmdopts[k.replace('-', '_')] = v
680
all_cmd_args = cmdargs.copy()
681
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
687
def _setup_run(self):
688
"""Wrap the defined run method on self with a cleanup.
690
This is called by __init__ to make the Command be able to be run
691
by just calling run(), as it could be before cleanups were added.
693
If a different form of cleanups are in use by your Command subclass,
694
you can override this method.
697
def run(*args, **kwargs):
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
return self._operation.run_simple(*args, **kwargs)
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
711
276
"""Actually run the command.
742
295
return _unsquish_command_name(self.__class__.__name__)
744
def plugin_name(self):
745
"""Get the name of the plugin that provides this command.
747
:return: The name of the plugin or None if the command is builtin.
749
mod_parts = self.__module__.split('.')
750
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
298
class ExternalCommand(Command):
299
"""Class to wrap external commands.
301
We cheat a little here, when get_cmd_class() calls us we actually
302
give it back an object we construct that has the appropriate path,
303
help, options etc for the specified command.
305
When run_bzr() tries to instantiate that 'class' it gets caught by
306
the __call__ method, which we override to call the Command.__init__
307
method. That then calls our run method which is pretty straight
310
The only wrinkle is that we have to map bzr's dictionary of options
311
and arguments back into command line options and arguments for the
315
def find_command(cls, cmd):
317
bzrpath = os.environ.get('BZRPATH', '')
319
for dir in bzrpath.split(os.pathsep):
320
path = os.path.join(dir, cmd)
321
if os.path.isfile(path):
322
return ExternalCommand(path)
326
find_command = classmethod(find_command)
328
def __init__(self, path):
331
pipe = os.popen('%s --bzr-usage' % path, 'r')
332
self.takes_options = pipe.readline().split()
334
for opt in self.takes_options:
335
if not opt in OPTIONS:
336
raise BzrError("Unknown option '%s' returned by external command %s"
339
# TODO: Is there any way to check takes_args is valid here?
340
self.takes_args = pipe.readline().split()
342
if pipe.close() is not None:
343
raise BzrError("Failed funning '%s --bzr-usage'" % path)
345
pipe = os.popen('%s --bzr-help' % path, 'r')
346
self.__doc__ = pipe.read()
347
if pipe.close() is not None:
348
raise BzrError("Failed funning '%s --bzr-help'" % path)
350
def __call__(self, options, arguments):
351
Command.__init__(self, options, arguments)
355
raise NotImplementedError()
357
def run(self, **kargs):
358
raise NotImplementedError()
366
optname = name.replace('_','-')
368
if OPTIONS.has_key(optname):
370
opts.append('--%s' % optname)
371
if value is not None and value is not True:
372
opts.append(str(value))
374
# it's an arg, or arg list
375
if type(value) is not list:
381
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
386
def parse_spec(spec):
392
>>> parse_spec("../@")
394
>>> parse_spec("../f/@35")
396
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
397
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
402
parsed = spec.split('/@')
403
assert len(parsed) == 2
756
class CommandHooks(Hooks):
757
"""Hooks related to Command object creation/enumeration."""
760
"""Create the default hooks.
762
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
"Called after creating a command object to allow modifications "
768
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
771
"Called when creating a single command. Called with "
772
"(cmd_or_None, command_name). get_command should either return "
773
"the cmd_or_None parameter, or a replacement Command object that "
774
"should be used for the command. Note that the Command.hooks "
775
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
779
"Called when creating a single command if no command could be "
780
"found. Called with (command_name). get_missing_command should "
781
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
784
"Called when enumerating commands. Called with a set of "
785
"cmd_name strings for all the commands found so far. This set "
786
" is safe to mutate - e.g. to remove a command. "
787
"list_commands should return the updated set of command names.",
790
Command.hooks = CommandHooks()
793
def parse_args(command, argv, alias_argv=None):
408
parsed[1] = int(parsed[1])
410
pass # We can allow stuff like ./@revid:blahblahblah
414
parsed = [spec, None]
420
# list of all available options; the rhs can be either None for an
421
# option that takes no argument, or a constructor function that checks
434
'revision': _parse_revision_str,
446
'merge-type': get_merge_type,
460
def parse_args(argv):
794
461
"""Parse command line.
796
463
Arguments and options are parsed at this level before being passed
797
464
down to specific command handlers. This routine knows, from a
798
465
lookup table, something about the available options, what optargs
799
466
they take, and which commands will accept them.
468
>>> parse_args('--help'.split())
470
>>> parse_args('help -- --invalidcmd'.split())
471
(['help', '--invalidcmd'], {})
472
>>> parse_args('--version'.split())
473
([], {'version': True})
474
>>> parse_args('status --all'.split())
475
(['status'], {'all': True})
476
>>> parse_args('commit --message=biter'.split())
477
(['commit'], {'message': u'biter'})
478
>>> parse_args('log -r 500'.split())
479
(['log'], {'revision': [500]})
480
>>> parse_args('log -r500..600'.split())
481
(['log'], {'revision': [500, 600]})
482
>>> parse_args('log -vr500..600'.split())
483
(['log'], {'verbose': True, 'revision': [500, 600]})
484
>>> parse_args('log -rv500..600'.split()) #the r takes an argument
485
(['log'], {'revision': ['v500', 600]})
801
# TODO: make it a method of the Command?
802
parser = option.get_optparser(command.options())
803
if alias_argv is not None:
804
args = alias_argv + argv
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
493
if not argsover and a[0] == '-':
494
# option names must not be unicode
499
# We've received a standalone -- No more flags
502
mutter(" got option %r" % a)
504
optname, optarg = a[2:].split('=', 1)
507
if optname not in OPTIONS:
508
raise BzrError('unknown long option %r' % a)
511
if shortopt in SHORT_OPTIONS:
512
# Multi-character options must have a space to delimit
514
optname = SHORT_OPTIONS[shortopt]
516
# Single character short options, can be chained,
517
# and have their value appended to their name
519
if shortopt not in SHORT_OPTIONS:
520
# We didn't find the multi-character name, and we
521
# didn't find the single char name
522
raise BzrError('unknown short option %r' % a)
523
optname = SHORT_OPTIONS[shortopt]
526
# There are extra things on this option
527
# see if it is the value, or if it is another
529
optargfn = OPTIONS[optname]
531
# This option does not take an argument, so the
532
# next entry is another short option, pack it back
534
argv.insert(0, '-' + a[2:])
536
# This option takes an argument, so pack it
541
# XXX: Do we ever want to support this, e.g. for -r?
542
raise BzrError('repeated option %r' % a)
544
optargfn = OPTIONS[optname]
548
raise BzrError('option %r needs an argument' % a)
551
opts[optname] = optargfn(optarg)
554
raise BzrError('option %r takes no argument' % optname)
811
559
return args, opts
814
564
def _match_argform(cmd, takes_args, args):
828
578
argdict[argname + '_list'] = None
829
579
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
581
raise BzrCommandError("command %r needs one or more %s"
582
% (cmd, argname.upper()))
834
584
argdict[argname + '_list'] = args[:]
836
586
elif ap[-1] == '$': # all but one
837
587
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
588
raise BzrCommandError("command %r needs one or more %s"
589
% (cmd, argname.upper()))
840
590
argdict[argname + '_list'] = args[:-1]
843
593
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
596
raise BzrCommandError("command %r requires argument %s"
597
% (cmd, argname.upper()))
849
599
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
602
raise BzrCommandError("extra argument to command %s: %s"
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
859
# the standard library's trace.
860
trace = __import__('trace')
862
tracer = trace.Trace(count=1, trace=0)
863
sys.settrace(tracer.globaltrace)
864
threading.settrace(tracer.globaltrace)
867
return exception_to_return_code(the_callable, *args, **kwargs)
870
results = tracer.results()
871
results.write_results(show_missing=1, summary=False,
875
609
def apply_profiled(the_callable, *args, **kwargs):
879
612
pffileno, pfname = tempfile.mkstemp()
881
614
prof = hotshot.Profile(pfname)
883
ret = prof.runcall(exception_to_return_code, the_callable, *args,
616
ret = prof.runcall(the_callable, *args, **kwargs) or 0
887
621
stats = hotshot.stats.load(pfname)
889
stats.sort_stats('cum') # 'time'
623
stats.sort_stats('time')
890
624
## XXX: Might like to write to stderr or the trace file instead but
891
625
## print_stats seems hardcoded to stdout
892
626
stats.print_stats(20)
895
630
os.close(pffileno)
896
631
os.remove(pfname)
899
def exception_to_return_code(the_callable, *args, **kwargs):
900
"""UI level helper for profiling and coverage.
902
This transforms exceptions into a return value of 3. As such its only
903
relevant to the UI layer, and should never be called where catching
904
exceptions may be desirable.
907
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
909
# used to handle AssertionError and KeyboardInterrupt
910
# specially here, but hopefully they're handled ok by the logger now
911
exc_info = sys.exc_info()
912
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
948
trace.note('Profile data written to "%s".', filename)
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
957
def get_alias(cmd, config=None):
958
"""Return an expanded alias, or None if no alias exists.
961
Command to be checked for an alias.
963
Used to specify an alternative config to use,
964
which is especially useful for testing.
965
If it is unspecified, the global config will be used.
969
config = bzrlib.config.GlobalConfig()
970
alias = config.get_alias(cmd)
972
return cmdline.split(alias)
976
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
977
635
"""Execute a command.
979
:param argv: The command-line arguments, without the program name from
980
argv[0] These should already be decoded. All library/test code calling
981
run_bzr should be passing valid strings (don't need decoding).
982
:param load_plugins: What function to call when triggering plugin loading.
983
This function should take no arguments and cause all plugins to be
985
:param disable_plugins: What function to call when disabling plugin
986
loading. This function should take no arguments and cause all plugin
987
loading to be prohibited (so that code paths in your application that
988
know about some plugins possibly being present will fail to import
989
those plugins even if they are installed.)
990
:return: Returns a command exit code or raises an exception.
637
This is similar to main(), but without all the trappings for
638
logging and error handling.
641
The command-line arguments, without the program name from argv[0]
643
Returns a command status or raises an exception.
992
645
Special master options: these must come before the command because
993
646
they control how the command is interpreted.
996
649
Do not load plugin modules at all
1002
652
Only use builtin commands. (Plugins are still allowed to change
1003
653
other behaviour.)
1006
Run under the Python hotshot profiler.
1009
Run under the Python lsprof profiler.
1012
Generate line coverage report in the specified directory.
1015
Specify the number of processes that can be run concurrently (selftest).
656
Run under the Python profiler.
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
659
argv = [a.decode(bzrlib.user_encoding) for a in argv]
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof_file = opt_coverage_dir = None
661
opt_profile = opt_no_plugins = opt_builtin = False
1025
663
# --no-plugins is handled specially at a very early stage. We need
1026
664
# to load plugins before doing other command parsing so that they
1027
665
# can override commands, but this needs to happen first.
1031
while i < len(argv):
1033
668
if a == '--profile':
1034
669
opt_profile = True
1035
elif a == '--lsprof':
1037
elif a == '--lsprof-file':
1039
opt_lsprof_file = argv[i + 1]
1041
670
elif a == '--no-plugins':
1042
671
opt_no_plugins = True
1043
elif a == '--no-aliases':
1044
opt_no_aliases = True
1045
672
elif a == '--builtin':
1046
673
opt_builtin = True
1047
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1050
elif a == '--coverage':
1051
opt_coverage_dir = argv[i + 1]
1053
elif a.startswith('-D'):
1054
debug.debug_flags.add(a[2:])
1059
debug.set_debug_flags_from_config()
1061
678
if not opt_no_plugins:
679
from bzrlib.plugin import load_plugins
1068
get_cmd_object('help').run_argv_aliases([])
1071
if argv[0] == '--version':
1072
get_cmd_object('version').run_argv_aliases([])
1077
if not opt_no_aliases:
1078
alias_argv = get_alias(argv[0])
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1082
argv[0] = alias_argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
682
args, opts = parse_args(argv)
685
from bzrlib.help import help
692
if 'version' in opts:
693
from bzrlib.builtins import show_version
698
from bzrlib.help import help
702
cmd = str(args.pop(0))
1089
704
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1090
run = cmd_obj.run_argv_aliases
1091
run_argv = [argv, alias_argv]
706
# check options are reasonable
707
allowed = cmd_obj.takes_options
709
if oname not in allowed:
710
raise BzrCommandError("option '--%s' is not allowed for command %r"
713
# mix arguments and options into one dictionary
714
cmdargs = _match_argform(cmd, cmd_obj.takes_args, args)
716
for k, v in opts.items():
717
cmdopts[k.replace('-', '_')] = v
719
all_cmd_args = cmdargs.copy()
720
all_cmd_args.update(cmdopts)
723
ret = apply_profiled(cmd_obj.run, **all_cmd_args)
725
ret = cmd_obj.run(**all_cmd_args)
734
bzrlib.trace.log_startup(argv)
735
bzrlib.ui.ui_factory = bzrlib.ui.TextUIFactory()
1094
# We can be called recursively (tests for example), but we don't want
1095
# the verbosity level to propagate.
1096
saved_verbosity_level = option._verbosity_level
1097
option._verbosity_level = 0
1099
if opt_coverage_dir:
1101
'--coverage ignored, because --lsprof is in use.')
1102
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1104
if opt_coverage_dir:
1106
'--coverage ignored, because --profile is in use.')
1107
ret = apply_profiled(run, *run_argv)
1108
elif opt_coverage_dir:
1109
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1111
ret = run(*run_argv)
1114
# reset, in case we may do other commands later within the same
1115
# process. Commands that want to execute sub-commands must propagate
1116
# --verbose in their own way.
1117
if 'memory' in debug.debug_flags:
1118
trace.debug_memory('Process status after command:', short=False)
1119
option._verbosity_level = saved_verbosity_level
1122
def display_command(func):
1123
"""Decorator that suppresses pipe/interrupt errors."""
1124
def ignore_pipe(*args, **kwargs):
1126
result = func(*args, **kwargs)
739
return run_bzr(argv[1:])
741
# do this here inside the exception wrappers to catch EPIPE
1127
742
sys.stdout.flush()
1130
if getattr(e, 'errno', None) is None:
1132
if e.errno != errno.EPIPE:
1133
# Win32 raises IOError with errno=0 on a broken pipe
1134
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1137
except KeyboardInterrupt:
1142
def install_bzr_command_hooks():
1143
"""Install the hooks to supply bzr's own commands."""
1144
if _list_bzr_commands in Command.hooks["list_commands"]:
1146
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1148
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1150
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1151
"bzr plugin commands")
1152
Command.hooks.install_named_hook("get_command", _get_external_command,
1153
"bzr external command lookup")
1154
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1155
"bzr plugin-provider-db check")
1159
def _specified_or_unicode_argv(argv):
1160
# For internal or testing use, argv can be passed. Otherwise, get it from
1161
# the process arguments in a unicode-safe way.
1163
return osutils.get_unicode_argv()
1167
# ensure all arguments are unicode strings
1169
if isinstance(a, unicode):
1172
new_argv.append(a.decode('ascii'))
1173
except UnicodeDecodeError:
1174
raise errors.BzrError("argv should be list of unicode strings.")
1178
def main(argv=None):
1179
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
argv[0] is script name usually, it will be ignored.
1185
Don't pass here sys.argv because this list contains plain strings
1186
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1190
argv = _specified_or_unicode_argv(argv)
1191
_register_builtin_commands()
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
trace.mutter("return code %d", ret)
1199
def run_bzr_catch_errors(argv):
1200
"""Run a bzr command with parameters as described by argv.
1202
This function assumed that that UI layer is setup, that symbol deprecations
1203
are already applied, and that unicode decoding has already been performed on argv.
1205
# done here so that they're covered for every test run
1206
install_bzr_command_hooks()
1207
return exception_to_return_code(run_bzr, argv)
1210
def run_bzr_catch_user_errors(argv):
1211
"""Run bzr and report user errors, but let internal errors propagate.
1213
This is used for the test suite, and might be useful for other programs
1214
that want to wrap the commandline interface.
1216
# done here so that they're covered for every test run
1217
install_bzr_command_hooks()
1219
return run_bzr(argv)
743
except BzrCommandError, e:
744
# command line syntax error, etc
748
bzrlib.trace.log_exception()
750
except AssertionError, e:
751
bzrlib.trace.log_exception('assertion failed: ' + str(e))
753
except KeyboardInterrupt, e:
754
bzrlib.trace.note('interrupted')
1220
756
except Exception, e:
1221
if (isinstance(e, (OSError, IOError))
1222
or not getattr(e, 'internal_error', True)):
1223
trace.report_exception(sys.exc_info(), sys.stderr)
1229
class HelpCommandIndex(object):
1230
"""A index for bzr help that returns commands."""
1233
self.prefix = 'commands/'
1235
def get_topics(self, topic):
1236
"""Search for topic amongst commands.
1238
:param topic: A topic to search for.
1239
:return: A list which is either empty or contains a single
1242
if topic and topic.startswith(self.prefix):
1243
topic = topic[len(self.prefix):]
1245
cmd = _get_cmd_object(topic, check_missing=False)
1252
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1255
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1258
:return: A dictionary with all the available information
1259
for the requested plugin
1261
raise NotImplementedError
1264
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1268
for key, provider in self.iteritems():
1271
command_providers_registry = ProvidersRegistry()
758
if (isinstance(e, IOError)
759
and hasattr(e, 'errno')
760
and e.errno == errno.EPIPE):
761
bzrlib.trace.note('broken pipe')
764
bzrlib.trace.log_exception()
768
if __name__ == '__main__':
769
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
