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
49
from bzrlib.symbol_versioning import (
56
from bzrlib.option import Option
62
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
65
:param cmd: Command subclass to register
66
:param decorate: If true, allow overriding an existing command
67
of the same name; the old command is returned by this function.
68
Otherwise it is an error to try to override an existing command.
72
if k.startswith("cmd_"):
73
k_unsquished = _unsquish_command_name(k)
76
if k_unsquished not in plugin_cmds:
77
plugin_cmds[k_unsquished] = cmd
78
trace.mutter('registered plugin command %s', k_unsquished)
79
if decorate and k_unsquished in builtin_command_names():
80
return _builtin_commands()[k_unsquished]
82
result = plugin_cmds[k_unsquished]
83
plugin_cmds[k_unsquished] = cmd
86
trace.log_error('Two plugins defined the same command: %r' % k)
87
trace.log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
90
def _squish_command_name(cmd):
91
return 'cmd_' + cmd.replace('-', '_')
94
def _unsquish_command_name(cmd):
95
assert cmd.startswith("cmd_")
96
return cmd[4:].replace('_','-')
99
def _builtin_commands():
100
import bzrlib.builtins
102
builtins = bzrlib.builtins.__dict__
103
for name in builtins:
104
if name.startswith("cmd_"):
105
real_name = _unsquish_command_name(name)
106
r[real_name] = builtins[name]
110
def builtin_command_names():
111
"""Return list of builtin command names."""
112
return _builtin_commands().keys()
115
def plugin_command_names():
116
return plugin_cmds.keys()
119
def _get_cmd_dict(plugins_override=True):
120
"""Return name->class mapping for all commands."""
121
d = _builtin_commands()
123
d.update(plugin_cmds)
127
def get_all_cmds(plugins_override=True):
128
"""Return canonical name and class for all registered commands."""
129
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
133
def get_cmd_object(cmd_name, plugins_override=True):
134
"""Return the canonical name and command class for a command.
137
If true, plugin commands can override builtins.
139
from bzrlib.externalcommand import ExternalCommand
141
# We want only 'ascii' command names, but the user may have typed
142
# in a Unicode name. In that case, they should just get a
143
# 'command not found' error later.
144
# In the future, we may actually support Unicode command names.
146
# first look up this command under the specified name
147
cmds = _get_cmd_dict(plugins_override=plugins_override)
149
return cmds[cmd_name]()
153
# look for any command which claims this as an alias
154
for real_cmd_name, cmd_class in cmds.iteritems():
155
if cmd_name in cmd_class.aliases:
158
cmd_obj = ExternalCommand.find_command(cmd_name)
162
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
165
class Command(object):
166
"""Base class for commands.
168
Commands are the heart of the command-line bzr interface.
170
The command object mostly handles the mapping of command-line
171
parameters into one or more bzrlib operations, and of the results
174
Commands normally don't have any state. All their arguments are
175
passed in to the run method. (Subclasses may take a different
176
policy if the behaviour of the instance needs to depend on e.g. a
177
shell plugin and not just its Python class.)
179
The docstring for an actual command should give a single-line
180
summary, then a complete description of the command. A grammar
181
description will be inserted.
184
Other accepted names for this command.
187
List of argument forms, marked with whether they are optional,
192
['to_location', 'from_branch?', 'file*']
194
'to_location' is required
195
'from_branch' is optional
196
'file' can be specified 0 or more times
199
List of options that may be given for this command. These can
200
be either strings, referring to globally-defined options,
201
or option objects. Retrieve through options().
204
If true, this command isn't advertised. This is typically
205
for commands intended for expert users.
208
Command objects will get a 'outf' attribute, which has been
209
setup to properly handle encoding of unicode strings.
210
encoding_type determines what will happen when characters cannot
212
strict - abort if we cannot decode
213
replace - put in a bogus character (typically '?')
214
exact - do not encode sys.stdout
220
encoding_type = 'strict'
225
"""Construct an instance of this command."""
226
if self.__doc__ == Command.__doc__:
227
warn("No help message set for %r" % self)
230
"""Return dict of valid options for this command.
232
Maps from long option name to option object."""
234
r['help'] = option.Option.OPTIONS['help']
235
for o in self.takes_options:
236
if isinstance(o, basestring):
237
o = option.Option.OPTIONS[o]
241
def _setup_outf(self):
242
"""Return a file linked to stdout, which has proper encoding."""
243
assert self.encoding_type in ['strict', 'exact', 'replace']
245
# Originally I was using self.stdout, but that looks
246
# *way* too much like sys.stdout
247
if self.encoding_type == 'exact':
248
self.outf = sys.stdout
251
output_encoding = osutils.get_terminal_encoding()
253
# use 'replace' so that we don't abort if trying to write out
254
# in e.g. the default C locale.
255
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
256
# For whatever reason codecs.getwriter() does not advertise its encoding
257
# it just returns the encoding of the wrapped file, which is completely
258
# bogus. So set the attribute, so we can find the correct encoding later.
259
self.outf.encoding = output_encoding
261
@deprecated_method(zero_eight)
262
def run_argv(self, argv):
263
"""Parse command line and run.
265
See run_argv_aliases for the 0.8 and beyond api.
267
return self.run_argv_aliases(argv)
269
def run_argv_aliases(self, argv, alias_argv=None):
270
"""Parse the command line and run with extra aliases in alias_argv."""
272
warn("Passing None for [] is deprecated from bzrlib 0.10",
273
DeprecationWarning, stacklevel=2)
275
args, opts = parse_args(self, argv, alias_argv)
276
if 'help' in opts: # e.g. bzr add --help
277
from bzrlib.help import help_on_command
278
help_on_command(self.name())
280
# mix arguments and options into one dictionary
281
cmdargs = _match_argform(self.name(), self.takes_args, args)
283
for k, v in opts.items():
284
cmdopts[k.replace('-', '_')] = v
286
all_cmd_args = cmdargs.copy()
287
all_cmd_args.update(cmdopts)
291
return self.run(**all_cmd_args)
294
"""Actually run the command.
296
This is invoked with the options and arguments bound to
299
Return 0 or None if the command was successful, or a non-zero
300
shell error code if not. It's OK for this method to allow
301
an exception to raise up.
303
raise NotImplementedError('no implementation of command %r'
307
"""Return help message for this class."""
308
from inspect import getdoc
309
if self.__doc__ is Command.__doc__:
314
return _unsquish_command_name(self.__class__.__name__)
316
def plugin_name(self):
317
"""Get the name of the plugin that provides this command.
319
:return: The name of the plugin or None if the command is builtin.
321
mod_parts = self.__module__.split('.')
322
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
328
# Technically, this function hasn't been use in a *really* long time
329
# but we are only deprecating it now.
330
@deprecated_function(zero_eleven)
331
def parse_spec(spec):
337
>>> parse_spec("../@")
339
>>> parse_spec("../f/@35")
341
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
342
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
347
parsed = spec.split('/@')
348
assert len(parsed) == 2
353
parsed[1] = int(parsed[1])
355
pass # We can allow stuff like ./@revid:blahblahblah
359
parsed = [spec, None]
362
def parse_args(command, argv, alias_argv=None):
363
"""Parse command line.
365
Arguments and options are parsed at this level before being passed
366
down to specific command handlers. This routine knows, from a
367
lookup table, something about the available options, what optargs
368
they take, and which commands will accept them.
370
# TODO: make it a method of the Command?
371
parser = option.get_optparser(command.options())
372
if alias_argv is not None:
373
args = alias_argv + argv
377
options, args = parser.parse_args(args)
378
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
379
v is not option.OptionParser.DEFAULT_VALUE])
383
def _match_argform(cmd, takes_args, args):
386
# step through args and takes_args, allowing appropriate 0-many matches
387
for ap in takes_args:
391
argdict[argname] = args.pop(0)
392
elif ap[-1] == '*': # all remaining arguments
394
argdict[argname + '_list'] = args[:]
397
argdict[argname + '_list'] = None
400
raise errors.BzrCommandError("command %r needs one or more %s"
401
% (cmd, argname.upper()))
403
argdict[argname + '_list'] = args[:]
405
elif ap[-1] == '$': # all but one
407
raise errors.BzrCommandError("command %r needs one or more %s"
408
% (cmd, argname.upper()))
409
argdict[argname + '_list'] = args[:-1]
415
raise errors.BzrCommandError("command %r requires argument %s"
416
% (cmd, argname.upper()))
418
argdict[argname] = args.pop(0)
421
raise errors.BzrCommandError("extra argument to command %s: %s"
428
def apply_profiled(the_callable, *args, **kwargs):
432
pffileno, pfname = tempfile.mkstemp()
434
prof = hotshot.Profile(pfname)
436
ret = prof.runcall(the_callable, *args, **kwargs) or 0
439
stats = hotshot.stats.load(pfname)
441
stats.sort_stats('cum') # 'time'
442
## XXX: Might like to write to stderr or the trace file instead but
443
## print_stats seems hardcoded to stdout
444
stats.print_stats(20)
451
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
452
from bzrlib.lsprof import profile
454
ret, stats = profile(the_callable, *args, **kwargs)
460
cPickle.dump(stats, open(filename, 'w'), 2)
461
print 'Profile data written to %r.' % filename
466
"""Return an expanded alias, or None if no alias exists"""
468
alias = bzrlib.config.GlobalConfig().get_alias(cmd)
470
return alias.split(' ')
475
"""Execute a command.
477
This is similar to main(), but without all the trappings for
478
logging and error handling.
481
The command-line arguments, without the program name from argv[0]
482
These should already be decoded. All library/test code calling
483
run_bzr should be passing valid strings (don't need decoding).
485
Returns a command status or raises an exception.
487
Special master options: these must come before the command because
488
they control how the command is interpreted.
491
Do not load plugin modules at all
497
Only use builtin commands. (Plugins are still allowed to change
501
Run under the Python hotshot profiler.
504
Run under the Python lsprof profiler.
508
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
509
opt_no_aliases = False
510
opt_lsprof_file = None
512
# --no-plugins is handled specially at a very early stage. We need
513
# to load plugins before doing other command parsing so that they
514
# can override commands, but this needs to happen first.
522
elif a == '--lsprof':
524
elif a == '--lsprof-file':
526
opt_lsprof_file = argv[i + 1]
528
elif a == '--no-plugins':
529
opt_no_plugins = True
530
elif a == '--no-aliases':
531
opt_no_aliases = True
532
elif a == '--builtin':
534
elif a in ('--quiet', '-q'):
542
from bzrlib.builtins import cmd_help
543
cmd_help().run_argv_aliases([])
546
if argv[0] == '--version':
547
from bzrlib.version import show_version
551
if not opt_no_plugins:
552
from bzrlib.plugin import load_plugins
555
from bzrlib.plugin import disable_plugins
560
if not opt_no_aliases:
561
alias_argv = get_alias(argv[0])
563
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
564
argv[0] = alias_argv.pop(0)
567
# We want only 'ascii' command names, but the user may have typed
568
# in a Unicode name. In that case, they should just get a
569
# 'command not found' error later.
571
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
572
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
573
run = cmd_obj.run_argv
576
run = cmd_obj.run_argv_aliases
577
run_argv = [argv, alias_argv]
581
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
583
ret = apply_profiled(run, *run_argv)
588
# reset, in case we may do other commands later within the same process
589
trace.be_quiet(False)
591
def display_command(func):
592
"""Decorator that suppresses pipe/interrupt errors."""
593
def ignore_pipe(*args, **kwargs):
595
result = func(*args, **kwargs)
599
if getattr(e, 'errno', None) is None:
601
if e.errno != errno.EPIPE:
602
# Win32 raises IOError with errno=0 on a broken pipe
603
if sys.platform != 'win32' or e.errno != 0:
606
except KeyboardInterrupt:
613
from bzrlib.ui.text import TextUIFactory
614
bzrlib.ui.ui_factory = TextUIFactory()
615
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
616
ret = run_bzr_catch_errors(argv)
617
trace.mutter("return code %d", ret)
621
def run_bzr_catch_errors(argv):
624
# do this here inside the exception wrappers to catch EPIPE
626
except (KeyboardInterrupt, Exception), e:
627
# used to handle AssertionError and KeyboardInterrupt
628
# specially here, but hopefully they're handled ok by the logger now
629
trace.report_exception(sys.exc_info(), sys.stderr)
630
if os.environ.get('BZR_PDB'):
631
print '**** entering debugger'
633
pdb.post_mortem(sys.exc_traceback)
636
if __name__ == '__main__':
637
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
