29
from .lazy_import import lazy_import
28
from bzrlib.lazy_import import lazy_import
30
29
lazy_import(globals(), """
33
from warnings import warn
49
from .hooks import Hooks
50
from .i18n import gettext
49
from bzrlib.hooks import HookPoint, Hooks
51
50
# Compatibility - Option used to be in commands.
52
from .option import Option
53
from .plugin import disable_plugins, load_plugins, plugin_name
54
from . import registry
51
from bzrlib.option import Option
52
from bzrlib.plugin import disable_plugins, load_plugins
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
164
165
return cmd[4:].replace('_','-')
168
@deprecated_function(deprecated_in((2, 2, 0)))
169
def _builtin_commands():
170
"""Return a dict of {name: cmd_class} for builtin commands.
172
:deprecated: Use the builtin_command_registry registry instead
174
# return dict(name: cmd_class)
175
return dict(builtin_command_registry.items())
167
178
def _register_builtin_commands():
168
179
if builtin_command_registry.keys():
171
import breezy.builtins
172
for cmd_class in _scan_module_for_commands(breezy.builtins):
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
173
184
builtin_command_registry.register(cmd_class)
174
breezy.builtins._register_lazy_builtins()
185
bzrlib.builtins._register_lazy_builtins()
177
188
def _scan_module_for_commands(module):
178
module_dict = module.__dict__
179
for name in module_dict:
190
for name, obj in module.__dict__.iteritems():
180
191
if name.startswith("cmd_"):
181
yield module_dict[name]
192
real_name = _unsquish_command_name(name)
184
197
def _list_bzr_commands(names):
347
357
summary, then a complete description of the command. A grammar
348
358
description will be inserted.
350
:cvar aliases: Other accepted names for this command.
352
:cvar takes_args: List of argument forms, marked with whether they are
353
optional, repeated, etc. Examples::
355
['to_location', 'from_branch?', 'file*']
357
* 'to_location' is required
358
* 'from_branch' is optional
359
* 'file' can be specified 0 or more times
361
:cvar takes_options: List of options that may be given for this command.
362
These can be either strings, referring to globally-defined options, or
363
option objects. Retrieve through options().
365
:cvar hidden: If true, this command isn't advertised. This is typically
361
Other accepted names for this command.
364
List of argument forms, marked with whether they are optional,
369
['to_location', 'from_branch?', 'file*']
371
'to_location' is required
372
'from_branch' is optional
373
'file' can be specified 0 or more times
376
List of options that may be given for this command. These can
377
be either strings, referring to globally-defined options,
378
or option objects. Retrieve through options().
381
If true, this command isn't advertised. This is typically
366
382
for commands intended for expert users.
368
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
369
been setup to properly handle encoding of unicode strings.
370
encoding_type determines what will happen when characters cannot be
373
* strict - abort if we cannot decode
374
* replace - put in a bogus character (typically '?')
375
* exact - do not encode sys.stdout
377
NOTE: by default on Windows, sys.stdout is opened as a text stream,
378
therefore LF line-endings are converted to CRLF. When a command uses
379
encoding_type = 'exact', then sys.stdout is forced to be a binary
380
stream, and line-endings will not mangled.
383
A string indicating the real name under which this command was
384
invoked, before expansion of aliases.
385
(This may be None if the command was constructed and run in-process.)
385
Command objects will get a 'outf' attribute, which has been
386
setup to properly handle encoding of unicode strings.
387
encoding_type determines what will happen when characters cannot
389
strict - abort if we cannot decode
390
replace - put in a bogus character (typically '?')
391
exact - do not encode sys.stdout
393
NOTE: by default on Windows, sys.stdout is opened as a text
394
stream, therefore LF line-endings are converted to CRLF.
395
When a command uses encoding_type = 'exact', then
396
sys.stdout is forced to be a binary stream, and line-endings
387
399
:cvar hooks: An instance of CommandHooks.
389
:cvar __doc__: The help shown by 'brz help command' for this command.
390
This is set by assigning explicitly to __doc__ so that -OO can
394
__doc__ = "My help goes here"
398
403
takes_options = []
399
404
encoding_type = 'strict'
405
408
def __init__(self):
406
409
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
407
412
# List of standard options directly supported
408
413
self.supported_std_options = []
409
414
self._setup_run()
431
436
self._operation.cleanup_now()
438
@deprecated_method(deprecated_in((2, 1, 0)))
439
def _maybe_expand_globs(self, file_list):
440
"""Glob expand file_list if the platform does not do that itself.
442
Not used anymore, now that the bzr command-line parser globs on
445
:return: A possibly empty list of unicode paths.
447
Introduced in bzrlib 0.18.
433
451
def _usage(self):
434
452
"""Return single-line grammar for this command.
436
454
Only describes arguments, not options.
438
s = 'brz ' + self.name() + ' '
456
s = 'bzr ' + self.name() + ' '
439
457
for aname in self.takes_args:
440
458
aname = aname.upper()
441
459
if aname[-1] in ['$', '+']:
463
481
usage help (e.g. Purpose, Usage, Options) with a
464
482
message explaining how to obtain full help.
467
i18n.install() # Install i18n only for get_help_text for now.
468
484
doc = self.help()
470
# Note: If self.gettext() translates ':Usage:\n', the section will
471
# be shown after "Description" section and we don't want to
472
# translate the usage string.
473
# Though, brz export-pot don't exports :Usage: section and it must
475
doc = self.gettext(doc)
477
doc = gettext("No help for this command.")
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
479
488
# Extract the summary (purpose) and sections out from the text
480
489
purpose,sections,order = self._get_help_parts(doc)
482
491
# If a custom usage section was provided, use it
483
if 'Usage' in sections:
492
if sections.has_key('Usage'):
484
493
usage = sections.pop('Usage')
486
495
usage = self._usage()
488
497
# The header is the purpose and usage
490
result += gettext(':Purpose: %s\n') % (purpose,)
499
result += ':Purpose: %s\n' % purpose
491
500
if usage.find('\n') >= 0:
492
result += gettext(':Usage:\n%s\n') % (usage,)
501
result += ':Usage:\n%s\n' % usage
494
result += gettext(':Usage: %s\n') % (usage,)
503
result += ':Usage: %s\n' % usage
497
506
# Add the options
499
508
# XXX: optparse implicitly rewraps the help, and not always perfectly,
500
509
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
502
parser = option.get_optparser(self.options())
503
options = parser.format_option_help()
504
# FIXME: According to the spec, ReST option lists actually don't
505
# support options like --1.14 so that causes syntax errors (in Sphinx
506
# at least). As that pattern always appears in the commands that
507
# break, we trap on that and then format that block of 'format' options
508
# as a literal block. We use the most recent format still listed so we
509
# don't have to do that too often -- vila 20110514
510
if not plain and options.find(' --1.14 ') != -1:
511
options = option.get_optparser(self.options()).format_option_help()
512
# XXX: According to the spec, ReST option lists actually don't support
513
# options like --1.9 so that causes syntax errors (in Sphinx at least).
514
# As that pattern always appears in the commands that break, we trap
515
# on that and then format that block of 'format' options as a literal
517
if not plain and options.find(' --1.9 ') != -1:
511
518
options = options.replace(' format:\n', ' format::\n\n', 1)
512
519
if options.startswith('Options:'):
513
result += gettext(':Options:%s') % (options[len('options:'):],)
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
515
525
result += options
519
529
# Add the description, indenting it 2 spaces
520
530
# to match the indentation of the options
531
if sections.has_key(None):
522
532
text = sections.pop(None)
523
533
text = '\n '.join(text.splitlines())
524
result += gettext(':Description:\n %s\n\n') % (text,)
534
result += ':%s:\n %s\n\n' % ('Description',text)
526
536
# Add the custom sections (e.g. Examples). Note that there's no need
527
537
# to indent these as they must be indented already in the source.
529
539
for label in order:
530
if label in sections:
531
result += ':%s:\n%s\n' % (label, sections[label])
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
534
result += (gettext("See brz help %s for more details and examples.\n\n")
544
result += ("See bzr help %s for more details and examples.\n\n"
537
547
# Add the aliases, source (plug-in) and see also links, if any
539
result += gettext(':Aliases: ')
549
result += ':Aliases: '
540
550
result += ', '.join(self.aliases) + '\n'
541
551
plugin_name = self.plugin_name()
542
552
if plugin_name is not None:
543
result += gettext(':From: plugin "%s"\n') % plugin_name
553
result += ':From: plugin "%s"\n' % plugin_name
544
554
see_also = self.get_see_also(additional_see_also)
546
556
if not plain and see_also_as_links:
552
562
see_also_links.append(item)
554
564
# Use a Sphinx link for this entry
555
link_text = gettext(":doc:`{0} <{1}-help>`").format(
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
557
566
see_also_links.append(link_text)
558
567
see_also = see_also_links
559
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
561
571
# If this will be rendered as plain text, convert it
563
import breezy.help_topics
564
result = breezy.help_topics.help_as_plain_text(result)
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
643
653
def run_argv_aliases(self, argv, alias_argv=None):
644
654
"""Parse the command line and run with extra aliases in alias_argv."""
645
655
args, opts = parse_args(self, argv, alias_argv)
648
657
# Process the standard options
649
if 'help' in opts: # e.g. brz add --help
650
self.outf.write(self.get_help_text())
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
652
if 'usage' in opts: # e.g. brz add --usage
653
self.outf.write(self.get_help_text(verbose=False))
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
655
664
trace.set_verbosity_level(option._verbosity_level)
656
665
if 'verbose' in self.supported_std_options:
657
666
opts['verbose'] = trace.is_verbose()
658
elif 'verbose' in opts:
667
elif opts.has_key('verbose'):
659
668
del opts['verbose']
660
669
if 'quiet' in self.supported_std_options:
661
670
opts['quiet'] = trace.is_quiet()
662
elif 'quiet' in opts:
671
elif opts.has_key('quiet'):
663
672
del opts['quiet']
664
674
# mix arguments and options into one dictionary
665
675
cmdargs = _match_argform(self.name(), self.takes_args, args)
670
680
all_cmd_args = cmdargs.copy()
671
681
all_cmd_args.update(cmdopts)
674
return self.run(**all_cmd_args)
676
# reset it, so that other commands run in the same process won't
677
# inherit state. Before we reset it, log any activity, so that it
678
# gets properly tracked.
679
ui.ui_factory.log_transport_activity(
680
display=('bytes' in debug.debug_flags))
681
trace.set_verbosity_level(0)
685
return self.run(**all_cmd_args)
683
687
def _setup_run(self):
684
688
"""Wrap the defined run method on self with a cleanup.
692
696
class_run = self.run
693
697
def run(*args, **kwargs):
694
for hook in Command.hooks['pre_command']:
696
698
self._operation = cleanup.OperationWithCleanups(class_run)
698
700
return self._operation.run_simple(*args, **kwargs)
700
702
del self._operation
701
for hook in Command.hooks['post_command']:
705
@deprecated_method(deprecated_in((2, 2, 0)))
706
def run_direct(self, *args, **kwargs):
707
"""Deprecated thunk from bzrlib 2.1."""
708
return self.run(*args, **kwargs)
706
711
"""Actually run the command.
765
762
These are all empty initially, because by default nothing should get
768
Hooks.__init__(self, "breezy.commands", "Command.hooks")
769
self.add_hook('extend_command',
766
self.create_hook(HookPoint('extend_command',
770
767
"Called after creating a command object to allow modifications "
771
768
"such as adding or removing options, docs etc. Called with the "
772
"new breezy.commands.Command object.", (1, 13))
773
self.add_hook('get_command',
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
774
771
"Called when creating a single command. Called with "
775
772
"(cmd_or_None, command_name). get_command should either return "
776
773
"the cmd_or_None parameter, or a replacement Command object that "
777
774
"should be used for the command. Note that the Command.hooks "
778
775
"hooks are core infrastructure. Many users will prefer to use "
779
"breezy.commands.register_command or plugin_cmds.register_lazy.",
781
self.add_hook('get_missing_command',
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
782
779
"Called when creating a single command if no command could be "
783
780
"found. Called with (command_name). get_missing_command should "
784
781
"either return None, or a Command object to be used for the "
786
self.add_hook('list_commands',
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
787
784
"Called when enumerating commands. Called with a set of "
788
785
"cmd_name strings for all the commands found so far. This set "
789
786
" is safe to mutate - e.g. to remove a command. "
790
787
"list_commands should return the updated set of command names.",
792
self.add_hook('pre_command',
793
"Called prior to executing a command. Called with the command "
795
self.add_hook('post_command',
796
"Called after executing a command. Called with the command "
799
790
Command.hooks = CommandHooks()
817
# for python 2.5 and later, optparse raises this exception if a non-ascii
818
# option name is given. See http://bugs.python.org/issue2931
820
options, args = parser.parse_args(args)
821
except UnicodeEncodeError as e:
822
raise errors.BzrCommandError(
823
gettext('Only ASCII permitted in option names'))
825
opts = dict((k, v) for k, v in options.__dict__.items() if
826
v is not option.OptionParser.DEFAULT_VALUE)
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
v is not option.OptionParser.DEFAULT_VALUE])
827
811
return args, opts
844
828
argdict[argname + '_list'] = None
845
829
elif ap[-1] == '+':
847
raise errors.BzrCommandError(gettext(
848
"command {0!r} needs one or more {1}").format(
849
cmd, argname.upper()))
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
851
834
argdict[argname + '_list'] = args[:]
853
836
elif ap[-1] == '$': # all but one
854
837
if len(args) < 2:
855
raise errors.BzrCommandError(
856
gettext("command {0!r} needs one or more {1}").format(
857
cmd, argname.upper()))
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
858
840
argdict[argname + '_list'] = args[:-1]
861
843
# just a plain arg
864
raise errors.BzrCommandError(
865
gettext("command {0!r} requires argument {1}").format(
866
cmd, argname.upper()))
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
868
849
argdict[argname] = args.pop(0)
871
raise errors.BzrCommandError( gettext(
872
"extra argument to command {0}: {1}").format(
852
raise errors.BzrCommandError("extra argument to command %s: %s"
877
857
def apply_coveraged(dirname, the_callable, *args, **kwargs):
878
# Cannot use "import trace", as that would import breezy.trace instead of
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
879
859
# the standard library's trace.
880
860
trace = __import__('trace')
927
907
return the_callable(*args, **kwargs)
928
except (KeyboardInterrupt, Exception) as e:
908
except (KeyboardInterrupt, Exception), e:
929
909
# used to handle AssertionError and KeyboardInterrupt
930
910
# specially here, but hopefully they're handled ok by the logger now
931
911
exc_info = sys.exc_info()
932
912
exitcode = trace.report_exception(exc_info, sys.stderr)
933
if os.environ.get('BRZ_PDB'):
934
print('**** entering debugger')
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
936
pdb.post_mortem(exc_info[2])
917
if sys.version_info[:2] < (2, 6):
919
# pdb.post_mortem(tb)
920
# but because pdb.post_mortem gives bad results for tracebacks
921
# from inside generators, we do it manually.
922
# (http://bugs.python.org/issue4150, fixed in Python 2.6)
924
# Setup pdb on the traceback
927
p.setup(tb.tb_frame, tb)
928
# Point the debugger at the deepest frame of the stack
929
p.curindex = len(p.stack) - 1
930
p.curframe = p.stack[p.curindex][0]
931
# Start the pdb prompt.
932
p.print_stack_entry(p.stack[p.curindex])
940
940
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from breezy.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable,
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
945
944
if filename is None:
948
947
stats.save(filename)
949
trace.note(gettext('Profile data written to "%s".'), filename)
948
trace.note('Profile data written to "%s".', filename)
952
@deprecated_function(deprecated_in((2, 2, 0)))
953
def shlex_split_unicode(unsplit):
954
return cmdline.split(unsplit)
953
957
def get_alias(cmd, config=None):
954
958
"""Return an expanded alias, or None if no alias exists.
1011
1015
Specify the number of processes that can be run concurrently (selftest).
1013
trace.mutter("breezy version: " + breezy.__version__)
1014
argv = _specified_or_unicode_argv(argv)
1015
trace.mutter("brz arguments: %r", argv)
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1017
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1018
opt_no_l10n = opt_no_aliases = False
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1019
1023
opt_lsprof_file = opt_coverage_dir = None
1021
1025
# --no-plugins is handled specially at a very early stage. We need
1039
1042
opt_no_plugins = True
1040
1043
elif a == '--no-aliases':
1041
1044
opt_no_aliases = True
1042
elif a == '--no-l10n':
1044
1045
elif a == '--builtin':
1045
1046
opt_builtin = True
1046
1047
elif a == '--concurrency':
1047
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1049
1050
elif a == '--coverage':
1050
1051
opt_coverage_dir = argv[i + 1]
1052
elif a == '--profile-imports':
1053
pass # already handled in startup script Bug #588277
1054
1053
elif a.startswith('-D'):
1055
1054
debug.debug_flags.add(a[2:])
1056
elif a.startswith('-O'):
1057
override_config.append(a[2:])
1059
1056
argv_copy.append(a)
1062
if breezy.global_state is None:
1063
# FIXME: Workaround for users that imported breezy but didn't call
1064
# breezy.initialize -- vila 2012-01-19
1065
cmdline_overrides = config.CommandLineStore()
1067
cmdline_overrides = breezy.global_state.cmdline_overrides
1068
cmdline_overrides._from_cmdline(override_config)
1070
1059
debug.set_debug_flags_from_config()
1072
1061
if not opt_no_plugins:
1088
1077
if not opt_no_aliases:
1089
1078
alias_argv = get_alias(argv[0])
1080
user_encoding = osutils.get_user_encoding()
1081
alias_argv = [a.decode(user_encoding) for a in alias_argv]
1091
1082
argv[0] = alias_argv.pop(0)
1093
1084
cmd = argv.pop(0)
1085
# We want only 'ascii' command names, but the user may have typed
1086
# in a Unicode name. In that case, they should just get a
1087
# 'command not found' error later.
1094
1089
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1096
cmd_obj.l10n = False
1097
1090
run = cmd_obj.run_argv_aliases
1098
1091
run_argv = [argv, alias_argv]
1188
1178
def main(argv=None):
1189
1179
"""Main entry point of command-line interface.
1191
Typically `breezy.initialize` should be called first.
1181
Typically `bzrlib.initialize` should be called first.
1193
1183
:param argv: list of unicode command-line arguments similar to sys.argv.
1194
1184
argv[0] is script name usually, it will be ignored.
1195
1185
Don't pass here sys.argv because this list contains plain strings
1196
1186
and not unicode; pass None instead.
1198
:return: exit code of brz command.
1188
:return: exit code of bzr command.
1200
if argv is not None:
1190
argv = _specified_or_unicode_argv(argv)
1202
1191
_register_builtin_commands()
1203
1192
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1204
1195
trace.mutter("return code %d", ret)
1261
1252
class Provider(object):
1262
"""Generic class to be overriden by plugins"""
1253
'''Generic class to be overriden by plugins'''
1264
1255
def plugin_for_command(self, cmd_name):
1265
"""Takes a command and returns the information for that plugin
1256
'''Takes a command and returns the information for that plugin
1267
1258
:return: A dictionary with all the available information
1268
for the requested plugin
1259
for the requested plugin
1270
1261
raise NotImplementedError
1273
1264
class ProvidersRegistry(registry.Registry):
1274
"""This registry exists to allow other providers to exist"""
1265
'''This registry exists to allow other providers to exist'''
1276
1267
def __iter__(self):
1277
for key, provider in self.items():
1268
for key, provider in self.iteritems():
1280
1271
command_providers_registry = ProvidersRegistry()
added
removed
bzrlib/commands.py
