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
assert cmd.startswith("cmd_")
99
return cmd[4:].replace('_','-')
102
def _builtin_commands():
103
import bzrlib.builtins
105
builtins = bzrlib.builtins.__dict__
106
for name in builtins:
107
if name.startswith("cmd_"):
108
real_name = _unsquish_command_name(name)
109
r[real_name] = builtins[name]
113
def builtin_command_names():
114
"""Return list of builtin command names."""
115
return _builtin_commands().keys()
118
def plugin_command_names():
119
return plugin_cmds.keys()
122
def _get_cmd_dict(plugins_override=True):
123
"""Return name->class mapping for all commands."""
124
d = _builtin_commands()
126
d.update(plugin_cmds)
130
def get_all_cmds(plugins_override=True):
131
"""Return canonical name and class for all registered commands."""
132
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
136
def get_cmd_object(cmd_name, plugins_override=True):
137
"""Return the canonical name and command class for a command.
140
If true, plugin commands can override builtins.
143
return _get_cmd_object(cmd_name, plugins_override)
145
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
148
def _get_cmd_object(cmd_name, plugins_override=True):
149
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
150
from bzrlib.externalcommand import ExternalCommand
152
# We want only 'ascii' command names, but the user may have typed
153
# in a Unicode name. In that case, they should just get a
154
# 'command not found' error later.
155
# In the future, we may actually support Unicode command names.
157
# first look up this command under the specified name
158
cmds = _get_cmd_dict(plugins_override=plugins_override)
160
return cmds[cmd_name]()
164
# look for any command which claims this as an alias
165
for real_cmd_name, cmd_class in cmds.iteritems():
166
if cmd_name in cmd_class.aliases:
169
cmd_obj = ExternalCommand.find_command(cmd_name)
173
# look for plugins that provide this command but aren't installed
174
for provider in command_providers_registry:
176
plugin_metadata = provider.plugin_for_command(cmd_name)
177
except errors.NoPluginAvailable:
180
raise errors.CommandAvailableInPlugin(cmd_name,
181
plugin_metadata, provider)
186
class Command(object):
187
"""Base class for commands.
189
Commands are the heart of the command-line bzr interface.
191
The command object mostly handles the mapping of command-line
192
parameters into one or more bzrlib operations, and of the results
195
Commands normally don't have any state. All their arguments are
196
passed in to the run method. (Subclasses may take a different
197
policy if the behaviour of the instance needs to depend on e.g. a
198
shell plugin and not just its Python class.)
200
The docstring for an actual command should give a single-line
201
summary, then a complete description of the command. A grammar
202
description will be inserted.
205
Other accepted names for this command.
208
List of argument forms, marked with whether they are optional,
213
['to_location', 'from_branch?', 'file*']
215
'to_location' is required
216
'from_branch' is optional
217
'file' can be specified 0 or more times
220
List of options that may be given for this command. These can
221
be either strings, referring to globally-defined options,
222
or option objects. Retrieve through options().
225
If true, this command isn't advertised. This is typically
226
for commands intended for expert users.
229
Command objects will get a 'outf' attribute, which has been
230
setup to properly handle encoding of unicode strings.
231
encoding_type determines what will happen when characters cannot
233
strict - abort if we cannot decode
234
replace - put in a bogus character (typically '?')
235
exact - do not encode sys.stdout
237
NOTE: by default on Windows, sys.stdout is opened as a text
238
stream, therefore LF line-endings are converted to CRLF.
239
When a command uses encoding_type = 'exact', then
240
sys.stdout is forced to be a binary stream, and line-endings
247
encoding_type = 'strict'
252
"""Construct an instance of this command."""
253
if self.__doc__ == Command.__doc__:
254
warn("No help message set for %r" % self)
255
# List of standard options directly supported
256
self.supported_std_options = []
258
def _maybe_expand_globs(self, file_list):
259
"""Glob expand file_list if the platform does not do that itself.
261
:return: A possibly empty list of unicode paths.
263
Introduced in bzrlib 0.18.
267
if sys.platform == 'win32':
268
file_list = win32utils.glob_expand(file_list)
269
return list(file_list)
272
"""Return single-line grammar for this command.
274
Only describes arguments, not options.
276
s = 'bzr ' + self.name() + ' '
277
for aname in self.takes_args:
278
aname = aname.upper()
279
if aname[-1] in ['$', '+']:
280
aname = aname[:-1] + '...'
281
elif aname[-1] == '?':
282
aname = '[' + aname[:-1] + ']'
283
elif aname[-1] == '*':
284
aname = '[' + aname[:-1] + '...]'
291
def get_help_text(self, additional_see_also=None, plain=True,
292
see_also_as_links=False):
293
"""Return a text string with help for this command.
295
:param additional_see_also: Additional help topics to be
297
:param plain: if False, raw help (reStructuredText) is
298
returned instead of plain text.
299
:param see_also_as_links: if True, convert items in 'See also'
300
list to internal links (used by bzr_man rstx generator)
304
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
306
# Extract the summary (purpose) and sections out from the text
307
purpose,sections = self._get_help_parts(doc)
309
# If a custom usage section was provided, use it
310
if sections.has_key('Usage'):
311
usage = sections.pop('Usage')
313
usage = self._usage()
315
# The header is the purpose and usage
317
result += ':Purpose: %s\n' % purpose
318
if usage.find('\n') >= 0:
319
result += ':Usage:\n%s\n' % usage
321
result += ':Usage: %s\n' % usage
325
options = option.get_optparser(self.options()).format_option_help()
326
if options.startswith('Options:'):
327
result += ':' + options
328
elif options.startswith('options:'):
329
# Python 2.4 version of optparse
330
result += ':Options:' + options[len('options:'):]
335
# Add the description, indenting it 2 spaces
336
# to match the indentation of the options
337
if sections.has_key(None):
338
text = sections.pop(None)
339
text = '\n '.join(text.splitlines())
340
result += ':%s:\n %s\n\n' % ('Description',text)
342
# Add the custom sections (e.g. Examples). Note that there's no need
343
# to indent these as they must be indented already in the source.
345
labels = sorted(sections.keys())
347
result += ':%s:\n%s\n\n' % (label,sections[label])
349
# Add the aliases, source (plug-in) and see also links, if any
351
result += ':Aliases: '
352
result += ', '.join(self.aliases) + '\n'
353
plugin_name = self.plugin_name()
354
if plugin_name is not None:
355
result += ':From: plugin "%s"\n' % plugin_name
356
see_also = self.get_see_also(additional_see_also)
358
if not plain and see_also_as_links:
360
for item in see_also:
362
# topics doesn't have an independent section
363
# so don't create a real link
364
see_also_links.append(item)
366
# Use a reST link for this entry
367
see_also_links.append("`%s`_" % (item,))
368
see_also = see_also_links
369
result += ':See also: '
370
result += ', '.join(see_also) + '\n'
372
# If this will be rendered as plan text, convert it
374
import bzrlib.help_topics
375
result = bzrlib.help_topics.help_as_plain_text(result)
379
def _get_help_parts(text):
380
"""Split help text into a summary and named sections.
382
:return: (summary,sections) where summary is the top line and
383
sections is a dictionary of the rest indexed by section name.
384
A section starts with a heading line of the form ":xxx:".
385
Indented text on following lines is the section value.
386
All text found outside a named section is assigned to the
387
default section which is given the key of None.
389
def save_section(sections, label, section):
391
if sections.has_key(label):
392
sections[label] += '\n' + section
394
sections[label] = section
396
lines = text.rstrip().splitlines()
397
summary = lines.pop(0)
399
label,section = None,''
401
if line.startswith(':') and line.endswith(':') and len(line) > 2:
402
save_section(sections, label, section)
403
label,section = line[1:-1],''
404
elif label != None and len(line) > 1 and not line[0].isspace():
405
save_section(sections, label, section)
406
label,section = None,line
409
section += '\n' + line
412
save_section(sections, label, section)
413
return summary, sections
415
def get_help_topic(self):
416
"""Return the commands help topic - its name."""
419
def get_see_also(self, additional_terms=None):
420
"""Return a list of help topics that are related to this command.
422
The list is derived from the content of the _see_also attribute. Any
423
duplicates are removed and the result is in lexical order.
424
:param additional_terms: Additional help topics to cross-reference.
425
:return: A list of help topics.
427
see_also = set(getattr(self, '_see_also', []))
429
see_also.update(additional_terms)
430
return sorted(see_also)
433
"""Return dict of valid options for this command.
435
Maps from long option name to option object."""
436
r = Option.STD_OPTIONS.copy()
438
for o in self.takes_options:
439
if isinstance(o, basestring):
440
o = option.Option.OPTIONS[o]
442
if o.name in std_names:
443
self.supported_std_options.append(o.name)
446
def _setup_outf(self):
447
"""Return a file linked to stdout, which has proper encoding."""
448
assert self.encoding_type in ['strict', 'exact', 'replace']
450
# Originally I was using self.stdout, but that looks
451
# *way* too much like sys.stdout
452
if self.encoding_type == 'exact':
453
# force sys.stdout to be binary stream on win32
454
if sys.platform == 'win32':
455
fileno = getattr(sys.stdout, 'fileno', None)
458
msvcrt.setmode(fileno(), os.O_BINARY)
459
self.outf = sys.stdout
462
output_encoding = osutils.get_terminal_encoding()
464
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
465
errors=self.encoding_type)
466
# For whatever reason codecs.getwriter() does not advertise its encoding
467
# it just returns the encoding of the wrapped file, which is completely
468
# bogus. So set the attribute, so we can find the correct encoding later.
469
self.outf.encoding = output_encoding
471
def run_argv_aliases(self, argv, alias_argv=None):
472
"""Parse the command line and run with extra aliases in alias_argv."""
474
warn("Passing None for [] is deprecated from bzrlib 0.10",
475
DeprecationWarning, stacklevel=2)
477
args, opts = parse_args(self, argv, alias_argv)
479
# Process the standard options
480
if 'help' in opts: # e.g. bzr add --help
481
sys.stdout.write(self.get_help_text())
483
trace.set_verbosity_level(option._verbosity_level)
484
if 'verbose' in self.supported_std_options:
485
opts['verbose'] = trace.is_verbose()
486
elif opts.has_key('verbose'):
488
if 'quiet' in self.supported_std_options:
489
opts['quiet'] = trace.is_quiet()
490
elif opts.has_key('quiet'):
493
# mix arguments and options into one dictionary
494
cmdargs = _match_argform(self.name(), self.takes_args, args)
496
for k, v in opts.items():
497
cmdopts[k.replace('-', '_')] = v
499
all_cmd_args = cmdargs.copy()
500
all_cmd_args.update(cmdopts)
504
return self.run(**all_cmd_args)
507
"""Actually run the command.
509
This is invoked with the options and arguments bound to
512
Return 0 or None if the command was successful, or a non-zero
513
shell error code if not. It's OK for this method to allow
514
an exception to raise up.
516
raise NotImplementedError('no implementation of command %r'
520
"""Return help message for this class."""
521
from inspect import getdoc
522
if self.__doc__ is Command.__doc__:
527
return _unsquish_command_name(self.__class__.__name__)
529
def plugin_name(self):
530
"""Get the name of the plugin that provides this command.
532
:return: The name of the plugin or None if the command is builtin.
534
mod_parts = self.__module__.split('.')
535
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
541
def parse_args(command, argv, alias_argv=None):
542
"""Parse command line.
544
Arguments and options are parsed at this level before being passed
545
down to specific command handlers. This routine knows, from a
546
lookup table, something about the available options, what optargs
547
they take, and which commands will accept them.
549
# TODO: make it a method of the Command?
550
parser = option.get_optparser(command.options())
551
if alias_argv is not None:
552
args = alias_argv + argv
556
options, args = parser.parse_args(args)
557
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
558
v is not option.OptionParser.DEFAULT_VALUE])
562
def _match_argform(cmd, takes_args, args):
565
# step through args and takes_args, allowing appropriate 0-many matches
566
for ap in takes_args:
570
argdict[argname] = args.pop(0)
571
elif ap[-1] == '*': # all remaining arguments
573
argdict[argname + '_list'] = args[:]
576
argdict[argname + '_list'] = None
579
raise errors.BzrCommandError("command %r needs one or more %s"
580
% (cmd, argname.upper()))
582
argdict[argname + '_list'] = args[:]
584
elif ap[-1] == '$': # all but one
586
raise errors.BzrCommandError("command %r needs one or more %s"
587
% (cmd, argname.upper()))
588
argdict[argname + '_list'] = args[:-1]
594
raise errors.BzrCommandError("command %r requires argument %s"
595
% (cmd, argname.upper()))
597
argdict[argname] = args.pop(0)
600
raise errors.BzrCommandError("extra argument to command %s: %s"
605
def apply_coveraged(dirname, the_callable, *args, **kwargs):
606
# Cannot use "import trace", as that would import bzrlib.trace instead of
607
# the standard library's trace.
608
trace = __import__('trace')
610
tracer = trace.Trace(count=1, trace=0)
611
sys.settrace(tracer.globaltrace)
613
ret = the_callable(*args, **kwargs)
616
results = tracer.results()
617
results.write_results(show_missing=1, summary=False,
621
def apply_profiled(the_callable, *args, **kwargs):
625
pffileno, pfname = tempfile.mkstemp()
627
prof = hotshot.Profile(pfname)
629
ret = prof.runcall(the_callable, *args, **kwargs) or 0
632
stats = hotshot.stats.load(pfname)
634
stats.sort_stats('cum') # 'time'
635
## XXX: Might like to write to stderr or the trace file instead but
636
## print_stats seems hardcoded to stdout
637
stats.print_stats(20)
644
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
645
from bzrlib.lsprof import profile
646
ret, stats = profile(the_callable, *args, **kwargs)
652
trace.note('Profile data written to "%s".', filename)
656
def shlex_split_unicode(unsplit):
658
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
661
def get_alias(cmd, config=None):
662
"""Return an expanded alias, or None if no alias exists.
665
Command to be checked for an alias.
667
Used to specify an alternative config to use,
668
which is especially useful for testing.
669
If it is unspecified, the global config will be used.
673
config = bzrlib.config.GlobalConfig()
674
alias = config.get_alias(cmd)
676
return shlex_split_unicode(alias)
681
"""Execute a command.
683
This is similar to main(), but without all the trappings for
684
logging and error handling.
687
The command-line arguments, without the program name from argv[0]
688
These should already be decoded. All library/test code calling
689
run_bzr should be passing valid strings (don't need decoding).
691
Returns a command status or raises an exception.
693
Special master options: these must come before the command because
694
they control how the command is interpreted.
697
Do not load plugin modules at all
703
Only use builtin commands. (Plugins are still allowed to change
707
Run under the Python hotshot profiler.
710
Run under the Python lsprof profiler.
713
Generate line coverage report in the specified directory.
716
trace.mutter("bzr arguments: %r", argv)
718
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
719
opt_no_aliases = False
720
opt_lsprof_file = opt_coverage_dir = None
722
# --no-plugins is handled specially at a very early stage. We need
723
# to load plugins before doing other command parsing so that they
724
# can override commands, but this needs to happen first.
732
elif a == '--lsprof':
734
elif a == '--lsprof-file':
736
opt_lsprof_file = argv[i + 1]
738
elif a == '--no-plugins':
739
opt_no_plugins = True
740
elif a == '--no-aliases':
741
opt_no_aliases = True
742
elif a == '--builtin':
744
elif a == '--coverage':
745
opt_coverage_dir = argv[i + 1]
747
elif a.startswith('-D'):
748
debug.debug_flags.add(a[2:])
755
from bzrlib.builtins import cmd_help
756
cmd_help().run_argv_aliases([])
759
if argv[0] == '--version':
760
from bzrlib.builtins import cmd_version
761
cmd_version().run_argv_aliases([])
764
if not opt_no_plugins:
765
from bzrlib.plugin import load_plugins
768
from bzrlib.plugin import disable_plugins
773
if not opt_no_aliases:
774
alias_argv = get_alias(argv[0])
776
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
777
argv[0] = alias_argv.pop(0)
780
# We want only 'ascii' command names, but the user may have typed
781
# in a Unicode name. In that case, they should just get a
782
# 'command not found' error later.
784
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
785
run = cmd_obj.run_argv_aliases
786
run_argv = [argv, alias_argv]
792
'--coverage ignored, because --lsprof is in use.')
793
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
797
'--coverage ignored, because --profile is in use.')
798
ret = apply_profiled(run, *run_argv)
799
elif opt_coverage_dir:
800
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
805
# reset, in case we may do other commands later within the same process
806
option._verbosity_level = 0
808
def display_command(func):
809
"""Decorator that suppresses pipe/interrupt errors."""
810
def ignore_pipe(*args, **kwargs):
812
result = func(*args, **kwargs)
816
if getattr(e, 'errno', None) is None:
818
if e.errno != errno.EPIPE:
819
# Win32 raises IOError with errno=0 on a broken pipe
820
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
823
except KeyboardInterrupt:
830
from bzrlib.ui.text import TextUIFactory
831
bzrlib.ui.ui_factory = TextUIFactory()
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
