26
23
# TODO: Specific "examples" property on commands for consistent formatting.
28
# TODO: "--profile=cum", to change sort order. Is there any value in leaving
29
# the profile output behind so it can be interactively examined?
34
28
from bzrlib.lazy_import import lazy_import
35
29
lazy_import(globals(), """
39
from warnings import warn
42
34
from bzrlib import (
52
from bzrlib.hooks import HookPoint, Hooks
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
53
49
# Compatibility - Option used to be in commands.
54
50
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
55
52
from bzrlib import registry
56
53
from bzrlib.symbol_versioning import (
57
54
deprecated_function,
59
suppress_deprecation_warnings,
96
109
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
99
117
info = CommandInfo.from_command(cmd)
101
119
registry.Registry.register(self, k_unsquished, cmd,
102
120
override_existing=decorate, info=info)
104
trace.log_error('Two plugins defined the same command: %r' % k)
105
trace.log_error('Not loading the one in %r' %
106
sys.modules[cmd.__module__])
107
trace.log_error('Previously this command was registered from %r' %
108
sys.modules[previous.__module__])
122
trace.warning('Two plugins defined the same command: %r' % k)
123
trace.warning('Not loading the one in %r' %
124
sys.modules[cmd.__module__])
125
trace.warning('Previously this command was registered from %r' %
126
sys.modules[previous.__module__])
127
for a in cmd.aliases:
128
self._alias_dict[a] = k_unsquished
111
131
def register_lazy(self, command_name, aliases, module_name):
328
349
summary, then a complete description of the command. A grammar
329
350
description will be inserted.
332
Other accepted names for this command.
335
List of argument forms, marked with whether they are optional,
340
['to_location', 'from_branch?', 'file*']
342
'to_location' is required
343
'from_branch' is optional
344
'file' can be specified 0 or more times
347
List of options that may be given for this command. These can
348
be either strings, referring to globally-defined options,
349
or option objects. Retrieve through options().
352
If true, this command isn't advertised. This is typically
352
:cvar aliases: Other accepted names for this command.
354
:cvar takes_args: List of argument forms, marked with whether they are
355
optional, repeated, etc. Examples::
357
['to_location', 'from_branch?', 'file*']
359
* 'to_location' is required
360
* 'from_branch' is optional
361
* 'file' can be specified 0 or more times
363
:cvar takes_options: List of options that may be given for this command.
364
These can be either strings, referring to globally-defined options, or
365
option objects. Retrieve through options().
367
:cvar hidden: If true, this command isn't advertised. This is typically
353
368
for commands intended for expert users.
356
Command objects will get a 'outf' attribute, which has been
357
setup to properly handle encoding of unicode strings.
358
encoding_type determines what will happen when characters cannot
360
strict - abort if we cannot decode
361
replace - put in a bogus character (typically '?')
362
exact - do not encode sys.stdout
364
NOTE: by default on Windows, sys.stdout is opened as a text
365
stream, therefore LF line-endings are converted to CRLF.
366
When a command uses encoding_type = 'exact', then
367
sys.stdout is forced to be a binary stream, and line-endings
370
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
371
been setup to properly handle encoding of unicode strings.
372
encoding_type determines what will happen when characters cannot be
375
* strict - abort if we cannot decode
376
* replace - put in a bogus character (typically '?')
377
* exact - do not encode sys.stdout
379
NOTE: by default on Windows, sys.stdout is opened as a text stream,
380
therefore LF line-endings are converted to CRLF. When a command uses
381
encoding_type = 'exact', then sys.stdout is forced to be a binary
382
stream, and line-endings will not mangled.
385
A string indicating the real name under which this command was
386
invoked, before expansion of aliases.
387
(This may be None if the command was constructed and run in-process.)
370
389
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'bzr help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
374
400
takes_options = []
375
401
encoding_type = 'strict'
379
407
def __init__(self):
380
408
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
383
409
# List of standard options directly supported
384
410
self.supported_std_options = []
386
def _maybe_expand_globs(self, file_list):
387
"""Glob expand file_list if the platform does not do that itself.
389
:return: A possibly empty list of unicode paths.
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
413
def add_cleanup(self, cleanup_func, *args, **kwargs):
414
"""Register a function to call after self.run returns or raises.
416
Functions will be called in LIFO order.
418
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
420
def cleanup_now(self):
421
"""Execute and empty pending cleanup functions immediately.
423
After cleanup_now all registered cleanups are forgotten. add_cleanup
424
may be called again after cleanup_now; these cleanups will be called
425
after self.run returns or raises (or when cleanup_now is next called).
427
This is useful for releasing expensive or contentious resources (such
428
as write locks) before doing further work that does not require those
429
resources (such as writing results to self.outf). Note though, that
430
as it releases all resources, this may release locks that the command
431
wants to hold, so use should be done with care.
433
self._operation.cleanup_now()
399
435
def _usage(self):
400
436
"""Return single-line grammar for this command.
445
490
# The header is the purpose and usage
447
result += ':Purpose: %s\n' % purpose
492
result += gettext(':Purpose: %s\n') % (purpose,)
448
493
if usage.find('\n') >= 0:
449
result += ':Usage:\n%s\n' % usage
494
result += gettext(':Usage:\n%s\n') % (usage,)
451
result += ':Usage: %s\n' % usage
496
result += gettext(':Usage: %s\n') % (usage,)
454
499
# Add the options
455
options = option.get_optparser(self.options()).format_option_help()
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
504
parser = option.get_optparser(self.options())
505
options = parser.format_option_help()
506
# FIXME: According to the spec, ReST option lists actually don't
507
# support options like --1.14 so that causes syntax errors (in Sphinx
508
# at least). As that pattern always appears in the commands that
509
# break, we trap on that and then format that block of 'format' options
510
# as a literal block. We use the most recent format still listed so we
511
# don't have to do that too often -- vila 20110514
512
if not plain and options.find(' --1.14 ') != -1:
513
options = options.replace(' format:\n', ' format::\n\n', 1)
456
514
if options.startswith('Options:'):
457
result += ':' + options
458
elif options.startswith('options:'):
459
# Python 2.4 version of optparse
460
result += ':Options:' + options[len('options:'):]
515
result += gettext(':Options:%s') % (options[len('options:'):],)
462
517
result += options
468
523
if sections.has_key(None):
469
524
text = sections.pop(None)
470
525
text = '\n '.join(text.splitlines())
471
result += ':%s:\n %s\n\n' % ('Description',text)
526
result += gettext(':Description:\n %s\n\n') % (text,)
473
528
# Add the custom sections (e.g. Examples). Note that there's no need
474
529
# to indent these as they must be indented already in the source.
476
531
for label in order:
477
if sections.has_key(label):
478
result += ':%s:\n%s\n' % (label,sections[label])
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
481
result += ("See bzr help %s for more details and examples.\n\n"
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
484
539
# Add the aliases, source (plug-in) and see also links, if any
486
result += ':Aliases: '
541
result += gettext(':Aliases: ')
487
542
result += ', '.join(self.aliases) + '\n'
488
543
plugin_name = self.plugin_name()
489
544
if plugin_name is not None:
490
result += ':From: plugin "%s"\n' % plugin_name
545
result += gettext(':From: plugin "%s"\n') % plugin_name
491
546
see_also = self.get_see_also(additional_see_also)
493
548
if not plain and see_also_as_links:
584
640
def _setup_outf(self):
585
641
"""Return a file linked to stdout, which has proper encoding."""
586
# Originally I was using self.stdout, but that looks
587
# *way* too much like sys.stdout
588
if self.encoding_type == 'exact':
589
# force sys.stdout to be binary stream on win32
590
if sys.platform == 'win32':
591
fileno = getattr(sys.stdout, 'fileno', None)
594
msvcrt.setmode(fileno(), os.O_BINARY)
595
self.outf = sys.stdout
598
output_encoding = osutils.get_terminal_encoding()
600
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
601
errors=self.encoding_type)
602
# For whatever reason codecs.getwriter() does not advertise its encoding
603
# it just returns the encoding of the wrapped file, which is completely
604
# bogus. So set the attribute, so we can find the correct encoding later.
605
self.outf.encoding = output_encoding
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
607
645
def run_argv_aliases(self, argv, alias_argv=None):
608
646
"""Parse the command line and run with extra aliases in alias_argv."""
610
warn("Passing None for [] is deprecated from bzrlib 0.10",
611
DeprecationWarning, stacklevel=2)
613
647
args, opts = parse_args(self, argv, alias_argv)
615
650
# Process the standard options
616
651
if 'help' in opts: # e.g. bzr add --help
617
sys.stdout.write(self.get_help_text())
652
self.outf.write(self.get_help_text())
619
654
if 'usage' in opts: # e.g. bzr add --usage
620
sys.stdout.write(self.get_help_text(verbose=False))
655
self.outf.write(self.get_help_text(verbose=False))
622
657
trace.set_verbosity_level(option._verbosity_level)
623
658
if 'verbose' in self.supported_std_options:
638
672
all_cmd_args = cmdargs.copy()
639
673
all_cmd_args.update(cmdopts)
643
return self.run(**all_cmd_args)
676
return self.run(**all_cmd_args)
678
# reset it, so that other commands run in the same process won't
679
# inherit state. Before we reset it, log any activity, so that it
680
# gets properly tracked.
681
ui.ui_factory.log_transport_activity(
682
display=('bytes' in debug.debug_flags))
683
trace.set_verbosity_level(0)
685
def _setup_run(self):
686
"""Wrap the defined run method on self with a cleanup.
688
This is called by __init__ to make the Command be able to be run
689
by just calling run(), as it could be before cleanups were added.
691
If a different form of cleanups are in use by your Command subclass,
692
you can override this method.
695
def run(*args, **kwargs):
696
self._operation = cleanup.OperationWithCleanups(class_run)
698
return self._operation.run_simple(*args, **kwargs)
646
704
"""Actually run the command.
686
767
These are all empty initially, because by default nothing should get
690
self.create_hook(HookPoint('extend_command',
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
691
772
"Called after creating a command object to allow modifications "
692
773
"such as adding or removing options, docs etc. Called with the "
693
"new bzrlib.commands.Command object.", (1, 13), None))
694
self.create_hook(HookPoint('get_command',
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
695
776
"Called when creating a single command. Called with "
696
777
"(cmd_or_None, command_name). get_command should either return "
697
778
"the cmd_or_None parameter, or a replacement Command object that "
698
779
"should be used for the command. Note that the Command.hooks "
699
780
"hooks are core infrastructure. Many users will prefer to use "
700
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
702
self.create_hook(HookPoint('get_missing_command',
783
self.add_hook('get_missing_command',
703
784
"Called when creating a single command if no command could be "
704
785
"found. Called with (command_name). get_missing_command should "
705
786
"either return None, or a Command object to be used for the "
706
"command.", (1, 17), None))
707
self.create_hook(HookPoint('list_commands',
788
self.add_hook('list_commands',
708
789
"Called when enumerating commands. Called with a set of "
709
790
"cmd_name strings for all the commands found so far. This set "
710
791
" is safe to mutate - e.g. to remove a command. "
711
792
"list_commands should return the updated set of command names.",
714
795
Command.hooks = CommandHooks()
752
840
argdict[argname + '_list'] = None
753
841
elif ap[-1] == '+':
755
raise errors.BzrCommandError("command %r needs one or more %s"
756
% (cmd, argname.upper()))
843
raise errors.BzrCommandError(gettext(
844
"command {0!r} needs one or more {1}").format(
845
cmd, argname.upper()))
758
847
argdict[argname + '_list'] = args[:]
760
849
elif ap[-1] == '$': # all but one
761
850
if len(args) < 2:
762
raise errors.BzrCommandError("command %r needs one or more %s"
763
% (cmd, argname.upper()))
851
raise errors.BzrCommandError(
852
gettext("command {0!r} needs one or more {1}").format(
853
cmd, argname.upper()))
764
854
argdict[argname + '_list'] = args[:-1]
767
857
# just a plain arg
770
raise errors.BzrCommandError("command %r requires argument %s"
771
% (cmd, argname.upper()))
860
raise errors.BzrCommandError(
861
gettext("command {0!r} requires argument {1}").format(
862
cmd, argname.upper()))
773
864
argdict[argname] = args.pop(0)
776
raise errors.BzrCommandError("extra argument to command %s: %s"
867
raise errors.BzrCommandError( gettext(
868
"extra argument to command {0}: {1}").format(
864
956
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
865
957
from bzrlib.lsprof import profile
866
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
958
ret, stats = profile(exception_to_return_code, the_callable,
868
961
if filename is None:
871
964
stats.save(filename)
872
trace.note('Profile data written to "%s".', filename)
965
trace.note(gettext('Profile data written to "%s".'), filename)
876
def shlex_split_unicode(unsplit):
878
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
881
969
def get_alias(cmd, config=None):
882
970
"""Return an expanded alias, or None if no alias exists.
893
981
config = bzrlib.config.GlobalConfig()
894
982
alias = config.get_alias(cmd)
896
return shlex_split_unicode(alias)
984
return cmdline.split(alias)
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
901
989
"""Execute a command.
904
The command-line arguments, without the program name from argv[0]
905
These should already be decoded. All library/test code calling
906
run_bzr should be passing valid strings (don't need decoding).
908
Returns a command status or raises an exception.
991
:param argv: The command-line arguments, without the program name from
992
argv[0] These should already be decoded. All library/test code calling
993
run_bzr should be passing valid strings (don't need decoding).
994
:param load_plugins: What function to call when triggering plugin loading.
995
This function should take no arguments and cause all plugins to be
997
:param disable_plugins: What function to call when disabling plugin
998
loading. This function should take no arguments and cause all plugin
999
loading to be prohibited (so that code paths in your application that
1000
know about some plugins possibly being present will fail to import
1001
those plugins even if they are installed.)
1002
:return: Returns a command exit code or raises an exception.
910
1004
Special master options: these must come before the command because
911
1005
they control how the command is interpreted.
956
1055
opt_no_plugins = True
957
1056
elif a == '--no-aliases':
958
1057
opt_no_aliases = True
1058
elif a == '--no-l10n':
959
1060
elif a == '--builtin':
960
1061
opt_builtin = True
1062
elif a == '--concurrency':
1063
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
961
1065
elif a == '--coverage':
962
1066
opt_coverage_dir = argv[i + 1]
1068
elif a == '--profile-imports':
1069
pass # already handled in startup script Bug #588277
964
1070
elif a.startswith('-D'):
965
1071
debug.debug_flags.add(a[2:])
1072
elif a.startswith('-O'):
1073
override_config.append(a[2:])
967
1075
argv_copy.append(a)
1078
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
970
1080
debug.set_debug_flags_from_config()
1082
if not opt_no_plugins:
972
1087
argv = argv_copy
974
from bzrlib.builtins import cmd_help
975
cmd_help().run_argv_aliases([])
1089
get_cmd_object('help').run_argv_aliases([])
978
1092
if argv[0] == '--version':
979
from bzrlib.builtins import cmd_version
980
cmd_version().run_argv_aliases([])
1093
get_cmd_object('version').run_argv_aliases([])
983
if not opt_no_plugins:
984
from bzrlib.plugin import load_plugins
987
from bzrlib.plugin import disable_plugins
990
1096
alias_argv = None
992
1098
if not opt_no_aliases:
993
1099
alias_argv = get_alias(argv[0])
995
user_encoding = osutils.get_user_encoding()
996
alias_argv = [a.decode(user_encoding) for a in alias_argv]
997
1101
argv[0] = alias_argv.pop(0)
999
1103
cmd = argv.pop(0)
1000
# We want only 'ascii' command names, but the user may have typed
1001
# in a Unicode name. In that case, they should just get a
1002
# 'command not found' error later.
1004
1104
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1005
1107
run = cmd_obj.run_argv_aliases
1006
1108
run_argv = [argv, alias_argv]
1066
1170
"bzr plugin commands")
1067
1171
Command.hooks.install_named_hook("get_command", _get_external_command,
1068
1172
"bzr external command lookup")
1069
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1070
"bzr plugin-provider-db check")
1073
def main(argv=None):
1074
"""Main entry point of command-line interface.
1076
:param argv: list of unicode command-line arguments similar to sys.argv.
1077
argv[0] is script name usually, it will be ignored.
1078
Don't pass here sys.argv because this list contains plain strings
1079
and not unicode; pass None instead.
1081
:return: exit code of bzr command.
1084
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1085
sys.stdin, sys.stdout, sys.stderr)
1087
# Is this a final release version? If so, we should suppress warnings
1088
if bzrlib.version_info[3] == 'final':
1089
suppress_deprecation_warnings(override=False)
1173
Command.hooks.install_named_hook("get_missing_command",
1174
_try_plugin_provider,
1175
"bzr plugin-provider-db check")
1179
def _specified_or_unicode_argv(argv):
1180
# For internal or testing use, argv can be passed. Otherwise, get it from
1181
# the process arguments in a unicode-safe way.
1090
1182
if argv is None:
1091
argv = osutils.get_unicode_argv()
1183
return osutils.get_unicode_argv()
1095
1187
# ensure all arguments are unicode strings
1097
1189
if isinstance(a, unicode):
1098
1190
new_argv.append(a)
1100
1192
new_argv.append(a.decode('ascii'))
1101
1193
except UnicodeDecodeError:
1102
1194
raise errors.BzrError("argv should be list of unicode strings.")
1198
def main(argv=None):
1199
"""Main entry point of command-line interface.
1201
Typically `bzrlib.initialize` should be called first.
1203
:param argv: list of unicode command-line arguments similar to sys.argv.
1204
argv[0] is script name usually, it will be ignored.
1205
Don't pass here sys.argv because this list contains plain strings
1206
and not unicode; pass None instead.
1208
:return: exit code of bzr command.
1210
if argv is not None:
1212
_register_builtin_commands()
1104
1213
ret = run_bzr_catch_errors(argv)
1105
1214
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
