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
50
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__])
91
def _squish_command_name(cmd):
92
return 'cmd_' + cmd.replace('-', '_')
95
def _unsquish_command_name(cmd):
96
assert cmd.startswith("cmd_")
97
return cmd[4:].replace('_','-')
100
def _builtin_commands():
101
import bzrlib.builtins
103
builtins = bzrlib.builtins.__dict__
104
for name in builtins:
105
if name.startswith("cmd_"):
106
real_name = _unsquish_command_name(name)
107
r[real_name] = builtins[name]
111
def builtin_command_names():
112
"""Return list of builtin command names."""
113
return _builtin_commands().keys()
116
def plugin_command_names():
117
return plugin_cmds.keys()
120
def _get_cmd_dict(plugins_override=True):
121
"""Return name->class mapping for all commands."""
122
d = _builtin_commands()
124
d.update(plugin_cmds)
128
def get_all_cmds(plugins_override=True):
129
"""Return canonical name and class for all registered commands."""
130
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
134
def get_cmd_object(cmd_name, plugins_override=True):
135
"""Return the canonical name and command class for a command.
138
If true, plugin commands can override builtins.
141
return _get_cmd_object(cmd_name, plugins_override)
143
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
146
def _get_cmd_object(cmd_name, plugins_override=True):
147
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
148
from bzrlib.externalcommand import ExternalCommand
150
# We want only 'ascii' command names, but the user may have typed
151
# in a Unicode name. In that case, they should just get a
152
# 'command not found' error later.
153
# In the future, we may actually support Unicode command names.
155
# first look up this command under the specified name
156
cmds = _get_cmd_dict(plugins_override=plugins_override)
158
return cmds[cmd_name]()
162
# look for any command which claims this as an alias
163
for real_cmd_name, cmd_class in cmds.iteritems():
164
if cmd_name in cmd_class.aliases:
167
cmd_obj = ExternalCommand.find_command(cmd_name)
173
class Command(object):
174
"""Base class for commands.
176
Commands are the heart of the command-line bzr interface.
178
The command object mostly handles the mapping of command-line
179
parameters into one or more bzrlib operations, and of the results
182
Commands normally don't have any state. All their arguments are
183
passed in to the run method. (Subclasses may take a different
184
policy if the behaviour of the instance needs to depend on e.g. a
185
shell plugin and not just its Python class.)
187
The docstring for an actual command should give a single-line
188
summary, then a complete description of the command. A grammar
189
description will be inserted.
192
Other accepted names for this command.
195
List of argument forms, marked with whether they are optional,
200
['to_location', 'from_branch?', 'file*']
202
'to_location' is required
203
'from_branch' is optional
204
'file' can be specified 0 or more times
207
List of options that may be given for this command. These can
208
be either strings, referring to globally-defined options,
209
or option objects. Retrieve through options().
212
If true, this command isn't advertised. This is typically
213
for commands intended for expert users.
216
Command objects will get a 'outf' attribute, which has been
217
setup to properly handle encoding of unicode strings.
218
encoding_type determines what will happen when characters cannot
220
strict - abort if we cannot decode
221
replace - put in a bogus character (typically '?')
222
exact - do not encode sys.stdout
224
NOTE: by default on Windows, sys.stdout is opened as a text
225
stream, therefore LF line-endings are converted to CRLF.
226
When a command uses encoding_type = 'exact', then
227
sys.stdout is forced to be a binary stream, and line-endings
234
encoding_type = 'strict'
239
"""Construct an instance of this command."""
240
if self.__doc__ == Command.__doc__:
241
warn("No help message set for %r" % self)
244
"""Return single-line grammar for this command.
246
Only describes arguments, not options.
248
s = 'bzr ' + self.name() + ' '
249
for aname in self.takes_args:
250
aname = aname.upper()
251
if aname[-1] in ['$', '+']:
252
aname = aname[:-1] + '...'
253
elif aname[-1] == '?':
254
aname = '[' + aname[:-1] + ']'
255
elif aname[-1] == '*':
256
aname = '[' + aname[:-1] + '...]'
263
def get_help_text(self, additional_see_also=None):
264
"""Return a text string with help for this command.
266
:param additional_see_also: Additional help topics to be
271
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
274
result += 'usage:%s\n' % self._usage()
277
result += 'aliases:\n'
278
result += ', '.join(self.aliases) + '\n'
282
plugin_name = self.plugin_name()
283
if plugin_name is not None:
284
result += '(From plugin "%s")' % plugin_name
288
if result[-1] != '\n':
291
result += option.get_optparser(self.options()).format_option_help()
292
see_also = self.get_see_also(additional_see_also)
294
result += '\nSee also: '
295
result += ', '.join(see_also)
299
def get_see_also(self, additional_terms=None):
300
"""Return a list of help topics that are related to this ommand.
302
The list is derived from the content of the _see_also attribute. Any
303
duplicates are removed and the result is in lexical order.
304
:param additional_terms: Additional help topics to cross-reference.
305
:return: A list of help topics.
307
see_also = set(getattr(self, '_see_also', []))
309
see_also.update(additional_terms)
310
return sorted(see_also)
313
"""Return dict of valid options for this command.
315
Maps from long option name to option object."""
317
r['help'] = option.Option.OPTIONS['help']
318
for o in self.takes_options:
319
if isinstance(o, basestring):
320
o = option.Option.OPTIONS[o]
324
def _setup_outf(self):
325
"""Return a file linked to stdout, which has proper encoding."""
326
assert self.encoding_type in ['strict', 'exact', 'replace']
328
# Originally I was using self.stdout, but that looks
329
# *way* too much like sys.stdout
330
if self.encoding_type == 'exact':
331
# force sys.stdout to be binary stream on win32
332
if sys.platform == 'win32':
333
fileno = getattr(sys.stdout, 'fileno', None)
336
msvcrt.setmode(fileno(), os.O_BINARY)
337
self.outf = sys.stdout
340
output_encoding = osutils.get_terminal_encoding()
342
# use 'replace' so that we don't abort if trying to write out
343
# in e.g. the default C locale.
344
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
345
# For whatever reason codecs.getwriter() does not advertise its encoding
346
# it just returns the encoding of the wrapped file, which is completely
347
# bogus. So set the attribute, so we can find the correct encoding later.
348
self.outf.encoding = output_encoding
350
def run_argv_aliases(self, argv, alias_argv=None):
351
"""Parse the command line and run with extra aliases in alias_argv."""
353
warn("Passing None for [] is deprecated from bzrlib 0.10",
354
DeprecationWarning, stacklevel=2)
356
args, opts = parse_args(self, argv, alias_argv)
357
if 'help' in opts: # e.g. bzr add --help
358
sys.stdout.write(self.get_help_text())
360
# mix arguments and options into one dictionary
361
cmdargs = _match_argform(self.name(), self.takes_args, args)
363
for k, v in opts.items():
364
cmdopts[k.replace('-', '_')] = v
366
all_cmd_args = cmdargs.copy()
367
all_cmd_args.update(cmdopts)
371
return self.run(**all_cmd_args)
374
"""Actually run the command.
376
This is invoked with the options and arguments bound to
379
Return 0 or None if the command was successful, or a non-zero
380
shell error code if not. It's OK for this method to allow
381
an exception to raise up.
383
raise NotImplementedError('no implementation of command %r'
387
"""Return help message for this class."""
388
from inspect import getdoc
389
if self.__doc__ is Command.__doc__:
394
return _unsquish_command_name(self.__class__.__name__)
396
def plugin_name(self):
397
"""Get the name of the plugin that provides this command.
399
:return: The name of the plugin or None if the command is builtin.
401
mod_parts = self.__module__.split('.')
402
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
408
# Technically, this function hasn't been use in a *really* long time
409
# but we are only deprecating it now.
410
@deprecated_function(zero_eleven)
411
def parse_spec(spec):
417
>>> parse_spec("../@")
419
>>> parse_spec("../f/@35")
421
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
422
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
427
parsed = spec.split('/@')
428
assert len(parsed) == 2
433
parsed[1] = int(parsed[1])
435
pass # We can allow stuff like ./@revid:blahblahblah
439
parsed = [spec, None]
442
def parse_args(command, argv, alias_argv=None):
443
"""Parse command line.
445
Arguments and options are parsed at this level before being passed
446
down to specific command handlers. This routine knows, from a
447
lookup table, something about the available options, what optargs
448
they take, and which commands will accept them.
450
# TODO: make it a method of the Command?
451
parser = option.get_optparser(command.options())
452
if alias_argv is not None:
453
args = alias_argv + argv
457
options, args = parser.parse_args(args)
458
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
459
v is not option.OptionParser.DEFAULT_VALUE])
463
def _match_argform(cmd, takes_args, args):
466
# step through args and takes_args, allowing appropriate 0-many matches
467
for ap in takes_args:
471
argdict[argname] = args.pop(0)
472
elif ap[-1] == '*': # all remaining arguments
474
argdict[argname + '_list'] = args[:]
477
argdict[argname + '_list'] = None
480
raise errors.BzrCommandError("command %r needs one or more %s"
481
% (cmd, argname.upper()))
483
argdict[argname + '_list'] = args[:]
485
elif ap[-1] == '$': # all but one
487
raise errors.BzrCommandError("command %r needs one or more %s"
488
% (cmd, argname.upper()))
489
argdict[argname + '_list'] = args[:-1]
495
raise errors.BzrCommandError("command %r requires argument %s"
496
% (cmd, argname.upper()))
498
argdict[argname] = args.pop(0)
501
raise errors.BzrCommandError("extra argument to command %s: %s"
508
def apply_profiled(the_callable, *args, **kwargs):
512
pffileno, pfname = tempfile.mkstemp()
514
prof = hotshot.Profile(pfname)
516
ret = prof.runcall(the_callable, *args, **kwargs) or 0
519
stats = hotshot.stats.load(pfname)
521
stats.sort_stats('cum') # 'time'
522
## XXX: Might like to write to stderr or the trace file instead but
523
## print_stats seems hardcoded to stdout
524
stats.print_stats(20)
531
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
532
from bzrlib.lsprof import profile
534
ret, stats = profile(the_callable, *args, **kwargs)
540
cPickle.dump(stats, open(filename, 'w'), 2)
541
print 'Profile data written to %r.' % filename
545
def get_alias(cmd, config=None):
546
"""Return an expanded alias, or None if no alias exists.
549
Command to be checked for an alias.
551
Used to specify an alternative config to use,
552
which is especially useful for testing.
553
If it is unspecified, the global config will be used.
557
config = bzrlib.config.GlobalConfig()
558
alias = config.get_alias(cmd)
561
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
566
"""Execute a command.
568
This is similar to main(), but without all the trappings for
569
logging and error handling.
572
The command-line arguments, without the program name from argv[0]
573
These should already be decoded. All library/test code calling
574
run_bzr should be passing valid strings (don't need decoding).
576
Returns a command status or raises an exception.
578
Special master options: these must come before the command because
579
they control how the command is interpreted.
582
Do not load plugin modules at all
588
Only use builtin commands. (Plugins are still allowed to change
592
Run under the Python hotshot profiler.
595
Run under the Python lsprof profiler.
598
trace.mutter("bzr arguments: %r", argv)
600
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
601
opt_no_aliases = False
602
opt_lsprof_file = None
604
# --no-plugins is handled specially at a very early stage. We need
605
# to load plugins before doing other command parsing so that they
606
# can override commands, but this needs to happen first.
614
elif a == '--lsprof':
616
elif a == '--lsprof-file':
618
opt_lsprof_file = argv[i + 1]
620
elif a == '--no-plugins':
621
opt_no_plugins = True
622
elif a == '--no-aliases':
623
opt_no_aliases = True
624
elif a == '--builtin':
626
elif a in ('--quiet', '-q'):
628
elif a.startswith('-D'):
629
debug.debug_flags.add(a[2:])
636
from bzrlib.builtins import cmd_help
637
cmd_help().run_argv_aliases([])
640
if argv[0] == '--version':
641
from bzrlib.version import show_version
645
if not opt_no_plugins:
646
from bzrlib.plugin import load_plugins
649
from bzrlib.plugin import disable_plugins
654
if not opt_no_aliases:
655
alias_argv = get_alias(argv[0])
657
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
658
argv[0] = alias_argv.pop(0)
661
# We want only 'ascii' command names, but the user may have typed
662
# in a Unicode name. In that case, they should just get a
663
# 'command not found' error later.
665
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
666
run = cmd_obj.run_argv_aliases
667
run_argv = [argv, alias_argv]
671
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
673
ret = apply_profiled(run, *run_argv)
678
# reset, in case we may do other commands later within the same process
679
trace.be_quiet(False)
681
def display_command(func):
682
"""Decorator that suppresses pipe/interrupt errors."""
683
def ignore_pipe(*args, **kwargs):
685
result = func(*args, **kwargs)
689
if getattr(e, 'errno', None) is None:
691
if e.errno != errno.EPIPE:
692
# Win32 raises IOError with errno=0 on a broken pipe
693
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
696
except KeyboardInterrupt:
703
from bzrlib.ui.text import TextUIFactory
704
bzrlib.ui.ui_factory = TextUIFactory()
705
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
706
ret = run_bzr_catch_errors(argv)
707
trace.mutter("return code %d", ret)
711
def run_bzr_catch_errors(argv):
714
# do this here inside the exception wrappers to catch EPIPE
716
except (KeyboardInterrupt, Exception), e:
717
# used to handle AssertionError and KeyboardInterrupt
718
# specially here, but hopefully they're handled ok by the logger now
719
trace.report_exception(sys.exc_info(), sys.stderr)
720
if os.environ.get('BZR_PDB'):
721
print '**** entering debugger'
723
pdb.post_mortem(sys.exc_traceback)
727
class HelpCommandIndex(object):
728
"""A index for bzr help that returns commands."""
731
self.prefix = 'commands/'
733
def get_topics(self, topic):
734
"""Search for topic amongst commands.
736
:param topic: A topic to search for.
737
:return: A list which is either empty or contains a single
740
if topic and topic.startswith(self.prefix):
741
topic = topic[len(self.prefix):]
743
cmd = _get_cmd_object(topic)
750
if __name__ == '__main__':
751
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
