29
35
lazy_import(globals(), """
33
38
from warnings import warn
36
41
from bzrlib import (
49
from bzrlib.hooks import HookPoint, Hooks
50
# Compatibility - Option used to be in commands.
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
51
from bzrlib.symbol_versioning import (
55
52
deprecated_function,
61
class CommandInfo(object):
62
"""Information about a command."""
64
def __init__(self, aliases):
65
"""The list of aliases for the command."""
66
self.aliases = aliases
69
def from_command(klass, command):
70
"""Factory to construct a CommandInfo from a command."""
71
return klass(command.aliases)
74
class CommandRegistry(registry.Registry):
75
"""Special registry mapping command names to command classes.
77
:ivar overridden_registry: Look in this registry for commands being
78
overridden by this registry. This can be used to tell plugin commands
79
about the builtin they're decorating.
83
registry.Registry.__init__(self)
84
self.overridden_registry = None
85
# map from aliases to the real command that implements the name
88
def get(self, command_name):
89
real_name = self._alias_dict.get(command_name, command_name)
90
return registry.Registry.get(self, real_name)
93
def _get_name(command_name):
94
if command_name.startswith("cmd_"):
95
return _unsquish_command_name(command_name)
99
def register(self, cmd, decorate=False):
100
"""Utility function to help register a command
102
:param cmd: Command subclass to register
103
:param decorate: If true, allow overriding an existing command
104
of the same name; the old command is returned by this function.
105
Otherwise it is an error to try to override an existing command.
108
k_unsquished = self._get_name(k)
110
previous = self.get(k_unsquished)
113
if self.overridden_registry:
115
previous = self.overridden_registry.get(k_unsquished)
118
info = CommandInfo.from_command(cmd)
120
registry.Registry.register(self, k_unsquished, cmd,
121
override_existing=decorate, info=info)
123
trace.warning('Two plugins defined the same command: %r' % k)
124
trace.warning('Not loading the one in %r' %
125
sys.modules[cmd.__module__])
126
trace.warning('Previously this command was registered from %r' %
127
sys.modules[previous.__module__])
128
for a in cmd.aliases:
129
self._alias_dict[a] = k_unsquished
132
def register_lazy(self, command_name, aliases, module_name):
133
"""Register a command without loading its module.
135
:param command_name: The primary name of the command.
136
:param aliases: A list of aliases for the command.
137
:module_name: The module that the command lives in.
139
key = self._get_name(command_name)
140
registry.Registry.register_lazy(self, key, module_name, command_name,
141
info=CommandInfo(aliases))
143
self._alias_dict[a] = key
146
plugin_cmds = CommandRegistry()
147
builtin_command_registry = CommandRegistry()
148
plugin_cmds.overridden_registry = builtin_command_registry
56
from bzrlib.option import Option
151
62
def register_command(cmd, decorate=False):
152
"""Register a plugin command.
63
"""Utility function to help register a command
154
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.
156
70
global plugin_cmds
157
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__])
160
92
def _squish_command_name(cmd):
164
96
def _unsquish_command_name(cmd):
97
assert cmd.startswith("cmd_")
165
98
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
101
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
178
def _register_builtin_commands():
179
if builtin_command_registry.keys():
182
102
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
184
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
188
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
104
builtins = bzrlib.builtins.__dict__
105
for name in builtins:
191
106
if name.startswith("cmd_"):
192
107
real_name = _unsquish_command_name(name)
108
r[real_name] = builtins[name]
197
def _list_bzr_commands(names):
198
"""Find commands from bzr's core and plugins.
200
This is not the public interface, just the default hook called by all_command_names.
202
# to eliminate duplicates
203
names.update(builtin_command_names())
204
names.update(plugin_command_names())
208
def all_command_names():
209
"""Return a set of all command names."""
211
for hook in Command.hooks['list_commands']:
214
raise AssertionError(
215
'hook %s returned None' % Command.hooks.get_hook_name(hook))
219
112
def builtin_command_names():
220
"""Return list of builtin command names.
113
"""Return list of builtin command names."""
114
return _builtin_commands().keys()
222
Use of all_command_names() is encouraged rather than builtin_command_names
223
and/or plugin_command_names.
225
_register_builtin_commands()
226
return builtin_command_registry.keys()
229
117
def plugin_command_names():
230
"""Returns command names from commands registered by plugins."""
231
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():
234
135
def get_cmd_object(cmd_name, plugins_override=True):
235
"""Return the command object for a command.
136
"""Return the canonical name and command class for a command.
238
139
If true, plugin commands can override builtins.
243
144
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
247
"""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
249
:param cmd_name: The name of the command.
250
:param plugins_override: Allow plugins to override builtins.
251
:param check_missing: Look up commands not found in the regular index via
252
the get_missing_command hook.
253
:return: A Command object instance
254
:raises KeyError: If no command is found.
256
151
# We want only 'ascii' command names, but the user may have typed
257
152
# in a Unicode name. In that case, they should just get a
258
153
# 'command not found' error later.
259
154
# In the future, we may actually support Unicode command names.
262
for hook in Command.hooks['get_command']:
263
cmd = hook(cmd, cmd_name)
264
if cmd is not None and not plugins_override and not cmd.plugin_name():
265
# We've found a non-plugin command, don't permit it to be
268
if cmd is None and check_missing:
269
for hook in Command.hooks['get_missing_command']:
276
# Allow plugins to extend commands
277
for hook in Command.hooks['extend_command']:
282
def _try_plugin_provider(cmd_name):
283
"""Probe for a plugin provider having cmd_name."""
285
plugin_metadata, provider = probe_for_provider(cmd_name)
286
raise errors.CommandAvailableInPlugin(cmd_name,
287
plugin_metadata, provider)
288
except errors.NoPluginAvailable:
292
def probe_for_provider(cmd_name):
293
"""Look for a provider for cmd_name.
295
:param cmd_name: The command name.
296
:return: plugin_metadata, provider for getting cmd_name.
297
:raises NoPluginAvailable: When no provider can supply the plugin.
299
# look for providers that provide this command but aren't installed
300
for provider in command_providers_registry:
302
return provider.plugin_for_command(cmd_name), provider
303
except errors.NoPluginAvailable:
305
raise errors.NoPluginAvailable(cmd_name)
308
def _get_bzr_command(cmd_or_None, cmd_name):
309
"""Get a command from bzr's core."""
311
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]()
319
def _get_external_command(cmd_or_None, cmd_name):
320
"""Lookup a command that is a shell script."""
321
# Only do external command lookups when no command is found so far.
322
if cmd_or_None is not None:
324
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:
325
168
cmd_obj = ExternalCommand.find_command(cmd_name)
330
def _get_plugin_command(cmd_or_None, cmd_name):
331
"""Get a command from bzr's plugins."""
333
return plugin_cmds.get(cmd_name)()
336
for key in plugin_cmds.keys():
337
info = plugin_cmds.get_info(key)
338
if cmd_name in info.aliases:
339
return plugin_cmds.get(key)()
343
174
class Command(object):
411
235
encoding_type = 'strict'
415
239
def __init__(self):
416
240
"""Construct an instance of this command."""
241
if self.__doc__ == Command.__doc__:
242
warn("No help message set for %r" % self)
417
243
# List of standard options directly supported
418
244
self.supported_std_options = []
421
def add_cleanup(self, cleanup_func, *args, **kwargs):
422
"""Register a function to call after self.run returns or raises.
424
Functions will be called in LIFO order.
426
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
428
def cleanup_now(self):
429
"""Execute and empty pending cleanup functions immediately.
431
After cleanup_now all registered cleanups are forgotten. add_cleanup
432
may be called again after cleanup_now; these cleanups will be called
433
after self.run returns or raises (or when cleanup_now is next called).
435
This is useful for releasing expensive or contentious resources (such
436
as write locks) before doing further work that does not require those
437
resources (such as writing results to self.outf). Note though, that
438
as it releases all resources, this may release locks that the command
439
wants to hold, so use should be done with care.
441
self._operation.cleanup_now()
443
@deprecated_method(deprecated_in((2, 1, 0)))
444
246
def _maybe_expand_globs(self, file_list):
445
247
"""Glob expand file_list if the platform does not do that itself.
447
Not used anymore, now that the bzr command-line parser globs on
450
249
:return: A possibly empty list of unicode paths.
452
251
Introduced in bzrlib 0.18.
255
if sys.platform == 'win32':
256
file_list = win32utils.glob_expand(file_list)
257
return list(file_list)
456
259
def _usage(self):
457
260
"""Return single-line grammar for this command.
468
271
elif aname[-1] == '*':
469
272
aname = '[' + aname[:-1] + '...]'
471
s = s[:-1] # remove last space
474
279
def get_help_text(self, additional_see_also=None, plain=True,
475
see_also_as_links=False, verbose=True):
280
see_also_as_links=False):
476
281
"""Return a text string with help for this command.
478
283
:param additional_see_also: Additional help topics to be
479
284
cross-referenced.
480
285
:param plain: if False, raw help (reStructuredText) is
481
286
returned instead of plain text.
482
287
:param see_also_as_links: if True, convert items in 'See also'
483
288
list to internal links (used by bzr_man rstx generator)
484
:param verbose: if True, display the full help, otherwise
485
leave out the descriptive sections and just display
486
usage help (e.g. Purpose, Usage, Options) with a
487
message explaining how to obtain full help.
489
290
doc = self.help()
491
doc = "No help for this command."
292
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
493
294
# Extract the summary (purpose) and sections out from the text
494
purpose,sections,order = self._get_help_parts(doc)
295
purpose,sections = self._get_help_parts(doc)
496
297
# If a custom usage section was provided, use it
497
298
if sections.has_key('Usage'):
530
320
result += options
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)
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)
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"
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])
552
337
# Add the aliases, source (plug-in) and see also links, if any
583
367
def _get_help_parts(text):
584
368
"""Split help text into a summary and named sections.
586
:return: (summary,sections,order) where summary is the top line and
370
:return: (summary,sections) where summary is the top line and
587
371
sections is a dictionary of the rest indexed by section name.
588
order is the order the section appear in the text.
589
372
A section starts with a heading line of the form ":xxx:".
590
373
Indented text on following lines is the section value.
591
374
All text found outside a named section is assigned to the
592
375
default section which is given the key of None.
594
def save_section(sections, order, label, section):
377
def save_section(sections, label, section):
595
378
if len(section) > 0:
596
379
if sections.has_key(label):
597
380
sections[label] += '\n' + section
600
382
sections[label] = section
602
384
lines = text.rstrip().splitlines()
603
385
summary = lines.pop(0)
606
387
label,section = None,''
607
388
for line in lines:
608
389
if line.startswith(':') and line.endswith(':') and len(line) > 2:
609
save_section(sections, order, label, section)
390
save_section(sections, label, section)
610
391
label,section = line[1:-1],''
611
elif (label is not None) and len(line) > 1 and not line[0].isspace():
612
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)
613
394
label,section = None,line
615
396
if len(section) > 0:
616
397
section += '\n' + line
619
save_section(sections, order, label, section)
620
return summary, sections, order
400
save_section(sections, label, section)
401
return summary, sections
622
403
def get_help_topic(self):
623
404
"""Return the commands help topic - its name."""
653
434
def _setup_outf(self):
654
435
"""Return a file linked to stdout, which has proper encoding."""
655
self.outf = ui.ui_factory.make_output_stream(
656
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
658
459
def run_argv_aliases(self, argv, alias_argv=None):
659
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)
660
465
args, opts = parse_args(self, argv, alias_argv)
662
467
# Process the standard options
663
468
if 'help' in opts: # e.g. bzr add --help
664
469
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))
669
471
trace.set_verbosity_level(option._verbosity_level)
670
472
if 'verbose' in self.supported_std_options:
671
473
opts['verbose'] = trace.is_verbose()
688
490
self._setup_outf()
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)
492
return self.run(**all_cmd_args)
724
495
"""Actually run the command.
769
class CommandHooks(Hooks):
770
"""Hooks related to Command object creation/enumeration."""
773
"""Create the default hooks.
775
These are all empty initially, because by default nothing should get
779
self.create_hook(HookPoint('extend_command',
780
"Called after creating a command object to allow modifications "
781
"such as adding or removing options, docs etc. Called with the "
782
"new bzrlib.commands.Command object.", (1, 13), None))
783
self.create_hook(HookPoint('get_command',
784
"Called when creating a single command. Called with "
785
"(cmd_or_None, command_name). get_command should either return "
786
"the cmd_or_None parameter, or a replacement Command object that "
787
"should be used for the command. Note that the Command.hooks "
788
"hooks are core infrastructure. Many users will prefer to use "
789
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
791
self.create_hook(HookPoint('get_missing_command',
792
"Called when creating a single command if no command could be "
793
"found. Called with (command_name). get_missing_command should "
794
"either return None, or a Command object to be used for the "
795
"command.", (1, 17), None))
796
self.create_hook(HookPoint('list_commands',
797
"Called when enumerating commands. Called with a set of "
798
"cmd_name strings for all the commands found so far. This set "
799
" is safe to mutate - e.g. to remove a command. "
800
"list_commands should return the updated set of command names.",
803
Command.hooks = CommandHooks()
806
529
def parse_args(command, argv, alias_argv=None):
807
530
"""Parse command line.
809
532
Arguments and options are parsed at this level before being passed
810
533
down to specific command handlers. This routine knows, from a
811
534
lookup table, something about the available options, what optargs
866
583
% (cmd, argname.upper()))
868
585
argdict[argname] = args.pop(0)
871
588
raise errors.BzrCommandError("extra argument to command %s: %s"
872
589
% (cmd, args[0]))
876
def apply_coveraged(dirname, the_callable, *args, **kwargs):
877
# Cannot use "import trace", as that would import bzrlib.trace instead of
878
# the standard library's trace.
879
trace = __import__('trace')
881
tracer = trace.Trace(count=1, trace=0)
882
sys.settrace(tracer.globaltrace)
883
threading.settrace(tracer.globaltrace)
886
return exception_to_return_code(the_callable, *args, **kwargs)
889
results = tracer.results()
890
results.write_results(show_missing=1, summary=False,
894
595
def apply_profiled(the_callable, *args, **kwargs):
915
615
os.remove(pfname)
918
def exception_to_return_code(the_callable, *args, **kwargs):
919
"""UI level helper for profiling and coverage.
921
This transforms exceptions into a return value of 3. As such its only
922
relevant to the UI layer, and should never be called where catching
923
exceptions may be desirable.
926
return the_callable(*args, **kwargs)
927
except (KeyboardInterrupt, Exception), e:
928
# used to handle AssertionError and KeyboardInterrupt
929
# specially here, but hopefully they're handled ok by the logger now
930
exc_info = sys.exc_info()
931
exitcode = trace.report_exception(exc_info, sys.stderr)
932
if os.environ.get('BZR_PDB'):
933
print '**** entering debugger'
936
if sys.version_info[:2] < (2, 6):
938
# pdb.post_mortem(tb)
939
# but because pdb.post_mortem gives bad results for tracebacks
940
# from inside generators, we do it manually.
941
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
943
# Setup pdb on the traceback
946
p.setup(tb.tb_frame, tb)
947
# Point the debugger at the deepest frame of the stack
948
p.curindex = len(p.stack) - 1
949
p.curframe = p.stack[p.curindex][0]
950
# Start the pdb prompt.
951
p.print_stack_entry(p.stack[p.curindex])
959
618
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
960
619
from bzrlib.lsprof import profile
961
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
620
ret, stats = profile(the_callable, *args, **kwargs)
963
622
if filename is None:
988
642
config = bzrlib.config.GlobalConfig()
989
643
alias = config.get_alias(cmd)
991
return cmdline.split(alias)
646
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
995
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
996
651
"""Execute a command.
998
:param argv: The command-line arguments, without the program name from
999
argv[0] These should already be decoded. All library/test code calling
1000
run_bzr should be passing valid strings (don't need decoding).
1001
:param load_plugins: What function to call when triggering plugin loading.
1002
This function should take no arguments and cause all plugins to be
1004
:param disable_plugins: What function to call when disabling plugin
1005
loading. This function should take no arguments and cause all plugin
1006
loading to be prohibited (so that code paths in your application that
1007
know about some plugins possibly being present will fail to import
1008
those plugins even if they are installed.)
1009
: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.
1011
663
Special master options: these must come before the command because
1012
664
they control how the command is interpreted.
1063
708
opt_no_aliases = True
1064
709
elif a == '--builtin':
1065
710
opt_builtin = True
1066
elif a == '--concurrency':
1067
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1069
elif a == '--coverage':
1070
opt_coverage_dir = argv[i + 1]
1072
elif a == '--profile-imports':
1073
pass # already handled in startup script Bug #588277
1074
711
elif a.startswith('-D'):
1075
712
debug.debug_flags.add(a[2:])
1077
714
argv_copy.append(a)
1080
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([])
1082
728
if not opt_no_plugins:
729
from bzrlib.plugin import load_plugins
732
from bzrlib.plugin import disable_plugins
1085
733
disable_plugins()
1089
get_cmd_object('help').run_argv_aliases([])
1092
if argv[0] == '--version':
1093
get_cmd_object('version').run_argv_aliases([])
1096
735
alias_argv = None
1098
737
if not opt_no_aliases:
1099
738
alias_argv = get_alias(argv[0])
740
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
1101
741
argv[0] = alias_argv.pop(0)
1103
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.
1104
748
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1105
749
run = cmd_obj.run_argv_aliases
1106
750
run_argv = [argv, alias_argv]
1109
# We can be called recursively (tests for example), but we don't want
1110
# the verbosity level to propagate.
1111
saved_verbosity_level = option._verbosity_level
1112
option._verbosity_level = 0
1114
if opt_coverage_dir:
1116
'--coverage ignored, because --lsprof is in use.')
1117
754
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
1118
755
elif opt_profile:
1119
if opt_coverage_dir:
1121
'--coverage ignored, because --profile is in use.')
1122
756
ret = apply_profiled(run, *run_argv)
1123
elif opt_coverage_dir:
1124
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
1126
758
ret = run(*run_argv)
1129
# reset, in case we may do other commands later within the same
1130
# process. Commands that want to execute sub-commands must propagate
1131
# --verbose in their own way.
1132
if 'memory' in debug.debug_flags:
1133
trace.debug_memory('Process status after command:', short=False)
1134
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
1137
764
def display_command(func):
1138
765
"""Decorator that suppresses pipe/interrupt errors."""
1154
781
return ignore_pipe
1157
def install_bzr_command_hooks():
1158
"""Install the hooks to supply bzr's own commands."""
1159
if _list_bzr_commands in Command.hooks["list_commands"]:
1161
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1163
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1165
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1166
"bzr plugin commands")
1167
Command.hooks.install_named_hook("get_command", _get_external_command,
1168
"bzr external command lookup")
1169
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1170
"bzr plugin-provider-db check")
1174
def _specified_or_unicode_argv(argv):
1175
# For internal or testing use, argv can be passed. Otherwise, get it from
1176
# the process arguments in a unicode-safe way.
1178
return osutils.get_unicode_argv()
1182
# ensure all arguments are unicode strings
1184
if isinstance(a, unicode):
1187
new_argv.append(a.decode('ascii'))
1188
except UnicodeDecodeError:
1189
raise errors.BzrError("argv should be list of unicode strings.")
1193
def main(argv=None):
1194
"""Main entry point of command-line interface.
1196
Typically `bzrlib.initialize` should be called first.
1198
:param argv: list of unicode command-line arguments similar to sys.argv.
1199
argv[0] is script name usually, it will be ignored.
1200
Don't pass here sys.argv because this list contains plain strings
1201
and not unicode; pass None instead.
1203
:return: exit code of bzr command.
1205
argv = _specified_or_unicode_argv(argv)
1206
_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 "
1207
793
ret = run_bzr_catch_errors(argv)
1208
794
trace.mutter("return code %d", ret)
1212
798
def run_bzr_catch_errors(argv):
1213
"""Run a bzr command with parameters as described by argv.
1215
This function assumed that that UI layer is setup, that symbol deprecations
1216
are already applied, and that unicode decoding has already been performed on argv.
1218
# done here so that they're covered for every test run
1219
install_bzr_command_hooks()
1220
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)
1223
814
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
