23
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?
28
34
from bzrlib.lazy_import import lazy_import
29
35
lazy_import(globals(), """
38
from warnings import warn
34
41
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
51
51
from bzrlib.symbol_versioning import (
52
52
deprecated_function,
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
56
from bzrlib.option import Option
148
62
def register_command(cmd, decorate=False):
149
"""Register a plugin command.
63
"""Utility function to help register a command
151
Should generally be avoided in favor of lazy registration.
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.
153
70
global plugin_cmds
154
return plugin_cmds.register(cmd, decorate)
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__])
88
trace.log_error('Previously this command was registered from %r' %
89
sys.modules[plugin_cmds[k_unsquished].__module__])
157
92
def _squish_command_name(cmd):
161
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
162
98
return cmd[4:].replace('_','-')
165
@deprecated_function(deprecated_in((2, 2, 0)))
166
101
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():
179
102
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):
187
for name, obj in module.__dict__.iteritems():
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
188
106
if name.startswith("cmd_"):
189
107
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))
216
112
def builtin_command_names():
217
"""Return list of builtin command names.
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
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()
226
117
def plugin_command_names():
227
"""Returns command names from commands registered by plugins."""
228
118
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():
231
135
def get_cmd_object(cmd_name, plugins_override=True):
232
"""Return the command object for a command.
136
"""Return the canonical name and command class for a command.
235
139
If true, plugin commands can override builtins.
240
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
243
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
244
"""Get a command object.
147
def _get_cmd_object(cmd_name, plugins_override=True):
148
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
149
from bzrlib.externalcommand import ExternalCommand
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
151
# We want only 'ascii' command names, but the user may have typed
254
152
# in a Unicode name. In that case, they should just get a
255
153
# 'command not found' error later.
256
154
# 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)
156
# first look up this command under the specified name
157
cmds = _get_cmd_dict(plugins_override=plugins_override)
159
return cmds[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:
323
from bzrlib.externalcommand import ExternalCommand
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:
324
168
cmd_obj = ExternalCommand.find_command(cmd_name)
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)()
342
174
class Command(object):
396
228
sys.stdout is forced to be a binary stream, and line-endings
397
229
will not mangled.
400
A string indicating the real name under which this command was
401
invoked, before expansion of aliases.
402
(This may be None if the command was constructed and run in-process.)
404
:cvar hooks: An instance of CommandHooks.
406
:ivar __doc__: The help shown by 'bzr help command' for this command.
407
This is set by assigning explicitly to __doc__ so that -OO can
411
__doc__ = "My help goes here"
415
234
takes_options = []
416
235
encoding_type = 'strict'
421
239
def __init__(self):
422
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
423
243
# List of standard options directly supported
424
244
self.supported_std_options = []
427
def add_cleanup(self, cleanup_func, *args, **kwargs):
428
"""Register a function to call after self.run returns or raises.
430
Functions will be called in LIFO order.
432
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
434
def cleanup_now(self):
435
"""Execute and empty pending cleanup functions immediately.
437
After cleanup_now all registered cleanups are forgotten. add_cleanup
438
may be called again after cleanup_now; these cleanups will be called
439
after self.run returns or raises (or when cleanup_now is next called).
441
This is useful for releasing expensive or contentious resources (such
442
as write locks) before doing further work that does not require those
443
resources (such as writing results to self.outf). Note though, that
444
as it releases all resources, this may release locks that the command
445
wants to hold, so use should be done with care.
447
self._operation.cleanup_now()
449
@deprecated_method(deprecated_in((2, 1, 0)))
450
246
def _maybe_expand_globs(self, file_list):
451
247
"""Glob expand file_list if the platform does not do that itself.
453
Not used anymore, now that the bzr command-line parser globs on
456
249
:return: A possibly empty list of unicode paths.
458
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
462
259
def _usage(self):
463
260
"""Return single-line grammar for this command.
474
271
elif aname[-1] == '*':
475
272
aname = '[' + aname[:-1] + '...]'
477
s = s[:-1] # remove last space
480
279
def get_help_text(self, additional_see_also=None, plain=True,
481
see_also_as_links=False, verbose=True):
280
see_also_as_links=False):
482
281
"""Return a text string with help for this command.
484
283
:param additional_see_also: Additional help topics to be
485
284
cross-referenced.
486
285
:param plain: if False, raw help (reStructuredText) is
487
286
returned instead of plain text.
488
287
:param see_also_as_links: if True, convert items in 'See also'
489
288
list to internal links (used by bzr_man rstx generator)
490
:param verbose: if True, display the full help, otherwise
491
leave out the descriptive sections and just display
492
usage help (e.g. Purpose, Usage, Options) with a
493
message explaining how to obtain full help.
495
290
doc = self.help()
497
doc = "No help for this command."
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
499
294
# Extract the summary (purpose) and sections out from the text
500
purpose,sections,order = self._get_help_parts(doc)
295
purpose,sections = self._get_help_parts(doc)
502
297
# If a custom usage section was provided, use it
503
298
if sections.has_key('Usage'):
536
320
result += options
540
# Add the description, indenting it 2 spaces
541
# to match the indentation of the options
542
if sections.has_key(None):
543
text = sections.pop(None)
544
text = '\n '.join(text.splitlines())
545
result += ':%s:\n %s\n\n' % ('Description',text)
323
# Add the description, indenting it 2 spaces
324
# to match the indentation of the options
325
if sections.has_key(None):
326
text = sections.pop(None)
327
text = '\n '.join(text.splitlines())
328
result += ':%s:\n %s\n\n' % ('Description',text)
547
# Add the custom sections (e.g. Examples). Note that there's no need
548
# to indent these as they must be indented already in the source.
551
if sections.has_key(label):
552
result += ':%s:\n%s\n' % (label,sections[label])
555
result += ("See bzr help %s for more details and examples.\n\n"
330
# Add the custom sections (e.g. Examples). Note that there's no need
331
# to indent these as they must be indented already in the source.
333
labels = sorted(sections.keys())
335
result += ':%s:\n%s\n\n' % (label,sections[label])
558
337
# Add the aliases, source (plug-in) and see also links, if any
589
367
def _get_help_parts(text):
590
368
"""Split help text into a summary and named sections.
592
:return: (summary,sections,order) where summary is the top line and
370
:return: (summary,sections) where summary is the top line and
593
371
sections is a dictionary of the rest indexed by section name.
594
order is the order the section appear in the text.
595
372
A section starts with a heading line of the form ":xxx:".
596
373
Indented text on following lines is the section value.
597
374
All text found outside a named section is assigned to the
598
375
default section which is given the key of None.
600
def save_section(sections, order, label, section):
377
def save_section(sections, label, section):
601
378
if len(section) > 0:
602
379
if sections.has_key(label):
603
380
sections[label] += '\n' + section
606
382
sections[label] = section
608
384
lines = text.rstrip().splitlines()
609
385
summary = lines.pop(0)
612
387
label,section = None,''
613
388
for line in lines:
614
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
615
save_section(sections, order, label, section)
390
save_section(sections, label, section)
616
391
label,section = line[1:-1],''
617
elif (label is not None) and len(line) > 1 and not line[0].isspace():
618
save_section(sections, order, label, section)
392
elif label != None and len(line) > 1 and not line[0].isspace():
393
save_section(sections, label, section)
619
394
label,section = None,line
621
396
if len(section) > 0:
622
397
section += '\n' + line
625
save_section(sections, order, label, section)
626
return summary, sections, order
400
save_section(sections, label, section)
401
return summary, sections
628
403
def get_help_topic(self):
629
404
"""Return the commands help topic - its name."""
659
434
def _setup_outf(self):
660
435
"""Return a file linked to stdout, which has proper encoding."""
661
self.outf = ui.ui_factory.make_output_stream(
662
encoding_type=self.encoding_type)
436
assert self.encoding_type in ['strict', 'exact', 'replace']
438
# Originally I was using self.stdout, but that looks
439
# *way* too much like sys.stdout
440
if self.encoding_type == 'exact':
441
# force sys.stdout to be binary stream on win32
442
if sys.platform == 'win32':
443
fileno = getattr(sys.stdout, 'fileno', None)
446
msvcrt.setmode(fileno(), os.O_BINARY)
447
self.outf = sys.stdout
450
output_encoding = osutils.get_terminal_encoding()
452
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
453
errors=self.encoding_type)
454
# For whatever reason codecs.getwriter() does not advertise its encoding
455
# it just returns the encoding of the wrapped file, which is completely
456
# bogus. So set the attribute, so we can find the correct encoding later.
457
self.outf.encoding = output_encoding
664
459
def run_argv_aliases(self, argv, alias_argv=None):
665
460
"""Parse the command line and run with extra aliases in alias_argv."""
462
warn("Passing None for [] is deprecated from bzrlib 0.10",
463
DeprecationWarning, stacklevel=2)
666
465
args, opts = parse_args(self, argv, alias_argv)
668
467
# Process the standard options
669
468
if 'help' in opts: # e.g. bzr add --help
670
469
sys.stdout.write(self.get_help_text())
672
if 'usage' in opts: # e.g. bzr add --usage
673
sys.stdout.write(self.get_help_text(verbose=False))
675
471
trace.set_verbosity_level(option._verbosity_level)
676
472
if 'verbose' in self.supported_std_options:
677
473
opts['verbose'] = trace.is_verbose()
694
490
self._setup_outf()
697
return self.run(**all_cmd_args)
699
# reset it, so that other commands run in the same process won't
700
# inherit state. Before we reset it, log any activity, so that it
701
# gets properly tracked.
702
ui.ui_factory.log_transport_activity(
703
display=('bytes' in debug.debug_flags))
704
trace.set_verbosity_level(0)
706
def _setup_run(self):
707
"""Wrap the defined run method on self with a cleanup.
709
This is called by __init__ to make the Command be able to be run
710
by just calling run(), as it could be before cleanups were added.
712
If a different form of cleanups are in use by your Command subclass,
713
you can override this method.
716
def run(*args, **kwargs):
717
self._operation = cleanup.OperationWithCleanups(class_run)
719
return self._operation.run_simple(*args, **kwargs)
724
@deprecated_method(deprecated_in((2, 2, 0)))
725
def run_direct(self, *args, **kwargs):
726
"""Deprecated thunk from bzrlib 2.1."""
727
return self.run(*args, **kwargs)
492
return self.run(**all_cmd_args)
730
495
"""Actually run the command.
779
class CommandHooks(Hooks):
780
"""Hooks related to Command object creation/enumeration."""
783
"""Create the default hooks.
785
These are all empty initially, because by default nothing should get
788
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
789
self.add_hook('extend_command',
790
"Called after creating a command object to allow modifications "
791
"such as adding or removing options, docs etc. Called with the "
792
"new bzrlib.commands.Command object.", (1, 13))
793
self.add_hook('get_command',
794
"Called when creating a single command. Called with "
795
"(cmd_or_None, command_name). get_command should either return "
796
"the cmd_or_None parameter, or a replacement Command object that "
797
"should be used for the command. Note that the Command.hooks "
798
"hooks are core infrastructure. Many users will prefer to use "
799
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
801
self.add_hook('get_missing_command',
802
"Called when creating a single command if no command could be "
803
"found. Called with (command_name). get_missing_command should "
804
"either return None, or a Command object to be used for the "
806
self.add_hook('list_commands',
807
"Called when enumerating commands. Called with a set of "
808
"cmd_name strings for all the commands found so far. This set "
809
" is safe to mutate - e.g. to remove a command. "
810
"list_commands should return the updated set of command names.",
813
Command.hooks = CommandHooks()
816
529
def parse_args(command, argv, alias_argv=None):
817
530
"""Parse command line.
819
532
Arguments and options are parsed at this level before being passed
820
533
down to specific command handlers. This routine knows, from a
821
534
lookup table, something about the available options, what optargs
876
583
% (cmd, argname.upper()))
878
585
argdict[argname] = args.pop(0)
881
588
raise errors.BzrCommandError("extra argument to command %s: %s"
882
589
% (cmd, args[0]))
886
def apply_coveraged(dirname, the_callable, *args, **kwargs):
887
# Cannot use "import trace", as that would import bzrlib.trace instead of
888
# the standard library's trace.
889
trace = __import__('trace')
891
tracer = trace.Trace(count=1, trace=0)
892
sys.settrace(tracer.globaltrace)
893
threading.settrace(tracer.globaltrace)
896
return exception_to_return_code(the_callable, *args, **kwargs)
899
results = tracer.results()
900
results.write_results(show_missing=1, summary=False,
904
595
def apply_profiled(the_callable, *args, **kwargs):
925
615
os.remove(pfname)
928
def exception_to_return_code(the_callable, *args, **kwargs):
929
"""UI level helper for profiling and coverage.
931
This transforms exceptions into a return value of 3. As such its only
932
relevant to the UI layer, and should never be called where catching
933
exceptions may be desirable.
936
return the_callable(*args, **kwargs)
937
except (KeyboardInterrupt, Exception), e:
938
# used to handle AssertionError and KeyboardInterrupt
939
# specially here, but hopefully they're handled ok by the logger now
940
exc_info = sys.exc_info()
941
exitcode = trace.report_exception(exc_info, sys.stderr)
942
if os.environ.get('BZR_PDB'):
943
print '**** entering debugger'
946
if sys.version_info[:2] < (2, 6):
948
# pdb.post_mortem(tb)
949
# but because pdb.post_mortem gives bad results for tracebacks
950
# from inside generators, we do it manually.
951
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
953
# Setup pdb on the traceback
956
p.setup(tb.tb_frame, tb)
957
# Point the debugger at the deepest frame of the stack
958
p.curindex = len(p.stack) - 1
959
p.curframe = p.stack[p.curindex][0]
960
# Start the pdb prompt.
961
p.print_stack_entry(p.stack[p.curindex])
969
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
970
619
from bzrlib.lsprof import profile
971
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
620
ret, stats = profile(the_callable, *args, **kwargs)
973
622
if filename is None:
998
642
config = bzrlib.config.GlobalConfig()
999
643
alias = config.get_alias(cmd)
1001
return cmdline.split(alias)
646
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
1005
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1006
651
"""Execute a command.
1008
:param argv: The command-line arguments, without the program name from
1009
argv[0] These should already be decoded. All library/test code calling
1010
run_bzr should be passing valid strings (don't need decoding).
1011
:param load_plugins: What function to call when triggering plugin loading.
1012
This function should take no arguments and cause all plugins to be
1014
:param disable_plugins: What function to call when disabling plugin
1015
loading. This function should take no arguments and cause all plugin
1016
loading to be prohibited (so that code paths in your application that
1017
know about some plugins possibly being present will fail to import
1018
those plugins even if they are installed.)
1019
:return: Returns a command exit code or raises an exception.
653
This is similar to main(), but without all the trappings for
654
logging and error handling.
657
The command-line arguments, without the program name from argv[0]
658
These should already be decoded. All library/test code calling
659
run_bzr should be passing valid strings (don't need decoding).
661
Returns a command status or raises an exception.
1021
663
Special master options: these must come before the command because
1022
664
they control how the command is interpreted.
1073
708
opt_no_aliases = True
1074
709
elif a == '--builtin':
1075
710
opt_builtin = True
1076
elif a == '--concurrency':
1077
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1079
elif a == '--coverage':
1080
opt_coverage_dir = argv[i + 1]
1082
elif a == '--profile-imports':
1083
pass # already handled in startup script Bug #588277
1084
711
elif a.startswith('-D'):
1085
712
debug.debug_flags.add(a[2:])
1087
714
argv_copy.append(a)
1090
debug.set_debug_flags_from_config()
719
from bzrlib.builtins import cmd_help
720
cmd_help().run_argv_aliases([])
723
if argv[0] == '--version':
724
from bzrlib.builtins import cmd_version
725
cmd_version().run_argv_aliases([])
1092
728
if not opt_no_plugins:
729
from bzrlib.plugin import load_plugins
732
from bzrlib.plugin import disable_plugins
1095
733
disable_plugins()
1099
get_cmd_object('help').run_argv_aliases([])
1102
if argv[0] == '--version':
1103
get_cmd_object('version').run_argv_aliases([])
1106
735
alias_argv = None
1108
737
if not opt_no_aliases:
1109
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1111
741
argv[0] = alias_argv.pop(0)
1113
743
cmd = argv.pop(0)
744
# We want only 'ascii' command names, but the user may have typed
745
# in a Unicode name. In that case, they should just get a
746
# 'command not found' error later.
1114
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1115
749
run = cmd_obj.run_argv_aliases
1116
750
run_argv = [argv, alias_argv]
1119
# We can be called recursively (tests for example), but we don't want
1120
# the verbosity level to propagate.
1121
saved_verbosity_level = option._verbosity_level
1122
option._verbosity_level = 0
1124
if opt_coverage_dir:
1126
'--coverage ignored, because --lsprof is in use.')
1127
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1128
755
elif opt_profile:
1129
if opt_coverage_dir:
1131
'--coverage ignored, because --profile is in use.')
1132
756
ret = apply_profiled(run, *run_argv)
1133
elif opt_coverage_dir:
1134
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1136
758
ret = run(*run_argv)
1139
# reset, in case we may do other commands later within the same
1140
# process. Commands that want to execute sub-commands must propagate
1141
# --verbose in their own way.
1142
if 'memory' in debug.debug_flags:
1143
trace.debug_memory('Process status after command:', short=False)
1144
option._verbosity_level = saved_verbosity_level
761
# reset, in case we may do other commands later within the same process
762
option._verbosity_level = 0
1147
764
def display_command(func):
1148
765
"""Decorator that suppresses pipe/interrupt errors."""
1164
781
return ignore_pipe
1167
def install_bzr_command_hooks():
1168
"""Install the hooks to supply bzr's own commands."""
1169
if _list_bzr_commands in Command.hooks["list_commands"]:
1171
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1173
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1175
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1176
"bzr plugin commands")
1177
Command.hooks.install_named_hook("get_command", _get_external_command,
1178
"bzr external command lookup")
1179
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1180
"bzr plugin-provider-db check")
1184
def _specified_or_unicode_argv(argv):
1185
# For internal or testing use, argv can be passed. Otherwise, get it from
1186
# the process arguments in a unicode-safe way.
1188
return osutils.get_unicode_argv()
1192
# ensure all arguments are unicode strings
1194
if isinstance(a, unicode):
1197
new_argv.append(a.decode('ascii'))
1198
except UnicodeDecodeError:
1199
raise errors.BzrError("argv should be list of unicode strings.")
1203
def main(argv=None):
1204
"""Main entry point of command-line interface.
1206
Typically `bzrlib.initialize` should be called first.
1208
:param argv: list of unicode command-line arguments similar to sys.argv.
1209
argv[0] is script name usually, it will be ignored.
1210
Don't pass here sys.argv because this list contains plain strings
1211
and not unicode; pass None instead.
1213
:return: exit code of bzr command.
1215
if argv is not None:
1217
_register_builtin_commands()
786
from bzrlib.ui.text import TextUIFactory
787
bzrlib.ui.ui_factory = TextUIFactory()
789
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
790
except UnicodeDecodeError:
791
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1218
793
ret = run_bzr_catch_errors(argv)
1219
794
trace.mutter("return code %d", ret)
1223
798
def run_bzr_catch_errors(argv):
1224
"""Run a bzr command with parameters as described by argv.
1226
This function assumed that that UI layer is setup, that symbol deprecations
1227
are already applied, and that unicode decoding has already been performed on argv.
1229
# done here so that they're covered for every test run
1230
install_bzr_command_hooks()
1231
return exception_to_return_code(run_bzr, argv)
799
# Note: The except clause logic below should be kept in sync with the
800
# profile() routine in lsprof.py.
803
except (KeyboardInterrupt, Exception), e:
804
# used to handle AssertionError and KeyboardInterrupt
805
# specially here, but hopefully they're handled ok by the logger now
806
exitcode = trace.report_exception(sys.exc_info(), sys.stderr)
807
if os.environ.get('BZR_PDB'):
808
print '**** entering debugger'
810
pdb.post_mortem(sys.exc_traceback)
1234
814
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
