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
see_also_as_links=False):
279
"""Return a text string with help for this command.
281
:param additional_see_also: Additional help topics to be
283
:param plain: if False, raw help (reStructuredText) is
284
returned instead of plain text.
285
:param see_also_as_links: if True, convert items in 'See also'
286
list to internal links (used by bzr_man rstx generator)
290
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
292
# Extract the summary (purpose) and sections out from the text
293
purpose,sections = self._get_help_parts(doc)
295
# If a custom usage section was provided, use it
296
if sections.has_key('Usage'):
297
usage = sections.pop('Usage')
299
usage = self._usage()
301
# The header is the purpose and usage
303
result += ':Purpose: %s\n' % purpose
304
if usage.find('\n') >= 0:
305
result += ':Usage:\n%s\n' % usage
307
result += ':Usage: %s\n' % usage
311
options = option.get_optparser(self.options()).format_option_help()
312
if options.startswith('Options:'):
313
result += ':' + options
314
elif options.startswith('options:'):
315
# Python 2.4 version of optparse
316
result += ':Options:' + options[len('options:'):]
321
# Add the description, indenting it 2 spaces
322
# to match the indentation of the options
323
if sections.has_key(None):
324
text = sections.pop(None)
325
text = '\n '.join(text.splitlines())
326
result += ':%s:\n %s\n\n' % ('Description',text)
328
# Add the custom sections (e.g. Examples). Note that there's no need
329
# to indent these as they must be indented already in the source.
331
labels = sorted(sections.keys())
333
result += ':%s:\n%s\n\n' % (label,sections[label])
335
# Add the aliases, source (plug-in) and see also links, if any
337
result += ':Aliases: '
338
result += ', '.join(self.aliases) + '\n'
339
plugin_name = self.plugin_name()
340
if plugin_name is not None:
341
result += ':From: plugin "%s"\n' % plugin_name
342
see_also = self.get_see_also(additional_see_also)
344
if not plain and see_also_as_links:
346
for item in see_also:
348
# topics doesn't have an independent section
349
# so don't create a real link
350
see_also_links.append(item)
352
# Use a reST link for this entry
353
see_also_links.append("`%s`_" % (item,))
354
see_also = see_also_links
355
result += ':See also: '
356
result += ', '.join(see_also) + '\n'
358
# If this will be rendered as plan text, convert it
360
import bzrlib.help_topics
361
result = bzrlib.help_topics.help_as_plain_text(result)
365
def _get_help_parts(text):
366
"""Split help text into a summary and named sections.
368
:return: (summary,sections) where summary is the top line and
369
sections is a dictionary of the rest indexed by section name.
370
A section starts with a heading line of the form ":xxx:".
371
Indented text on following lines is the section value.
372
All text found outside a named section is assigned to the
373
default section which is given the key of None.
375
def save_section(sections, label, section):
377
if sections.has_key(label):
378
sections[label] += '\n' + section
380
sections[label] = section
382
lines = text.rstrip().splitlines()
383
summary = lines.pop(0)
385
label,section = None,''
387
if line.startswith(':') and line.endswith(':') and len(line) > 2:
388
save_section(sections, label, section)
389
label,section = line[1:-1],''
390
elif label != None and len(line) > 1 and not line[0].isspace():
391
save_section(sections, label, section)
392
label,section = None,line
395
section += '\n' + line
398
save_section(sections, label, section)
399
return summary, sections
401
def get_help_topic(self):
402
"""Return the commands help topic - its name."""
405
def get_see_also(self, additional_terms=None):
406
"""Return a list of help topics that are related to this command.
408
The list is derived from the content of the _see_also attribute. Any
409
duplicates are removed and the result is in lexical order.
410
:param additional_terms: Additional help topics to cross-reference.
411
:return: A list of help topics.
413
see_also = set(getattr(self, '_see_also', []))
415
see_also.update(additional_terms)
416
return sorted(see_also)
419
"""Return dict of valid options for this command.
421
Maps from long option name to option object."""
423
r['help'] = option._help_option
424
for o in self.takes_options:
425
if isinstance(o, basestring):
426
o = option.Option.OPTIONS[o]
430
def _setup_outf(self):
431
"""Return a file linked to stdout, which has proper encoding."""
432
assert self.encoding_type in ['strict', 'exact', 'replace']
434
# Originally I was using self.stdout, but that looks
435
# *way* too much like sys.stdout
436
if self.encoding_type == 'exact':
437
# force sys.stdout to be binary stream on win32
438
if sys.platform == 'win32':
439
fileno = getattr(sys.stdout, 'fileno', None)
442
msvcrt.setmode(fileno(), os.O_BINARY)
443
self.outf = sys.stdout
446
output_encoding = osutils.get_terminal_encoding()
448
# use 'replace' so that we don't abort if trying to write out
449
# in e.g. the default C locale.
450
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
451
# For whatever reason codecs.getwriter() does not advertise its encoding
452
# it just returns the encoding of the wrapped file, which is completely
453
# bogus. So set the attribute, so we can find the correct encoding later.
454
self.outf.encoding = output_encoding
456
def run_argv_aliases(self, argv, alias_argv=None):
457
"""Parse the command line and run with extra aliases in alias_argv."""
459
warn("Passing None for [] is deprecated from bzrlib 0.10",
460
DeprecationWarning, stacklevel=2)
462
args, opts = parse_args(self, argv, alias_argv)
463
if 'help' in opts: # e.g. bzr add --help
464
sys.stdout.write(self.get_help_text())
466
# mix arguments and options into one dictionary
467
cmdargs = _match_argform(self.name(), self.takes_args, args)
469
for k, v in opts.items():
470
cmdopts[k.replace('-', '_')] = v
472
all_cmd_args = cmdargs.copy()
473
all_cmd_args.update(cmdopts)
477
return self.run(**all_cmd_args)
480
"""Actually run the command.
482
This is invoked with the options and arguments bound to
485
Return 0 or None if the command was successful, or a non-zero
486
shell error code if not. It's OK for this method to allow
487
an exception to raise up.
489
raise NotImplementedError('no implementation of command %r'
493
"""Return help message for this class."""
494
from inspect import getdoc
495
if self.__doc__ is Command.__doc__:
500
return _unsquish_command_name(self.__class__.__name__)
502
def plugin_name(self):
503
"""Get the name of the plugin that provides this command.
505
:return: The name of the plugin or None if the command is builtin.
507
mod_parts = self.__module__.split('.')
508
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
514
# Technically, this function hasn't been use in a *really* long time
515
# but we are only deprecating it now.
516
@deprecated_function(zero_eleven)
517
def parse_spec(spec):
523
>>> parse_spec("../@")
525
>>> parse_spec("../f/@35")
527
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
528
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
533
parsed = spec.split('/@')
534
assert len(parsed) == 2
539
parsed[1] = int(parsed[1])
541
pass # We can allow stuff like ./@revid:blahblahblah
545
parsed = [spec, None]
548
def parse_args(command, argv, alias_argv=None):
549
"""Parse command line.
551
Arguments and options are parsed at this level before being passed
552
down to specific command handlers. This routine knows, from a
553
lookup table, something about the available options, what optargs
554
they take, and which commands will accept them.
556
# TODO: make it a method of the Command?
557
parser = option.get_optparser(command.options())
558
if alias_argv is not None:
559
args = alias_argv + argv
563
options, args = parser.parse_args(args)
564
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
565
v is not option.OptionParser.DEFAULT_VALUE])
569
def _match_argform(cmd, takes_args, args):
572
# step through args and takes_args, allowing appropriate 0-many matches
573
for ap in takes_args:
577
argdict[argname] = args.pop(0)
578
elif ap[-1] == '*': # all remaining arguments
580
argdict[argname + '_list'] = args[:]
583
argdict[argname + '_list'] = None
586
raise errors.BzrCommandError("command %r needs one or more %s"
587
% (cmd, argname.upper()))
589
argdict[argname + '_list'] = args[:]
591
elif ap[-1] == '$': # all but one
593
raise errors.BzrCommandError("command %r needs one or more %s"
594
% (cmd, argname.upper()))
595
argdict[argname + '_list'] = args[:-1]
601
raise errors.BzrCommandError("command %r requires argument %s"
602
% (cmd, argname.upper()))
604
argdict[argname] = args.pop(0)
607
raise errors.BzrCommandError("extra argument to command %s: %s"
614
def apply_profiled(the_callable, *args, **kwargs):
618
pffileno, pfname = tempfile.mkstemp()
620
prof = hotshot.Profile(pfname)
622
ret = prof.runcall(the_callable, *args, **kwargs) or 0
625
stats = hotshot.stats.load(pfname)
627
stats.sort_stats('cum') # 'time'
628
## XXX: Might like to write to stderr or the trace file instead but
629
## print_stats seems hardcoded to stdout
630
stats.print_stats(20)
637
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
638
from bzrlib.lsprof import profile
639
ret, stats = profile(the_callable, *args, **kwargs)
645
trace.note('Profile data written to "%s".', filename)
649
def get_alias(cmd, config=None):
650
"""Return an expanded alias, or None if no alias exists.
653
Command to be checked for an alias.
655
Used to specify an alternative config to use,
656
which is especially useful for testing.
657
If it is unspecified, the global config will be used.
661
config = bzrlib.config.GlobalConfig()
662
alias = config.get_alias(cmd)
665
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
670
"""Execute a command.
672
This is similar to main(), but without all the trappings for
673
logging and error handling.
676
The command-line arguments, without the program name from argv[0]
677
These should already be decoded. All library/test code calling
678
run_bzr should be passing valid strings (don't need decoding).
680
Returns a command status or raises an exception.
682
Special master options: these must come before the command because
683
they control how the command is interpreted.
686
Do not load plugin modules at all
692
Only use builtin commands. (Plugins are still allowed to change
696
Run under the Python hotshot profiler.
699
Run under the Python lsprof profiler.
702
trace.mutter("bzr arguments: %r", argv)
704
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
705
opt_no_aliases = False
706
opt_lsprof_file = None
708
# --no-plugins is handled specially at a very early stage. We need
709
# to load plugins before doing other command parsing so that they
710
# can override commands, but this needs to happen first.
718
elif a == '--lsprof':
720
elif a == '--lsprof-file':
722
opt_lsprof_file = argv[i + 1]
724
elif a == '--no-plugins':
725
opt_no_plugins = True
726
elif a == '--no-aliases':
727
opt_no_aliases = True
728
elif a == '--builtin':
730
elif a in ('--quiet', '-q'):
732
elif a.startswith('-D'):
733
debug.debug_flags.add(a[2:])
740
from bzrlib.builtins import cmd_help
741
cmd_help().run_argv_aliases([])
744
if argv[0] == '--version':
745
from bzrlib.version import show_version
749
if not opt_no_plugins:
750
from bzrlib.plugin import load_plugins
753
from bzrlib.plugin import disable_plugins
758
if not opt_no_aliases:
759
alias_argv = get_alias(argv[0])
761
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
762
argv[0] = alias_argv.pop(0)
765
# We want only 'ascii' command names, but the user may have typed
766
# in a Unicode name. In that case, they should just get a
767
# 'command not found' error later.
769
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
770
run = cmd_obj.run_argv_aliases
771
run_argv = [argv, alias_argv]
775
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
777
ret = apply_profiled(run, *run_argv)
782
# reset, in case we may do other commands later within the same process
783
trace.be_quiet(False)
785
def display_command(func):
786
"""Decorator that suppresses pipe/interrupt errors."""
787
def ignore_pipe(*args, **kwargs):
789
result = func(*args, **kwargs)
793
if getattr(e, 'errno', None) is None:
795
if e.errno != errno.EPIPE:
796
# Win32 raises IOError with errno=0 on a broken pipe
797
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
800
except KeyboardInterrupt:
807
from bzrlib.ui.text import TextUIFactory
808
bzrlib.ui.ui_factory = TextUIFactory()
809
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
810
ret = run_bzr_catch_errors(argv)
811
trace.mutter("return code %d", ret)
815
def run_bzr_catch_errors(argv):
818
except (KeyboardInterrupt, Exception), e:
819
# used to handle AssertionError and KeyboardInterrupt
820
# specially here, but hopefully they're handled ok by the logger now
821
trace.report_exception(sys.exc_info(), sys.stderr)
822
if os.environ.get('BZR_PDB'):
823
print '**** entering debugger'
825
pdb.post_mortem(sys.exc_traceback)
829
class HelpCommandIndex(object):
830
"""A index for bzr help that returns commands."""
833
self.prefix = 'commands/'
835
def get_topics(self, topic):
836
"""Search for topic amongst commands.
838
:param topic: A topic to search for.
839
:return: A list which is either empty or contains a single
842
if topic and topic.startswith(self.prefix):
843
topic = topic[len(self.prefix):]
845
cmd = _get_cmd_object(topic)
852
if __name__ == '__main__':
853
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
