24
26
# 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?
29
34
from bzrlib.lazy_import import lazy_import
30
35
lazy_import(globals(), """
39
from warnings import warn
35
42
from bzrlib import (
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
52
from bzrlib.hooks import HookPoint, Hooks
51
53
# Compatibility - Option used to be in commands.
52
54
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
54
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
60
suppress_deprecation_warnings,
57
64
class CommandInfo(object):
346
329
summary, then a complete description of the command. A grammar
347
330
description will be inserted.
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
333
Other accepted names for this command.
336
List of argument forms, marked with whether they are optional,
341
['to_location', 'from_branch?', 'file*']
343
'to_location' is required
344
'from_branch' is optional
345
'file' can be specified 0 or more times
348
List of options that may be given for this command. These can
349
be either strings, referring to globally-defined options,
350
or option objects. Retrieve through options().
353
If true, this command isn't advertised. This is typically
365
354
for commands intended for expert users.
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
357
Command objects will get a 'outf' attribute, which has been
358
setup to properly handle encoding of unicode strings.
359
encoding_type determines what will happen when characters cannot
361
strict - abort if we cannot decode
362
replace - put in a bogus character (typically '?')
363
exact - do not encode sys.stdout
365
NOTE: by default on Windows, sys.stdout is opened as a text
366
stream, therefore LF line-endings are converted to CRLF.
367
When a command uses encoding_type = 'exact', then
368
sys.stdout is forced to be a binary stream, and line-endings
386
371
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
397
375
takes_options = []
398
376
encoding_type = 'strict'
404
380
def __init__(self):
405
381
"""Construct an instance of this command."""
382
if self.__doc__ == Command.__doc__:
383
warn("No help message set for %r" % self)
406
384
# List of standard options directly supported
407
385
self.supported_std_options = []
410
def add_cleanup(self, cleanup_func, *args, **kwargs):
411
"""Register a function to call after self.run returns or raises.
413
Functions will be called in LIFO order.
415
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
417
def cleanup_now(self):
418
"""Execute and empty pending cleanup functions immediately.
420
After cleanup_now all registered cleanups are forgotten. add_cleanup
421
may be called again after cleanup_now; these cleanups will be called
422
after self.run returns or raises (or when cleanup_now is next called).
424
This is useful for releasing expensive or contentious resources (such
425
as write locks) before doing further work that does not require those
426
resources (such as writing results to self.outf). Note though, that
427
as it releases all resources, this may release locks that the command
428
wants to hold, so use should be done with care.
430
self._operation.cleanup_now()
387
@deprecated_method(deprecated_in((2, 1, 0)))
388
def _maybe_expand_globs(self, file_list):
389
"""Glob expand file_list if the platform does not do that itself.
391
Not used anymore, now that the bzr command-line parser globs on
394
:return: A possibly empty list of unicode paths.
396
Introduced in bzrlib 0.18.
432
400
def _usage(self):
433
401
"""Return single-line grammar for this command.
498
457
# XXX: optparse implicitly rewraps the help, and not always perfectly,
499
458
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
460
options = option.get_optparser(self.options()).format_option_help()
461
# XXX: According to the spec, ReST option lists actually don't support
462
# options like --1.9 so that causes syntax errors (in Sphinx at least).
463
# As that pattern always appears in the commands that break, we trap
464
# on that and then format that block of 'format' options as a literal
466
if not plain and options.find(' --1.9 ') != -1:
510
467
options = options.replace(' format:\n', ' format::\n\n', 1)
511
468
if options.startswith('Options:'):
512
result += gettext(':Options:%s') % (options[len('options:'):],)
469
result += ':' + options
470
elif options.startswith('options:'):
471
# Python 2.4 version of optparse
472
result += ':Options:' + options[len('options:'):]
514
474
result += options
520
480
if sections.has_key(None):
521
481
text = sections.pop(None)
522
482
text = '\n '.join(text.splitlines())
523
result += gettext(':Description:\n %s\n\n') % (text,)
483
result += ':%s:\n %s\n\n' % ('Description',text)
525
485
# Add the custom sections (e.g. Examples). Note that there's no need
526
486
# to indent these as they must be indented already in the source.
528
488
for label in order:
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
489
if sections.has_key(label):
490
result += ':%s:\n%s\n' % (label,sections[label])
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
493
result += ("See bzr help %s for more details and examples.\n\n"
536
496
# Add the aliases, source (plug-in) and see also links, if any
538
result += gettext(':Aliases: ')
498
result += ':Aliases: '
539
499
result += ', '.join(self.aliases) + '\n'
540
500
plugin_name = self.plugin_name()
541
501
if plugin_name is not None:
542
result += gettext(':From: plugin "%s"\n') % plugin_name
502
result += ':From: plugin "%s"\n' % plugin_name
543
503
see_also = self.get_see_also(additional_see_also)
545
505
if not plain and see_also_as_links:
637
596
def _setup_outf(self):
638
597
"""Return a file linked to stdout, which has proper encoding."""
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
598
# Originally I was using self.stdout, but that looks
599
# *way* too much like sys.stdout
600
if self.encoding_type == 'exact':
601
# force sys.stdout to be binary stream on win32
602
if sys.platform == 'win32':
603
fileno = getattr(sys.stdout, 'fileno', None)
606
msvcrt.setmode(fileno(), os.O_BINARY)
607
self.outf = sys.stdout
610
output_encoding = osutils.get_terminal_encoding()
612
self.outf = codecs.getwriter(output_encoding)(sys.stdout,
613
errors=self.encoding_type)
614
# For whatever reason codecs.getwriter() does not advertise its encoding
615
# it just returns the encoding of the wrapped file, which is completely
616
# bogus. So set the attribute, so we can find the correct encoding later.
617
self.outf.encoding = output_encoding
642
619
def run_argv_aliases(self, argv, alias_argv=None):
643
620
"""Parse the command line and run with extra aliases in alias_argv."""
622
warn("Passing None for [] is deprecated from bzrlib 0.10",
623
DeprecationWarning, stacklevel=2)
644
625
args, opts = parse_args(self, argv, alias_argv)
647
627
# Process the standard options
648
628
if 'help' in opts: # e.g. bzr add --help
649
self.outf.write(self.get_help_text())
629
sys.stdout.write(self.get_help_text())
651
631
if 'usage' in opts: # e.g. bzr add --usage
652
self.outf.write(self.get_help_text(verbose=False))
632
sys.stdout.write(self.get_help_text(verbose=False))
654
634
trace.set_verbosity_level(option._verbosity_level)
655
635
if 'verbose' in self.supported_std_options:
669
650
all_cmd_args = cmdargs.copy()
670
651
all_cmd_args.update(cmdopts)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
682
def _setup_run(self):
683
"""Wrap the defined run method on self with a cleanup.
685
This is called by __init__ to make the Command be able to be run
686
by just calling run(), as it could be before cleanups were added.
688
If a different form of cleanups are in use by your Command subclass,
689
you can override this method.
692
def run(*args, **kwargs):
693
for hook in Command.hooks['pre_command']:
695
self._operation = cleanup.OperationWithCleanups(class_run)
697
return self._operation.run_simple(*args, **kwargs)
700
for hook in Command.hooks['post_command']:
655
return self.run(**all_cmd_args)
705
658
"""Actually run the command.
768
698
These are all empty initially, because by default nothing should get
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
702
self.create_hook(HookPoint('extend_command',
773
703
"Called after creating a command object to allow modifications "
774
704
"such as adding or removing options, docs etc. Called with the "
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
705
"new bzrlib.commands.Command object.", (1, 13), None))
706
self.create_hook(HookPoint('get_command',
777
707
"Called when creating a single command. Called with "
778
708
"(cmd_or_None, command_name). get_command should either return "
779
709
"the cmd_or_None parameter, or a replacement Command object that "
780
710
"should be used for the command. Note that the Command.hooks "
781
711
"hooks are core infrastructure. Many users will prefer to use "
782
712
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
784
self.add_hook('get_missing_command',
714
self.create_hook(HookPoint('get_missing_command',
785
715
"Called when creating a single command if no command could be "
786
716
"found. Called with (command_name). get_missing_command should "
787
717
"either return None, or a Command object to be used for the "
789
self.add_hook('list_commands',
718
"command.", (1, 17), None))
719
self.create_hook(HookPoint('list_commands',
790
720
"Called when enumerating commands. Called with a set of "
791
721
"cmd_name strings for all the commands found so far. This set "
792
722
" is safe to mutate - e.g. to remove a command. "
793
723
"list_commands should return the updated set of command names.",
795
self.add_hook('pre_command',
796
"Called prior to executing a command. Called with the command "
798
self.add_hook('post_command',
799
"Called after executing a command. Called with the command "
802
726
Command.hooks = CommandHooks()
847
764
argdict[argname + '_list'] = None
848
765
elif ap[-1] == '+':
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
767
raise errors.BzrCommandError("command %r needs one or more %s"
768
% (cmd, argname.upper()))
854
770
argdict[argname + '_list'] = args[:]
856
772
elif ap[-1] == '$': # all but one
857
773
if len(args) < 2:
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
774
raise errors.BzrCommandError("command %r needs one or more %s"
775
% (cmd, argname.upper()))
861
776
argdict[argname + '_list'] = args[:-1]
864
779
# just a plain arg
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
782
raise errors.BzrCommandError("command %r requires argument %s"
783
% (cmd, argname.upper()))
871
785
argdict[argname] = args.pop(0)
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
788
raise errors.BzrCommandError("extra argument to command %s: %s"
963
876
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
964
877
from bzrlib.lsprof import profile
965
ret, stats = profile(exception_to_return_code, the_callable,
878
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
968
880
if filename is None:
971
883
stats.save(filename)
972
trace.note(gettext('Profile data written to "%s".'), filename)
884
trace.note('Profile data written to "%s".', filename)
888
def shlex_split_unicode(unsplit):
890
return [u.decode('utf-8') for u in shlex.split(unsplit.encode('utf-8'))]
976
893
def get_alias(cmd, config=None):
977
894
"""Return an expanded alias, or None if no alias exists.
988
905
config = bzrlib.config.GlobalConfig()
989
906
alias = config.get_alias(cmd)
991
return cmdline.split(alias)
908
return shlex_split_unicode(alias)
995
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
996
913
"""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.
916
The command-line arguments, without the program name from argv[0]
917
These should already be decoded. All library/test code calling
918
run_bzr should be passing valid strings (don't need decoding).
920
Returns a command status or raises an exception.
1011
922
Special master options: these must come before the command because
1012
923
they control how the command is interpreted.
1072
979
elif a == '--coverage':
1073
980
opt_coverage_dir = argv[i + 1]
1075
elif a == '--profile-imports':
1076
pass # already handled in startup script Bug #588277
1077
982
elif a.startswith('-D'):
1078
983
debug.debug_flags.add(a[2:])
1079
elif a.startswith('-O'):
1080
override_config.append(a[2:])
1082
985
argv_copy.append(a)
1085
if bzrlib.global_state is None:
1086
# FIXME: Workaround for users that imported bzrlib but didn't call
1087
# bzrlib.initialize -- vila 2012-01-19
1088
cmdline_overrides = config.CommandLineStore()
1090
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1091
cmdline_overrides._from_cmdline(override_config)
1093
988
debug.set_debug_flags_from_config()
992
from bzrlib.builtins import cmd_help
993
cmd_help().run_argv_aliases([])
996
if argv[0] == '--version':
997
from bzrlib.builtins import cmd_version
998
cmd_version().run_argv_aliases([])
1095
1001
if not opt_no_plugins:
1002
from bzrlib.plugin import load_plugins
1005
from bzrlib.plugin import disable_plugins
1098
1006
disable_plugins()
1102
get_cmd_object('help').run_argv_aliases([])
1105
if argv[0] == '--version':
1106
get_cmd_object('version').run_argv_aliases([])
1109
1008
alias_argv = None
1111
1010
if not opt_no_aliases:
1112
1011
alias_argv = get_alias(argv[0])
1013
user_encoding = osutils.get_user_encoding()
1014
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1114
1015
argv[0] = alias_argv.pop(0)
1116
1017
cmd = argv.pop(0)
1018
# We want only 'ascii' command names, but the user may have typed
1019
# in a Unicode name. In that case, they should just get a
1020
# 'command not found' error later.
1117
1022
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1120
1023
run = cmd_obj.run_argv_aliases
1121
1024
run_argv = [argv, alias_argv]
1183
1084
"bzr plugin commands")
1184
1085
Command.hooks.install_named_hook("get_command", _get_external_command,
1185
1086
"bzr external command lookup")
1186
Command.hooks.install_named_hook("get_missing_command",
1187
_try_plugin_provider,
1188
"bzr plugin-provider-db check")
1192
def _specified_or_unicode_argv(argv):
1193
# For internal or testing use, argv can be passed. Otherwise, get it from
1194
# the process arguments in a unicode-safe way.
1087
Command.hooks.install_named_hook("get_missing_command", _try_plugin_provider,
1088
"bzr plugin-provider-db check")
1091
def main(argv=None):
1092
"""Main entry point of command-line interface.
1094
:param argv: list of unicode command-line arguments similar to sys.argv.
1095
argv[0] is script name usually, it will be ignored.
1096
Don't pass here sys.argv because this list contains plain strings
1097
and not unicode; pass None instead.
1099
:return: exit code of bzr command.
1102
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1103
sys.stdin, sys.stdout, sys.stderr)
1105
# Is this a final release version? If so, we should suppress warnings
1106
if bzrlib.version_info[3] == 'final':
1107
suppress_deprecation_warnings(override=True)
1195
1108
if argv is None:
1196
return osutils.get_unicode_argv()
1109
argv = osutils.get_unicode_argv()
1200
1113
# ensure all arguments are unicode strings
1202
1115
if isinstance(a, unicode):
1203
1116
new_argv.append(a)
1205
1118
new_argv.append(a.decode('ascii'))
1206
1119
except UnicodeDecodeError:
1207
1120
raise errors.BzrError("argv should be list of unicode strings.")
1211
def main(argv=None):
1212
"""Main entry point of command-line interface.
1214
Typically `bzrlib.initialize` should be called first.
1216
:param argv: list of unicode command-line arguments similar to sys.argv.
1217
argv[0] is script name usually, it will be ignored.
1218
Don't pass here sys.argv because this list contains plain strings
1219
and not unicode; pass None instead.
1221
:return: exit code of bzr command.
1223
if argv is not None:
1225
_register_builtin_commands()
1226
1122
ret = run_bzr_catch_errors(argv)
1227
1123
trace.mutter("return code %d", ret)
1124
osutils.report_extension_load_failures()
added
removed
bzrlib/commands.py
