35
29
lazy_import(globals(), """
38
33
from warnings import warn
41
36
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
51
54
from bzrlib.symbol_versioning import (
52
55
deprecated_function,
56
from bzrlib.option import Option
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
62
151
def register_command(cmd, decorate=False):
63
"""Utility function to help register a command
152
"""Register a plugin command.
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.
154
Should generally be avoided in favor of lazy registration.
70
156
global plugin_cmds
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__])
157
return plugin_cmds.register(cmd, decorate)
90
160
def _squish_command_name(cmd):
94
164
def _unsquish_command_name(cmd):
95
assert cmd.startswith("cmd_")
96
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
99
169
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():
100
182
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):
102
builtins = bzrlib.builtins.__dict__
103
for name in builtins:
190
for name, obj in module.__dict__.iteritems():
104
191
if name.startswith("cmd_"):
105
192
real_name = _unsquish_command_name(name)
106
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))
110
219
def builtin_command_names():
111
"""Return list of builtin command names."""
112
return _builtin_commands().keys()
220
"""Return list of builtin command names.
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()
115
229
def plugin_command_names():
230
"""Returns command names from commands registered by plugins."""
116
231
return plugin_cmds.keys()
119
def _get_cmd_dict(plugins_override=True):
120
"""Return name->class mapping for all commands."""
121
d = _builtin_commands()
123
d.update(plugin_cmds)
127
def get_all_cmds(plugins_override=True):
128
"""Return canonical name and class for all registered commands."""
129
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
133
234
def get_cmd_object(cmd_name, plugins_override=True):
134
"""Return the canonical name and command class for a command.
235
"""Return the command object for a command.
137
238
If true, plugin commands can override builtins.
142
243
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
145
def _get_cmd_object(cmd_name, plugins_override=True):
146
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
246
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
247
"""Get a command object.
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
# We want only 'ascii' command names, but the user may have typed
257
# in a Unicode name. In that case, they should just get a
258
# 'command not found' error later.
259
# 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)
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:
147
324
from bzrlib.externalcommand import ExternalCommand
149
# We want only 'ascii' command names, but the user may have typed
150
# in a Unicode name. In that case, they should just get a
151
# 'command not found' error later.
152
# In the future, we may actually support Unicode command names.
154
# first look up this command under the specified name
155
cmds = _get_cmd_dict(plugins_override=plugins_override)
157
return cmds[cmd_name]()
161
# look for any command which claims this as an alias
162
for real_cmd_name, cmd_class in cmds.iteritems():
163
if cmd_name in cmd_class.aliases:
166
325
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)()
172
343
class Command(object):
233
411
encoding_type = 'strict'
237
415
def __init__(self):
238
416
"""Construct an instance of this command."""
239
if self.__doc__ == Command.__doc__:
240
warn("No help message set for %r" % self)
417
# List of standard options directly supported
418
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)))
242
444
def _maybe_expand_globs(self, file_list):
243
445
"""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
245
450
:return: A possibly empty list of unicode paths.
247
452
Introduced in bzrlib 0.18.
251
if sys.platform == 'win32':
252
file_list = win32utils.glob_expand(file_list)
253
return list(file_list)
255
456
def _usage(self):
256
457
"""Return single-line grammar for this command.
267
468
elif aname[-1] == '*':
268
469
aname = '[' + aname[:-1] + '...]'
471
s = s[:-1] # remove last space
275
474
def get_help_text(self, additional_see_also=None, plain=True,
276
see_also_as_links=False):
475
see_also_as_links=False, verbose=True):
277
476
"""Return a text string with help for this command.
279
478
:param additional_see_also: Additional help topics to be
280
479
cross-referenced.
281
480
:param plain: if False, raw help (reStructuredText) is
282
481
returned instead of plain text.
283
482
:param see_also_as_links: if True, convert items in 'See also'
284
483
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.
286
489
doc = self.help()
288
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
491
doc = "No help for this command."
290
493
# Extract the summary (purpose) and sections out from the text
291
purpose,sections = self._get_help_parts(doc)
494
purpose,sections,order = self._get_help_parts(doc)
293
496
# If a custom usage section was provided, use it
294
497
if sections.has_key('Usage'):
316
530
result += options
319
# Add the description, indenting it 2 spaces
320
# to match the indentation of the options
321
if sections.has_key(None):
322
text = sections.pop(None)
323
text = '\n '.join(text.splitlines())
324
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)
326
# Add the custom sections (e.g. Examples). Note that there's no need
327
# to indent these as they must be indented already in the source.
329
labels = sorted(sections.keys())
331
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"
333
552
# Add the aliases, source (plug-in) and see also links, if any
363
583
def _get_help_parts(text):
364
584
"""Split help text into a summary and named sections.
366
:return: (summary,sections) where summary is the top line and
586
:return: (summary,sections,order) where summary is the top line and
367
587
sections is a dictionary of the rest indexed by section name.
588
order is the order the section appear in the text.
368
589
A section starts with a heading line of the form ":xxx:".
369
590
Indented text on following lines is the section value.
370
591
All text found outside a named section is assigned to the
371
592
default section which is given the key of None.
373
def save_section(sections, label, section):
594
def save_section(sections, order, label, section):
374
595
if len(section) > 0:
375
596
if sections.has_key(label):
376
597
sections[label] += '\n' + section
378
600
sections[label] = section
380
602
lines = text.rstrip().splitlines()
381
603
summary = lines.pop(0)
383
606
label,section = None,''
384
607
for line in lines:
385
608
if line.startswith(':') and line.endswith(':') and len(line) > 2:
386
save_section(sections, label, section)
609
save_section(sections, order, label, section)
387
610
label,section = line[1:-1],''
388
elif label != None and len(line) > 1 and not line[0].isspace():
389
save_section(sections, label, section)
611
elif (label is not None) and len(line) > 1 and not line[0].isspace():
612
save_section(sections, order, label, section)
390
613
label,section = None,line
392
615
if len(section) > 0:
393
616
section += '\n' + line
396
save_section(sections, label, section)
397
return summary, sections
619
save_section(sections, order, label, section)
620
return summary, sections, order
399
622
def get_help_topic(self):
400
623
"""Return the commands help topic - its name."""
417
640
"""Return dict of valid options for this command.
419
642
Maps from long option name to option object."""
421
r['help'] = option._help_option
643
r = Option.STD_OPTIONS.copy()
422
645
for o in self.takes_options:
423
646
if isinstance(o, basestring):
424
647
o = option.Option.OPTIONS[o]
649
if o.name in std_names:
650
self.supported_std_options.append(o.name)
428
653
def _setup_outf(self):
429
654
"""Return a file linked to stdout, which has proper encoding."""
430
assert self.encoding_type in ['strict', 'exact', 'replace']
432
# Originally I was using self.stdout, but that looks
433
# *way* too much like sys.stdout
434
if self.encoding_type == 'exact':
435
# force sys.stdout to be binary stream on win32
436
if sys.platform == 'win32':
437
fileno = getattr(sys.stdout, 'fileno', None)
440
msvcrt.setmode(fileno(), os.O_BINARY)
441
self.outf = sys.stdout
444
output_encoding = osutils.get_terminal_encoding()
446
# use 'replace' so that we don't abort if trying to write out
447
# in e.g. the default C locale.
448
self.outf = codecs.getwriter(output_encoding)(sys.stdout, errors=self.encoding_type)
449
# For whatever reason codecs.getwriter() does not advertise its encoding
450
# it just returns the encoding of the wrapped file, which is completely
451
# bogus. So set the attribute, so we can find the correct encoding later.
452
self.outf.encoding = output_encoding
655
self.outf = ui.ui_factory.make_output_stream(
656
encoding_type=self.encoding_type)
454
658
def run_argv_aliases(self, argv, alias_argv=None):
455
659
"""Parse the command line and run with extra aliases in alias_argv."""
457
warn("Passing None for [] is deprecated from bzrlib 0.10",
458
DeprecationWarning, stacklevel=2)
460
660
args, opts = parse_args(self, argv, alias_argv)
662
# Process the standard options
461
663
if 'help' in opts: # e.g. bzr add --help
462
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))
669
trace.set_verbosity_level(option._verbosity_level)
670
if 'verbose' in self.supported_std_options:
671
opts['verbose'] = trace.is_verbose()
672
elif opts.has_key('verbose'):
674
if 'quiet' in self.supported_std_options:
675
opts['quiet'] = trace.is_quiet()
676
elif opts.has_key('quiet'):
464
679
# mix arguments and options into one dictionary
465
680
cmdargs = _match_argform(self.name(), self.takes_args, args)
473
688
self._setup_outf()
475
690
return self.run(**all_cmd_args)
692
def _setup_run(self):
693
"""Wrap the defined run method on self with a cleanup.
695
This is called by __init__ to make the Command be able to be run
696
by just calling run(), as it could be before cleanups were added.
698
If a different form of cleanups are in use by your Command subclass,
699
you can override this method.
702
def run(*args, **kwargs):
703
self._operation = cleanup.OperationWithCleanups(class_run)
705
return self._operation.run_simple(*args, **kwargs)
710
@deprecated_method(deprecated_in((2, 2, 0)))
711
def run_direct(self, *args, **kwargs):
712
"""Deprecated thunk from bzrlib 2.1."""
713
return self.run(*args, **kwargs)
478
716
"""Actually run the command.
761
class CommandHooks(Hooks):
762
"""Hooks related to Command object creation/enumeration."""
765
"""Create the default hooks.
767
These are all empty initially, because by default nothing should get
771
self.create_hook(HookPoint('extend_command',
772
"Called after creating a command object to allow modifications "
773
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13), None))
775
self.create_hook(HookPoint('get_command',
776
"Called when creating a single command. Called with "
777
"(cmd_or_None, command_name). get_command should either return "
778
"the cmd_or_None parameter, or a replacement Command object that "
779
"should be used for the command. Note that the Command.hooks "
780
"hooks are core infrastructure. Many users will prefer to use "
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.create_hook(HookPoint('get_missing_command',
784
"Called when creating a single command if no command could be "
785
"found. Called with (command_name). get_missing_command should "
786
"either return None, or a Command object to be used for the "
787
"command.", (1, 17), None))
788
self.create_hook(HookPoint('list_commands',
789
"Called when enumerating commands. Called with a set of "
790
"cmd_name strings for all the commands found so far. This set "
791
" is safe to mutate - e.g. to remove a command. "
792
"list_commands should return the updated set of command names.",
795
Command.hooks = CommandHooks()
512
798
def parse_args(command, argv, alias_argv=None):
513
799
"""Parse command line.
515
801
Arguments and options are parsed at this level before being passed
516
802
down to specific command handlers. This routine knows, from a
517
803
lookup table, something about the available options, what optargs
566
852
% (cmd, argname.upper()))
568
854
argdict[argname] = args.pop(0)
571
857
raise errors.BzrCommandError("extra argument to command %s: %s"
572
858
% (cmd, args[0]))
862
def apply_coveraged(dirname, the_callable, *args, **kwargs):
863
# Cannot use "import trace", as that would import bzrlib.trace instead of
864
# the standard library's trace.
865
trace = __import__('trace')
867
tracer = trace.Trace(count=1, trace=0)
868
sys.settrace(tracer.globaltrace)
869
threading.settrace(tracer.globaltrace)
872
return exception_to_return_code(the_callable, *args, **kwargs)
875
results = tracer.results()
876
results.write_results(show_missing=1, summary=False,
578
880
def apply_profiled(the_callable, *args, **kwargs):
598
901
os.remove(pfname)
904
def exception_to_return_code(the_callable, *args, **kwargs):
905
"""UI level helper for profiling and coverage.
907
This transforms exceptions into a return value of 3. As such its only
908
relevant to the UI layer, and should never be called where catching
909
exceptions may be desirable.
912
return the_callable(*args, **kwargs)
913
except (KeyboardInterrupt, Exception), e:
914
# used to handle AssertionError and KeyboardInterrupt
915
# specially here, but hopefully they're handled ok by the logger now
916
exc_info = sys.exc_info()
917
exitcode = trace.report_exception(exc_info, sys.stderr)
918
if os.environ.get('BZR_PDB'):
919
print '**** entering debugger'
922
if sys.version_info[:2] < (2, 6):
924
# pdb.post_mortem(tb)
925
# but because pdb.post_mortem gives bad results for tracebacks
926
# from inside generators, we do it manually.
927
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
929
# Setup pdb on the traceback
932
p.setup(tb.tb_frame, tb)
933
# Point the debugger at the deepest frame of the stack
934
p.curindex = len(p.stack) - 1
935
p.curframe = p.stack[p.curindex][0]
936
# Start the pdb prompt.
937
p.print_stack_entry(p.stack[p.curindex])
601
945
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
602
946
from bzrlib.lsprof import profile
603
ret, stats = profile(the_callable, *args, **kwargs)
947
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
605
949
if filename is None:
625
974
config = bzrlib.config.GlobalConfig()
626
975
alias = config.get_alias(cmd)
629
return [a.decode('utf-8') for a in shlex.split(alias.encode('utf-8'))]
977
return cmdline.split(alias)
981
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
634
982
"""Execute a command.
636
This is similar to main(), but without all the trappings for
637
logging and error handling.
640
The command-line arguments, without the program name from argv[0]
641
These should already be decoded. All library/test code calling
642
run_bzr should be passing valid strings (don't need decoding).
644
Returns a command status or raises an exception.
984
:param argv: The command-line arguments, without the program name from
985
argv[0] These should already be decoded. All library/test code calling
986
run_bzr should be passing valid strings (don't need decoding).
987
:param load_plugins: What function to call when triggering plugin loading.
988
This function should take no arguments and cause all plugins to be
990
:param disable_plugins: What function to call when disabling plugin
991
loading. This function should take no arguments and cause all plugin
992
loading to be prohibited (so that code paths in your application that
993
know about some plugins possibly being present will fail to import
994
those plugins even if they are installed.)
995
:return: Returns a command exit code or raises an exception.
646
997
Special master options: these must come before the command because
647
998
they control how the command is interpreted.
691
1049
opt_no_aliases = True
692
1050
elif a == '--builtin':
693
1051
opt_builtin = True
694
elif a in ('--quiet', '-q'):
1052
elif a == '--concurrency':
1053
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1055
elif a == '--coverage':
1056
opt_coverage_dir = argv[i + 1]
1058
elif a == '--profile-imports':
1059
pass # already handled in startup script Bug #588277
696
1060
elif a.startswith('-D'):
697
1061
debug.debug_flags.add(a[2:])
699
1063
argv_copy.append(a)
1066
debug.set_debug_flags_from_config()
1068
if not opt_no_plugins:
702
1073
argv = argv_copy
704
from bzrlib.builtins import cmd_help
705
cmd_help().run_argv_aliases([])
1075
get_cmd_object('help').run_argv_aliases([])
708
1078
if argv[0] == '--version':
709
from bzrlib.version import show_version
1079
get_cmd_object('version').run_argv_aliases([])
713
if not opt_no_plugins:
714
from bzrlib.plugin import load_plugins
717
from bzrlib.plugin import disable_plugins
720
1082
alias_argv = None
722
1084
if not opt_no_aliases:
723
1085
alias_argv = get_alias(argv[0])
725
alias_argv = [a.decode(bzrlib.user_encoding) for a in alias_argv]
726
1087
argv[0] = alias_argv.pop(0)
728
1089
cmd = argv.pop(0)
729
# We want only 'ascii' command names, but the user may have typed
730
# in a Unicode name. In that case, they should just get a
731
# 'command not found' error later.
733
1090
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
734
1091
run = cmd_obj.run_argv_aliases
735
1092
run_argv = [argv, alias_argv]
1095
# We can be called recursively (tests for example), but we don't want
1096
# the verbosity level to propagate.
1097
saved_verbosity_level = option._verbosity_level
1098
option._verbosity_level = 0
1100
if opt_coverage_dir:
1102
'--coverage ignored, because --lsprof is in use.')
739
1103
ret = apply_lsprofiled(opt_lsprof_file, run, *run_argv)
740
1104
elif opt_profile:
1105
if opt_coverage_dir:
1107
'--coverage ignored, because --profile is in use.')
741
1108
ret = apply_profiled(run, *run_argv)
1109
elif opt_coverage_dir:
1110
ret = apply_coveraged(opt_coverage_dir, run, *run_argv)
743
1112
ret = run(*run_argv)
746
# reset, in case we may do other commands later within the same process
747
trace.be_quiet(False)
1115
# reset, in case we may do other commands later within the same
1116
# process. Commands that want to execute sub-commands must propagate
1117
# --verbose in their own way.
1118
if 'memory' in debug.debug_flags:
1119
trace.debug_memory('Process status after command:', short=False)
1120
option._verbosity_level = saved_verbosity_level
749
1123
def display_command(func):
750
1124
"""Decorator that suppresses pipe/interrupt errors."""
766
1140
return ignore_pipe
771
from bzrlib.ui.text import TextUIFactory
772
bzrlib.ui.ui_factory = TextUIFactory()
774
argv = [a.decode(bzrlib.user_encoding) for a in argv[1:]]
775
except UnicodeDecodeError:
776
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1143
def install_bzr_command_hooks():
1144
"""Install the hooks to supply bzr's own commands."""
1145
if _list_bzr_commands in Command.hooks["list_commands"]:
1147
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1149
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1151
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1152
"bzr plugin commands")
1153
Command.hooks.install_named_hook("get_command", _get_external_command,
1154
"bzr external command lookup")
1155
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1156
"bzr plugin-provider-db check")
1160
def _specified_or_unicode_argv(argv):
1161
# For internal or testing use, argv can be passed. Otherwise, get it from
1162
# the process arguments in a unicode-safe way.
1164
return osutils.get_unicode_argv()
1168
# ensure all arguments are unicode strings
1170
if isinstance(a, unicode):
1173
new_argv.append(a.decode('ascii'))
1174
except UnicodeDecodeError:
1175
raise errors.BzrError("argv should be list of unicode strings.")
1179
def main(argv=None):
1180
"""Main entry point of command-line interface.
1182
Typically `bzrlib.initialize` should be called first.
1184
:param argv: list of unicode command-line arguments similar to sys.argv.
1185
argv[0] is script name usually, it will be ignored.
1186
Don't pass here sys.argv because this list contains plain strings
1187
and not unicode; pass None instead.
1189
:return: exit code of bzr command.
1191
argv = _specified_or_unicode_argv(argv)
1192
_register_builtin_commands()
778
1193
ret = run_bzr_catch_errors(argv)
1194
bzrlib.ui.ui_factory.log_transport_activity(
1195
display=('bytes' in debug.debug_flags))
779
1196
trace.mutter("return code %d", ret)
783
1200
def run_bzr_catch_errors(argv):
1201
"""Run a bzr command with parameters as described by argv.
1203
This function assumed that that UI layer is setup, that symbol deprecations
1204
are already applied, and that unicode decoding has already been performed on argv.
1206
# done here so that they're covered for every test run
1207
install_bzr_command_hooks()
1208
return exception_to_return_code(run_bzr, argv)
1211
def run_bzr_catch_user_errors(argv):
1212
"""Run bzr and report user errors, but let internal errors propagate.
1214
This is used for the test suite, and might be useful for other programs
1215
that want to wrap the commandline interface.
1217
# done here so that they're covered for every test run
1218
install_bzr_command_hooks()
785
1220
return run_bzr(argv)
786
except (KeyboardInterrupt, Exception), e:
787
# used to handle AssertionError and KeyboardInterrupt
788
# specially here, but hopefully they're handled ok by the logger now
789
trace.report_exception(sys.exc_info(), sys.stderr)
790
if os.environ.get('BZR_PDB'):
791
print '**** entering debugger'
793
pdb.post_mortem(sys.exc_traceback)
1221
except Exception, e:
1222
if (isinstance(e, (OSError, IOError))
1223
or not getattr(e, 'internal_error', True)):
1224
trace.report_exception(sys.exc_info(), sys.stderr)
797
1230
class HelpCommandIndex(object):
810
1243
if topic and topic.startswith(self.prefix):
811
1244
topic = topic[len(self.prefix):]
813
cmd = _get_cmd_object(topic)
1246
cmd = _get_cmd_object(topic, check_missing=False)
814
1247
except KeyError:
820
if __name__ == '__main__':
821
sys.exit(main(sys.argv))
1253
class Provider(object):
1254
'''Generic class to be overriden by plugins'''
1256
def plugin_for_command(self, cmd_name):
1257
'''Takes a command and returns the information for that plugin
1259
:return: A dictionary with all the available information
1260
for the requested plugin
1262
raise NotImplementedError
1265
class ProvidersRegistry(registry.Registry):
1266
'''This registry exists to allow other providers to exist'''
1269
for key, provider in self.iteritems():
1272
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
