23
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?
28
34
from bzrlib.lazy_import import lazy_import
29
35
lazy_import(globals(), """
39
from warnings import warn
34
42
from bzrlib import (
47
from bzrlib.hooks import Hooks
48
from bzrlib.i18n import gettext
53
from bzrlib.hooks import HookPoint, Hooks
49
54
# Compatibility - Option used to be in commands.
50
55
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
56
from bzrlib import registry
53
57
from bzrlib.symbol_versioning import (
54
58
deprecated_function,
61
suppress_deprecation_warnings,
349
330
summary, then a complete description of the command. A grammar
350
331
description will be inserted.
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
334
Other accepted names for this command.
337
List of argument forms, marked with whether they are optional,
342
['to_location', 'from_branch?', 'file*']
344
'to_location' is required
345
'from_branch' is optional
346
'file' can be specified 0 or more times
349
List of options that may be given for this command. These can
350
be either strings, referring to globally-defined options,
351
or option objects. Retrieve through options().
354
If true, this command isn't advertised. This is typically
368
355
for commands intended for expert users.
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.)
358
Command objects will get a 'outf' attribute, which has been
359
setup to properly handle encoding of unicode strings.
360
encoding_type determines what will happen when characters cannot
362
strict - abort if we cannot decode
363
replace - put in a bogus character (typically '?')
364
exact - do not encode sys.stdout
366
NOTE: by default on Windows, sys.stdout is opened as a text
367
stream, therefore LF line-endings are converted to CRLF.
368
When a command uses encoding_type = 'exact', then
369
sys.stdout is forced to be a binary stream, and line-endings
389
372
: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"
400
376
takes_options = []
401
377
encoding_type = 'strict'
407
381
def __init__(self):
408
382
"""Construct an instance of this command."""
383
if self.__doc__ == Command.__doc__:
384
warn("No help message set for %r" % self)
409
385
# List of standard options directly supported
410
386
self.supported_std_options = []
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()
388
@deprecated_method(deprecated_in((2, 1, 0)))
389
def _maybe_expand_globs(self, file_list):
390
"""Glob expand file_list if the platform does not do that itself.
392
Not used anymore, now that the bzr command-line parser globs on
395
:return: A possibly empty list of unicode paths.
397
Introduced in bzrlib 0.18.
435
401
def _usage(self):
436
402
"""Return single-line grammar for this command.
501
458
# XXX: optparse implicitly rewraps the help, and not always perfectly,
502
459
# 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:
461
options = option.get_optparser(self.options()).format_option_help()
462
# XXX: According to the spec, ReST option lists actually don't support
463
# options like --1.9 so that causes syntax errors (in Sphinx at least).
464
# As that pattern always appears in the commands that break, we trap
465
# on that and then format that block of 'format' options as a literal
467
if not plain and options.find(' --1.9 ') != -1:
513
468
options = options.replace(' format:\n', ' format::\n\n', 1)
514
469
if options.startswith('Options:'):
515
result += gettext(':Options:%s') % (options[len('options:'):],)
470
result += ':' + options
471
elif options.startswith('options:'):
472
# Python 2.4 version of optparse
473
result += ':Options:' + options[len('options:'):]
517
475
result += options
523
481
if sections.has_key(None):
524
482
text = sections.pop(None)
525
483
text = '\n '.join(text.splitlines())
526
result += gettext(':Description:\n %s\n\n') % (text,)
484
result += ':%s:\n %s\n\n' % ('Description',text)
528
486
# Add the custom sections (e.g. Examples). Note that there's no need
529
487
# to indent these as they must be indented already in the source.
531
489
for label in order:
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
490
if sections.has_key(label):
491
result += ':%s:\n%s\n' % (label,sections[label])
536
result += (gettext("See bzr help %s for more details and examples.\n\n")
494
result += ("See bzr help %s for more details and examples.\n\n"
539
497
# Add the aliases, source (plug-in) and see also links, if any
541
result += gettext(':Aliases: ')
499
result += ':Aliases: '
542
500
result += ', '.join(self.aliases) + '\n'
543
501
plugin_name = self.plugin_name()
544
502
if plugin_name is not None:
545
result += gettext(':From: plugin "%s"\n') % plugin_name
503
result += ':From: plugin "%s"\n' % plugin_name
546
504
see_also = self.get_see_also(additional_see_also)
548
506
if not plain and see_also_as_links:
644
602
def run_argv_aliases(self, argv, alias_argv=None):
645
603
"""Parse the command line and run with extra aliases in alias_argv."""
605
warn("Passing None for [] is deprecated from bzrlib 0.10",
606
DeprecationWarning, stacklevel=2)
646
608
args, opts = parse_args(self, argv, alias_argv)
649
610
# Process the standard options
650
611
if 'help' in opts: # e.g. bzr add --help
651
self.outf.write(self.get_help_text())
612
sys.stdout.write(self.get_help_text())
653
614
if 'usage' in opts: # e.g. bzr add --usage
654
self.outf.write(self.get_help_text(verbose=False))
615
sys.stdout.write(self.get_help_text(verbose=False))
656
617
trace.set_verbosity_level(option._verbosity_level)
657
618
if 'verbose' in self.supported_std_options:
672
633
all_cmd_args = cmdargs.copy()
673
634
all_cmd_args.update(cmdopts)
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)
638
return self.run(**all_cmd_args)
704
641
"""Actually run the command.
767
681
These are all empty initially, because by default nothing should get
770
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
771
self.add_hook('extend_command',
685
self.create_hook(HookPoint('extend_command',
772
686
"Called after creating a command object to allow modifications "
773
687
"such as adding or removing options, docs etc. Called with the "
774
"new bzrlib.commands.Command object.", (1, 13))
775
self.add_hook('get_command',
688
"new bzrlib.commands.Command object.", (1, 13), None))
689
self.create_hook(HookPoint('get_command',
776
690
"Called when creating a single command. Called with "
777
691
"(cmd_or_None, command_name). get_command should either return "
778
692
"the cmd_or_None parameter, or a replacement Command object that "
779
693
"should be used for the command. Note that the Command.hooks "
780
694
"hooks are core infrastructure. Many users will prefer to use "
781
695
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
783
self.add_hook('get_missing_command',
697
self.create_hook(HookPoint('get_missing_command',
784
698
"Called when creating a single command if no command could be "
785
699
"found. Called with (command_name). get_missing_command should "
786
700
"either return None, or a Command object to be used for the "
788
self.add_hook('list_commands',
701
"command.", (1, 17), None))
702
self.create_hook(HookPoint('list_commands',
789
703
"Called when enumerating commands. Called with a set of "
790
704
"cmd_name strings for all the commands found so far. This set "
791
705
" is safe to mutate - e.g. to remove a command. "
792
706
"list_commands should return the updated set of command names.",
795
709
Command.hooks = CommandHooks()
976
888
config = bzrlib.config.GlobalConfig()
977
889
alias = config.get_alias(cmd)
979
return cmdline.split(alias)
891
return shlex_split_unicode(alias)
983
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
984
896
"""Execute a command.
986
:param argv: The command-line arguments, without the program name from
987
argv[0] These should already be decoded. All library/test code calling
988
run_bzr should be passing valid strings (don't need decoding).
989
:param load_plugins: What function to call when triggering plugin loading.
990
This function should take no arguments and cause all plugins to be
992
:param disable_plugins: What function to call when disabling plugin
993
loading. This function should take no arguments and cause all plugin
994
loading to be prohibited (so that code paths in your application that
995
know about some plugins possibly being present will fail to import
996
those plugins even if they are installed.)
997
:return: Returns a command exit code or raises an exception.
899
The command-line arguments, without the program name from argv[0]
900
These should already be decoded. All library/test code calling
901
run_bzr should be passing valid strings (don't need decoding).
903
Returns a command status or raises an exception.
999
905
Special master options: these must come before the command because
1000
906
they control how the command is interpreted.
1070
971
debug.set_debug_flags_from_config()
975
from bzrlib.builtins import cmd_help
976
cmd_help().run_argv_aliases([])
979
if argv[0] == '--version':
980
from bzrlib.builtins import cmd_version
981
cmd_version().run_argv_aliases([])
1072
984
if not opt_no_plugins:
985
from bzrlib.plugin import load_plugins
988
from bzrlib.plugin import disable_plugins
1075
989
disable_plugins()
1079
get_cmd_object('help').run_argv_aliases([])
1082
if argv[0] == '--version':
1083
get_cmd_object('version').run_argv_aliases([])
1086
991
alias_argv = None
1088
993
if not opt_no_aliases:
1089
994
alias_argv = get_alias(argv[0])
996
user_encoding = osutils.get_user_encoding()
997
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1091
998
argv[0] = alias_argv.pop(0)
1093
1000
cmd = argv.pop(0)
1001
# We want only 'ascii' command names, but the user may have typed
1002
# in a Unicode name. In that case, they should just get a
1003
# 'command not found' error later.
1094
1005
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1097
1006
run = cmd_obj.run_argv_aliases
1098
1007
run_argv = [argv, alias_argv]
1162
1071
"bzr plugin-provider-db check")
1166
def _specified_or_unicode_argv(argv):
1167
# For internal or testing use, argv can be passed. Otherwise, get it from
1168
# the process arguments in a unicode-safe way.
1074
def main(argv=None):
1075
"""Main entry point of command-line interface.
1077
:param argv: list of unicode command-line arguments similar to sys.argv.
1078
argv[0] is script name usually, it will be ignored.
1079
Don't pass here sys.argv because this list contains plain strings
1080
and not unicode; pass None instead.
1082
:return: exit code of bzr command.
1085
bzrlib.ui.ui_factory = bzrlib.ui.make_ui_for_terminal(
1086
sys.stdin, sys.stdout, sys.stderr)
1088
# Is this a final release version? If so, we should suppress warnings
1089
if bzrlib.version_info[3] == 'final':
1090
suppress_deprecation_warnings(override=True)
1169
1091
if argv is None:
1170
return osutils.get_unicode_argv()
1092
argv = osutils.get_unicode_argv()
1174
1096
# ensure all arguments are unicode strings
1176
1098
if isinstance(a, unicode):
1177
1099
new_argv.append(a)
1179
1101
new_argv.append(a.decode('ascii'))
1180
1102
except UnicodeDecodeError:
1181
1103
raise errors.BzrError("argv should be list of unicode strings.")
1185
def main(argv=None):
1186
"""Main entry point of command-line interface.
1188
Typically `bzrlib.initialize` should be called first.
1190
:param argv: list of unicode command-line arguments similar to sys.argv.
1191
argv[0] is script name usually, it will be ignored.
1192
Don't pass here sys.argv because this list contains plain strings
1193
and not unicode; pass None instead.
1195
:return: exit code of bzr command.
1197
if argv is not None:
1199
_register_builtin_commands()
1200
1105
ret = run_bzr_catch_errors(argv)
1201
1106
trace.mutter("return code %d", ret)
1107
osutils.report_extension_load_failures()
added
removed
bzrlib/commands.py
