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
52
from bzrlib.hooks import HookPoint, Hooks
49
53
# Compatibility - Option used to be in commands.
50
54
from bzrlib.option import Option
51
from bzrlib.plugin import disable_plugins, load_plugins
52
55
from bzrlib import registry
53
56
from bzrlib.symbol_versioning import (
54
57
deprecated_function,
59
suppress_deprecation_warnings,
109
96
previous = self.get(k_unsquished)
112
if self.overridden_registry:
114
previous = self.overridden_registry.get(k_unsquished)
98
previous = _builtin_commands().get(k_unsquished)
117
99
info = CommandInfo.from_command(cmd)
119
101
registry.Registry.register(self, k_unsquished, cmd,
120
102
override_existing=decorate, info=info)
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
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__])
131
111
def register_lazy(self, command_name, aliases, module_name):
359
328
summary, then a complete description of the command. A grammar
360
329
description will be inserted.
362
:cvar aliases: Other accepted names for this command.
364
:cvar takes_args: List of argument forms, marked with whether they are
365
optional, repeated, etc. Examples::
367
['to_location', 'from_branch?', 'file*']
369
* 'to_location' is required
370
* 'from_branch' is optional
371
* 'file' can be specified 0 or more times
373
:cvar takes_options: List of options that may be given for this command.
374
These can be either strings, referring to globally-defined options, or
375
option objects. Retrieve through options().
377
:cvar hidden: If true, this command isn't advertised. This is typically
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
378
353
for commands intended for expert users.
380
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
381
been setup to properly handle encoding of unicode strings.
382
encoding_type determines what will happen when characters cannot be
385
* strict - abort if we cannot decode
386
* replace - put in a bogus character (typically '?')
387
* exact - do not encode sys.stdout
389
NOTE: by default on Windows, sys.stdout is opened as a text stream,
390
therefore LF line-endings are converted to CRLF. When a command uses
391
encoding_type = 'exact', then sys.stdout is forced to be a binary
392
stream, and line-endings will not mangled.
395
A string indicating the real name under which this command was
396
invoked, before expansion of aliases.
397
(This may be None if the command was constructed and run in-process.)
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
399
370
:cvar hooks: An instance of CommandHooks.
401
:cvar __doc__: The help shown by 'bzr help command' for this command.
402
This is set by assigning explicitly to __doc__ so that -OO can
406
__doc__ = "My help goes here"
410
374
takes_options = []
411
375
encoding_type = 'strict'
417
379
def __init__(self):
418
380
"""Construct an instance of this command."""
381
if self.__doc__ == Command.__doc__:
382
warn("No help message set for %r" % self)
419
383
# List of standard options directly supported
420
384
self.supported_std_options = []
423
def add_cleanup(self, cleanup_func, *args, **kwargs):
424
"""Register a function to call after self.run returns or raises.
426
Functions will be called in LIFO order.
428
self._operation.add_cleanup(cleanup_func, *args, **kwargs)
430
def cleanup_now(self):
431
"""Execute and empty pending cleanup functions immediately.
433
After cleanup_now all registered cleanups are forgotten. add_cleanup
434
may be called again after cleanup_now; these cleanups will be called
435
after self.run returns or raises (or when cleanup_now is next called).
437
This is useful for releasing expensive or contentious resources (such
438
as write locks) before doing further work that does not require those
439
resources (such as writing results to self.outf). Note though, that
440
as it releases all resources, this may release locks that the command
441
wants to hold, so use should be done with care.
443
self._operation.cleanup_now()
445
@deprecated_method(deprecated_in((2, 1, 0)))
446
386
def _maybe_expand_globs(self, file_list):
447
387
"""Glob expand file_list if the platform does not do that itself.
449
Not used anymore, now that the bzr command-line parser globs on
452
389
:return: A possibly empty list of unicode paths.
454
391
Introduced in bzrlib 0.18.
395
if sys.platform == 'win32':
396
file_list = win32utils.glob_expand(file_list)
397
return list(file_list)
458
399
def _usage(self):
459
400
"""Return single-line grammar for this command.
524
456
# XXX: optparse implicitly rewraps the help, and not always perfectly,
525
457
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
527
parser = option.get_optparser(self.options())
528
options = parser.format_option_help()
529
# FIXME: According to the spec, ReST option lists actually don't
530
# support options like --1.14 so that causes syntax errors (in Sphinx
531
# at least). As that pattern always appears in the commands that
532
# break, we trap on that and then format that block of 'format' options
533
# as a literal block. We use the most recent format still listed so we
534
# don't have to do that too often -- vila 20110514
535
if not plain and options.find(' --1.14 ') != -1:
536
options = options.replace(' format:\n', ' format::\n\n', 1)
459
options = option.get_optparser(self.options()).format_option_help()
537
460
if options.startswith('Options:'):
538
result += gettext(':Options:%s') % (options[len('options:'):],)
461
result += ':' + options
462
elif options.startswith('options:'):
463
# Python 2.4 version of optparse
464
result += ':Options:' + options[len('options:'):]
540
466
result += options
546
472
if sections.has_key(None):
547
473
text = sections.pop(None)
548
474
text = '\n '.join(text.splitlines())
549
result += gettext(':Description:\n %s\n\n') % (text,)
475
result += ':%s:\n %s\n\n' % ('Description',text)
551
477
# Add the custom sections (e.g. Examples). Note that there's no need
552
478
# to indent these as they must be indented already in the source.
554
480
for label in order:
555
if label in sections:
556
result += ':%s:\n%s\n' % (label, sections[label])
481
if sections.has_key(label):
482
result += ':%s:\n%s\n' % (label,sections[label])
559
result += (gettext("See bzr help %s for more details and examples.\n\n")
485
result += ("See bzr help %s for more details and examples.\n\n"
562
488
# Add the aliases, source (plug-in) and see also links, if any
564
result += gettext(':Aliases: ')
490
result += ':Aliases: '
565
491
result += ', '.join(self.aliases) + '\n'
566
492
plugin_name = self.plugin_name()
567
493
if plugin_name is not None:
568
result += gettext(':From: plugin "%s"\n') % plugin_name
494
result += ':From: plugin "%s"\n' % plugin_name
569
495
see_also = self.get_see_also(additional_see_also)
571
497
if not plain and see_also_as_links:
662
588
def _setup_outf(self):
663
589
"""Return a file linked to stdout, which has proper encoding."""
664
self.outf = ui.ui_factory.make_output_stream(
665
encoding_type=self.encoding_type)
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
667
611
def run_argv_aliases(self, argv, alias_argv=None):
668
612
"""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)
669
617
args, opts = parse_args(self, argv, alias_argv)
672
619
# Process the standard options
673
620
if 'help' in opts: # e.g. bzr add --help
674
self.outf.write(self.get_help_text())
621
sys.stdout.write(self.get_help_text())
676
623
if 'usage' in opts: # e.g. bzr add --usage
677
self.outf.write(self.get_help_text(verbose=False))
624
sys.stdout.write(self.get_help_text(verbose=False))
679
626
trace.set_verbosity_level(option._verbosity_level)
680
627
if 'verbose' in self.supported_std_options:
695
642
all_cmd_args = cmdargs.copy()
696
643
all_cmd_args.update(cmdopts)
699
return self.run(**all_cmd_args)
701
# reset it, so that other commands run in the same process won't
702
# inherit state. Before we reset it, log any activity, so that it
703
# gets properly tracked.
704
ui.ui_factory.log_transport_activity(
705
display=('bytes' in debug.debug_flags))
706
trace.set_verbosity_level(0)
708
def _setup_run(self):
709
"""Wrap the defined run method on self with a cleanup.
711
This is called by __init__ to make the Command be able to be run
712
by just calling run(), as it could be before cleanups were added.
714
If a different form of cleanups are in use by your Command subclass,
715
you can override this method.
718
def run(*args, **kwargs):
719
self._operation = cleanup.OperationWithCleanups(class_run)
721
return self._operation.run_simple(*args, **kwargs)
726
@deprecated_method(deprecated_in((2, 2, 0)))
727
def run_direct(self, *args, **kwargs):
728
"""Deprecated thunk from bzrlib 2.1."""
729
return self.run(*args, **kwargs)
647
return self.run(**all_cmd_args)
732
650
"""Actually run the command.
795
690
These are all empty initially, because by default nothing should get
798
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
799
self.add_hook('extend_command',
694
self.create_hook(HookPoint('extend_command',
800
695
"Called after creating a command object to allow modifications "
801
696
"such as adding or removing options, docs etc. Called with the "
802
"new bzrlib.commands.Command object.", (1, 13))
803
self.add_hook('get_command',
697
"new bzrlib.commands.Command object.", (1, 13), None))
698
self.create_hook(HookPoint('get_command',
804
699
"Called when creating a single command. Called with "
805
700
"(cmd_or_None, command_name). get_command should either return "
806
701
"the cmd_or_None parameter, or a replacement Command object that "
807
702
"should be used for the command. Note that the Command.hooks "
808
703
"hooks are core infrastructure. Many users will prefer to use "
809
704
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
811
self.add_hook('get_missing_command',
706
self.create_hook(HookPoint('get_missing_command',
812
707
"Called when creating a single command if no command could be "
813
708
"found. Called with (command_name). get_missing_command should "
814
709
"either return None, or a Command object to be used for the "
816
self.add_hook('list_commands',
710
"command.", (1, 17), None))
711
self.create_hook(HookPoint('list_commands',
817
712
"Called when enumerating commands. Called with a set of "
818
713
"cmd_name strings for all the commands found so far. This set "
819
714
" is safe to mutate - e.g. to remove a command. "
820
715
"list_commands should return the updated set of command names.",
823
718
Command.hooks = CommandHooks()
1008
897
config = bzrlib.config.GlobalConfig()
1009
898
alias = config.get_alias(cmd)
1011
return cmdline.split(alias)
900
return shlex_split_unicode(alias)
1015
def run_bzr(argv, load_plugins=load_plugins, disable_plugins=disable_plugins):
1016
905
"""Execute a command.
1018
:param argv: The command-line arguments, without the program name from
1019
argv[0] These should already be decoded. All library/test code calling
1020
run_bzr should be passing valid strings (don't need decoding).
1021
:param load_plugins: What function to call when triggering plugin loading.
1022
This function should take no arguments and cause all plugins to be
1024
:param disable_plugins: What function to call when disabling plugin
1025
loading. This function should take no arguments and cause all plugin
1026
loading to be prohibited (so that code paths in your application that
1027
know about some plugins possibly being present will fail to import
1028
those plugins even if they are installed.)
1029
:return: Returns a command exit code or raises an exception.
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.
1031
914
Special master options: these must come before the command because
1032
915
they control how the command is interpreted.
1102
974
debug.set_debug_flags_from_config()
978
from bzrlib.builtins import cmd_help
979
cmd_help().run_argv_aliases([])
982
if argv[0] == '--version':
983
from bzrlib.builtins import cmd_version
984
cmd_version().run_argv_aliases([])
1104
987
if not opt_no_plugins:
988
from bzrlib.plugin import load_plugins
991
from bzrlib.plugin import disable_plugins
1107
992
disable_plugins()
1111
get_cmd_object('help').run_argv_aliases([])
1114
if argv[0] == '--version':
1115
get_cmd_object('version').run_argv_aliases([])
1118
994
alias_argv = None
1120
996
if not opt_no_aliases:
1121
997
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]
1123
1001
argv[0] = alias_argv.pop(0)
1125
1003
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.
1126
1008
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1129
1009
run = cmd_obj.run_argv_aliases
1130
1010
run_argv = [argv, alias_argv]
1194
1074
"bzr plugin-provider-db check")
1198
def _specified_or_unicode_argv(argv):
1199
# For internal or testing use, argv can be passed. Otherwise, get it from
1200
# the process arguments in a unicode-safe way.
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)
1201
1094
if argv is None:
1202
return osutils.get_unicode_argv()
1095
argv = osutils.get_unicode_argv()
1206
1099
# ensure all arguments are unicode strings
1208
1101
if isinstance(a, unicode):
1209
1102
new_argv.append(a)
1211
1104
new_argv.append(a.decode('ascii'))
1212
1105
except UnicodeDecodeError:
1213
1106
raise errors.BzrError("argv should be list of unicode strings.")
1217
def main(argv=None):
1218
"""Main entry point of command-line interface.
1220
Typically `bzrlib.initialize` should be called first.
1222
:param argv: list of unicode command-line arguments similar to sys.argv.
1223
argv[0] is script name usually, it will be ignored.
1224
Don't pass here sys.argv because this list contains plain strings
1225
and not unicode; pass None instead.
1227
:return: exit code of bzr command.
1229
if argv is not None:
1231
_register_builtin_commands()
1232
1108
ret = run_bzr_catch_errors(argv)
1233
1109
trace.mutter("return code %d", ret)
added
removed
bzrlib/commands.py
