26
24
# 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
29
from bzrlib.lazy_import import lazy_import
35
30
lazy_import(globals(), """
39
from warnings import warn
42
35
from bzrlib import (
52
from bzrlib.hooks import HookPoint, Hooks
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
53
51
# Compatibility - Option used to be in commands.
54
52
from bzrlib.option import Option
53
from bzrlib.plugin import disable_plugins, load_plugins
55
54
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
59
suppress_deprecation_warnings,
63
57
class CommandInfo(object):
96
106
previous = self.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
109
if self.overridden_registry:
111
previous = self.overridden_registry.get(k_unsquished)
99
114
info = CommandInfo.from_command(cmd)
101
116
registry.Registry.register(self, k_unsquished, cmd,
102
117
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__])
119
trace.warning('Two plugins defined the same command: %r' % k)
120
trace.warning('Not loading the one in %r' %
121
sys.modules[cmd.__module__])
122
trace.warning('Previously this command was registered from %r' %
123
sys.modules[previous.__module__])
124
for a in cmd.aliases:
125
self._alias_dict[a] = k_unsquished
111
128
def register_lazy(self, command_name, aliases, module_name):
328
346
summary, then a complete description of the command. A grammar
329
347
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
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
353
365
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
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.)
370
386
: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"
374
397
takes_options = []
375
398
encoding_type = 'strict'
379
404
def __init__(self):
380
405
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
383
406
# List of standard options directly supported
384
407
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)
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()
399
432
def _usage(self):
400
433
"""Return single-line grammar for this command.
456
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
457
499
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
459
options = option.get_optparser(self.options()).format_option_help()
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:
510
options = options.replace(' format:\n', ' format::\n\n', 1)
460
511
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:'):]
512
result += gettext(':Options:%s') % (options[len('options:'):],)
466
514
result += options
472
520
if sections.has_key(None):
473
521
text = sections.pop(None)
474
522
text = '\n '.join(text.splitlines())
475
result += ':%s:\n %s\n\n' % ('Description',text)
523
result += gettext(':Description:\n %s\n\n') % (text,)
477
525
# Add the custom sections (e.g. Examples). Note that there's no need
478
526
# to indent these as they must be indented already in the source.
480
528
for label in order:
481
if sections.has_key(label):
482
result += ':%s:\n%s\n' % (label,sections[label])
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
485
result += ("See bzr help %s for more details and examples.\n\n"
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
488
536
# Add the aliases, source (plug-in) and see also links, if any
490
result += ':Aliases: '
538
result += gettext(':Aliases: ')
491
539
result += ', '.join(self.aliases) + '\n'
492
540
plugin_name = self.plugin_name()
493
541
if plugin_name is not None:
494
result += ':From: plugin "%s"\n' % plugin_name
542
result += gettext(':From: plugin "%s"\n') % plugin_name
495
543
see_also = self.get_see_also(additional_see_also)
497
545
if not plain and see_also_as_links:
588
637
def _setup_outf(self):
589
638
"""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
639
self.outf = ui.ui_factory.make_output_stream(
640
encoding_type=self.encoding_type)
611
642
def run_argv_aliases(self, argv, alias_argv=None):
612
643
"""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
644
args, opts = parse_args(self, argv, alias_argv)
619
647
# Process the standard options
620
648
if 'help' in opts: # e.g. bzr add --help
621
sys.stdout.write(self.get_help_text())
649
self.outf.write(self.get_help_text())
623
651
if 'usage' in opts: # e.g. bzr add --usage
624
sys.stdout.write(self.get_help_text(verbose=False))
652
self.outf.write(self.get_help_text(verbose=False))
626
654
trace.set_verbosity_level(option._verbosity_level)
627
655
if 'verbose' in self.supported_std_options:
642
669
all_cmd_args = cmdargs.copy()
643
670
all_cmd_args.update(cmdopts)
647
return self.run(**all_cmd_args)
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']:
650
705
"""Actually run the command.
690
768
These are all empty initially, because by default nothing should get
694
self.create_hook(HookPoint('extend_command',
771
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
772
self.add_hook('extend_command',
695
773
"Called after creating a command object to allow modifications "
696
774
"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',
775
"new bzrlib.commands.Command object.", (1, 13))
776
self.add_hook('get_command',
699
777
"Called when creating a single command. Called with "
700
778
"(cmd_or_None, command_name). get_command should either return "
701
779
"the cmd_or_None parameter, or a replacement Command object that "
702
780
"should be used for the command. Note that the Command.hooks "
703
781
"hooks are core infrastructure. Many users will prefer to use "
704
782
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
706
self.create_hook(HookPoint('get_missing_command',
784
self.add_hook('get_missing_command',
707
785
"Called when creating a single command if no command could be "
708
786
"found. Called with (command_name). get_missing_command should "
709
787
"either return None, or a Command object to be used for the "
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
789
self.add_hook('list_commands',
712
790
"Called when enumerating commands. Called with a set of "
713
791
"cmd_name strings for all the commands found so far. This set "
714
792
" is safe to mutate - e.g. to remove a command. "
715
793
"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 "
718
802
Command.hooks = CommandHooks()
756
847
argdict[argname + '_list'] = None
757
848
elif ap[-1] == '+':
759
raise errors.BzrCommandError("command %r needs one or more %s"
760
% (cmd, argname.upper()))
850
raise errors.BzrCommandError(gettext(
851
"command {0!r} needs one or more {1}").format(
852
cmd, argname.upper()))
762
854
argdict[argname + '_list'] = args[:]
764
856
elif ap[-1] == '$': # all but one
765
857
if len(args) < 2:
766
raise errors.BzrCommandError("command %r needs one or more %s"
767
% (cmd, argname.upper()))
858
raise errors.BzrCommandError(
859
gettext("command {0!r} needs one or more {1}").format(
860
cmd, argname.upper()))
768
861
argdict[argname + '_list'] = args[:-1]
771
864
# just a plain arg
774
raise errors.BzrCommandError("command %r requires argument %s"
775
% (cmd, argname.upper()))
867
raise errors.BzrCommandError(
868
gettext("command {0!r} requires argument {1}").format(
869
cmd, argname.upper()))
777
871
argdict[argname] = args.pop(0)
780
raise errors.BzrCommandError("extra argument to command %s: %s"
874
raise errors.BzrCommandError( gettext(
875
"extra argument to command {0}: {1}").format(
840
935
exitcode = trace.report_exception(exc_info, sys.stderr)
841
936
if os.environ.get('BZR_PDB'):
842
937
print '**** entering debugger'
845
if sys.version_info[:2] < (2, 6):
847
# pdb.post_mortem(tb)
848
# but because pdb.post_mortem gives bad results for tracebacks
849
# from inside generators, we do it manually.
850
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
852
# Setup pdb on the traceback
855
p.setup(tb.tb_frame, tb)
856
# Point the debugger at the deepest frame of the stack
857
p.curindex = len(p.stack) - 1
858
p.curframe = p.stack[p.curindex][0]
859
# Start the pdb prompt.
860
p.print_stack_entry(p.stack[p.curindex])
939
pdb.post_mortem(exc_info[2])
868
943
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
869
944
from bzrlib.lsprof import profile
870
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
945
ret, stats = profile(exception_to_return_code, the_callable,
872
948
if filename is None:
875
951
stats.save(filename)
876
trace.note('Profile data written to "%s".', filename)
952
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
956
def get_alias(cmd, config=None):
886
957
"""Return an expanded alias, or None if no alias exists.
897
968
config = bzrlib.config.GlobalConfig()
898
969
alias = config.get_alias(cmd)
900
return shlex_split_unicode(alias)
971
return cmdline.split(alias)
975
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
905
976
"""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.
978
:param argv: The command-line arguments, without the program name from
979
argv[0] These should already be decoded. All library/test code calling
980
run_bzr should be passing valid strings (don't need decoding).
981
:param load_plugins: What function to call when triggering plugin loading.
982
This function should take no arguments and cause all plugins to be
984
:param disable_plugins: What function to call when disabling plugin
985
loading. This function should take no arguments and cause all plugin
986
loading to be prohibited (so that code paths in your application that
987
know about some plugins possibly being present will fail to import
988
those plugins even if they are installed.)
989
:return: Returns a command exit code or raises an exception.
914
991
Special master options: these must come before the command because
915
992
they control how the command is interpreted.
960
1042
opt_no_plugins = True
961
1043
elif a == '--no-aliases':
962
1044
opt_no_aliases = True
1045
elif a == '--no-l10n':
963
1047
elif a == '--builtin':
964
1048
opt_builtin = True
1049
elif a == '--concurrency':
1050
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
965
1052
elif a == '--coverage':
966
1053
opt_coverage_dir = argv[i + 1]
1055
elif a == '--profile-imports':
1056
pass # already handled in startup script Bug #588277
968
1057
elif a.startswith('-D'):
969
1058
debug.debug_flags.add(a[2:])
1059
elif a.startswith('-O'):
1060
override_config.append(a[2:])
971
1062
argv_copy.append(a)
1065
if bzrlib.global_state is None:
1066
# FIXME: Workaround for users that imported bzrlib but didn't call
1067
# bzrlib.initialize -- vila 2012-01-19
1068
cmdline_overrides = config.CommandLineStore()
1070
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1071
cmdline_overrides._from_cmdline(override_config)
974
1073
debug.set_debug_flags_from_config()
1075
if not opt_no_plugins:
976
1080
argv = argv_copy
978
from bzrlib.builtins import cmd_help
979
cmd_help().run_argv_aliases([])
1082
get_cmd_object('help').run_argv_aliases([])
982
1085
if argv[0] == '--version':
983
from bzrlib.builtins import cmd_version
984
cmd_version().run_argv_aliases([])
1086
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
1089
alias_argv = None
996
1091
if not opt_no_aliases:
997
1092
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
1094
argv[0] = alias_argv.pop(0)
1003
1096
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
1097
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1009
1100
run = cmd_obj.run_argv_aliases
1010
1101
run_argv = [argv, alias_argv]
1070
1163
"bzr plugin commands")
1071
1164
Command.hooks.install_named_hook("get_command", _get_external_command,
1072
1165
"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)
1166
Command.hooks.install_named_hook("get_missing_command",
1167
_try_plugin_provider,
1168
"bzr plugin-provider-db check")
1172
def _specified_or_unicode_argv(argv):
1173
# For internal or testing use, argv can be passed. Otherwise, get it from
1174
# the process arguments in a unicode-safe way.
1094
1175
if argv is None:
1095
argv = osutils.get_unicode_argv()
1176
return osutils.get_unicode_argv()
1099
1180
# ensure all arguments are unicode strings
1101
1182
if isinstance(a, unicode):
1102
1183
new_argv.append(a)
1104
1185
new_argv.append(a.decode('ascii'))
1105
1186
except UnicodeDecodeError:
1106
1187
raise errors.BzrError("argv should be list of unicode strings.")
1191
def main(argv=None):
1192
"""Main entry point of command-line interface.
1194
Typically `bzrlib.initialize` should be called first.
1196
:param argv: list of unicode command-line arguments similar to sys.argv.
1197
argv[0] is script name usually, it will be ignored.
1198
Don't pass here sys.argv because this list contains plain strings
1199
and not unicode; pass None instead.
1201
:return: exit code of bzr command.
1203
if argv is not None:
1205
_register_builtin_commands()
1108
1206
ret = run_bzr_catch_errors(argv)
1109
1207
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
