26
23
# 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
28
from bzrlib.lazy_import import lazy_import
35
29
lazy_import(globals(), """
38
from warnings import warn
41
34
from bzrlib import (
46
from bzrlib.hooks import Hooks
47
# Compatibility - Option used to be in commands.
48
from bzrlib.option import Option
49
from bzrlib.plugin import disable_plugins, load_plugins
50
from bzrlib import registry
52
51
from bzrlib.symbol_versioning import (
53
52
deprecated_function,
57
from bzrlib.option import Option
58
class CommandInfo(object):
59
"""Information about a command."""
61
def __init__(self, aliases):
62
"""The list of aliases for the command."""
63
self.aliases = aliases
66
def from_command(klass, command):
67
"""Factory to construct a CommandInfo from a command."""
68
return klass(command.aliases)
71
class CommandRegistry(registry.Registry):
72
"""Special registry mapping command names to command classes.
74
:ivar overridden_registry: Look in this registry for commands being
75
overridden by this registry. This can be used to tell plugin commands
76
about the builtin they're decorating.
80
registry.Registry.__init__(self)
81
self.overridden_registry = None
82
# map from aliases to the real command that implements the name
85
def get(self, command_name):
86
real_name = self._alias_dict.get(command_name, command_name)
87
return registry.Registry.get(self, real_name)
90
def _get_name(command_name):
91
if command_name.startswith("cmd_"):
92
return _unsquish_command_name(command_name)
96
def register(self, cmd, decorate=False):
97
"""Utility function to help register a command
99
:param cmd: Command subclass to register
100
:param decorate: If true, allow overriding an existing command
101
of the same name; the old command is returned by this function.
102
Otherwise it is an error to try to override an existing command.
105
k_unsquished = self._get_name(k)
107
previous = self.get(k_unsquished)
110
if self.overridden_registry:
112
previous = self.overridden_registry.get(k_unsquished)
115
info = CommandInfo.from_command(cmd)
117
registry.Registry.register(self, k_unsquished, cmd,
118
override_existing=decorate, info=info)
120
trace.warning('Two plugins defined the same command: %r' % k)
121
trace.warning('Not loading the one in %r' %
122
sys.modules[cmd.__module__])
123
trace.warning('Previously this command was registered from %r' %
124
sys.modules[previous.__module__])
125
for a in cmd.aliases:
126
self._alias_dict[a] = k_unsquished
129
def register_lazy(self, command_name, aliases, module_name):
130
"""Register a command without loading its module.
132
:param command_name: The primary name of the command.
133
:param aliases: A list of aliases for the command.
134
:module_name: The module that the command lives in.
136
key = self._get_name(command_name)
137
registry.Registry.register_lazy(self, key, module_name, command_name,
138
info=CommandInfo(aliases))
140
self._alias_dict[a] = key
143
plugin_cmds = CommandRegistry()
144
builtin_command_registry = CommandRegistry()
145
plugin_cmds.overridden_registry = builtin_command_registry
63
148
def register_command(cmd, decorate=False):
64
"""Utility function to help register a command
149
"""Register a plugin 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.
151
Should generally be avoided in favor of lazy registration.
71
153
global plugin_cmds
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__])
89
trace.log_error('Previously this command was registered from %r' %
90
sys.modules[plugin_cmds[k_unsquished].__module__])
154
return plugin_cmds.register(cmd, decorate)
93
157
def _squish_command_name(cmd):
98
162
return cmd[4:].replace('_','-')
165
@deprecated_function(deprecated_in((2, 2, 0)))
101
166
def _builtin_commands():
167
"""Return a dict of {name: cmd_class} for builtin commands.
169
:deprecated: Use the builtin_command_registry registry instead
171
# return dict(name: cmd_class)
172
return dict(builtin_command_registry.items())
175
def _register_builtin_commands():
176
if builtin_command_registry.keys():
102
179
import bzrlib.builtins
180
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
181
builtin_command_registry.register(cmd_class)
182
bzrlib.builtins._register_lazy_builtins()
185
def _scan_module_for_commands(module):
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
187
for name, obj in module.__dict__.iteritems():
106
188
if name.startswith("cmd_"):
107
189
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
194
def _list_bzr_commands(names):
195
"""Find commands from bzr's core and plugins.
197
This is not the public interface, just the default hook called by all_command_names.
199
# to eliminate duplicates
200
names.update(builtin_command_names())
201
names.update(plugin_command_names())
205
def all_command_names():
206
"""Return a set of all command names."""
208
for hook in Command.hooks['list_commands']:
211
raise AssertionError(
212
'hook %s returned None' % Command.hooks.get_hook_name(hook))
112
216
def builtin_command_names():
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
217
"""Return list of builtin command names.
219
Use of all_command_names() is encouraged rather than builtin_command_names
220
and/or plugin_command_names.
222
_register_builtin_commands()
223
return builtin_command_registry.keys()
117
226
def plugin_command_names():
227
"""Returns command names from commands registered by plugins."""
118
228
return plugin_cmds.keys()
121
def _get_cmd_dict(plugins_override=True):
122
"""Return name->class mapping for all commands."""
123
d = _builtin_commands()
125
d.update(plugin_cmds)
129
def get_all_cmds(plugins_override=True):
130
"""Return canonical name and class for all registered commands."""
131
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
135
231
def get_cmd_object(cmd_name, plugins_override=True):
136
"""Return the canonical name and command class for a command.
232
"""Return the command object for a command.
139
235
If true, plugin commands can override builtins.
144
240
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
244
"""Get a command object.
246
:param cmd_name: The name of the command.
247
:param plugins_override: Allow plugins to override builtins.
248
:param check_missing: Look up commands not found in the regular index via
249
the get_missing_command hook.
250
:return: A Command object instance
251
:raises KeyError: If no command is found.
253
# We want only 'ascii' command names, but the user may have typed
254
# in a Unicode name. In that case, they should just get a
255
# 'command not found' error later.
256
# In the future, we may actually support Unicode command names.
259
for hook in Command.hooks['get_command']:
260
cmd = hook(cmd, cmd_name)
261
if cmd is not None and not plugins_override and not cmd.plugin_name():
262
# We've found a non-plugin command, don't permit it to be
265
if cmd is None and check_missing:
266
for hook in Command.hooks['get_missing_command']:
273
# Allow plugins to extend commands
274
for hook in Command.hooks['extend_command']:
276
if getattr(cmd, 'invoked_as', None) is None:
277
cmd.invoked_as = cmd_name
281
def _try_plugin_provider(cmd_name):
282
"""Probe for a plugin provider having cmd_name."""
284
plugin_metadata, provider = probe_for_provider(cmd_name)
285
raise errors.CommandAvailableInPlugin(cmd_name,
286
plugin_metadata, provider)
287
except errors.NoPluginAvailable:
291
def probe_for_provider(cmd_name):
292
"""Look for a provider for cmd_name.
294
:param cmd_name: The command name.
295
:return: plugin_metadata, provider for getting cmd_name.
296
:raises NoPluginAvailable: When no provider can supply the plugin.
298
# look for providers that provide this command but aren't installed
299
for provider in command_providers_registry:
301
return provider.plugin_for_command(cmd_name), provider
302
except errors.NoPluginAvailable:
304
raise errors.NoPluginAvailable(cmd_name)
307
def _get_bzr_command(cmd_or_None, cmd_name):
308
"""Get a command from bzr's core."""
310
cmd_class = builtin_command_registry.get(cmd_name)
318
def _get_external_command(cmd_or_None, cmd_name):
319
"""Lookup a command that is a shell script."""
320
# Only do external command lookups when no command is found so far.
321
if cmd_or_None is not None:
149
323
from bzrlib.externalcommand import ExternalCommand
151
# We want only 'ascii' command names, but the user may have typed
152
# in a Unicode name. In that case, they should just get a
153
# 'command not found' error later.
154
# In the future, we may actually support Unicode command names.
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[cmd_name]()
163
# look for any command which claims this as an alias
164
for real_cmd_name, cmd_class in cmds.iteritems():
165
if cmd_name in cmd_class.aliases:
168
324
cmd_obj = ExternalCommand.find_command(cmd_name)
172
# look for plugins that provide this command but aren't installed
173
for provider in command_providers_registry:
175
plugin_metadata = provider.plugin_for_command(cmd_name)
176
except errors.NoPluginAvailable:
179
raise errors.CommandAvailableInPlugin(cmd_name,
180
plugin_metadata, provider)
329
def _get_plugin_command(cmd_or_None, cmd_name):
330
"""Get a command from bzr's plugins."""
332
return plugin_cmds.get(cmd_name)()
335
for key in plugin_cmds.keys():
336
info = plugin_cmds.get_info(key)
337
if cmd_name in info.aliases:
338
return plugin_cmds.get(key)()
185
342
class Command(object):
200
357
summary, then a complete description of the command. A grammar
201
358
description will be inserted.
204
Other accepted names for this command.
207
List of argument forms, marked with whether they are optional,
212
['to_location', 'from_branch?', 'file*']
214
'to_location' is required
215
'from_branch' is optional
216
'file' can be specified 0 or more times
219
List of options that may be given for this command. These can
220
be either strings, referring to globally-defined options,
221
or option objects. Retrieve through options().
224
If true, this command isn't advertised. This is typically
360
:cvar aliases: Other accepted names for this command.
362
:cvar takes_args: List of argument forms, marked with whether they are
363
optional, repeated, etc. Examples::
365
['to_location', 'from_branch?', 'file*']
367
* 'to_location' is required
368
* 'from_branch' is optional
369
* 'file' can be specified 0 or more times
371
:cvar takes_options: List of options that may be given for this command.
372
These can be either strings, referring to globally-defined options, or
373
option objects. Retrieve through options().
375
:cvar hidden: If true, this command isn't advertised. This is typically
225
376
for commands intended for expert users.
228
Command objects will get a 'outf' attribute, which has been
229
setup to properly handle encoding of unicode strings.
230
encoding_type determines what will happen when characters cannot
232
strict - abort if we cannot decode
233
replace - put in a bogus character (typically '?')
234
exact - do not encode sys.stdout
236
NOTE: by default on Windows, sys.stdout is opened as a text
237
stream, therefore LF line-endings are converted to CRLF.
238
When a command uses encoding_type = 'exact', then
239
sys.stdout is forced to be a binary stream, and line-endings
378
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
379
been setup to properly handle encoding of unicode strings.
380
encoding_type determines what will happen when characters cannot be
383
* strict - abort if we cannot decode
384
* replace - put in a bogus character (typically '?')
385
* exact - do not encode sys.stdout
387
NOTE: by default on Windows, sys.stdout is opened as a text stream,
388
therefore LF line-endings are converted to CRLF. When a command uses
389
encoding_type = 'exact', then sys.stdout is forced to be a binary
390
stream, and line-endings will not mangled.
393
A string indicating the real name under which this command was
394
invoked, before expansion of aliases.
395
(This may be None if the command was constructed and run in-process.)
397
:cvar hooks: An instance of CommandHooks.
399
:cvar __doc__: The help shown by 'bzr help command' for this command.
400
This is set by assigning explicitly to __doc__ so that -OO can
404
__doc__ = "My help goes here"
245
408
takes_options = []
246
409
encoding_type = 'strict'
250
414
def __init__(self):
251
415
"""Construct an instance of this command."""
252
if self.__doc__ == Command.__doc__:
253
warn("No help message set for %r" % self)
254
416
# List of standard options directly supported
255
417
self.supported_std_options = []
420
def add_cleanup(self, cleanup_func, *args, **kwargs):
421
"""Register a function to call after self.run returns or raises.
423
Functions will be called in LIFO order.
425
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
427
def cleanup_now(self):
428
"""Execute and empty pending cleanup functions immediately.
430
After cleanup_now all registered cleanups are forgotten. add_cleanup
431
may be called again after cleanup_now; these cleanups will be called
432
after self.run returns or raises (or when cleanup_now is next called).
434
This is useful for releasing expensive or contentious resources (such
435
as write locks) before doing further work that does not require those
436
resources (such as writing results to self.outf). Note though, that
437
as it releases all resources, this may release locks that the command
438
wants to hold, so use should be done with care.
440
self._operation.cleanup_now()
442
@deprecated_method(deprecated_in((2, 1, 0)))
257
443
def _maybe_expand_globs(self, file_list):
258
444
"""Glob expand file_list if the platform does not do that itself.
446
Not used anymore, now that the bzr command-line parser globs on
260
449
:return: A possibly empty list of unicode paths.
262
451
Introduced in bzrlib 0.18.
266
if sys.platform == 'win32':
267
file_list = win32utils.glob_expand(file_list)
268
return list(file_list)
270
455
def _usage(self):
271
456
"""Return single-line grammar for this command.
288
473
def get_help_text(self, additional_see_also=None, plain=True,
289
see_also_as_links=False):
474
see_also_as_links=False, verbose=True):
290
475
"""Return a text string with help for this command.
292
477
:param additional_see_also: Additional help topics to be
293
478
cross-referenced.
294
479
:param plain: if False, raw help (reStructuredText) is
295
480
returned instead of plain text.
296
481
:param see_also_as_links: if True, convert items in 'See also'
297
482
list to internal links (used by bzr_man rstx generator)
483
:param verbose: if True, display the full help, otherwise
484
leave out the descriptive sections and just display
485
usage help (e.g. Purpose, Usage, Options) with a
486
message explaining how to obtain full help.
299
488
doc = self.help()
301
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
490
doc = "No help for this command."
303
492
# Extract the summary (purpose) and sections out from the text
304
purpose,sections = self._get_help_parts(doc)
493
purpose,sections,order = self._get_help_parts(doc)
306
495
# If a custom usage section was provided, use it
307
496
if sections.has_key('Usage'):
329
530
result += options
332
# Add the description, indenting it 2 spaces
333
# to match the indentation of the options
334
if sections.has_key(None):
335
text = sections.pop(None)
336
text = '\n '.join(text.splitlines())
337
result += ':%s:\n %s\n\n' % ('Description',text)
534
# Add the description, indenting it 2 spaces
535
# to match the indentation of the options
536
if sections.has_key(None):
537
text = sections.pop(None)
538
text = '\n '.join(text.splitlines())
539
result += ':%s:\n %s\n\n' % ('Description',text)
339
# Add the custom sections (e.g. Examples). Note that there's no need
340
# to indent these as they must be indented already in the source.
342
labels = sorted(sections.keys())
344
result += ':%s:\n%s\n\n' % (label,sections[label])
541
# Add the custom sections (e.g. Examples). Note that there's no need
542
# to indent these as they must be indented already in the source.
545
if sections.has_key(label):
546
result += ':%s:\n%s\n' % (label,sections[label])
549
result += ("See bzr help %s for more details and examples.\n\n"
346
552
# Add the aliases, source (plug-in) and see also links, if any
376
583
def _get_help_parts(text):
377
584
"""Split help text into a summary and named sections.
379
:return: (summary,sections) where summary is the top line and
586
:return: (summary,sections,order) where summary is the top line and
380
587
sections is a dictionary of the rest indexed by section name.
588
order is the order the section appear in the text.
381
589
A section starts with a heading line of the form ":xxx:".
382
590
Indented text on following lines is the section value.
383
591
All text found outside a named section is assigned to the
384
592
default section which is given the key of None.
386
def save_section(sections, label, section):
594
def save_section(sections, order, label, section):
387
595
if len(section) > 0:
388
596
if sections.has_key(label):
389
597
sections[label] += '\n' + section
391
600
sections[label] = section
393
602
lines = text.rstrip().splitlines()
394
603
summary = lines.pop(0)
396
606
label,section = None,''
397
607
for line in lines:
398
608
if line.startswith(':') and line.endswith(':') and len(line) > 2:
399
save_section(sections, label, section)
609
save_section(sections, order, label, section)
400
610
label,section = line[1:-1],''
401
611
elif (label is not None) and len(line) > 1 and not line[0].isspace():
402
save_section(sections, label, section)
612
save_section(sections, order, label, section)
403
613
label,section = None,line
405
615
if len(section) > 0:
406
616
section += '\n' + line
409
save_section(sections, label, section)
410
return summary, sections
619
save_section(sections, order, label, section)
620
return summary, sections, order
412
622
def get_help_topic(self):
413
623
"""Return the commands help topic - its name."""
443
653
def _setup_outf(self):
444
654
"""Return a file linked to stdout, which has proper encoding."""
445
# Originally I was using self.stdout, but that looks
446
# *way* too much like sys.stdout
447
if self.encoding_type == 'exact':
448
# force sys.stdout to be binary stream on win32
449
if sys.platform == 'win32':
450
fileno = getattr(sys.stdout, 'fileno', None)
453
msvcrt.setmode(fileno(), os.O_BINARY)
454
self.outf = sys.stdout
457
output_encoding = osutils.get_terminal_encoding()
459
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
460
errors=self.encoding_type)
461
# For whatever reason codecs.getwriter() does not advertise its encoding
462
# it just returns the encoding of the wrapped file, which is completely
463
# bogus. So set the attribute, so we can find the correct encoding later.
464
self.outf.encoding = output_encoding
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
466
658
def run_argv_aliases(self, argv, alias_argv=None):
467
659
"""Parse the command line and run with extra aliases in alias_argv."""
469
warn("Passing None for [] is deprecated from bzrlib 0.10",
470
DeprecationWarning, stacklevel=2)
472
660
args, opts = parse_args(self, argv, alias_argv)
474
662
# Process the standard options
475
663
if 'help' in opts: # e.g. bzr add --help
476
664
sys.stdout.write(self.get_help_text())
666
if 'usage' in opts: # e.g. bzr add --usage
667
sys.stdout.write(self.get_help_text(verbose=False))
478
669
trace.set_verbosity_level(option._verbosity_level)
479
670
if 'verbose' in self.supported_std_options:
480
671
opts['verbose'] = trace.is_verbose()
497
688
self._setup_outf()
499
return self.run(**all_cmd_args)
691
return self.run(**all_cmd_args)
693
# reset it, so that other commands run in the same process won't
694
# inherit state. Before we reset it, log any activity, so that it
695
# gets properly tracked.
696
ui.ui_factory.log_transport_activity(
697
display=('bytes' in debug.debug_flags))
698
trace.set_verbosity_level(0)
700
def _setup_run(self):
701
"""Wrap the defined run method on self with a cleanup.
703
This is called by __init__ to make the Command be able to be run
704
by just calling run(), as it could be before cleanups were added.
706
If a different form of cleanups are in use by your Command subclass,
707
you can override this method.
710
def run(*args, **kwargs):
711
self._operation = cleanup.OperationWithCleanups(class_run)
713
return self._operation.run_simple(*args, **kwargs)
718
@deprecated_method(deprecated_in((2, 2, 0)))
719
def run_direct(self, *args, **kwargs):
720
"""Deprecated thunk from bzrlib 2.1."""
721
return self.run(*args, **kwargs)
502
724
"""Actually run the command.
773
class CommandHooks(Hooks):
774
"""Hooks related to Command object creation/enumeration."""
777
"""Create the default hooks.
779
These are all empty initially, because by default nothing should get
782
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
783
self.add_hook('extend_command',
784
"Called after creating a command object to allow modifications "
785
"such as adding or removing options, docs etc. Called with the "
786
"new bzrlib.commands.Command object.", (1, 13))
787
self.add_hook('get_command',
788
"Called when creating a single command. Called with "
789
"(cmd_or_None, command_name). get_command should either return "
790
"the cmd_or_None parameter, or a replacement Command object that "
791
"should be used for the command. Note that the Command.hooks "
792
"hooks are core infrastructure. Many users will prefer to use "
793
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
795
self.add_hook('get_missing_command',
796
"Called when creating a single command if no command could be "
797
"found. Called with (command_name). get_missing_command should "
798
"either return None, or a Command object to be used for the "
800
self.add_hook('list_commands',
801
"Called when enumerating commands. Called with a set of "
802
"cmd_name strings for all the commands found so far. This set "
803
" is safe to mutate - e.g. to remove a command. "
804
"list_commands should return the updated set of command names.",
807
Command.hooks = CommandHooks()
536
810
def parse_args(command, argv, alias_argv=None):
537
811
"""Parse command line.
539
813
Arguments and options are parsed at this level before being passed
540
814
down to specific command handlers. This routine knows, from a
541
815
lookup table, something about the available options, what optargs
636
919
os.remove(pfname)
922
def exception_to_return_code(the_callable, *args, **kwargs):
923
"""UI level helper for profiling and coverage.
925
This transforms exceptions into a return value of 3. As such its only
926
relevant to the UI layer, and should never be called where catching
927
exceptions may be desirable.
930
return the_callable(*args, **kwargs)
931
except (KeyboardInterrupt, Exception), e:
932
# used to handle AssertionError and KeyboardInterrupt
933
# specially here, but hopefully they're handled ok by the logger now
934
exc_info = sys.exc_info()
935
exitcode = trace.report_exception(exc_info, sys.stderr)
936
if os.environ.get('BZR_PDB'):
937
print '**** entering debugger'
940
if sys.version_info[:2] < (2, 6):
942
# pdb.post_mortem(tb)
943
# but because pdb.post_mortem gives bad results for tracebacks
944
# from inside generators, we do it manually.
945
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
947
# Setup pdb on the traceback
950
p.setup(tb.tb_frame, tb)
951
# Point the debugger at the deepest frame of the stack
952
p.curindex = len(p.stack) - 1
953
p.curframe = p.stack[p.curindex][0]
954
# Start the pdb prompt.
955
p.print_stack_entry(p.stack[p.curindex])
639
963
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
640
964
from bzrlib.lsprof import profile
641
ret, stats = profile(the_callable, *args, **kwargs)
965
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
643
967
if filename is None:
668
992
config = bzrlib.config.GlobalConfig()
669
993
alias = config.get_alias(cmd)
671
return shlex_split_unicode(alias)
995
return cmdline.split(alias)
999
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
676
1000
"""Execute a command.
678
This is similar to main(), but without all the trappings for
679
logging and error handling.
682
The command-line arguments, without the program name from argv[0]
683
These should already be decoded. All library/test code calling
684
run_bzr should be passing valid strings (don't need decoding).
686
Returns a command status or raises an exception.
1002
:param argv: The command-line arguments, without the program name from
1003
argv[0] These should already be decoded. All library/test code calling
1004
run_bzr should be passing valid strings (don't need decoding).
1005
:param load_plugins: What function to call when triggering plugin loading.
1006
This function should take no arguments and cause all plugins to be
1008
:param disable_plugins: What function to call when disabling plugin
1009
loading. This function should take no arguments and cause all plugin
1010
loading to be prohibited (so that code paths in your application that
1011
know about some plugins possibly being present will fail to import
1012
those plugins even if they are installed.)
1013
:return: Returns a command exit code or raises an exception.
688
1015
Special master options: these must come before the command because
689
1016
they control how the command is interpreted.
736
1067
opt_no_aliases = True
737
1068
elif a == '--builtin':
738
1069
opt_builtin = True
1070
elif a == '--concurrency':
1071
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
739
1073
elif a == '--coverage':
740
1074
opt_coverage_dir = argv[i + 1]
1076
elif a == '--profile-imports':
1077
pass # already handled in startup script Bug #588277
742
1078
elif a.startswith('-D'):
743
1079
debug.debug_flags.add(a[2:])
745
1081
argv_copy.append(a)
1084
debug.set_debug_flags_from_config()
1086
if not opt_no_plugins:
748
1091
argv = argv_copy
750
from bzrlib.builtins import cmd_help
751
cmd_help().run_argv_aliases([])
1093
get_cmd_object('help').run_argv_aliases([])
754
1096
if argv[0] == '--version':
755
from bzrlib.builtins import cmd_version
756
cmd_version().run_argv_aliases([])
1097
get_cmd_object('version').run_argv_aliases([])
759
if not opt_no_plugins:
760
from bzrlib.plugin import load_plugins
763
from bzrlib.plugin import disable_plugins
766
1100
alias_argv = None
768
1102
if not opt_no_aliases:
769
1103
alias_argv = get_alias(argv[0])
771
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
772
1105
argv[0] = alias_argv.pop(0)
774
1107
cmd = argv.pop(0)
775
# We want only 'ascii' command names, but the user may have typed
776
# in a Unicode name. In that case, they should just get a
777
# 'command not found' error later.
779
1108
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
780
1109
run = cmd_obj.run_argv_aliases
781
1110
run_argv = [argv, alias_argv]
1113
# We can be called recursively (tests for example), but we don't want
1114
# the verbosity level to propagate.
1115
saved_verbosity_level = option._verbosity_level
1116
option._verbosity_level = 0
785
1118
if opt_coverage_dir:
795
1128
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
797
1130
ret = run(*run_argv)
1133
# reset, in case we may do other commands later within the same
1134
# process. Commands that want to execute sub-commands must propagate
1135
# --verbose in their own way.
798
1136
if 'memory' in debug.debug_flags:
800
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
804
status = status_file.read()
806
trace.note("Process status after command:")
807
for line in status.splitlines():
811
# reset, in case we may do other commands later within the same process
812
option._verbosity_level = 0
1137
trace.debug_memory('Process status after command:', short=False)
1138
option._verbosity_level = saved_verbosity_level
814
1141
def display_command(func):
815
1142
"""Decorator that suppresses pipe/interrupt errors."""
831
1158
return ignore_pipe
836
from bzrlib.ui.text import TextUIFactory
837
bzrlib.ui.ui_factory = TextUIFactory()
839
# Is this a final release version? If so, we should suppress warnings
840
if bzrlib.version_info[3] == 'final':
841
from bzrlib import symbol_versioning
842
symbol_versioning.suppress_deprecation_warnings(override=False)
844
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
845
except UnicodeDecodeError:
846
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1161
def install_bzr_command_hooks():
1162
"""Install the hooks to supply bzr's own commands."""
1163
if _list_bzr_commands in Command.hooks["list_commands"]:
1165
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1167
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1169
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1170
"bzr plugin commands")
1171
Command.hooks.install_named_hook("get_command", _get_external_command,
1172
"bzr external command lookup")
1173
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1174
"bzr plugin-provider-db check")
1178
def _specified_or_unicode_argv(argv):
1179
# For internal or testing use, argv can be passed. Otherwise, get it from
1180
# the process arguments in a unicode-safe way.
1182
return osutils.get_unicode_argv()
1186
# ensure all arguments are unicode strings
1188
if isinstance(a, unicode):
1191
new_argv.append(a.decode('ascii'))
1192
except UnicodeDecodeError:
1193
raise errors.BzrError("argv should be list of unicode strings.")
1197
def main(argv=None):
1198
"""Main entry point of command-line interface.
1200
Typically `bzrlib.initialize` should be called first.
1202
:param argv: list of unicode command-line arguments similar to sys.argv.
1203
argv[0] is script name usually, it will be ignored.
1204
Don't pass here sys.argv because this list contains plain strings
1205
and not unicode; pass None instead.
1207
:return: exit code of bzr command.
1209
if argv is not None:
1211
_register_builtin_commands()
848
1212
ret = run_bzr_catch_errors(argv)
849
1213
trace.mutter("return code %d", ret)
853
1217
def run_bzr_catch_errors(argv):
854
# Note: The except clause logic below should be kept in sync with the
855
# profile() routine in lsprof.py.
858
except (KeyboardInterrupt, Exception), e:
859
# used to handle AssertionError and KeyboardInterrupt
860
# specially here, but hopefully they're handled ok by the logger now
861
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
862
if os.environ.get('BZR_PDB'):
863
print '**** entering debugger'
865
pdb.post_mortem(sys.exc_traceback)
1218
"""Run a bzr command with parameters as described by argv.
1220
This function assumed that that UI layer is setup, that symbol deprecations
1221
are already applied, and that unicode decoding has already been performed on argv.
1223
# done here so that they're covered for every test run
1224
install_bzr_command_hooks()
1225
return exception_to_return_code(run_bzr, argv)
869
1228
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
