1
# Copyright (C) 2006, 2008, 2009 Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
# TODO: probably should say which arguments are candidates for glob
19
19
# expansion on windows and do that at the command level.
21
# TODO: Help messages for options.
21
23
# TODO: Define arguments by objects, rather than just using names.
22
24
# 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.
25
# would help with validation and shell completion.
28
27
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
28
# the profile output behind so it can be interactively examined?
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
32
from warnings import warn
33
from inspect import getdoc
39
from warnings import warn
54
from bzrlib.hooks import HookPoint, Hooks
55
# Compatibility - Option used to be in commands.
38
from bzrlib.trace import mutter, note, log_error, warning, be_quiet
39
from bzrlib.errors import (BzrError,
44
from bzrlib.revisionspec import RevisionSpec
45
from bzrlib import BZRDIR
56
46
from bzrlib.option import Option
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
suppress_deprecation_warnings,
66
class CommandInfo(object):
67
"""Information about a command."""
69
def __init__(self, aliases):
70
"""The list of aliases for the command."""
71
self.aliases = aliases
74
def from_command(klass, command):
75
"""Factory to construct a CommandInfo from a command."""
76
return klass(command.aliases)
79
class CommandRegistry(registry.Registry):
82
def _get_name(command_name):
83
if command_name.startswith("cmd_"):
84
return _unsquish_command_name(command_name)
88
def register(self, cmd, decorate=False):
89
"""Utility function to help register a command
91
:param cmd: Command subclass to register
92
:param decorate: If true, allow overriding an existing command
93
of the same name; the old command is returned by this function.
94
Otherwise it is an error to try to override an existing command.
97
k_unsquished = self._get_name(k)
99
previous = self.get(k_unsquished)
101
previous = _builtin_commands().get(k_unsquished)
102
info = CommandInfo.from_command(cmd)
104
registry.Registry.register(self, k_unsquished, cmd,
105
override_existing=decorate, info=info)
107
trace.warning('Two plugins defined the same command: %r' % k)
108
trace.warning('Not loading the one in %r' %
109
sys.modules[cmd.__module__])
110
trace.warning('Previously this command was registered from %r' %
111
sys.modules[previous.__module__])
114
def register_lazy(self, command_name, aliases, module_name):
115
"""Register a command without loading its module.
117
:param command_name: The primary name of the command.
118
:param aliases: A list of aliases for the command.
119
:module_name: The module that the command lives in.
121
key = self._get_name(command_name)
122
registry.Registry.register_lazy(self, key, module_name, command_name,
123
info=CommandInfo(aliases))
126
plugin_cmds = CommandRegistry()
129
51
def register_command(cmd, decorate=False):
52
"Utility function to help register a command"
130
53
global plugin_cmds
131
return plugin_cmds.register(cmd, decorate)
55
if k.startswith("cmd_"):
56
k_unsquished = _unsquish_command_name(k)
59
if not plugin_cmds.has_key(k_unsquished):
60
plugin_cmds[k_unsquished] = cmd
61
mutter('registered plugin command %s', k_unsquished)
62
if decorate and k_unsquished in builtin_command_names():
63
return _builtin_commands()[k_unsquished]
65
result = plugin_cmds[k_unsquished]
66
plugin_cmds[k_unsquished] = cmd
69
log_error('Two plugins defined the same command: %r' % k)
70
log_error('Not loading the one in %r' % sys.modules[cmd.__module__])
134
73
def _squish_command_name(cmd):
138
77
def _unsquish_command_name(cmd):
78
assert cmd.startswith("cmd_")
139
79
return cmd[4:].replace('_','-')
142
82
def _builtin_commands():
143
83
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
85
builtins = bzrlib.builtins.__dict__
150
87
if name.startswith("cmd_"):
151
real_name = _unsquish_command_name(name)
88
real_name = _unsquish_command_name(name)
89
r[real_name] = builtins[name]
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
94
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
95
"""Return list of builtin command names."""
181
96
return _builtin_commands().keys()
184
99
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
100
return plugin_cmds.keys()
103
def _get_cmd_dict(plugins_override=True):
104
"""Return name->class mapping for all commands."""
105
d = _builtin_commands()
107
d.update(plugin_cmds)
111
def get_all_cmds(plugins_override=True):
112
"""Return canonical name and class for all registered commands."""
113
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
189
117
def get_cmd_object(cmd_name, plugins_override=True):
190
"""Return the command object for a command.
118
"""Return the canonical name and command class for a command.
193
121
If true, plugin commands can override builtins.
196
return _get_cmd_object(cmd_name, plugins_override)
198
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
201
def _get_cmd_object(cmd_name, plugins_override=True):
202
"""Get a command object.
204
:param cmd_name: The name of the command.
205
:param plugins_override: Allow plugins to override builtins.
206
:return: A Command object instance
207
:raises KeyError: If no command is found.
209
# We want only 'ascii' command names, but the user may have typed
210
# in a Unicode name. In that case, they should just get a
211
# 'command not found' error later.
212
# In the future, we may actually support Unicode command names.
215
for hook in Command.hooks['get_command']:
216
cmd = hook(cmd, cmd_name)
217
if cmd is not None and not plugins_override and not cmd.plugin_name():
218
# We've found a non-plugin command, don't permit it to be
222
for hook in Command.hooks['get_missing_command']:
229
# Allow plugins to extend commands
230
for hook in Command.hooks['extend_command']:
235
def _try_plugin_provider(cmd_name):
236
"""Probe for a plugin provider having cmd_name."""
238
plugin_metadata, provider = probe_for_provider(cmd_name)
239
raise errors.CommandAvailableInPlugin(cmd_name,
240
plugin_metadata, provider)
241
except errors.NoPluginAvailable:
245
def probe_for_provider(cmd_name):
246
"""Look for a provider for cmd_name.
248
:param cmd_name: The command name.
249
:return: plugin_metadata, provider for getting cmd_name.
250
:raises NoPluginAvailable: When no provider can supply the plugin.
252
# look for providers that provide this command but aren't installed
253
for provider in command_providers_registry:
255
return provider.plugin_for_command(cmd_name), provider
256
except errors.NoPluginAvailable:
258
raise errors.NoPluginAvailable(cmd_name)
261
def _get_bzr_command(cmd_or_None, cmd_name):
262
"""Get a command from bzr's core."""
263
cmds = _builtin_commands()
123
from bzrlib.externalcommand import ExternalCommand
125
cmd_name = str(cmd_name) # not unicode
127
# first look up this command under the specified name
128
cmds = _get_cmd_dict(plugins_override=plugins_override)
265
130
return cmds[cmd_name]()
268
134
# look for any command which claims this as an alias
269
135
for real_cmd_name, cmd_class in cmds.iteritems():
270
136
if cmd_name in cmd_class.aliases:
271
137
return cmd_class()
275
def _get_external_command(cmd_or_None, cmd_name):
276
"""Lookup a command that is a shell script."""
277
# Only do external command lookups when no command is found so far.
278
if cmd_or_None is not None:
280
from bzrlib.externalcommand import ExternalCommand
281
139
cmd_obj = ExternalCommand.find_command(cmd_name)
286
def _get_plugin_command(cmd_or_None, cmd_name):
287
"""Get a command from bzr's plugins."""
289
return plugin_cmds.get(cmd_name)()
292
for key in plugin_cmds.keys():
293
info = plugin_cmds.get_info(key)
294
if cmd_name in info.aliases:
295
return plugin_cmds.get(key)()
143
raise BzrCommandError("unknown command %r" % cmd_name)
299
146
class Command(object):
338
185
If true, this command isn't advertised. This is typically
339
186
for commands intended for expert users.
342
Command objects will get a 'outf' attribute, which has been
343
setup to properly handle encoding of unicode strings.
344
encoding_type determines what will happen when characters cannot
346
strict - abort if we cannot decode
347
replace - put in a bogus character (typically '?')
348
exact - do not encode sys.stdout
350
NOTE: by default on Windows, sys.stdout is opened as a text
351
stream, therefore LF line-endings are converted to CRLF.
352
When a command uses encoding_type = 'exact', then
353
sys.stdout is forced to be a binary stream, and line-endings
356
:cvar hooks: An instance of CommandHooks.
360
190
takes_options = []
361
encoding_type = 'strict'
365
194
def __init__(self):
366
195
"""Construct an instance of this command."""
367
196
if self.__doc__ == Command.__doc__:
368
197
warn("No help message set for %r" % self)
369
# List of standard options directly supported
370
self.supported_std_options = []
371
self._operation = cleanup.OperationWithCleanups(self.run)
373
def add_cleanup(self, cleanup_func, *args, **kwargs):
374
"""Register a function to call after self.run returns or raises.
376
Functions will be called in LIFO order.
378
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
380
def cleanup_now(self):
381
"""Execute and empty pending cleanup functions immediately.
383
After cleanup_now all registered cleanups are forgotten. add_cleanup
384
may be called again after cleanup_now; these cleanups will be called
385
after self.run returns or raises (or when cleanup_now is next called).
387
This is useful for releasing expensive or contentious resources (such
388
as write locks) before doing further work that does not require those
389
resources (such as writing results to self.outf).
391
self._operation.cleanup_now()
393
@deprecated_method(deprecated_in((2, 1, 0)))
394
def _maybe_expand_globs(self, file_list):
395
"""Glob expand file_list if the platform does not do that itself.
397
Not used anymore, now that the bzr command-line parser globs on
400
:return: A possibly empty list of unicode paths.
402
Introduced in bzrlib 0.18.
407
"""Return single-line grammar for this command.
409
Only describes arguments, not options.
411
s = 'bzr ' + self.name() + ' '
412
for aname in self.takes_args:
413
aname = aname.upper()
414
if aname[-1] in ['$', '+']:
415
aname = aname[:-1] + '...'
416
elif aname[-1] == '?':
417
aname = '[' + aname[:-1] + ']'
418
elif aname[-1] == '*':
419
aname = '[' + aname[:-1] + '...]'
421
s = s[:-1] # remove last space
424
def get_help_text(self, additional_see_also=None, plain=True,
425
see_also_as_links=False, verbose=True):
426
"""Return a text string with help for this command.
428
:param additional_see_also: Additional help topics to be
430
:param plain: if False, raw help (reStructuredText) is
431
returned instead of plain text.
432
:param see_also_as_links: if True, convert items in 'See also'
433
list to internal links (used by bzr_man rstx generator)
434
:param verbose: if True, display the full help, otherwise
435
leave out the descriptive sections and just display
436
usage help (e.g. Purpose, Usage, Options) with a
437
message explaining how to obtain full help.
441
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
443
# Extract the summary (purpose) and sections out from the text
444
purpose,sections,order = self._get_help_parts(doc)
446
# If a custom usage section was provided, use it
447
if sections.has_key('Usage'):
448
usage = sections.pop('Usage')
450
usage = self._usage()
452
# The header is the purpose and usage
454
result += ':Purpose: %s\n' % purpose
455
if usage.find('\n') >= 0:
456
result += ':Usage:\n%s\n' % usage
458
result += ':Usage: %s\n' % usage
463
# XXX: optparse implicitly rewraps the help, and not always perfectly,
464
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
466
options = option.get_optparser(self.options()).format_option_help()
467
# XXX: According to the spec, ReST option lists actually don't support
468
# options like --1.9 so that causes syntax errors (in Sphinx at least).
469
# As that pattern always appears in the commands that break, we trap
470
# on that and then format that block of 'format' options as a literal
472
if not plain and options.find(' --1.9 ') != -1:
473
options = options.replace(' format:\n', ' format::\n\n', 1)
474
if options.startswith('Options:'):
475
result += ':' + options
476
elif options.startswith('options:'):
477
# Python 2.4 version of optparse
478
result += ':Options:' + options[len('options:'):]
484
# Add the description, indenting it 2 spaces
485
# to match the indentation of the options
486
if sections.has_key(None):
487
text = sections.pop(None)
488
text = '\n '.join(text.splitlines())
489
result += ':%s:\n %s\n\n' % ('Description',text)
491
# Add the custom sections (e.g. Examples). Note that there's no need
492
# to indent these as they must be indented already in the source.
495
if sections.has_key(label):
496
result += ':%s:\n%s\n' % (label,sections[label])
499
result += ("See bzr help %s for more details and examples.\n\n"
502
# Add the aliases, source (plug-in) and see also links, if any
504
result += ':Aliases: '
505
result += ', '.join(self.aliases) + '\n'
506
plugin_name = self.plugin_name()
507
if plugin_name is not None:
508
result += ':From: plugin "%s"\n' % plugin_name
509
see_also = self.get_see_also(additional_see_also)
511
if not plain and see_also_as_links:
513
for item in see_also:
515
# topics doesn't have an independent section
516
# so don't create a real link
517
see_also_links.append(item)
519
# Use a Sphinx link for this entry
520
link_text = ":doc:`%s <%s-help>`" % (item, item)
521
see_also_links.append(link_text)
522
see_also = see_also_links
523
result += ':See also: '
524
result += ', '.join(see_also) + '\n'
526
# If this will be rendered as plain text, convert it
528
import bzrlib.help_topics
529
result = bzrlib.help_topics.help_as_plain_text(result)
533
def _get_help_parts(text):
534
"""Split help text into a summary and named sections.
536
:return: (summary,sections,order) where summary is the top line and
537
sections is a dictionary of the rest indexed by section name.
538
order is the order the section appear in the text.
539
A section starts with a heading line of the form ":xxx:".
540
Indented text on following lines is the section value.
541
All text found outside a named section is assigned to the
542
default section which is given the key of None.
544
def save_section(sections, order, label, section):
546
if sections.has_key(label):
547
sections[label] += '\n' + section
550
sections[label] = section
552
lines = text.rstrip().splitlines()
553
summary = lines.pop(0)
556
label,section = None,''
558
if line.startswith(':') and line.endswith(':') and len(line) > 2:
559
save_section(sections, order, label, section)
560
label,section = line[1:-1],''
561
elif (label is not None) and len(line) > 1 and not line[0].isspace():
562
save_section(sections, order, label, section)
563
label,section = None,line
566
section += '\n' + line
569
save_section(sections, order, label, section)
570
return summary, sections, order
572
def get_help_topic(self):
573
"""Return the commands help topic - its name."""
576
def get_see_also(self, additional_terms=None):
577
"""Return a list of help topics that are related to this command.
579
The list is derived from the content of the _see_also attribute. Any
580
duplicates are removed and the result is in lexical order.
581
:param additional_terms: Additional help topics to cross-reference.
582
:return: A list of help topics.
584
see_also = set(getattr(self, '_see_also', []))
586
see_also.update(additional_terms)
587
return sorted(see_also)
589
199
def options(self):
590
200
"""Return dict of valid options for this command.
592
202
Maps from long option name to option object."""
593
r = Option.STD_OPTIONS.copy()
204
r['help'] = Option.OPTIONS['help']
595
205
for o in self.takes_options:
596
if isinstance(o, basestring):
597
o = option.Option.OPTIONS[o]
206
if not isinstance(o, Option):
207
o = Option.OPTIONS[o]
599
if o.name in std_names:
600
self.supported_std_options.append(o.name)
603
def _setup_outf(self):
604
"""Return a file linked to stdout, which has proper encoding."""
605
self.outf = ui.ui_factory.make_output_stream(
606
encoding_type=self.encoding_type)
608
def run_argv_aliases(self, argv, alias_argv=None):
609
"""Parse the command line and run with extra aliases in alias_argv."""
610
args, opts = parse_args(self, argv, alias_argv)
612
# Process the standard options
211
def run_argv(self, argv):
212
"""Parse command line and run."""
213
args, opts = parse_args(self, argv)
613
214
if 'help' in opts: # e.g. bzr add --help
614
sys.stdout.write(self.get_help_text())
616
if 'usage' in opts: # e.g. bzr add --usage
617
sys.stdout.write(self.get_help_text(verbose=False))
619
trace.set_verbosity_level(option._verbosity_level)
620
if 'verbose' in self.supported_std_options:
621
opts['verbose'] = trace.is_verbose()
622
elif opts.has_key('verbose'):
624
if 'quiet' in self.supported_std_options:
625
opts['quiet'] = trace.is_quiet()
626
elif opts.has_key('quiet'):
215
from bzrlib.help import help_on_command
216
help_on_command(self.name())
218
# XXX: This should be handled by the parser
219
allowed_names = self.options().keys()
221
if oname not in allowed_names:
222
raise BzrCommandError("option '--%s' is not allowed for command %r"
223
% (oname, self.name()))
629
224
# mix arguments and options into one dictionary
630
225
cmdargs = _match_argform(self.name(), self.takes_args, args)
667
255
return _unsquish_command_name(self.__class__.__name__)
669
def plugin_name(self):
670
"""Get the name of the plugin that provides this command.
672
:return: The name of the plugin or None if the command is builtin.
674
mod_parts = self.__module__.split('.')
675
if len(mod_parts) >= 3 and mod_parts[1] == 'plugins':
258
def parse_spec(spec):
264
>>> parse_spec("../@")
266
>>> parse_spec("../f/@35")
268
>>> parse_spec('./@revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67')
269
['.', 'revid:john@arbash-meinel.com-20050711044610-3ca0327c6a222f67']
274
parsed = spec.split('/@')
275
assert len(parsed) == 2
681
class CommandHooks(Hooks):
682
"""Hooks related to Command object creation/enumeration."""
685
"""Create the default hooks.
687
These are all empty initially, because by default nothing should get
691
self.create_hook(HookPoint('extend_command',
692
"Called after creating a command object to allow modifications "
693
"such as adding or removing options, docs etc. Called with the "
694
"new bzrlib.commands.Command object.", (1, 13), None))
695
self.create_hook(HookPoint('get_command',
696
"Called when creating a single command. Called with "
697
"(cmd_or_None, command_name). get_command should either return "
698
"the cmd_or_None parameter, or a replacement Command object that "
699
"should be used for the command. Note that the Command.hooks "
700
"hooks are core infrastructure. Many users will prefer to use "
701
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
703
self.create_hook(HookPoint('get_missing_command',
704
"Called when creating a single command if no command could be "
705
"found. Called with (command_name). get_missing_command should "
706
"either return None, or a Command object to be used for the "
707
"command.", (1, 17), None))
708
self.create_hook(HookPoint('list_commands',
709
"Called when enumerating commands. Called with a set of "
710
"cmd_name strings for all the commands found so far. This set "
711
" is safe to mutate - e.g. to remove a command. "
712
"list_commands should return the updated set of command names.",
715
Command.hooks = CommandHooks()
718
def parse_args(command, argv, alias_argv=None):
280
parsed[1] = int(parsed[1])
282
pass # We can allow stuff like ./@revid:blahblahblah
286
parsed = [spec, None]
289
def parse_args(command, argv):
719
290
"""Parse command line.
721
292
Arguments and options are parsed at this level before being passed
722
293
down to specific command handlers. This routine knows, from a
723
294
lookup table, something about the available options, what optargs
724
295
they take, and which commands will accept them.
726
# TODO: make it a method of the Command?
727
parser = option.get_optparser(command.options())
728
if alias_argv is not None:
729
args = alias_argv + argv
733
options, args = parser.parse_args(args)
734
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
735
v is not option.OptionParser.DEFAULT_VALUE])
297
# TODO: chop up this beast; make it a method of the Command
301
cmd_options = command.options()
309
# We've received a standalone -- No more flags
313
# option names must not be unicode
317
mutter(" got option %r", a)
319
optname, optarg = a[2:].split('=', 1)
322
if optname not in cmd_options:
323
raise BzrOptionError('unknown long option %r for command %s'
324
% (a, command.name()))
327
if shortopt in Option.SHORT_OPTIONS:
328
# Multi-character options must have a space to delimit
330
# ^^^ what does this mean? mbp 20051014
331
optname = Option.SHORT_OPTIONS[shortopt].name
333
# Single character short options, can be chained,
334
# and have their value appended to their name
336
if shortopt not in Option.SHORT_OPTIONS:
337
# We didn't find the multi-character name, and we
338
# didn't find the single char name
339
raise BzrError('unknown short option %r' % a)
340
optname = Option.SHORT_OPTIONS[shortopt].name
343
# There are extra things on this option
344
# see if it is the value, or if it is another
346
optargfn = Option.OPTIONS[optname].type
348
# This option does not take an argument, so the
349
# next entry is another short option, pack it back
351
argv.insert(0, '-' + a[2:])
353
# This option takes an argument, so pack it
357
if optname not in cmd_options:
358
raise BzrOptionError('unknown short option %r for command'
359
' %s' % (shortopt, command.name()))
361
# XXX: Do we ever want to support this, e.g. for -r?
362
raise BzrError('repeated option %r' % a)
364
option_obj = cmd_options[optname]
365
optargfn = option_obj.type
369
raise BzrError('option %r needs an argument' % a)
372
opts[optname] = optargfn(optarg)
375
raise BzrError('option %r takes no argument' % optname)
736
379
return args, opts
821
447
os.remove(pfname)
824
def exception_to_return_code(the_callable, *args, **kwargs):
825
"""UI level helper for profiling and coverage.
827
This transforms exceptions into a return value of 3. As such its only
828
relevant to the UI layer, and should never be called where catching
829
exceptions may be desirable.
832
return the_callable(*args, **kwargs)
833
except (KeyboardInterrupt, Exception), e:
834
# used to handle AssertionError and KeyboardInterrupt
835
# specially here, but hopefully they're handled ok by the logger now
836
exc_info = sys.exc_info()
837
exitcode = trace.report_exception(exc_info, sys.stderr)
838
if os.environ.get('BZR_PDB'):
839
print '**** entering debugger'
842
if sys.version_info[:2] < (2, 6):
844
# pdb.post_mortem(tb)
845
# but because pdb.post_mortem gives bad results for tracebacks
846
# from inside generators, we do it manually.
847
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
849
# Setup pdb on the traceback
852
p.setup(tb.tb_frame, tb)
853
# Point the debugger at the deepest frame of the stack
854
p.curindex = len(p.stack) - 1
855
p.curframe = p.stack[p.curindex][0]
856
# Start the pdb prompt.
857
p.print_stack_entry(p.stack[p.curindex])
865
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
450
def apply_lsprofiled(the_callable, *args, **kwargs):
866
451
from bzrlib.lsprof import profile
867
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
452
ret,stats = profile(the_callable,*args,**kwargs)
873
trace.note('Profile data written to "%s".', filename)
877
def shlex_split_unicode(unsplit):
879
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
882
def get_alias(cmd, config=None):
883
"""Return an expanded alias, or None if no alias exists.
886
Command to be checked for an alias.
888
Used to specify an alternative config to use,
889
which is especially useful for testing.
890
If it is unspecified, the global config will be used.
894
config = bzrlib.config.GlobalConfig()
895
alias = config.get_alias(cmd)
897
return shlex_split_unicode(alias)
901
457
def run_bzr(argv):
902
458
"""Execute a command.
460
This is similar to main(), but without all the trappings for
461
logging and error handling.
905
464
The command-line arguments, without the program name from argv[0]
906
These should already be decoded. All library/test code calling
907
run_bzr should be passing valid strings (don't need decoding).
909
466
Returns a command status or raises an exception.
911
468
Special master options: these must come before the command because
928
482
Run under the Python lsprof profiler.
931
Generate line coverage report in the specified directory.
934
Specify the number of processes that can be run concurrently (selftest).
936
trace.mutter("bazaar version: " + bzrlib.__version__)
938
trace.mutter("bzr arguments: %r", argv)
484
argv = [a.decode(bzrlib.user_encoding) for a in argv]
940
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
941
opt_no_aliases = False
942
opt_lsprof_file = opt_coverage_dir = None
486
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = False
944
488
# --no-plugins is handled specially at a very early stage. We need
945
489
# to load plugins before doing other command parsing so that they
946
490
# can override commands, but this needs to happen first.
952
493
if a == '--profile':
953
494
opt_profile = True
954
495
elif a == '--lsprof':
955
496
opt_lsprof = True
956
elif a == '--lsprof-file':
958
opt_lsprof_file = argv[i + 1]
960
497
elif a == '--no-plugins':
961
498
opt_no_plugins = True
962
elif a == '--no-aliases':
963
opt_no_aliases = True
964
499
elif a == '--builtin':
965
500
opt_builtin = True
966
elif a == '--concurrency':
967
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
969
elif a == '--coverage':
970
opt_coverage_dir = argv[i + 1]
972
elif a.startswith('-D'):
973
debug.debug_flags.add(a[2:])
978
debug.set_debug_flags_from_config()
982
from bzrlib.builtins import cmd_help
983
cmd_help().run_argv_aliases([])
501
elif a in ('--quiet', '-q'):
507
if (not argv) or (argv[0] == '--help'):
508
from bzrlib.help import help
986
515
if argv[0] == '--version':
987
from bzrlib.builtins import cmd_version
988
cmd_version().run_argv_aliases([])
516
from bzrlib.builtins import show_version
991
520
if not opt_no_plugins:
992
521
from bzrlib.plugin import load_plugins
995
from bzrlib.plugin import disable_plugins
1000
if not opt_no_aliases:
1001
alias_argv = get_alias(argv[0])
1003
user_encoding = osutils.get_user_encoding()
1004
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1005
argv[0] = alias_argv.pop(0)
1008
# We want only 'ascii' command names, but the user may have typed
1009
# in a Unicode name. In that case, they should just get a
1010
# 'command not found' error later.
524
cmd = str(argv.pop(0))
1012
526
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1013
run = cmd_obj.run_argv_aliases
1014
run_argv = [argv, alias_argv]
1017
# We can be called recursively (tests for example), but we don't want
1018
# the verbosity level to propagate.
1019
saved_verbosity_level = option._verbosity_level
1020
option._verbosity_level = 0
1022
if opt_coverage_dir:
1024
'--coverage ignored, because --lsprof is in use.')
1025
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
530
ret = apply_lsprofiled(cmd_obj.run_argv, argv)
1026
531
elif opt_profile:
1027
if opt_coverage_dir:
1029
'--coverage ignored, because --profile is in use.')
1030
ret = apply_profiled(run, *run_argv)
1031
elif opt_coverage_dir:
1032
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
532
ret = apply_profiled(cmd_obj.run_argv, argv)
1034
ret = run(*run_argv)
534
ret = cmd_obj.run_argv(argv)
1037
# reset, in case we may do other commands later within the same
1038
# process. Commands that want to execute sub-commands must propagate
1039
# --verbose in their own way.
1040
if 'memory' in debug.debug_flags:
1041
trace.debug_memory('Process status after command:', short=False)
1042
option._verbosity_level = saved_verbosity_level
537
# reset, in case we may do other commands later within the same process
1045
540
def display_command(func):
1046
541
"""Decorator that suppresses pipe/interrupt errors."""
1050
545
sys.stdout.flush()
1052
547
except IOError, e:
1053
if getattr(e, 'errno', None) is None:
548
if not hasattr(e, 'errno'):
1055
550
if e.errno != errno.EPIPE:
1056
# Win32 raises IOError with errno=0 on a broken pipe
1057
if sys.platform != 'win32' or (e.errno not in (0, errno.EINVAL)):
1060
553
except KeyboardInterrupt:
1062
555
return ignore_pipe
1065
def install_bzr_command_hooks():
1066
"""Install the hooks to supply bzr's own commands."""
1067
if _list_bzr_commands in Command.hooks["list_commands"]:
1069
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1071
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1073
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1074
"bzr plugin commands")
1075
Command.hooks.install_named_hook("get_command", _get_external_command,
1076
"bzr external command lookup")
1077
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1078
"bzr plugin-provider-db check")
1081
def main(argv=None):
1082
"""Main entry point of command-line interface.
1084
:param argv: list of unicode command-line arguments similar to sys.argv.
1085
argv[0] is script name usually, it will be ignored.
1086
Don't pass here sys.argv because this list contains plain strings
1087
and not unicode; pass None instead.
1089
:return: exit code of bzr command.
1091
559
import bzrlib.ui
1092
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1093
sys.stdin, sys.stdout, sys.stderr)
1095
# Is this a final release version? If so, we should suppress warnings
1096
if bzrlib.version_info[3] == 'final':
1097
suppress_deprecation_warnings(override=True)
1099
argv = osutils.get_unicode_argv()
1103
# ensure all arguments are unicode strings
1105
if isinstance(a, unicode):
1108
new_argv.append(a.decode('ascii'))
1109
except UnicodeDecodeError:
1110
raise errors.BzrError("argv should be list of unicode strings.")
1112
ret = run_bzr_catch_errors(argv)
1113
bzrlib.ui.ui_factory.log_transport_activity(
1114
display=('bytes' in debug.debug_flags))
1115
trace.mutter("return code %d", ret)
1116
osutils.report_extension_load_failures()
560
from bzrlib.ui.text import TextUIFactory
561
## bzrlib.trace.enable_default_logging()
562
bzrlib.trace.log_startup(argv)
563
bzrlib.ui.ui_factory = TextUIFactory()
564
ret = run_bzr_catch_errors(argv[1:])
565
mutter("return code %d", ret)
1120
569
def run_bzr_catch_errors(argv):
1121
"""Run a bzr command with parameters as described by argv.
1123
This function assumed that that UI layer is setup, that symbol deprecations
1124
are already applied, and that unicode decoding has already been performed on argv.
1126
install_bzr_command_hooks()
1127
return exception_to_return_code(run_bzr, argv)
1130
def run_bzr_catch_user_errors(argv):
1131
"""Run bzr and report user errors, but let internal errors propagate.
1133
This is used for the test suite, and might be useful for other programs
1134
that want to wrap the commandline interface.
1136
install_bzr_command_hooks()
1138
return run_bzr(argv)
574
# do this here inside the exception wrappers to catch EPIPE
1139
576
except Exception, e:
1140
if (isinstance(e, (OSError, IOError))
1141
or not getattr(e, 'internal_error', True)):
1142
trace.report_exception(sys.exc_info(), sys.stderr)
1148
class HelpCommandIndex(object):
1149
"""A index for bzr help that returns commands."""
1152
self.prefix = 'commands/'
1154
def get_topics(self, topic):
1155
"""Search for topic amongst commands.
1157
:param topic: A topic to search for.
1158
:return: A list which is either empty or contains a single
1161
if topic and topic.startswith(self.prefix):
1162
topic = topic[len(self.prefix):]
1164
cmd = _get_cmd_object(topic)
1171
class Provider(object):
1172
'''Generic class to be overriden by plugins'''
1174
def plugin_for_command(self, cmd_name):
1175
'''Takes a command and returns the information for that plugin
1177
:return: A dictionary with all the available information
1178
for the requested plugin
1180
raise NotImplementedError
1183
class ProvidersRegistry(registry.Registry):
1184
'''This registry exists to allow other providers to exist'''
1187
for key, provider in self.iteritems():
1190
command_providers_registry = ProvidersRegistry()
577
# used to handle AssertionError and KeyboardInterrupt
578
# specially here, but hopefully they're handled ok by the logger now
580
if (isinstance(e, IOError)
581
and hasattr(e, 'errno')
582
and e.errno == errno.EPIPE):
583
bzrlib.trace.note('broken pipe')
586
bzrlib.trace.log_exception()
587
if os.environ.get('BZR_PDB'):
588
print '**** entering debugger'
590
pdb.post_mortem(sys.exc_traceback)
1193
593
if __name__ == '__main__':
1194
594
sys.exit(main(sys.argv))
added
removed
bzrlib/commands.py
