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.
140
from bzrlib.externalcommand import ExternalCommand
142
# We want only 'ascii' command names, but the user may have typed
143
# in a Unicode name. In that case, they should just get a
144
# 'command not found' error later.
145
# In the future, we may actually support Unicode command names.
147
# first look up this command under the specified name
148
cmds = _get_cmd_dict(plugins_override=plugins_override)
150
return cmds[cmd_name]()
154
# look for any command which claims this as an alias
155
for real_cmd_name, cmd_class in cmds.iteritems():
156
if cmd_name in cmd_class.aliases:
159
cmd_obj = ExternalCommand.find_command(cmd_name)
163
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
166
class Command(object):
167
"""Base class for commands.
169
Commands are the heart of the command-line bzr interface.
171
The command object mostly handles the mapping of command-line
172
parameters into one or more bzrlib operations, and of the results
175
Commands normally don't have any state. All their arguments are
176
passed in to the run method. (Subclasses may take a different
177
policy if the behaviour of the instance needs to depend on e.g. a
178
shell plugin and not just its Python class.)
180
The docstring for an actual command should give a single-line
181
summary, then a complete description of the command. A grammar
182
description will be inserted.
185
Other accepted names for this command.
188
List of argument forms, marked with whether they are optional,
193
['to_location', 'from_branch?', 'file*']
195
'to_location' is required
196
'from_branch' is optional
197
'file' can be specified 0 or more times
200
List of options that may be given for this command. These can
201
be either strings, referring to globally-defined options,
202
or option objects. Retrieve through options().
205
If true, this command isn't advertised. This is typically
206
for commands intended for expert users.
209
Command objects will get a 'outf' attribute, which has been
210
setup to properly handle encoding of unicode strings.
211
encoding_type determines what will happen when characters cannot
213
strict - abort if we cannot decode
214
replace - put in a bogus character (typically '?')
215
exact - do not encode sys.stdout
217
NOTE: by default on Windows sys.stdout opened as text stream,
218
therefore line-endings LF converted to CRLF.
219
When command use encoding_type = 'exact' then
220
sys.stdout forced to be binary stream and line-endings
226
encoding_type = 'strict'
231
"""Construct an instance of this command."""
232
if self.__doc__ == Command.__doc__:
233
warn("No help message set for %r" % self)
236
"""Return dict of valid options for this command.
238
Maps from long option name to option object."""
240
r['help'] = option.Option.OPTIONS['help']
241
for o in self.takes_options:
242
if isinstance(o, basestring):
243
o = option.Option.OPTIONS[o]
247
def _setup_outf(self):
248
"""Return a file linked to stdout, which has proper encoding."""
249
assert self.encoding_type in ['strict', 'exact', 'replace']
251
# Originally I was using self.stdout, but that looks
252
# *way* too much like sys.stdout
253
if self.encoding_type == 'exact':
254
# force sys.stdout to be binary stream on win32
255
if sys.platform == 'win32':
256
fileno = getattr(sys.stdout, 'fileno', None)
259
msvcrt.setmode(fileno(), os.O_BINARY)
260
self.outf = sys.stdout
263
output_encoding = osutils.get_terminal_encoding()
265
# use 'replace' so that we don't abort if trying to write out
266
# in e.g. the default C locale.
267
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
268
# For whatever reason codecs.getwriter() does not advertise its encoding
269
# it just returns the encoding of the wrapped file, which is completely
270
# bogus. So set the attribute, so we can find the correct encoding later.
271
self.outf.encoding = output_encoding
273
@deprecated_method(zero_eight)
274
def run_argv(self, argv):
275
"""Parse command line and run.
277
See run_argv_aliases for the 0.8 and beyond api.
279
return self.run_argv_aliases(argv)
281
def run_argv_aliases(self, argv, alias_argv=None):
282
"""Parse the command line and run with extra aliases in alias_argv."""
284
warn("Passing None for [] is deprecated from bzrlib 0.10",
285
DeprecationWarning, stacklevel=2)
287
args, opts = parse_args(self, argv, alias_argv)
288
if 'help' in opts: # e.g. bzr add --help
289
from bzrlib.help import help_on_command
290
help_on_command(self.name())
292
# mix arguments and options into one dictionary
293
cmdargs = _match_argform(self.name(), self.takes_args, args)
295
for k, v in opts.items():
296
cmdopts[k.replace('-', '_')] = v
298
all_cmd_args = cmdargs.copy()
299
all_cmd_args.update(cmdopts)
303
return self.run(**all_cmd_args)
306
"""Actually run the command.
308
This is invoked with the options and arguments bound to
311
Return 0 or None if the command was successful, or a non-zero
312
shell error code if not. It's OK for this method to allow
313
an exception to raise up.
315
raise NotImplementedError('no implementation of command %r'
319
"""Return help message for this class."""
320
from inspect import getdoc
321
if self.__doc__ is Command.__doc__:
326
return _unsquish_command_name(self.__class__.__name__)
328
def plugin_name(self):
329
"""Get the name of the plugin that provides this command.
331
:return: The name of the plugin or None if the command is builtin.
333
mod_parts = self.__module__.split('.')
334
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
340
# Technically, this function hasn't been use in a *really* long time
341
# but we are only deprecating it now.
342
@deprecated_function(zero_eleven)
343
def parse_spec(spec):
349
>>> parse_spec("../@")
351
>>> parse_spec("../f/@35")
353
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
354
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
359
parsed = spec.split('/@')
360
assert len(parsed) == 2
365
parsed[1] = int(parsed[1])
367
pass # We can allow stuff like ./@revid:blahblahblah
371
parsed = [spec, None]
374
def parse_args(command, argv, alias_argv=None):
375
"""Parse command line.
377
Arguments and options are parsed at this level before being passed
378
down to specific command handlers. This routine knows, from a
379
lookup table, something about the available options, what optargs
380
they take, and which commands will accept them.
382
# TODO: make it a method of the Command?
383
parser = option.get_optparser(command.options())
384
if alias_argv is not None:
385
args = alias_argv + argv
389
options, args = parser.parse_args(args)
390
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
391
v is not option.OptionParser.DEFAULT_VALUE])
395
def _match_argform(cmd, takes_args, args):
398
# step through args and takes_args, allowing appropriate 0-many matches
399
for ap in takes_args:
403
argdict[argname] = args.pop(0)
404
elif ap[-1] == '*': # all remaining arguments
406
argdict[argname + '_list'] = args[:]
409
argdict[argname + '_list'] = None
412
raise errors.BzrCommandError("command %r needs one or more %s"
413
% (cmd, argname.upper()))
415
argdict[argname + '_list'] = args[:]
417
elif ap[-1] == '$': # all but one
419
raise errors.BzrCommandError("command %r needs one or more %s"
420
% (cmd, argname.upper()))
421
argdict[argname + '_list'] = args[:-1]
427
raise errors.BzrCommandError("command %r requires argument %s"
428
% (cmd, argname.upper()))
430
argdict[argname] = args.pop(0)
433
raise errors.BzrCommandError("extra argument to command %s: %s"
440
def apply_profiled(the_callable, *args, **kwargs):
444
pffileno, pfname = tempfile.mkstemp()
446
prof = hotshot.Profile(pfname)
448
ret = prof.runcall(the_callable, *args, **kwargs) or 0
451
stats = hotshot.stats.load(pfname)
453
stats.sort_stats('cum') # 'time'
454
## XXX: Might like to write to stderr or the trace file instead but
455
## print_stats seems hardcoded to stdout
456
stats.print_stats(20)
463
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
464
from bzrlib.lsprof import profile
466
ret, stats = profile(the_callable, *args, **kwargs)
472
cPickle.dump(stats, open(filename, 'w'), 2)
473
print 'Profile data written to %r.' % filename
477
def get_alias(cmd, config=None):
478
"""Return an expanded alias, or None if no alias exists.
481
Command to be checked for an alias.
483
Used to specify an alternative config to use,
484
which is especially useful for testing.
485
If it is unspecified, the global config will be used.
489
config = bzrlib.config.GlobalConfig()
490
alias = config.get_alias(cmd)
493
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
498
"""Execute a command.
500
This is similar to main(), but without all the trappings for
501
logging and error handling.
504
The command-line arguments, without the program name from argv[0]
505
These should already be decoded. All library/test code calling
506
run_bzr should be passing valid strings (don't need decoding).
508
Returns a command status or raises an exception.
510
Special master options: these must come before the command because
511
they control how the command is interpreted.
514
Do not load plugin modules at all
520
Only use builtin commands. (Plugins are still allowed to change
524
Run under the Python hotshot profiler.
527
Run under the Python lsprof profiler.
530
trace.mutter("bzr arguments: %r", argv)
532
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
533
opt_no_aliases = False
534
opt_lsprof_file = None
536
# --no-plugins is handled specially at a very early stage. We need
537
# to load plugins before doing other command parsing so that they
538
# can override commands, but this needs to happen first.
546
elif a == '--lsprof':
548
elif a == '--lsprof-file':
550
opt_lsprof_file = argv[i + 1]
552
elif a == '--no-plugins':
553
opt_no_plugins = True
554
elif a == '--no-aliases':
555
opt_no_aliases = True
556
elif a == '--builtin':
558
elif a in ('--quiet', '-q'):
560
elif a.startswith('-D'):
561
debug.debug_flags.add(a[2:])
568
from bzrlib.builtins import cmd_help
569
cmd_help().run_argv_aliases([])
572
if argv[0] == '--version':
573
from bzrlib.version import show_version
577
if not opt_no_plugins:
578
from bzrlib.plugin import load_plugins
581
from bzrlib.plugin import disable_plugins
586
if not opt_no_aliases:
587
alias_argv = get_alias(argv[0])
589
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
590
argv[0] = alias_argv.pop(0)
593
# We want only 'ascii' command names, but the user may have typed
594
# in a Unicode name. In that case, they should just get a
595
# 'command not found' error later.
597
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
598
if not getattr(cmd_obj.run_argv, 'is_deprecated', False):
599
run = cmd_obj.run_argv
602
run = cmd_obj.run_argv_aliases
603
run_argv = [argv, alias_argv]
607
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
609
ret = apply_profiled(run, *run_argv)
614
# reset, in case we may do other commands later within the same process
615
trace.be_quiet(False)
617
def display_command(func):
618
"""Decorator that suppresses pipe/interrupt errors."""
619
def ignore_pipe(*args, **kwargs):
621
result = func(*args, **kwargs)
625
if getattr(e, 'errno', None) is None:
627
if e.errno != errno.EPIPE:
628
# Win32 raises IOError with errno=0 on a broken pipe
629
if sys.platform != 'win32' or e.errno != 0:
632
except KeyboardInterrupt:
639
from bzrlib.ui.text import TextUIFactory
640
bzrlib.ui.ui_factory = TextUIFactory()
641
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
642
ret = run_bzr_catch_errors(argv)
643
trace.mutter("return code %d", ret)
647
def run_bzr_catch_errors(argv):
650
# do this here inside the exception wrappers to catch EPIPE
652
except (KeyboardInterrupt, Exception), e:
653
# used to handle AssertionError and KeyboardInterrupt
654
# specially here, but hopefully they're handled ok by the logger now
655
trace.report_exception(sys.exc_info(), sys.stderr)
656
if os.environ.get('BZR_PDB'):
657
print '**** entering debugger'
659
pdb.post_mortem(sys.exc_traceback)
662
if __name__ == '__main__':
663
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
