1
# Copyright (C) 2006, 2008 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 import registry
53
from bzrlib.option import Option
56
class CommandInfo(object):
57
"""Information about a command."""
59
def __init__(self, aliases):
60
"""The list of aliases for the command."""
61
self.aliases = aliases
64
def from_command(klass, command):
65
"""Factory to construct a CommandInfo from a command."""
66
return klass(command.aliases)
69
class CommandRegistry(registry.Registry):
72
def _get_name(command_name):
73
if command_name.startswith("cmd_"):
74
return _unsquish_command_name(command_name)
78
def register(self, cmd, decorate=False):
79
"""Utility function to help register a command
81
:param cmd: Command subclass to register
82
:param decorate: If true, allow overriding an existing command
83
of the same name; the old command is returned by this function.
84
Otherwise it is an error to try to override an existing command.
87
k_unsquished = self._get_name(k)
89
previous = self.get(k_unsquished)
91
previous = _builtin_commands().get(k_unsquished)
92
info = CommandInfo.from_command(cmd)
94
registry.Registry.register(self, k_unsquished, cmd,
95
override_existing=decorate, info=info)
97
trace.log_error('Two plugins defined the same command: %r' % k)
98
trace.log_error('Not loading the one in %r' %
99
sys.modules[cmd.__module__])
100
trace.log_error('Previously this command was registered from %r' %
101
sys.modules[previous.__module__])
104
def register_lazy(self, command_name, aliases, module_name):
105
"""Register a command without loading its module.
107
:param command_name: The primary name of the command.
108
:param aliases: A list of aliases for the command.
109
:module_name: The module that the command lives in.
111
key = self._get_name(command_name)
112
registry.Registry.register_lazy(self, key, module_name, command_name,
113
info=CommandInfo(aliases))
116
plugin_cmds = CommandRegistry()
119
def register_command(cmd, decorate=False):
121
return plugin_cmds.register(cmd, decorate)
124
def _squish_command_name(cmd):
125
return 'cmd_' + cmd.replace('-', '_')
128
def _unsquish_command_name(cmd):
129
return cmd[4:].replace('_','-')
132
def _builtin_commands():
133
import bzrlib.builtins
135
builtins = bzrlib.builtins.__dict__
136
for name in builtins:
137
if name.startswith("cmd_"):
138
real_name = _unsquish_command_name(name)
139
r[real_name] = builtins[name]
143
def builtin_command_names():
144
"""Return list of builtin command names."""
145
return _builtin_commands().keys()
148
def plugin_command_names():
149
return plugin_cmds.keys()
152
def _get_cmd_dict(plugins_override=True):
153
"""Return name->class mapping for all commands."""
154
d = _builtin_commands()
156
d.update(plugin_cmds.iteritems())
160
def get_all_cmds(plugins_override=True):
161
"""Return canonical name and class for all registered commands."""
162
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
166
def get_cmd_object(cmd_name, plugins_override=True):
167
"""Return the canonical name and command class for a command.
170
If true, plugin commands can override builtins.
173
return _get_cmd_object(cmd_name, plugins_override)
175
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
178
def _get_cmd_object(cmd_name, plugins_override=True):
179
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
180
from bzrlib.externalcommand import ExternalCommand
182
# We want only 'ascii' command names, but the user may have typed
183
# in a Unicode name. In that case, they should just get a
184
# 'command not found' error later.
185
# In the future, we may actually support Unicode command names.
187
# first look up this command under the specified name
190
return plugin_cmds.get(cmd_name)()
193
cmds = _get_cmd_dict(plugins_override=False)
195
return cmds[cmd_name]()
199
for key in plugin_cmds.keys():
200
info = plugin_cmds.get_info(key)
201
if cmd_name in info.aliases:
202
return plugin_cmds.get(key)()
203
# look for any command which claims this as an alias
204
for real_cmd_name, cmd_class in cmds.iteritems():
205
if cmd_name in cmd_class.aliases:
208
cmd_obj = ExternalCommand.find_command(cmd_name)
212
# look for plugins that provide this command but aren't installed
213
for provider in command_providers_registry:
215
plugin_metadata = provider.plugin_for_command(cmd_name)
216
except errors.NoPluginAvailable:
219
raise errors.CommandAvailableInPlugin(cmd_name,
220
plugin_metadata, provider)
225
class Command(object):
226
"""Base class for commands.
228
Commands are the heart of the command-line bzr interface.
230
The command object mostly handles the mapping of command-line
231
parameters into one or more bzrlib operations, and of the results
234
Commands normally don't have any state. All their arguments are
235
passed in to the run method. (Subclasses may take a different
236
policy if the behaviour of the instance needs to depend on e.g. a
237
shell plugin and not just its Python class.)
239
The docstring for an actual command should give a single-line
240
summary, then a complete description of the command. A grammar
241
description will be inserted.
244
Other accepted names for this command.
247
List of argument forms, marked with whether they are optional,
252
['to_location', 'from_branch?', 'file*']
254
'to_location' is required
255
'from_branch' is optional
256
'file' can be specified 0 or more times
259
List of options that may be given for this command. These can
260
be either strings, referring to globally-defined options,
261
or option objects. Retrieve through options().
264
If true, this command isn't advertised. This is typically
265
for commands intended for expert users.
268
Command objects will get a 'outf' attribute, which has been
269
setup to properly handle encoding of unicode strings.
270
encoding_type determines what will happen when characters cannot
272
strict - abort if we cannot decode
273
replace - put in a bogus character (typically '?')
274
exact - do not encode sys.stdout
276
NOTE: by default on Windows, sys.stdout is opened as a text
277
stream, therefore LF line-endings are converted to CRLF.
278
When a command uses encoding_type = 'exact', then
279
sys.stdout is forced to be a binary stream, and line-endings
286
encoding_type = 'strict'
291
"""Construct an instance of this command."""
292
if self.__doc__ == Command.__doc__:
293
warn("No help message set for %r" % self)
294
# List of standard options directly supported
295
self.supported_std_options = []
297
def _maybe_expand_globs(self, file_list):
298
"""Glob expand file_list if the platform does not do that itself.
300
:return: A possibly empty list of unicode paths.
302
Introduced in bzrlib 0.18.
306
if sys.platform == 'win32':
307
file_list = win32utils.glob_expand(file_list)
308
return list(file_list)
311
"""Return single-line grammar for this command.
313
Only describes arguments, not options.
315
s = 'bzr ' + self.name() + ' '
316
for aname in self.takes_args:
317
aname = aname.upper()
318
if aname[-1] in ['$', '+']:
319
aname = aname[:-1] + '...'
320
elif aname[-1] == '?':
321
aname = '[' + aname[:-1] + ']'
322
elif aname[-1] == '*':
323
aname = '[' + aname[:-1] + '...]'
325
s = s[:-1] # remove last space
328
def get_help_text(self, additional_see_also=None, plain=True,
329
see_also_as_links=False):
330
"""Return a text string with help for this command.
332
:param additional_see_also: Additional help topics to be
334
:param plain: if False, raw help (reStructuredText) is
335
returned instead of plain text.
336
:param see_also_as_links: if True, convert items in 'See also'
337
list to internal links (used by bzr_man rstx generator)
341
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
343
# Extract the summary (purpose) and sections out from the text
344
purpose,sections = self._get_help_parts(doc)
346
# If a custom usage section was provided, use it
347
if sections.has_key('Usage'):
348
usage = sections.pop('Usage')
350
usage = self._usage()
352
# The header is the purpose and usage
354
result += ':Purpose: %s\n' % purpose
355
if usage.find('\n') >= 0:
356
result += ':Usage:\n%s\n' % usage
358
result += ':Usage: %s\n' % usage
362
options = option.get_optparser(self.options()).format_option_help()
363
if options.startswith('Options:'):
364
result += ':' + options
365
elif options.startswith('options:'):
366
# Python 2.4 version of optparse
367
result += ':Options:' + options[len('options:'):]
372
# Add the description, indenting it 2 spaces
373
# to match the indentation of the options
374
if sections.has_key(None):
375
text = sections.pop(None)
376
text = '\n '.join(text.splitlines())
377
result += ':%s:\n %s\n\n' % ('Description',text)
379
# Add the custom sections (e.g. Examples). Note that there's no need
380
# to indent these as they must be indented already in the source.
382
labels = sorted(sections.keys())
384
result += ':%s:\n%s\n\n' % (label,sections[label])
386
# Add the aliases, source (plug-in) and see also links, if any
388
result += ':Aliases: '
389
result += ', '.join(self.aliases) + '\n'
390
plugin_name = self.plugin_name()
391
if plugin_name is not None:
392
result += ':From: plugin "%s"\n' % plugin_name
393
see_also = self.get_see_also(additional_see_also)
395
if not plain and see_also_as_links:
397
for item in see_also:
399
# topics doesn't have an independent section
400
# so don't create a real link
401
see_also_links.append(item)
403
# Use a reST link for this entry
404
see_also_links.append("`%s`_" % (item,))
405
see_also = see_also_links
406
result += ':See also: '
407
result += ', '.join(see_also) + '\n'
409
# If this will be rendered as plain text, convert it
411
import bzrlib.help_topics
412
result = bzrlib.help_topics.help_as_plain_text(result)
416
def _get_help_parts(text):
417
"""Split help text into a summary and named sections.
419
:return: (summary,sections) where summary is the top line and
420
sections is a dictionary of the rest indexed by section name.
421
A section starts with a heading line of the form ":xxx:".
422
Indented text on following lines is the section value.
423
All text found outside a named section is assigned to the
424
default section which is given the key of None.
426
def save_section(sections, label, section):
428
if sections.has_key(label):
429
sections[label] += '\n' + section
431
sections[label] = section
433
lines = text.rstrip().splitlines()
434
summary = lines.pop(0)
436
label,section = None,''
438
if line.startswith(':') and line.endswith(':') and len(line) > 2:
439
save_section(sections, label, section)
440
label,section = line[1:-1],''
441
elif (label is not None) and len(line) > 1 and not line[0].isspace():
442
save_section(sections, label, section)
443
label,section = None,line
446
section += '\n' + line
449
save_section(sections, label, section)
450
return summary, sections
452
def get_help_topic(self):
453
"""Return the commands help topic - its name."""
456
def get_see_also(self, additional_terms=None):
457
"""Return a list of help topics that are related to this command.
459
The list is derived from the content of the _see_also attribute. Any
460
duplicates are removed and the result is in lexical order.
461
:param additional_terms: Additional help topics to cross-reference.
462
:return: A list of help topics.
464
see_also = set(getattr(self, '_see_also', []))
466
see_also.update(additional_terms)
467
return sorted(see_also)
470
"""Return dict of valid options for this command.
472
Maps from long option name to option object."""
473
r = Option.STD_OPTIONS.copy()
475
for o in self.takes_options:
476
if isinstance(o, basestring):
477
o = option.Option.OPTIONS[o]
479
if o.name in std_names:
480
self.supported_std_options.append(o.name)
483
def _setup_outf(self):
484
"""Return a file linked to stdout, which has proper encoding."""
485
# Originally I was using self.stdout, but that looks
486
# *way* too much like sys.stdout
487
if self.encoding_type == 'exact':
488
# force sys.stdout to be binary stream on win32
489
if sys.platform == 'win32':
490
fileno = getattr(sys.stdout, 'fileno', None)
493
msvcrt.setmode(fileno(), os.O_BINARY)
494
self.outf = sys.stdout
497
output_encoding = osutils.get_terminal_encoding()
499
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
500
errors=self.encoding_type)
501
# For whatever reason codecs.getwriter() does not advertise its encoding
502
# it just returns the encoding of the wrapped file, which is completely
503
# bogus. So set the attribute, so we can find the correct encoding later.
504
self.outf.encoding = output_encoding
506
def run_argv_aliases(self, argv, alias_argv=None):
507
"""Parse the command line and run with extra aliases in alias_argv."""
509
warn("Passing None for [] is deprecated from bzrlib 0.10",
510
DeprecationWarning, stacklevel=2)
512
args, opts = parse_args(self, argv, alias_argv)
514
# Process the standard options
515
if 'help' in opts: # e.g. bzr add --help
516
sys.stdout.write(self.get_help_text())
518
trace.set_verbosity_level(option._verbosity_level)
519
if 'verbose' in self.supported_std_options:
520
opts['verbose'] = trace.is_verbose()
521
elif opts.has_key('verbose'):
523
if 'quiet' in self.supported_std_options:
524
opts['quiet'] = trace.is_quiet()
525
elif opts.has_key('quiet'):
528
# mix arguments and options into one dictionary
529
cmdargs = _match_argform(self.name(), self.takes_args, args)
531
for k, v in opts.items():
532
cmdopts[k.replace('-', '_')] = v
534
all_cmd_args = cmdargs.copy()
535
all_cmd_args.update(cmdopts)
539
return self.run(**all_cmd_args)
542
"""Actually run the command.
544
This is invoked with the options and arguments bound to
547
Return 0 or None if the command was successful, or a non-zero
548
shell error code if not. It's OK for this method to allow
549
an exception to raise up.
551
raise NotImplementedError('no implementation of command %r'
555
"""Return help message for this class."""
556
from inspect import getdoc
557
if self.__doc__ is Command.__doc__:
562
return _unsquish_command_name(self.__class__.__name__)
564
def plugin_name(self):
565
"""Get the name of the plugin that provides this command.
567
:return: The name of the plugin or None if the command is builtin.
569
mod_parts = self.__module__.split('.')
570
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
576
def parse_args(command, argv, alias_argv=None):
577
"""Parse command line.
579
Arguments and options are parsed at this level before being passed
580
down to specific command handlers. This routine knows, from a
581
lookup table, something about the available options, what optargs
582
they take, and which commands will accept them.
584
# TODO: make it a method of the Command?
585
parser = option.get_optparser(command.options())
586
if alias_argv is not None:
587
args = alias_argv + argv
591
options, args = parser.parse_args(args)
592
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
593
v is not option.OptionParser.DEFAULT_VALUE])
597
def _match_argform(cmd, takes_args, args):
600
# step through args and takes_args, allowing appropriate 0-many matches
601
for ap in takes_args:
605
argdict[argname] = args.pop(0)
606
elif ap[-1] == '*': # all remaining arguments
608
argdict[argname + '_list'] = args[:]
611
argdict[argname + '_list'] = None
614
raise errors.BzrCommandError("command %r needs one or more %s"
615
% (cmd, argname.upper()))
617
argdict[argname + '_list'] = args[:]
619
elif ap[-1] == '$': # all but one
621
raise errors.BzrCommandError("command %r needs one or more %s"
622
% (cmd, argname.upper()))
623
argdict[argname + '_list'] = args[:-1]
629
raise errors.BzrCommandError("command %r requires argument %s"
630
% (cmd, argname.upper()))
632
argdict[argname] = args.pop(0)
635
raise errors.BzrCommandError("extra argument to command %s: %s"
640
def apply_coveraged(dirname, the_callable, *args, **kwargs):
641
# Cannot use "import trace", as that would import bzrlib.trace instead of
642
# the standard library's trace.
643
trace = __import__('trace')
645
tracer = trace.Trace(count=1, trace=0)
646
sys.settrace(tracer.globaltrace)
648
ret = the_callable(*args, **kwargs)
651
results = tracer.results()
652
results.write_results(show_missing=1, summary=False,
656
def apply_profiled(the_callable, *args, **kwargs):
660
pffileno, pfname = tempfile.mkstemp()
662
prof = hotshot.Profile(pfname)
664
ret = prof.runcall(the_callable, *args, **kwargs) or 0
667
stats = hotshot.stats.load(pfname)
669
stats.sort_stats('cum') # 'time'
670
## XXX: Might like to write to stderr or the trace file instead but
671
## print_stats seems hardcoded to stdout
672
stats.print_stats(20)
679
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
680
from bzrlib.lsprof import profile
681
ret, stats = profile(the_callable, *args, **kwargs)
687
trace.note('Profile data written to "%s".', filename)
691
def shlex_split_unicode(unsplit):
693
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
696
def get_alias(cmd, config=None):
697
"""Return an expanded alias, or None if no alias exists.
700
Command to be checked for an alias.
702
Used to specify an alternative config to use,
703
which is especially useful for testing.
704
If it is unspecified, the global config will be used.
708
config = bzrlib.config.GlobalConfig()
709
alias = config.get_alias(cmd)
711
return shlex_split_unicode(alias)
716
"""Execute a command.
719
The command-line arguments, without the program name from argv[0]
720
These should already be decoded. All library/test code calling
721
run_bzr should be passing valid strings (don't need decoding).
723
Returns a command status or raises an exception.
725
Special master options: these must come before the command because
726
they control how the command is interpreted.
729
Do not load plugin modules at all
735
Only use builtin commands. (Plugins are still allowed to change
739
Run under the Python hotshot profiler.
742
Run under the Python lsprof profiler.
745
Generate line coverage report in the specified directory.
748
trace.mutter("bzr arguments: %r", argv)
750
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
751
opt_no_aliases = False
752
opt_lsprof_file = opt_coverage_dir = None
754
# --no-plugins is handled specially at a very early stage. We need
755
# to load plugins before doing other command parsing so that they
756
# can override commands, but this needs to happen first.
764
elif a == '--lsprof':
766
elif a == '--lsprof-file':
768
opt_lsprof_file = argv[i + 1]
770
elif a == '--no-plugins':
771
opt_no_plugins = True
772
elif a == '--no-aliases':
773
opt_no_aliases = True
774
elif a == '--builtin':
776
elif a == '--coverage':
777
opt_coverage_dir = argv[i + 1]
779
elif a.startswith('-D'):
780
debug.debug_flags.add(a[2:])
787
from bzrlib.builtins import cmd_help
788
cmd_help().run_argv_aliases([])
791
if argv[0] == '--version':
792
from bzrlib.builtins import cmd_version
793
cmd_version().run_argv_aliases([])
796
if not opt_no_plugins:
797
from bzrlib.plugin import load_plugins
800
from bzrlib.plugin import disable_plugins
805
if not opt_no_aliases:
806
alias_argv = get_alias(argv[0])
808
user_encoding = osutils.get_user_encoding()
809
alias_argv = [a.decode(user_encoding) for a in alias_argv]
810
argv[0] = alias_argv.pop(0)
813
# We want only 'ascii' command names, but the user may have typed
814
# in a Unicode name. In that case, they should just get a
815
# 'command not found' error later.
817
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
818
run = cmd_obj.run_argv_aliases
819
run_argv = [argv, alias_argv]
822
# We can be called recursively (tests for example), but we don't want
823
# the verbosity level to propagate.
824
saved_verbosity_level = option._verbosity_level
825
option._verbosity_level = 0
829
'--coverage ignored, because --lsprof is in use.')
830
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
834
'--coverage ignored, because --profile is in use.')
835
ret = apply_profiled(run, *run_argv)
836
elif opt_coverage_dir:
837
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
840
if 'memory' in debug.debug_flags:
841
trace.debug_memory('Process status after command:', short=False)
844
# reset, in case we may do other commands later within the same
845
# process. Commands that want to execute sub-commands must propagate
846
# --verbose in their own way.
847
option._verbosity_level = saved_verbosity_level
849
def display_command(func):
850
"""Decorator that suppresses pipe/interrupt errors."""
851
def ignore_pipe(*args, **kwargs):
853
result = func(*args, **kwargs)
857
if getattr(e, 'errno', None) is None:
859
if e.errno != errno.EPIPE:
860
# Win32 raises IOError with errno=0 on a broken pipe
861
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
864
except KeyboardInterrupt:
871
from bzrlib.ui.text import TextUIFactory
872
bzrlib.ui.ui_factory = TextUIFactory()
874
# Is this a final release version? If so, we should suppress warnings
875
if bzrlib.version_info[3] == 'final':
876
from bzrlib import symbol_versioning
877
symbol_versioning.suppress_deprecation_warnings(override=False)
879
user_encoding = osutils.get_user_encoding()
880
argv = [a.decode(user_encoding) for a in argv[1:]]
881
except UnicodeDecodeError:
882
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
884
ret = run_bzr_catch_errors(argv)
885
trace.mutter("return code %d", ret)
889
def run_bzr_catch_errors(argv):
890
# Note: The except clause logic below should be kept in sync with the
891
# profile() routine in lsprof.py.
894
except (KeyboardInterrupt, Exception), e:
895
# used to handle AssertionError and KeyboardInterrupt
896
# specially here, but hopefully they're handled ok by the logger now
897
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
898
if os.environ.get('BZR_PDB'):
899
print '**** entering debugger'
901
pdb.post_mortem(sys.exc_traceback)
905
def run_bzr_catch_user_errors(argv):
906
"""Run bzr and report user errors, but let internal errors propagate.
908
This is used for the test suite, and might be useful for other programs
909
that want to wrap the commandline interface.
914
if (isinstance(e, (OSError, IOError))
915
or not getattr(e, 'internal_error', True)):
916
trace.report_exception(sys.exc_info(), sys.stderr)
922
class HelpCommandIndex(object):
923
"""A index for bzr help that returns commands."""
926
self.prefix = 'commands/'
928
def get_topics(self, topic):
929
"""Search for topic amongst commands.
931
:param topic: A topic to search for.
932
:return: A list which is either empty or contains a single
935
if topic and topic.startswith(self.prefix):
936
topic = topic[len(self.prefix):]
938
cmd = _get_cmd_object(topic)
945
class Provider(object):
946
'''Generic class to be overriden by plugins'''
948
def plugin_for_command(self, cmd_name):
949
'''Takes a command and returns the information for that plugin
951
:return: A dictionary with all the available information
952
for the requested plugin
954
raise NotImplementedError
957
class ProvidersRegistry(registry.Registry):
958
'''This registry exists to allow other providers to exist'''
961
for key, provider in self.iteritems():
964
command_providers_registry = ProvidersRegistry()
967
if __name__ == '__main__':
968
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
