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
51
from bzrlib.symbol_versioning import (
56
from bzrlib.option import Option
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
## trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
88
trace.log_error('Previously this command was registered from %r' %
89
sys.modules[plugin_cmds[k_unsquished].__module__])
92
def _squish_command_name(cmd):
93
return 'cmd_' + cmd.replace('-', '_')
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("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)
174
class Command(object):
175
"""Base class for commands.
177
Commands are the heart of the command-line bzr interface.
179
The command object mostly handles the mapping of command-line
180
parameters into one or more bzrlib operations, and of the results
183
Commands normally don't have any state. All their arguments are
184
passed in to the run method. (Subclasses may take a different
185
policy if the behaviour of the instance needs to depend on e.g. a
186
shell plugin and not just its Python class.)
188
The docstring for an actual command should give a single-line
189
summary, then a complete description of the command. A grammar
190
description will be inserted.
193
Other accepted names for this command.
196
List of argument forms, marked with whether they are optional,
201
['to_location', 'from_branch?', 'file*']
203
'to_location' is required
204
'from_branch' is optional
205
'file' can be specified 0 or more times
208
List of options that may be given for this command. These can
209
be either strings, referring to globally-defined options,
210
or option objects. Retrieve through options().
213
If true, this command isn't advertised. This is typically
214
for commands intended for expert users.
217
Command objects will get a 'outf' attribute, which has been
218
setup to properly handle encoding of unicode strings.
219
encoding_type determines what will happen when characters cannot
221
strict - abort if we cannot decode
222
replace - put in a bogus character (typically '?')
223
exact - do not encode sys.stdout
225
NOTE: by default on Windows, sys.stdout is opened as a text
226
stream, therefore LF line-endings are converted to CRLF.
227
When a command uses encoding_type = 'exact', then
228
sys.stdout is forced to be a binary stream, and line-endings
235
encoding_type = 'strict'
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
243
# List of standard options directly supported
244
self.supported_std_options = []
246
def _maybe_expand_globs(self, file_list):
247
"""Glob expand file_list if the platform does not do that itself.
249
:return: A possibly empty list of unicode paths.
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
260
"""Return single-line grammar for this command.
262
Only describes arguments, not options.
264
s = 'bzr ' + self.name() + ' '
265
for aname in self.takes_args:
266
aname = aname.upper()
267
if aname[-1] in ['$', '+']:
268
aname = aname[:-1] + '...'
269
elif aname[-1] == '?':
270
aname = '[' + aname[:-1] + ']'
271
elif aname[-1] == '*':
272
aname = '[' + aname[:-1] + '...]'
279
def get_help_text(self, additional_see_also=None, plain=True,
280
see_also_as_links=False):
281
"""Return a text string with help for this command.
283
:param additional_see_also: Additional help topics to be
285
:param plain: if False, raw help (reStructuredText) is
286
returned instead of plain text.
287
:param see_also_as_links: if True, convert items in 'See also'
288
list to internal links (used by bzr_man rstx generator)
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
294
# Extract the summary (purpose) and sections out from the text
295
purpose,sections = self._get_help_parts(doc)
297
# If a custom usage section was provided, use it
298
if sections.has_key('Usage'):
299
usage = sections.pop('Usage')
301
usage = self._usage()
303
# The header is the purpose and usage
305
result += ':Purpose: %s\n' % purpose
306
if usage.find('\n') >= 0:
307
result += ':Usage:\n%s\n' % usage
309
result += ':Usage: %s\n' % usage
313
options = option.get_optparser(self.options()).format_option_help()
314
if options.startswith('Options:'):
315
result += ':' + options
316
elif options.startswith('options:'):
317
# Python 2.4 version of optparse
318
result += ':Options:' + options[len('options:'):]
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
337
# Add the aliases, source (plug-in) and see also links, if any
339
result += ':Aliases: '
340
result += ', '.join(self.aliases) + '\n'
341
plugin_name = self.plugin_name()
342
if plugin_name is not None:
343
result += ':From: plugin "%s"\n' % plugin_name
344
see_also = self.get_see_also(additional_see_also)
346
if not plain and see_also_as_links:
348
for item in see_also:
350
# topics doesn't have an independent section
351
# so don't create a real link
352
see_also_links.append(item)
354
# Use a reST link for this entry
355
see_also_links.append("`%s`_" % (item,))
356
see_also = see_also_links
357
result += ':See also: '
358
result += ', '.join(see_also) + '\n'
360
# If this will be rendered as plan text, convert it
362
import bzrlib.help_topics
363
result = bzrlib.help_topics.help_as_plain_text(result)
367
def _get_help_parts(text):
368
"""Split help text into a summary and named sections.
370
:return: (summary,sections) where summary is the top line and
371
sections is a dictionary of the rest indexed by section name.
372
A section starts with a heading line of the form ":xxx:".
373
Indented text on following lines is the section value.
374
All text found outside a named section is assigned to the
375
default section which is given the key of None.
377
def save_section(sections, label, section):
379
if sections.has_key(label):
380
sections[label] += '\n' + section
382
sections[label] = section
384
lines = text.rstrip().splitlines()
385
summary = lines.pop(0)
387
label,section = None,''
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
390
save_section(sections, label, section)
391
label,section = line[1:-1],''
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
394
label,section = None,line
397
section += '\n' + line
400
save_section(sections, label, section)
401
return summary, sections
403
def get_help_topic(self):
404
"""Return the commands help topic - its name."""
407
def get_see_also(self, additional_terms=None):
408
"""Return a list of help topics that are related to this command.
410
The list is derived from the content of the _see_also attribute. Any
411
duplicates are removed and the result is in lexical order.
412
:param additional_terms: Additional help topics to cross-reference.
413
:return: A list of help topics.
415
see_also = set(getattr(self, '_see_also', []))
417
see_also.update(additional_terms)
418
return sorted(see_also)
421
"""Return dict of valid options for this command.
423
Maps from long option name to option object."""
424
r = Option.STD_OPTIONS.copy()
426
for o in self.takes_options:
427
if isinstance(o, basestring):
428
o = option.Option.OPTIONS[o]
430
if o.name in std_names:
431
self.supported_std_options.append(o.name)
434
def _setup_outf(self):
435
"""Return a file linked to stdout, which has proper encoding."""
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
459
def run_argv_aliases(self, argv, alias_argv=None):
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
465
args, opts = parse_args(self, argv, alias_argv)
467
# Process the standard options
468
if 'help' in opts: # e.g. bzr add --help
469
sys.stdout.write(self.get_help_text())
471
trace.set_verbosity_level(option._verbosity_level)
472
if 'verbose' in self.supported_std_options:
473
opts['verbose'] = trace.is_verbose()
474
elif opts.has_key('verbose'):
476
if 'quiet' in self.supported_std_options:
477
opts['quiet'] = trace.is_quiet()
478
elif opts.has_key('quiet'):
481
# mix arguments and options into one dictionary
482
cmdargs = _match_argform(self.name(), self.takes_args, args)
484
for k, v in opts.items():
485
cmdopts[k.replace('-', '_')] = v
487
all_cmd_args = cmdargs.copy()
488
all_cmd_args.update(cmdopts)
492
return self.run(**all_cmd_args)
495
"""Actually run the command.
497
This is invoked with the options and arguments bound to
500
Return 0 or None if the command was successful, or a non-zero
501
shell error code if not. It's OK for this method to allow
502
an exception to raise up.
504
raise NotImplementedError('no implementation of command %r'
508
"""Return help message for this class."""
509
from inspect import getdoc
510
if self.__doc__ is Command.__doc__:
515
return _unsquish_command_name(self.__class__.__name__)
517
def plugin_name(self):
518
"""Get the name of the plugin that provides this command.
520
:return: The name of the plugin or None if the command is builtin.
522
mod_parts = self.__module__.split('.')
523
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
529
def parse_args(command, argv, alias_argv=None):
530
"""Parse command line.
532
Arguments and options are parsed at this level before being passed
533
down to specific command handlers. This routine knows, from a
534
lookup table, something about the available options, what optargs
535
they take, and which commands will accept them.
537
# TODO: make it a method of the Command?
538
parser = option.get_optparser(command.options())
539
if alias_argv is not None:
540
args = alias_argv + argv
544
options, args = parser.parse_args(args)
545
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
546
v is not option.OptionParser.DEFAULT_VALUE])
550
def _match_argform(cmd, takes_args, args):
553
# step through args and takes_args, allowing appropriate 0-many matches
554
for ap in takes_args:
558
argdict[argname] = args.pop(0)
559
elif ap[-1] == '*': # all remaining arguments
561
argdict[argname + '_list'] = args[:]
564
argdict[argname + '_list'] = None
567
raise errors.BzrCommandError("command %r needs one or more %s"
568
% (cmd, argname.upper()))
570
argdict[argname + '_list'] = args[:]
572
elif ap[-1] == '$': # all but one
574
raise errors.BzrCommandError("command %r needs one or more %s"
575
% (cmd, argname.upper()))
576
argdict[argname + '_list'] = args[:-1]
582
raise errors.BzrCommandError("command %r requires argument %s"
583
% (cmd, argname.upper()))
585
argdict[argname] = args.pop(0)
588
raise errors.BzrCommandError("extra argument to command %s: %s"
595
def apply_profiled(the_callable, *args, **kwargs):
599
pffileno, pfname = tempfile.mkstemp()
601
prof = hotshot.Profile(pfname)
603
ret = prof.runcall(the_callable, *args, **kwargs) or 0
606
stats = hotshot.stats.load(pfname)
608
stats.sort_stats('cum') # 'time'
609
## XXX: Might like to write to stderr or the trace file instead but
610
## print_stats seems hardcoded to stdout
611
stats.print_stats(20)
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
619
from bzrlib.lsprof import profile
620
ret, stats = profile(the_callable, *args, **kwargs)
626
trace.note('Profile data written to "%s".', filename)
630
def get_alias(cmd, config=None):
631
"""Return an expanded alias, or None if no alias exists.
634
Command to be checked for an alias.
636
Used to specify an alternative config to use,
637
which is especially useful for testing.
638
If it is unspecified, the global config will be used.
642
config = bzrlib.config.GlobalConfig()
643
alias = config.get_alias(cmd)
646
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
651
"""Execute a command.
653
This is similar to main(), but without all the trappings for
654
logging and error handling.
657
The command-line arguments, without the program name from argv[0]
658
These should already be decoded. All library/test code calling
659
run_bzr should be passing valid strings (don't need decoding).
661
Returns a command status or raises an exception.
663
Special master options: these must come before the command because
664
they control how the command is interpreted.
667
Do not load plugin modules at all
673
Only use builtin commands. (Plugins are still allowed to change
677
Run under the Python hotshot profiler.
680
Run under the Python lsprof profiler.
683
trace.mutter("bzr arguments: %r", argv)
685
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
686
opt_no_aliases = False
687
opt_lsprof_file = None
689
# --no-plugins is handled specially at a very early stage. We need
690
# to load plugins before doing other command parsing so that they
691
# can override commands, but this needs to happen first.
699
elif a == '--lsprof':
701
elif a == '--lsprof-file':
703
opt_lsprof_file = argv[i + 1]
705
elif a == '--no-plugins':
706
opt_no_plugins = True
707
elif a == '--no-aliases':
708
opt_no_aliases = True
709
elif a == '--builtin':
711
elif a.startswith('-D'):
712
debug.debug_flags.add(a[2:])
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
723
if argv[0] == '--version':
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
728
if not opt_no_plugins:
729
from bzrlib.plugin import load_plugins
732
from bzrlib.plugin import disable_plugins
737
if not opt_no_aliases:
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
741
argv[0] = alias_argv.pop(0)
744
# We want only 'ascii' command names, but the user may have typed
745
# in a Unicode name. In that case, they should just get a
746
# 'command not found' error later.
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
749
run = cmd_obj.run_argv_aliases
750
run_argv = [argv, alias_argv]
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
756
ret = apply_profiled(run, *run_argv)
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
764
def display_command(func):
765
"""Decorator that suppresses pipe/interrupt errors."""
766
def ignore_pipe(*args, **kwargs):
768
result = func(*args, **kwargs)
772
if getattr(e, 'errno', None) is None:
774
if e.errno != errno.EPIPE:
775
# Win32 raises IOError with errno=0 on a broken pipe
776
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
779
except KeyboardInterrupt:
786
from bzrlib.ui.text import TextUIFactory
787
bzrlib.ui.ui_factory = TextUIFactory()
789
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
790
except UnicodeDecodeError:
791
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
793
ret = run_bzr_catch_errors(argv)
794
trace.mutter("return code %d", ret)
798
def run_bzr_catch_errors(argv):
799
# Note: The except clause logic below should be kept in sync with the
800
# profile() routine in lsprof.py.
803
except (KeyboardInterrupt, Exception), e:
804
# used to handle AssertionError and KeyboardInterrupt
805
# specially here, but hopefully they're handled ok by the logger now
806
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
807
if os.environ.get('BZR_PDB'):
808
print '**** entering debugger'
810
pdb.post_mortem(sys.exc_traceback)
814
def run_bzr_catch_user_errors(argv):
815
"""Run bzr and report user errors, but let internal errors propagate.
817
This is used for the test suite, and might be useful for other programs
818
that want to wrap the commandline interface.
823
if (isinstance(e, (OSError, IOError))
824
or not getattr(e, 'internal_error', True)):
825
trace.report_exception(sys.exc_info(), sys.stderr)
831
class HelpCommandIndex(object):
832
"""A index for bzr help that returns commands."""
835
self.prefix = 'commands/'
837
def get_topics(self, topic):
838
"""Search for topic amongst commands.
840
:param topic: A topic to search for.
841
:return: A list which is either empty or contains a single
844
if topic and topic.startswith(self.prefix):
845
topic = topic[len(self.prefix):]
847
cmd = _get_cmd_object(topic)
854
if __name__ == '__main__':
855
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
