142
133
def _builtin_commands():
143
134
import bzrlib.builtins
144
return _scan_module_for_commands(bzrlib.builtins)
147
def _scan_module_for_commands(module):
149
for name, obj in module.__dict__.iteritems():
136
builtins = bzrlib.builtins.__dict__
137
for name in builtins:
150
138
if name.startswith("cmd_"):
151
139
real_name = _unsquish_command_name(name)
140
r[real_name] = builtins[name]
156
def _list_bzr_commands(names):
157
"""Find commands from bzr's core and plugins."""
158
# to eliminate duplicates
159
names.update(builtin_command_names())
160
names.update(plugin_command_names())
164
def all_command_names():
165
"""Return a set of all command names."""
167
for hook in Command.hooks['list_commands']:
170
raise AssertionError(
171
'hook %s returned None' % Command.hooks.get_hook_name(hook))
175
144
def builtin_command_names():
176
"""Return list of builtin command names.
178
Use of all_command_names() is encouraged rather than builtin_command_names
179
and/or plugin_command_names.
145
"""Return list of builtin command names."""
181
146
return _builtin_commands().keys()
184
149
def plugin_command_names():
185
"""Returns command names from commands registered by plugins."""
186
150
return plugin_cmds.keys()
153
def _get_cmd_dict(plugins_override=True):
154
"""Return name->class mapping for all commands."""
155
d = _builtin_commands()
157
d.update(plugin_cmds.iteritems())
161
def get_all_cmds(plugins_override=True):
162
"""Return canonical name and class for all registered commands."""
163
for k, v in _get_cmd_dict(plugins_override=plugins_override).iteritems():
189
167
def get_cmd_object(cmd_name, plugins_override=True):
190
"""Return the command object for a command.
168
"""Return the canonical name and command class for a command.
193
171
If true, plugin commands can override builtins.
196
return _get_cmd_object(cmd_name, plugins_override)
174
cmd = _get_cmd_object(cmd_name, plugins_override)
175
# Allow plugins to extend commands
176
for hook in Command.hooks['extend_command']:
198
180
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
201
183
def _get_cmd_object(cmd_name, plugins_override=True):
202
"""Get a command object.
184
"""Worker for get_cmd_object which raises KeyError rather than BzrCommandError."""
185
from bzrlib.externalcommand import ExternalCommand
204
:param cmd_name: The name of the command.
205
:param plugins_override: Allow plugins to override builtins.
206
:return: A Command object instance
207
:raises KeyError: If no command is found.
209
187
# We want only 'ascii' command names, but the user may have typed
210
188
# in a Unicode name. In that case, they should just get a
211
189
# 'command not found' error later.
212
190
# In the future, we may actually support Unicode command names.
215
for hook in Command.hooks['get_command']:
216
cmd = hook(cmd, cmd_name)
217
if cmd is not None and not plugins_override and not cmd.plugin_name():
218
# We've found a non-plugin command, don't permit it to be
222
for hook in Command.hooks['get_missing_command']:
229
# Allow plugins to extend commands
230
for hook in Command.hooks['extend_command']:
235
def _try_plugin_provider(cmd_name):
236
"""Probe for a plugin provider having cmd_name."""
238
plugin_metadata, provider = probe_for_provider(cmd_name)
239
raise errors.CommandAvailableInPlugin(cmd_name,
240
plugin_metadata, provider)
241
except errors.NoPluginAvailable:
245
def probe_for_provider(cmd_name):
246
"""Look for a provider for cmd_name.
248
:param cmd_name: The command name.
249
:return: plugin_metadata, provider for getting cmd_name.
250
:raises NoPluginAvailable: When no provider can supply the plugin.
252
# look for providers that provide this command but aren't installed
253
for provider in command_providers_registry:
192
# first look up this command under the specified name
255
return provider.plugin_for_command(cmd_name), provider
256
except errors.NoPluginAvailable:
195
return plugin_cmds.get(cmd_name)()
258
raise errors.NoPluginAvailable(cmd_name)
261
def _get_bzr_command(cmd_or_None, cmd_name):
262
"""Get a command from bzr's core."""
263
cmds = _builtin_commands()
198
cmds = _get_cmd_dict(plugins_override=False)
265
200
return cmds[cmd_name]()
204
for key in plugin_cmds.keys():
205
info = plugin_cmds.get_info(key)
206
if cmd_name in info.aliases:
207
return plugin_cmds.get(key)()
268
208
# look for any command which claims this as an alias
269
209
for real_cmd_name, cmd_class in cmds.iteritems():
270
210
if cmd_name in cmd_class.aliases:
271
211
return cmd_class()
275
def _get_external_command(cmd_or_None, cmd_name):
276
"""Lookup a command that is a shell script."""
277
# Only do external command lookups when no command is found so far.
278
if cmd_or_None is not None:
280
from bzrlib.externalcommand import ExternalCommand
281
213
cmd_obj = ExternalCommand.find_command(cmd_name)
286
def _get_plugin_command(cmd_or_None, cmd_name):
287
"""Get a command from bzr's plugins."""
289
return plugin_cmds.get(cmd_name)()
292
for key in plugin_cmds.keys():
293
info = plugin_cmds.get_info(key)
294
if cmd_name in info.aliases:
295
return plugin_cmds.get(key)()
217
# look for plugins that provide this command but aren't installed
218
for provider in command_providers_registry:
220
plugin_metadata = provider.plugin_for_command(cmd_name)
221
except errors.NoPluginAvailable:
224
raise errors.CommandAvailableInPlugin(cmd_name,
225
plugin_metadata, provider)
299
229
class Command(object):
368
298
warn("No help message set for %r" % self)
369
299
# List of standard options directly supported
370
300
self.supported_std_options = []
371
self._operation = cleanup.OperationWithCleanups(self.run)
373
def add_cleanup(self, cleanup_func, *args, **kwargs):
374
"""Register a function to call after self.run returns or raises.
376
Functions will be called in LIFO order.
378
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
380
def cleanup_now(self):
381
"""Execute and empty pending cleanup functions immediately.
383
After cleanup_now all registered cleanups are forgotten. add_cleanup
384
may be called again after cleanup_now; these cleanups will be called
385
after self.run returns or raises (or when cleanup_now is next called).
387
This is useful for releasing expensive or contentious resources (such
388
as write locks) before doing further work that does not require those
389
resources (such as writing results to self.outf).
391
self._operation.cleanup_now()
393
@deprecated_method(deprecated_in((2, 1, 0)))
394
302
def _maybe_expand_globs(self, file_list):
395
303
"""Glob expand file_list if the platform does not do that itself.
397
Not used anymore, now that the bzr command-line parser globs on
400
305
:return: A possibly empty list of unicode paths.
402
307
Introduced in bzrlib 0.18.
311
if sys.platform == 'win32':
312
file_list = win32utils.glob_expand(file_list)
313
return list(file_list)
406
315
def _usage(self):
407
316
"""Return single-line grammar for this command.
480
374
result += options
484
# Add the description, indenting it 2 spaces
485
# to match the indentation of the options
486
if sections.has_key(None):
487
text = sections.pop(None)
488
text = '\n '.join(text.splitlines())
489
result += ':%s:\n %s\n\n' % ('Description',text)
377
# Add the description, indenting it 2 spaces
378
# to match the indentation of the options
379
if sections.has_key(None):
380
text = sections.pop(None)
381
text = '\n '.join(text.splitlines())
382
result += ':%s:\n %s\n\n' % ('Description',text)
491
# Add the custom sections (e.g. Examples). Note that there's no need
492
# to indent these as they must be indented already in the source.
495
if sections.has_key(label):
496
result += ':%s:\n%s\n' % (label,sections[label])
499
result += ("See bzr help %s for more details and examples.\n\n"
384
# Add the custom sections (e.g. Examples). Note that there's no need
385
# to indent these as they must be indented already in the source.
388
if sections.has_key(label):
389
result += ':%s:\n%s\n\n' % (label,sections[label])
502
391
# Add the aliases, source (plug-in) and see also links, if any
603
491
def _setup_outf(self):
604
492
"""Return a file linked to stdout, which has proper encoding."""
605
self.outf = ui.ui_factory.make_output_stream(
606
encoding_type=self.encoding_type)
493
# Originally I was using self.stdout, but that looks
494
# *way* too much like sys.stdout
495
if self.encoding_type == 'exact':
496
# force sys.stdout to be binary stream on win32
497
if sys.platform == 'win32':
498
fileno = getattr(sys.stdout, 'fileno', None)
501
msvcrt.setmode(fileno(), os.O_BINARY)
502
self.outf = sys.stdout
505
output_encoding = osutils.get_terminal_encoding()
507
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
508
errors=self.encoding_type)
509
# For whatever reason codecs.getwriter() does not advertise its encoding
510
# it just returns the encoding of the wrapped file, which is completely
511
# bogus. So set the attribute, so we can find the correct encoding later.
512
self.outf.encoding = output_encoding
608
514
def run_argv_aliases(self, argv, alias_argv=None):
609
515
"""Parse the command line and run with extra aliases in alias_argv."""
517
warn("Passing None for [] is deprecated from bzrlib 0.10",
518
DeprecationWarning, stacklevel=2)
610
520
args, opts = parse_args(self, argv, alias_argv)
612
522
# Process the standard options
613
523
if 'help' in opts: # e.g. bzr add --help
614
524
sys.stdout.write(self.get_help_text())
616
if 'usage' in opts: # e.g. bzr add --usage
617
sys.stdout.write(self.get_help_text(verbose=False))
619
526
trace.set_verbosity_level(option._verbosity_level)
620
527
if 'verbose' in self.supported_std_options:
621
528
opts['verbose'] = trace.is_verbose()
690
593
Hooks.__init__(self)
691
self.create_hook(HookPoint('extend_command',
692
"Called after creating a command object to allow modifications "
693
"such as adding or removing options, docs etc. Called with the "
694
"new bzrlib.commands.Command object.", (1, 13), None))
695
self.create_hook(HookPoint('get_command',
696
"Called when creating a single command. Called with "
697
"(cmd_or_None, command_name). get_command should either return "
698
"the cmd_or_None parameter, or a replacement Command object that "
699
"should be used for the command. Note that the Command.hooks "
700
"hooks are core infrastructure. Many users will prefer to use "
701
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
703
self.create_hook(HookPoint('get_missing_command',
704
"Called when creating a single command if no command could be "
705
"found. Called with (command_name). get_missing_command should "
706
"either return None, or a Command object to be used for the "
707
"command.", (1, 17), None))
708
self.create_hook(HookPoint('list_commands',
709
"Called when enumerating commands. Called with a set of "
710
"cmd_name strings for all the commands found so far. This set "
711
" is safe to mutate - e.g. to remove a command. "
712
"list_commands should return the updated set of command names.",
594
# Introduced in 1.13:
595
# invoked after creating a command object to allow modifications such
596
# as adding or removing options, docs etc. Invoked with the command
598
self['extend_command'] = []
715
600
Command.hooks = CommandHooks()
821
703
os.remove(pfname)
824
def exception_to_return_code(the_callable, *args, **kwargs):
825
"""UI level helper for profiling and coverage.
827
This transforms exceptions into a return value of 3. As such its only
828
relevant to the UI layer, and should never be called where catching
829
exceptions may be desirable.
832
return the_callable(*args, **kwargs)
833
except (KeyboardInterrupt, Exception), e:
834
# used to handle AssertionError and KeyboardInterrupt
835
# specially here, but hopefully they're handled ok by the logger now
836
exc_info = sys.exc_info()
837
exitcode = trace.report_exception(exc_info, sys.stderr)
838
if os.environ.get('BZR_PDB'):
839
print '**** entering debugger'
842
if sys.version_info[:2] < (2, 6):
844
# pdb.post_mortem(tb)
845
# but because pdb.post_mortem gives bad results for tracebacks
846
# from inside generators, we do it manually.
847
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
849
# Setup pdb on the traceback
852
p.setup(tb.tb_frame, tb)
853
# Point the debugger at the deepest frame of the stack
854
p.curindex = len(p.stack) - 1
855
p.curframe = p.stack[p.curindex][0]
856
# Start the pdb prompt.
857
p.print_stack_entry(p.stack[p.curindex])
865
706
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
866
707
from bzrlib.lsprof import profile
867
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
708
ret, stats = profile(the_callable, *args, **kwargs)
869
710
if filename is None:
1062
896
return ignore_pipe
1065
def install_bzr_command_hooks():
1066
"""Install the hooks to supply bzr's own commands."""
1067
if _list_bzr_commands in Command.hooks["list_commands"]:
1069
Command.hooks.install_named_hook("list_commands", _list_bzr_commands,
1071
Command.hooks.install_named_hook("get_command", _get_bzr_command,
1073
Command.hooks.install_named_hook("get_command", _get_plugin_command,
1074
"bzr plugin commands")
1075
Command.hooks.install_named_hook("get_command", _get_external_command,
1076
"bzr external command lookup")
1077
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1078
"bzr plugin-provider-db check")
1081
def main(argv=None):
1082
"""Main entry point of command-line interface.
1084
:param argv: list of unicode command-line arguments similar to sys.argv.
1085
argv[0] is script name usually, it will be ignored.
1086
Don't pass here sys.argv because this list contains plain strings
1087
and not unicode; pass None instead.
1089
:return: exit code of bzr command.
1091
900
import bzrlib.ui
1092
901
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1093
902
sys.stdin, sys.stdout, sys.stderr)
1095
904
# Is this a final release version? If so, we should suppress warnings
1096
905
if bzrlib.version_info[3] == 'final':
1097
suppress_deprecation_warnings(override=True)
1099
argv = osutils.get_unicode_argv()
1103
# ensure all arguments are unicode strings
1105
if isinstance(a, unicode):
1108
new_argv.append(a.decode('ascii'))
1109
except UnicodeDecodeError:
1110
raise errors.BzrError("argv should be list of unicode strings.")
906
from bzrlib import symbol_versioning
907
symbol_versioning.suppress_deprecation_warnings(override=False)
909
user_encoding = osutils.get_user_encoding()
910
argv = [a.decode(user_encoding) for a in argv[1:]]
911
except UnicodeDecodeError:
912
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
1112
914
ret = run_bzr_catch_errors(argv)
1113
bzrlib.ui.ui_factory.log_transport_activity(
1114
display=('bytes' in debug.debug_flags))
1115
915
trace.mutter("return code %d", ret)
1116
osutils.report_extension_load_failures()
1120
919
def run_bzr_catch_errors(argv):
1121
"""Run a bzr command with parameters as described by argv.
920
# Note: The except clause logic below should be kept in sync with the
921
# profile() routine in lsprof.py.
924
except (KeyboardInterrupt, Exception), e:
925
# used to handle AssertionError and KeyboardInterrupt
926
# specially here, but hopefully they're handled ok by the logger now
927
exc_info = sys.exc_info()
928
exitcode = trace.report_exception(exc_info, sys.stderr)
929
if os.environ.get('BZR_PDB'):
930
print '**** entering debugger'
933
if sys.version_info[:2] < (2, 6):
935
# pdb.post_mortem(tb)
936
# but because pdb.post_mortem gives bad results for tracebacks
937
# from inside generators, we do it manually.
938
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
1123
This function assumed that that UI layer is setup, that symbol deprecations
1124
are already applied, and that unicode decoding has already been performed on argv.
1126
install_bzr_command_hooks()
1127
return exception_to_return_code(run_bzr, argv)
940
# Setup pdb on the traceback
943
p.setup(tb.tb_frame, tb)
944
# Point the debugger at the deepest frame of the stack
945
p.curindex = len(p.stack) - 1
946
p.curframe = p.stack[p.curindex]
947
# Start the pdb prompt.
948
p.print_stack_entry(p.stack[p.curindex])
1130
956
def run_bzr_catch_user_errors(argv):
added
removed
bzrlib/commands.py
