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.
456
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
457
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
options = option.get_optparser(self.options()).format_option_help()
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)
460
514
if options.startswith('Options:'):
461
result += ':' + options
462
elif options.startswith('options:'):
463
# Python 2.4 version of optparse
464
result += ':Options:' + options[len('options:'):]
515
result += gettext(':Options:%s') % (options[len('options:'):],)
466
517
result += options
472
523
if sections.has_key(None):
473
524
text = sections.pop(None)
474
525
text = '\n '.join(text.splitlines())
475
result += ':%s:\n %s\n\n' % ('Description',text)
526
result += gettext(':Description:\n %s\n\n') % (text,)
477
528
# Add the custom sections (e.g. Examples). Note that there's no need
478
529
# to indent these as they must be indented already in the source.
480
531
for label in order:
481
if sections.has_key(label):
482
result += ':%s:\n%s\n' % (label,sections[label])
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
485
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")
488
539
# Add the aliases, source (plug-in) and see also links, if any
490
result += ':Aliases: '
541
result += gettext(':Aliases: ')
491
542
result += ', '.join(self.aliases) + '\n'
492
543
plugin_name = self.plugin_name()
493
544
if plugin_name is not None:
494
result += ':From: plugin "%s"\n' % plugin_name
545
result += gettext(':From: plugin "%s"\n') % plugin_name
495
546
see_also = self.get_see_also(additional_see_also)
497
548
if not plain and see_also_as_links:
588
640
def _setup_outf(self):
589
641
"""Return a file linked to stdout, which has proper encoding."""
590
# Originally I was using self.stdout, but that looks
591
# *way* too much like sys.stdout
592
if self.encoding_type == 'exact':
593
# force sys.stdout to be binary stream on win32
594
if sys.platform == 'win32':
595
fileno = getattr(sys.stdout, 'fileno', None)
598
msvcrt.setmode(fileno(), os.O_BINARY)
599
self.outf = sys.stdout
602
output_encoding = osutils.get_terminal_encoding()
604
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
605
errors=self.encoding_type)
606
# For whatever reason codecs.getwriter() does not advertise its encoding
607
# it just returns the encoding of the wrapped file, which is completely
608
# bogus. So set the attribute, so we can find the correct encoding later.
609
self.outf.encoding = output_encoding
642
self.outf = ui.ui_factory.make_output_stream(
643
encoding_type=self.encoding_type)
611
645
def run_argv_aliases(self, argv, alias_argv=None):
612
646
"""Parse the command line and run with extra aliases in alias_argv."""
614
warn("Passing None for [] is deprecated from bzrlib 0.10",
615
DeprecationWarning, stacklevel=2)
617
647
args, opts = parse_args(self, argv, alias_argv)
619
650
# Process the standard options
620
651
if 'help' in opts: # e.g. bzr add --help
621
sys.stdout.write(self.get_help_text())
652
self.outf.write(self.get_help_text())
623
654
if 'usage' in opts: # e.g. bzr add --usage
624
sys.stdout.write(self.get_help_text(verbose=False))
655
self.outf.write(self.get_help_text(verbose=False))
626
657
trace.set_verbosity_level(option._verbosity_level)
627
658
if 'verbose' in self.supported_std_options:
642
672
all_cmd_args = cmdargs.copy()
643
673
all_cmd_args.update(cmdopts)
647
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)
650
704
"""Actually run the command.
690
767
These are all empty initially, because by default nothing should get
694
self.create_hook(HookPoint('extend_command',
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
695
772
"Called after creating a command object to allow modifications "
696
773
"such as adding or removing options, docs etc. Called with the "
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
699
776
"Called when creating a single command. Called with "
700
777
"(cmd_or_None, command_name). get_command should either return "
701
778
"the cmd_or_None parameter, or a replacement Command object that "
702
779
"should be used for the command. Note that the Command.hooks "
703
780
"hooks are core infrastructure. Many users will prefer to use "
704
781
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
706
self.create_hook(HookPoint('get_missing_command',
783
self.add_hook('get_missing_command',
707
784
"Called when creating a single command if no command could be "
708
785
"found. Called with (command_name). get_missing_command should "
709
786
"either return None, or a Command object to be used for the "
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
788
self.add_hook('list_commands',
712
789
"Called when enumerating commands. Called with a set of "
713
790
"cmd_name strings for all the commands found so far. This set "
714
791
" is safe to mutate - e.g. to remove a command. "
715
792
"list_commands should return the updated set of command names.",
718
795
Command.hooks = CommandHooks()
756
840
argdict[argname + '_list'] = None
757
841
elif ap[-1] == '+':
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
843
raise errors.BzrCommandError(gettext(
844
"command {0!r} needs one or more {1}").format(
845
cmd, argname.upper()))
762
847
argdict[argname + '_list'] = args[:]
764
849
elif ap[-1] == '$': # all but one
765
850
if len(args) < 2:
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
851
raise errors.BzrCommandError(
852
gettext("command {0!r} needs one or more {1}").format(
853
cmd, argname.upper()))
768
854
argdict[argname + '_list'] = args[:-1]
771
857
# just a plain arg
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
860
raise errors.BzrCommandError(
861
gettext("command {0!r} requires argument {1}").format(
862
cmd, argname.upper()))
777
864
argdict[argname] = args.pop(0)
780
raise errors.BzrCommandError("extra argument to command %s: %s"
867
raise errors.BzrCommandError( gettext(
868
"extra argument to command {0}: {1}").format(
868
956
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
869
957
from bzrlib.lsprof import profile
870
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
958
ret, stats = profile(exception_to_return_code, the_callable,
872
961
if filename is None:
875
964
stats.save(filename)
876
trace.note('Profile data written to "%s".', filename)
965
trace.note(gettext('Profile data written to "%s".'), filename)
880
def shlex_split_unicode(unsplit):
882
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
885
969
def get_alias(cmd, config=None):
886
970
"""Return an expanded alias, or None if no alias exists.
897
981
config = bzrlib.config.GlobalConfig()
898
982
alias = config.get_alias(cmd)
900
return shlex_split_unicode(alias)
984
return cmdline.split(alias)
988
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
905
989
"""Execute a command.
908
The command-line arguments, without the program name from argv[0]
909
These should already be decoded. All library/test code calling
910
run_bzr should be passing valid strings (don't need decoding).
912
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.
914
1004
Special master options: these must come before the command because
915
1005
they control how the command is interpreted.
960
1055
opt_no_plugins = True
961
1056
elif a == '--no-aliases':
962
1057
opt_no_aliases = True
1058
elif a == '--no-l10n':
963
1060
elif a == '--builtin':
964
1061
opt_builtin = True
1062
elif a == '--concurrency':
1063
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
965
1065
elif a == '--coverage':
966
1066
opt_coverage_dir = argv[i + 1]
1068
elif a == '--profile-imports':
1069
pass # already handled in startup script Bug #588277
968
1070
elif a.startswith('-D'):
969
1071
debug.debug_flags.add(a[2:])
1072
elif a.startswith('-O'):
1073
override_config.append(a[2:])
971
1075
argv_copy.append(a)
1078
bzrlib.global_state.cmdline_overrides._from_cmdline(override_config)
974
1080
debug.set_debug_flags_from_config()
1082
if not opt_no_plugins:
976
1087
argv = argv_copy
978
from bzrlib.builtins import cmd_help
979
cmd_help().run_argv_aliases([])
1089
get_cmd_object('help').run_argv_aliases([])
982
1092
if argv[0] == '--version':
983
from bzrlib.builtins import cmd_version
984
cmd_version().run_argv_aliases([])
1093
get_cmd_object('version').run_argv_aliases([])
987
if not opt_no_plugins:
988
from bzrlib.plugin import load_plugins
991
from bzrlib.plugin import disable_plugins
994
1096
alias_argv = None
996
1098
if not opt_no_aliases:
997
1099
alias_argv = get_alias(argv[0])
999
user_encoding = osutils.get_user_encoding()
1000
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1001
1101
argv[0] = alias_argv.pop(0)
1003
1103
cmd = argv.pop(0)
1004
# We want only 'ascii' command names, but the user may have typed
1005
# in a Unicode name. In that case, they should just get a
1006
# 'command not found' error later.
1008
1104
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1009
1107
run = cmd_obj.run_argv_aliases
1010
1108
run_argv = [argv, alias_argv]
1070
1170
"bzr plugin commands")
1071
1171
Command.hooks.install_named_hook("get_command", _get_external_command,
1072
1172
"bzr external command lookup")
1073
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1074
"bzr plugin-provider-db check")
1077
def main(argv=None):
1078
"""Main entry point of command-line interface.
1080
:param argv: list of unicode command-line arguments similar to sys.argv.
1081
argv[0] is script name usually, it will be ignored.
1082
Don't pass here sys.argv because this list contains plain strings
1083
and not unicode; pass None instead.
1085
:return: exit code of bzr command.
1088
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1089
sys.stdin, sys.stdout, sys.stderr)
1091
# Is this a final release version? If so, we should suppress warnings
1092
if bzrlib.version_info[3] == 'final':
1093
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.
1094
1182
if argv is None:
1095
argv = osutils.get_unicode_argv()
1183
return osutils.get_unicode_argv()
1099
1187
# ensure all arguments are unicode strings
1101
1189
if isinstance(a, unicode):
1102
1190
new_argv.append(a)
1104
1192
new_argv.append(a.decode('ascii'))
1105
1193
except UnicodeDecodeError:
1106
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()
1108
1213
ret = run_bzr_catch_errors(argv)
1109
1214
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
