1
# Copyright (C) 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
18
# TODO: probably should say which arguments are candidates for glob
19
# expansion on windows and do that at the command level.
21
# TODO: Define arguments by objects, rather than just using names.
22
# Those objects can specify the expected type of the argument, which
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(), """
38
from warnings import warn
52
from bzrlib.symbol_versioning import (
57
from bzrlib.option import Option
63
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
66
:param cmd: Command subclass to register
67
:param decorate: If true, allow overriding an existing command
68
of the same name; the old command is returned by this function.
69
Otherwise it is an error to try to override an existing command.
73
if k.startswith("cmd_"):
74
k_unsquished = _unsquish_command_name(k)
77
if k_unsquished not in plugin_cmds:
78
plugin_cmds[k_unsquished] = cmd
79
## trace.mutter('registered plugin command %s', k_unsquished)
80
if decorate and k_unsquished in builtin_command_names():
81
return _builtin_commands()[k_unsquished]
83
result = plugin_cmds[k_unsquished]
84
plugin_cmds[k_unsquished] = cmd
87
trace.log_error('Two plugins defined the same command: %r' % k)
88
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
89
trace.log_error('Previously this command was registered from %r' %
90
sys.modules[plugin_cmds[k_unsquished].__module__])
93
def _squish_command_name(cmd):
94
return 'cmd_' + cmd.replace('-', '_')
97
def _unsquish_command_name(cmd):
98
return cmd[4:].replace('_','-')
101
def _builtin_commands():
102
import bzrlib.builtins
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
106
if name.startswith("cmd_"):
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
112
def builtin_command_names():
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
117
def plugin_command_names():
118
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
135
def get_cmd_object(cmd_name, plugins_override=True):
136
"""Return the canonical name and command class for a command.
139
If true, plugin commands can override builtins.
142
return _get_cmd_object(cmd_name, plugins_override)
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
151
# We want only 'ascii' command names, but the user may have typed
152
# in a Unicode name. In that case, they should just get a
153
# 'command not found' error later.
154
# In the future, we may actually support Unicode command names.
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
163
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
168
cmd_obj = ExternalCommand.find_command(cmd_name)
172
# look for plugins that provide this command but aren't installed
173
for provider in command_providers_registry:
175
plugin_metadata = provider.plugin_for_command(cmd_name)
176
except errors.NoPluginAvailable:
179
raise errors.CommandAvailableInPlugin(cmd_name,
180
plugin_metadata, provider)
185
class Command(object):
186
"""Base class for commands.
188
Commands are the heart of the command-line bzr interface.
190
The command object mostly handles the mapping of command-line
191
parameters into one or more bzrlib operations, and of the results
194
Commands normally don't have any state. All their arguments are
195
passed in to the run method. (Subclasses may take a different
196
policy if the behaviour of the instance needs to depend on e.g. a
197
shell plugin and not just its Python class.)
199
The docstring for an actual command should give a single-line
200
summary, then a complete description of the command. A grammar
201
description will be inserted.
204
Other accepted names for this command.
207
List of argument forms, marked with whether they are optional,
212
['to_location', 'from_branch?', 'file*']
214
'to_location' is required
215
'from_branch' is optional
216
'file' can be specified 0 or more times
219
List of options that may be given for this command. These can
220
be either strings, referring to globally-defined options,
221
or option objects. Retrieve through options().
224
If true, this command isn't advertised. This is typically
225
for commands intended for expert users.
228
Command objects will get a 'outf' attribute, which has been
229
setup to properly handle encoding of unicode strings.
230
encoding_type determines what will happen when characters cannot
232
strict - abort if we cannot decode
233
replace - put in a bogus character (typically '?')
234
exact - do not encode sys.stdout
236
NOTE: by default on Windows, sys.stdout is opened as a text
237
stream, therefore LF line-endings are converted to CRLF.
238
When a command uses encoding_type = 'exact', then
239
sys.stdout is forced to be a binary stream, and line-endings
246
encoding_type = 'strict'
251
"""Construct an instance of this command."""
252
if self.__doc__ == Command.__doc__:
253
warn("No help message set for %r" % self)
254
# List of standard options directly supported
255
self.supported_std_options = []
257
def _maybe_expand_globs(self, file_list):
258
"""Glob expand file_list if the platform does not do that itself.
260
:return: A possibly empty list of unicode paths.
262
Introduced in bzrlib 0.18.
266
if sys.platform == 'win32':
267
file_list = win32utils.glob_expand(file_list)
268
return list(file_list)
271
"""Return single-line grammar for this command.
273
Only describes arguments, not options.
275
s = 'bzr ' + self.name() + ' '
276
for aname in self.takes_args:
277
aname = aname.upper()
278
if aname[-1] in ['$', '+']:
279
aname = aname[:-1] + '...'
280
elif aname[-1] == '?':
281
aname = '[' + aname[:-1] + ']'
282
elif aname[-1] == '*':
283
aname = '[' + aname[:-1] + '...]'
285
s = s[:-1] # remove last space
288
def get_help_text(self, additional_see_also=None, plain=True,
289
see_also_as_links=False):
290
"""Return a text string with help for this command.
292
:param additional_see_also: Additional help topics to be
294
:param plain: if False, raw help (reStructuredText) is
295
returned instead of plain text.
296
:param see_also_as_links: if True, convert items in 'See also'
297
list to internal links (used by bzr_man rstx generator)
301
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
303
# Extract the summary (purpose) and sections out from the text
304
purpose,sections = self._get_help_parts(doc)
306
# If a custom usage section was provided, use it
307
if sections.has_key('Usage'):
308
usage = sections.pop('Usage')
310
usage = self._usage()
312
# The header is the purpose and usage
314
result += ':Purpose: %s\n' % purpose
315
if usage.find('\n') >= 0:
316
result += ':Usage:\n%s\n' % usage
318
result += ':Usage: %s\n' % usage
322
options = option.get_optparser(self.options()).format_option_help()
323
if options.startswith('Options:'):
324
result += ':' + options
325
elif options.startswith('options:'):
326
# Python 2.4 version of optparse
327
result += ':Options:' + options[len('options:'):]
332
# Add the description, indenting it 2 spaces
333
# to match the indentation of the options
334
if sections.has_key(None):
335
text = sections.pop(None)
336
text = '\n '.join(text.splitlines())
337
result += ':%s:\n %s\n\n' % ('Description',text)
339
# Add the custom sections (e.g. Examples). Note that there's no need
340
# to indent these as they must be indented already in the source.
342
labels = sorted(sections.keys())
344
result += ':%s:\n%s\n\n' % (label,sections[label])
346
# Add the aliases, source (plug-in) and see also links, if any
348
result += ':Aliases: '
349
result += ', '.join(self.aliases) + '\n'
350
plugin_name = self.plugin_name()
351
if plugin_name is not None:
352
result += ':From: plugin "%s"\n' % plugin_name
353
see_also = self.get_see_also(additional_see_also)
355
if not plain and see_also_as_links:
357
for item in see_also:
359
# topics doesn't have an independent section
360
# so don't create a real link
361
see_also_links.append(item)
363
# Use a reST link for this entry
364
see_also_links.append("`%s`_" % (item,))
365
see_also = see_also_links
366
result += ':See also: '
367
result += ', '.join(see_also) + '\n'
369
# If this will be rendered as plan text, convert it
371
import bzrlib.help_topics
372
result = bzrlib.help_topics.help_as_plain_text(result)
376
def _get_help_parts(text):
377
"""Split help text into a summary and named sections.
379
:return: (summary,sections) where summary is the top line and
380
sections is a dictionary of the rest indexed by section name.
381
A section starts with a heading line of the form ":xxx:".
382
Indented text on following lines is the section value.
383
All text found outside a named section is assigned to the
384
default section which is given the key of None.
386
def save_section(sections, label, section):
388
if sections.has_key(label):
389
sections[label] += '\n' + section
391
sections[label] = section
393
lines = text.rstrip().splitlines()
394
summary = lines.pop(0)
396
label,section = None,''
398
if line.startswith(':') and line.endswith(':') and len(line) > 2:
399
save_section(sections, label, section)
400
label,section = line[1:-1],''
401
elif (label is not None) and len(line) > 1 and not line[0].isspace():
402
save_section(sections, label, section)
403
label,section = None,line
406
section += '\n' + line
409
save_section(sections, label, section)
410
return summary, sections
412
def get_help_topic(self):
413
"""Return the commands help topic - its name."""
416
def get_see_also(self, additional_terms=None):
417
"""Return a list of help topics that are related to this command.
419
The list is derived from the content of the _see_also attribute. Any
420
duplicates are removed and the result is in lexical order.
421
:param additional_terms: Additional help topics to cross-reference.
422
:return: A list of help topics.
424
see_also = set(getattr(self, '_see_also', []))
426
see_also.update(additional_terms)
427
return sorted(see_also)
430
"""Return dict of valid options for this command.
432
Maps from long option name to option object."""
433
r = Option.STD_OPTIONS.copy()
435
for o in self.takes_options:
436
if isinstance(o, basestring):
437
o = option.Option.OPTIONS[o]
439
if o.name in std_names:
440
self.supported_std_options.append(o.name)
443
def _setup_outf(self):
444
"""Return a file linked to stdout, which has proper encoding."""
445
# Originally I was using self.stdout, but that looks
446
# *way* too much like sys.stdout
447
if self.encoding_type == 'exact':
448
# force sys.stdout to be binary stream on win32
449
if sys.platform == 'win32':
450
fileno = getattr(sys.stdout, 'fileno', None)
453
msvcrt.setmode(fileno(), os.O_BINARY)
454
self.outf = sys.stdout
457
output_encoding = osutils.get_terminal_encoding()
459
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
460
errors=self.encoding_type)
461
# For whatever reason codecs.getwriter() does not advertise its encoding
462
# it just returns the encoding of the wrapped file, which is completely
463
# bogus. So set the attribute, so we can find the correct encoding later.
464
self.outf.encoding = output_encoding
466
def run_argv_aliases(self, argv, alias_argv=None):
467
"""Parse the command line and run with extra aliases in alias_argv."""
469
warn("Passing None for [] is deprecated from bzrlib 0.10",
470
DeprecationWarning, stacklevel=2)
472
args, opts = parse_args(self, argv, alias_argv)
474
# Process the standard options
475
if 'help' in opts: # e.g. bzr add --help
476
sys.stdout.write(self.get_help_text())
478
trace.set_verbosity_level(option._verbosity_level)
479
if 'verbose' in self.supported_std_options:
480
opts['verbose'] = trace.is_verbose()
481
elif opts.has_key('verbose'):
483
if 'quiet' in self.supported_std_options:
484
opts['quiet'] = trace.is_quiet()
485
elif opts.has_key('quiet'):
488
# mix arguments and options into one dictionary
489
cmdargs = _match_argform(self.name(), self.takes_args, args)
491
for k, v in opts.items():
492
cmdopts[k.replace('-', '_')] = v
494
all_cmd_args = cmdargs.copy()
495
all_cmd_args.update(cmdopts)
499
return self.run(**all_cmd_args)
502
"""Actually run the command.
504
This is invoked with the options and arguments bound to
507
Return 0 or None if the command was successful, or a non-zero
508
shell error code if not. It's OK for this method to allow
509
an exception to raise up.
511
raise NotImplementedError('no implementation of command %r'
515
"""Return help message for this class."""
516
from inspect import getdoc
517
if self.__doc__ is Command.__doc__:
522
return _unsquish_command_name(self.__class__.__name__)
524
def plugin_name(self):
525
"""Get the name of the plugin that provides this command.
527
:return: The name of the plugin or None if the command is builtin.
529
mod_parts = self.__module__.split('.')
530
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
536
def parse_args(command, argv, alias_argv=None):
537
"""Parse command line.
539
Arguments and options are parsed at this level before being passed
540
down to specific command handlers. This routine knows, from a
541
lookup table, something about the available options, what optargs
542
they take, and which commands will accept them.
544
# TODO: make it a method of the Command?
545
parser = option.get_optparser(command.options())
546
if alias_argv is not None:
547
args = alias_argv + argv
551
options, args = parser.parse_args(args)
552
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
553
v is not option.OptionParser.DEFAULT_VALUE])
557
def _match_argform(cmd, takes_args, args):
560
# step through args and takes_args, allowing appropriate 0-many matches
561
for ap in takes_args:
565
argdict[argname] = args.pop(0)
566
elif ap[-1] == '*': # all remaining arguments
568
argdict[argname + '_list'] = args[:]
571
argdict[argname + '_list'] = None
574
raise errors.BzrCommandError("command %r needs one or more %s"
575
% (cmd, argname.upper()))
577
argdict[argname + '_list'] = args[:]
579
elif ap[-1] == '$': # all but one
581
raise errors.BzrCommandError("command %r needs one or more %s"
582
% (cmd, argname.upper()))
583
argdict[argname + '_list'] = args[:-1]
589
raise errors.BzrCommandError("command %r requires argument %s"
590
% (cmd, argname.upper()))
592
argdict[argname] = args.pop(0)
595
raise errors.BzrCommandError("extra argument to command %s: %s"
600
def apply_coveraged(dirname, the_callable, *args, **kwargs):
601
# Cannot use "import trace", as that would import bzrlib.trace instead of
602
# the standard library's trace.
603
trace = __import__('trace')
605
tracer = trace.Trace(count=1, trace=0)
606
sys.settrace(tracer.globaltrace)
608
ret = the_callable(*args, **kwargs)
611
results = tracer.results()
612
results.write_results(show_missing=1, summary=False,
616
def apply_profiled(the_callable, *args, **kwargs):
620
pffileno, pfname = tempfile.mkstemp()
622
prof = hotshot.Profile(pfname)
624
ret = prof.runcall(the_callable, *args, **kwargs) or 0
627
stats = hotshot.stats.load(pfname)
629
stats.sort_stats('cum') # 'time'
630
## XXX: Might like to write to stderr or the trace file instead but
631
## print_stats seems hardcoded to stdout
632
stats.print_stats(20)
639
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
640
from bzrlib.lsprof import profile
641
ret, stats = profile(the_callable, *args, **kwargs)
647
trace.note('Profile data written to "%s".', filename)
651
def shlex_split_unicode(unsplit):
653
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
656
def get_alias(cmd, config=None):
657
"""Return an expanded alias, or None if no alias exists.
660
Command to be checked for an alias.
662
Used to specify an alternative config to use,
663
which is especially useful for testing.
664
If it is unspecified, the global config will be used.
668
config = bzrlib.config.GlobalConfig()
669
alias = config.get_alias(cmd)
671
return shlex_split_unicode(alias)
676
"""Execute a command.
678
This is similar to main(), but without all the trappings for
679
logging and error handling.
682
The command-line arguments, without the program name from argv[0]
683
These should already be decoded. All library/test code calling
684
run_bzr should be passing valid strings (don't need decoding).
686
Returns a command status or raises an exception.
688
Special master options: these must come before the command because
689
they control how the command is interpreted.
692
Do not load plugin modules at all
698
Only use builtin commands. (Plugins are still allowed to change
702
Run under the Python hotshot profiler.
705
Run under the Python lsprof profiler.
708
Generate line coverage report in the specified directory.
711
trace.mutter("bzr arguments: %r", argv)
713
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
714
opt_no_aliases = False
715
opt_lsprof_file = opt_coverage_dir = None
717
# --no-plugins is handled specially at a very early stage. We need
718
# to load plugins before doing other command parsing so that they
719
# can override commands, but this needs to happen first.
727
elif a == '--lsprof':
729
elif a == '--lsprof-file':
731
opt_lsprof_file = argv[i + 1]
733
elif a == '--no-plugins':
734
opt_no_plugins = True
735
elif a == '--no-aliases':
736
opt_no_aliases = True
737
elif a == '--builtin':
739
elif a == '--coverage':
740
opt_coverage_dir = argv[i + 1]
742
elif a.startswith('-D'):
743
debug.debug_flags.add(a[2:])
750
from bzrlib.builtins import cmd_help
751
cmd_help().run_argv_aliases([])
754
if argv[0] == '--version':
755
from bzrlib.builtins import cmd_version
756
cmd_version().run_argv_aliases([])
759
if not opt_no_plugins:
760
from bzrlib.plugin import load_plugins
763
from bzrlib.plugin import disable_plugins
768
if not opt_no_aliases:
769
alias_argv = get_alias(argv[0])
771
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
772
argv[0] = alias_argv.pop(0)
775
# We want only 'ascii' command names, but the user may have typed
776
# in a Unicode name. In that case, they should just get a
777
# 'command not found' error later.
779
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
780
run = cmd_obj.run_argv_aliases
781
run_argv = [argv, alias_argv]
787
'--coverage ignored, because --lsprof is in use.')
788
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
792
'--coverage ignored, because --profile is in use.')
793
ret = apply_profiled(run, *run_argv)
794
elif opt_coverage_dir:
795
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
800
# reset, in case we may do other commands later within the same process
801
option._verbosity_level = 0
803
def display_command(func):
804
"""Decorator that suppresses pipe/interrupt errors."""
805
def ignore_pipe(*args, **kwargs):
807
result = func(*args, **kwargs)
811
if getattr(e, 'errno', None) is None:
813
if e.errno != errno.EPIPE:
814
# Win32 raises IOError with errno=0 on a broken pipe
815
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
818
except KeyboardInterrupt:
825
from bzrlib.ui.text import TextUIFactory
826
bzrlib.ui.ui_factory = TextUIFactory()
828
# Is this a final release version? If so, we should suppress warnings
829
if bzrlib.version_info[3] == 'final':
830
from bzrlib import symbol_versioning
831
symbol_versioning.suppress_deprecation_warnings(override=False)
833
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
834
except UnicodeDecodeError:
835
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
837
ret = run_bzr_catch_errors(argv)
838
trace.mutter("return code %d", ret)
842
def run_bzr_catch_errors(argv):
843
# Note: The except clause logic below should be kept in sync with the
844
# profile() routine in lsprof.py.
847
except (KeyboardInterrupt, Exception), e:
848
# used to handle AssertionError and KeyboardInterrupt
849
# specially here, but hopefully they're handled ok by the logger now
850
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
851
if os.environ.get('BZR_PDB'):
852
print '**** entering debugger'
854
pdb.post_mortem(sys.exc_traceback)
858
def run_bzr_catch_user_errors(argv):
859
"""Run bzr and report user errors, but let internal errors propagate.
861
This is used for the test suite, and might be useful for other programs
862
that want to wrap the commandline interface.
867
if (isinstance(e, (OSError, IOError))
868
or not getattr(e, 'internal_error', True)):
869
trace.report_exception(sys.exc_info(), sys.stderr)
875
class HelpCommandIndex(object):
876
"""A index for bzr help that returns commands."""
879
self.prefix = 'commands/'
881
def get_topics(self, topic):
882
"""Search for topic amongst commands.
884
:param topic: A topic to search for.
885
:return: A list which is either empty or contains a single
888
if topic and topic.startswith(self.prefix):
889
topic = topic[len(self.prefix):]
891
cmd = _get_cmd_object(topic)
898
class Provider(object):
899
'''Generic class to be overriden by plugins'''
901
def plugin_for_command(self, cmd_name):
902
'''Takes a command and returns the information for that plugin
904
:return: A dictionary with all the available information
905
for the requested plugin
907
raise NotImplementedError
910
class ProvidersRegistry(registry.Registry):
911
'''This registry exists to allow other providers to exist'''
914
for key, provider in self.iteritems():
917
command_providers_registry = ProvidersRegistry()
920
if __name__ == '__main__':
921
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
