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 (
58
from bzrlib.option import Option
64
def register_command(cmd, decorate=False):
65
"""Utility function to help register a command
67
:param cmd: Command subclass to register
68
:param decorate: If true, allow overriding an existing command
69
of the same name; the old command is returned by this function.
70
Otherwise it is an error to try to override an existing command.
74
if k.startswith("cmd_"):
75
k_unsquished = _unsquish_command_name(k)
78
if k_unsquished not in plugin_cmds:
79
plugin_cmds[k_unsquished] = cmd
80
## trace.mutter('registered plugin command %s', k_unsquished)
81
if decorate and k_unsquished in builtin_command_names():
82
return _builtin_commands()[k_unsquished]
84
result = plugin_cmds[k_unsquished]
85
plugin_cmds[k_unsquished] = cmd
88
trace.log_error('Two plugins defined the same command: %r' % k)
89
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__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)
244
def _maybe_expand_globs(self, file_list):
245
"""Glob expand file_list if the platform does not do that itself.
247
:return: A possibly empty list of unicode paths.
249
Introduced in bzrlib 0.18.
253
if sys.platform == 'win32':
254
file_list = win32utils.glob_expand(file_list)
255
return list(file_list)
258
"""Return single-line grammar for this command.
260
Only describes arguments, not options.
262
s = 'bzr ' + self.name() + ' '
263
for aname in self.takes_args:
264
aname = aname.upper()
265
if aname[-1] in ['$', '+']:
266
aname = aname[:-1] + '...'
267
elif aname[-1] == '?':
268
aname = '[' + aname[:-1] + ']'
269
elif aname[-1] == '*':
270
aname = '[' + aname[:-1] + '...]'
277
def get_help_text(self, additional_see_also=None, plain=True):
278
"""Return a text string with help for this command.
280
:param additional_see_also: Additional help topics to be
282
:param plain: if False, raw help (reStructuredText) is
283
returned instead of plain text.
287
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
289
# Extract the summary (purpose) and sections out from the text
290
purpose,sections = self._get_help_parts(doc)
292
# If a custom usage section was provided, use it
293
if sections.has_key('Usage'):
294
usage = sections.pop('Usage')
296
usage = self._usage()
298
# The header is the purpose and usage
300
result += ':Purpose: %s\n' % purpose
301
if usage.find('\n') >= 0:
302
result += ':Usage:\n%s\n' % usage
304
result += ':Usage: %s\n' % usage
308
options = option.get_optparser(self.options()).format_option_help()
309
if options.startswith('Options:'):
310
result += ':' + options
315
# Add the description, indenting it 2 spaces
316
# to match the indentation of the options
317
if sections.has_key(None):
318
text = sections.pop(None)
319
text = '\n '.join(text.splitlines())
320
result += ':%s:\n %s\n\n' % ('Description',text)
322
# Add the custom sections (e.g. Examples). Note that there's no need
323
# to indent these as they must be indented already in the source.
325
labels = sorted(sections.keys())
327
result += ':%s:\n%s\n\n' % (label,sections[label])
329
# Add the aliases, source (plug-in) and see also links, if any
331
result += ':Aliases: '
332
result += ', '.join(self.aliases) + '\n'
333
plugin_name = self.plugin_name()
334
if plugin_name is not None:
335
result += ':From: plugin "%s"\n' % plugin_name
336
see_also = self.get_see_also(additional_see_also)
338
result += ':See also: '
339
result += ', '.join(see_also) + '\n'
341
# If this will be rendered as plan text, convert it
343
import bzrlib.help_topics
344
result = bzrlib.help_topics.help_as_plain_text(result)
348
def _get_help_parts(text):
349
"""Split help text into a summary and named sections.
351
:return: (summary,sections) where summary is the top line and
352
sections is a dictionary of the rest indexed by section name.
353
A section starts with a heading line of the form ":xxx:".
354
Indented text on following lines is the section value.
355
All text found outside a named section is assigned to the
356
default section which is given the key of None.
358
def save_section(sections, label, section):
360
if sections.has_key(label):
361
sections[label] += '\n' + section
363
sections[label] = section
365
lines = text.rstrip().splitlines()
366
summary = lines.pop(0)
368
label,section = None,''
370
if line.startswith(':') and line.endswith(':') and len(line) > 2:
371
save_section(sections, label, section)
372
label,section = line[1:-1],''
373
elif label != None and len(line) > 1 and not line[0].isspace():
374
save_section(sections, label, section)
375
label,section = None,line
378
section += '\n' + line
381
save_section(sections, label, section)
382
return summary, sections
384
def get_help_topic(self):
385
"""Return the commands help topic - its name."""
388
def get_see_also(self, additional_terms=None):
389
"""Return a list of help topics that are related to this ommand.
391
The list is derived from the content of the _see_also attribute. Any
392
duplicates are removed and the result is in lexical order.
393
:param additional_terms: Additional help topics to cross-reference.
394
:return: A list of help topics.
396
see_also = set(getattr(self, '_see_also', []))
398
see_also.update(additional_terms)
399
return sorted(see_also)
402
"""Return dict of valid options for this command.
404
Maps from long option name to option object."""
406
r['help'] = option._help_option
407
for o in self.takes_options:
408
if isinstance(o, basestring):
409
o = option.Option.OPTIONS[o]
413
def _setup_outf(self):
414
"""Return a file linked to stdout, which has proper encoding."""
415
assert self.encoding_type in ['strict', 'exact', 'replace']
417
# Originally I was using self.stdout, but that looks
418
# *way* too much like sys.stdout
419
if self.encoding_type == 'exact':
420
# force sys.stdout to be binary stream on win32
421
if sys.platform == 'win32':
422
fileno = getattr(sys.stdout, 'fileno', None)
425
msvcrt.setmode(fileno(), os.O_BINARY)
426
self.outf = sys.stdout
429
output_encoding = osutils.get_terminal_encoding()
431
# use 'replace' so that we don't abort if trying to write out
432
# in e.g. the default C locale.
433
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
434
# For whatever reason codecs.getwriter() does not advertise its encoding
435
# it just returns the encoding of the wrapped file, which is completely
436
# bogus. So set the attribute, so we can find the correct encoding later.
437
self.outf.encoding = output_encoding
439
def run_argv_aliases(self, argv, alias_argv=None):
440
"""Parse the command line and run with extra aliases in alias_argv."""
442
warn("Passing None for [] is deprecated from bzrlib 0.10",
443
DeprecationWarning, stacklevel=2)
445
args, opts = parse_args(self, argv, alias_argv)
446
if 'help' in opts: # e.g. bzr add --help
447
sys.stdout.write(self.get_help_text())
449
# mix arguments and options into one dictionary
450
cmdargs = _match_argform(self.name(), self.takes_args, args)
452
for k, v in opts.items():
453
cmdopts[k.replace('-', '_')] = v
455
all_cmd_args = cmdargs.copy()
456
all_cmd_args.update(cmdopts)
460
return self.run(**all_cmd_args)
463
"""Actually run the command.
465
This is invoked with the options and arguments bound to
468
Return 0 or None if the command was successful, or a non-zero
469
shell error code if not. It's OK for this method to allow
470
an exception to raise up.
472
raise NotImplementedError('no implementation of command %r'
476
"""Return help message for this class."""
477
from inspect import getdoc
478
if self.__doc__ is Command.__doc__:
483
return _unsquish_command_name(self.__class__.__name__)
485
def plugin_name(self):
486
"""Get the name of the plugin that provides this command.
488
:return: The name of the plugin or None if the command is builtin.
490
mod_parts = self.__module__.split('.')
491
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
497
# Technically, this function hasn't been use in a *really* long time
498
# but we are only deprecating it now.
499
@deprecated_function(zero_eleven)
500
def parse_spec(spec):
506
>>> parse_spec("../@")
508
>>> parse_spec("../f/@35")
510
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
511
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
516
parsed = spec.split('/@')
517
assert len(parsed) == 2
522
parsed[1] = int(parsed[1])
524
pass # We can allow stuff like ./@revid:blahblahblah
528
parsed = [spec, None]
531
def parse_args(command, argv, alias_argv=None):
532
"""Parse command line.
534
Arguments and options are parsed at this level before being passed
535
down to specific command handlers. This routine knows, from a
536
lookup table, something about the available options, what optargs
537
they take, and which commands will accept them.
539
# TODO: make it a method of the Command?
540
parser = option.get_optparser(command.options())
541
if alias_argv is not None:
542
args = alias_argv + argv
546
options, args = parser.parse_args(args)
547
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
548
v is not option.OptionParser.DEFAULT_VALUE])
552
def _match_argform(cmd, takes_args, args):
555
# step through args and takes_args, allowing appropriate 0-many matches
556
for ap in takes_args:
560
argdict[argname] = args.pop(0)
561
elif ap[-1] == '*': # all remaining arguments
563
argdict[argname + '_list'] = args[:]
566
argdict[argname + '_list'] = None
569
raise errors.BzrCommandError("command %r needs one or more %s"
570
% (cmd, argname.upper()))
572
argdict[argname + '_list'] = args[:]
574
elif ap[-1] == '$': # all but one
576
raise errors.BzrCommandError("command %r needs one or more %s"
577
% (cmd, argname.upper()))
578
argdict[argname + '_list'] = args[:-1]
584
raise errors.BzrCommandError("command %r requires argument %s"
585
% (cmd, argname.upper()))
587
argdict[argname] = args.pop(0)
590
raise errors.BzrCommandError("extra argument to command %s: %s"
597
def apply_profiled(the_callable, *args, **kwargs):
601
pffileno, pfname = tempfile.mkstemp()
603
prof = hotshot.Profile(pfname)
605
ret = prof.runcall(the_callable, *args, **kwargs) or 0
608
stats = hotshot.stats.load(pfname)
610
stats.sort_stats('cum') # 'time'
611
## XXX: Might like to write to stderr or the trace file instead but
612
## print_stats seems hardcoded to stdout
613
stats.print_stats(20)
620
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
621
from bzrlib.lsprof import profile
622
ret, stats = profile(the_callable, *args, **kwargs)
628
trace.note('Profile data written to "%s".', filename)
632
def get_alias(cmd, config=None):
633
"""Return an expanded alias, or None if no alias exists.
636
Command to be checked for an alias.
638
Used to specify an alternative config to use,
639
which is especially useful for testing.
640
If it is unspecified, the global config will be used.
644
config = bzrlib.config.GlobalConfig()
645
alias = config.get_alias(cmd)
648
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
653
"""Execute a command.
655
This is similar to main(), but without all the trappings for
656
logging and error handling.
659
The command-line arguments, without the program name from argv[0]
660
These should already be decoded. All library/test code calling
661
run_bzr should be passing valid strings (don't need decoding).
663
Returns a command status or raises an exception.
665
Special master options: these must come before the command because
666
they control how the command is interpreted.
669
Do not load plugin modules at all
675
Only use builtin commands. (Plugins are still allowed to change
679
Run under the Python hotshot profiler.
682
Run under the Python lsprof profiler.
685
trace.mutter("bzr arguments: %r", argv)
687
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
688
opt_no_aliases = False
689
opt_lsprof_file = None
691
# --no-plugins is handled specially at a very early stage. We need
692
# to load plugins before doing other command parsing so that they
693
# can override commands, but this needs to happen first.
701
elif a == '--lsprof':
703
elif a == '--lsprof-file':
705
opt_lsprof_file = argv[i + 1]
707
elif a == '--no-plugins':
708
opt_no_plugins = True
709
elif a == '--no-aliases':
710
opt_no_aliases = True
711
elif a == '--builtin':
713
elif a in ('--quiet', '-q'):
715
elif a.startswith('-D'):
716
debug.debug_flags.add(a[2:])
723
from bzrlib.builtins import cmd_help
724
cmd_help().run_argv_aliases([])
727
if argv[0] == '--version':
728
from bzrlib.version import show_version
732
if not opt_no_plugins:
733
from bzrlib.plugin import load_plugins
736
from bzrlib.plugin import disable_plugins
741
if not opt_no_aliases:
742
alias_argv = get_alias(argv[0])
744
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
745
argv[0] = alias_argv.pop(0)
748
# We want only 'ascii' command names, but the user may have typed
749
# in a Unicode name. In that case, they should just get a
750
# 'command not found' error later.
752
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
753
run = cmd_obj.run_argv_aliases
754
run_argv = [argv, alias_argv]
758
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
760
ret = apply_profiled(run, *run_argv)
765
# reset, in case we may do other commands later within the same process
766
trace.be_quiet(False)
768
def display_command(func):
769
"""Decorator that suppresses pipe/interrupt errors."""
770
def ignore_pipe(*args, **kwargs):
772
result = func(*args, **kwargs)
776
if getattr(e, 'errno', None) is None:
778
if e.errno != errno.EPIPE:
779
# Win32 raises IOError with errno=0 on a broken pipe
780
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
783
except KeyboardInterrupt:
790
from bzrlib.ui.text import TextUIFactory
791
bzrlib.ui.ui_factory = TextUIFactory()
792
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
793
ret = run_bzr_catch_errors(argv)
794
trace.mutter("return code %d", ret)
798
def run_bzr_catch_errors(argv):
801
except (KeyboardInterrupt, Exception), e:
802
# used to handle AssertionError and KeyboardInterrupt
803
# specially here, but hopefully they're handled ok by the logger now
804
trace.report_exception(sys.exc_info(), sys.stderr)
805
if os.environ.get('BZR_PDB'):
806
print '**** entering debugger'
808
pdb.post_mortem(sys.exc_traceback)
812
class HelpCommandIndex(object):
813
"""A index for bzr help that returns commands."""
816
self.prefix = 'commands/'
818
def get_topics(self, topic):
819
"""Search for topic amongst commands.
821
:param topic: A topic to search for.
822
:return: A list which is either empty or contains a single
825
if topic and topic.startswith(self.prefix):
826
topic = topic[len(self.prefix):]
828
cmd = _get_cmd_object(topic)
835
if __name__ == '__main__':
836
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
