28
from bzrlib.lazy_import import lazy_import
29
from .lazy_import import lazy_import
29
30
lazy_import(globals(), """
33
from warnings import warn
49
from bzrlib.hooks import HookPoint, Hooks
49
from .hooks import Hooks
50
from .i18n import gettext
50
51
# Compatibility - Option used to be in commands.
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 (
52
from .option import Option
53
from .plugin import disable_plugins, load_plugins
54
from . import registry
165
164
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())
178
167
def _register_builtin_commands():
179
168
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
171
import breezy.builtins
172
for cmd_class in _scan_module_for_commands(breezy.builtins).values():
184
173
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
174
breezy.builtins._register_lazy_builtins()
188
177
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
179
for name, obj in module.__dict__.items():
191
180
if name.startswith("cmd_"):
192
181
real_name = _unsquish_command_name(name)
193
182
r[real_name] = obj
357
349
summary, then a complete description of the command. A grammar
358
350
description will be inserted.
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
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
382
368
for commands intended for expert users.
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
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.)
399
389
:cvar hooks: An instance of CommandHooks.
391
:cvar __doc__: The help shown by 'brz help command' for this command.
392
This is set by assigning explicitly to __doc__ so that -OO can
396
__doc__ = "My help goes here"
403
400
takes_options = []
404
401
encoding_type = 'strict'
408
407
def __init__(self):
409
408
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
412
409
# List of standard options directly supported
413
410
self.supported_std_options = []
414
411
self._setup_run()
436
433
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.
451
435
def _usage(self):
452
436
"""Return single-line grammar for this command.
454
438
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
440
s = 'brz ' + self.name() + ' '
457
441
for aname in self.takes_args:
458
442
aname = aname.upper()
459
443
if aname[-1] in ['$', '+']:
481
465
usage help (e.g. Purpose, Usage, Options) with a
482
466
message explaining how to obtain full help.
469
i18n.install() # Install i18n only for get_help_text for now.
484
470
doc = self.help()
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
472
# Note: If self.gettext() translates ':Usage:\n', the section will
473
# be shown after "Description" section and we don't want to
474
# translate the usage string.
475
# Though, brz export-pot don't exports :Usage: section and it must
477
doc = self.gettext(doc)
479
doc = gettext("No help for this command.")
488
481
# Extract the summary (purpose) and sections out from the text
489
482
purpose,sections,order = self._get_help_parts(doc)
491
484
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
485
if 'Usage' in sections:
493
486
usage = sections.pop('Usage')
495
488
usage = self._usage()
497
490
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
492
result += gettext(':Purpose: %s\n') % (purpose,)
500
493
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
494
result += gettext(':Usage:\n%s\n') % (usage,)
503
result += ':Usage: %s\n' % usage
496
result += gettext(':Usage: %s\n') % (usage,)
506
499
# Add the options
508
501
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
502
# so we get <https://bugs.launchpad.net/bzr/+bug/249908>. -- mbp
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:
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:
518
513
options = options.replace(' format:\n', ' format::\n\n', 1)
519
514
if options.startswith('Options:'):
520
result += ':' + options
521
elif options.startswith('options:'):
522
# Python 2.4 version of optparse
523
result += ':Options:' + options[len('options:'):]
515
result += gettext(':Options:%s') % (options[len('options:'):],)
525
517
result += options
529
521
# Add the description, indenting it 2 spaces
530
522
# to match the indentation of the options
531
if sections.has_key(None):
532
524
text = sections.pop(None)
533
525
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
526
result += gettext(':Description:\n %s\n\n') % (text,)
536
528
# Add the custom sections (e.g. Examples). Note that there's no need
537
529
# to indent these as they must be indented already in the source.
539
531
for label in order:
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
532
if label in sections:
533
result += ':%s:\n%s\n' % (label, sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
536
result += (gettext("See brz help %s for more details and examples.\n\n")
547
539
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
541
result += gettext(':Aliases: ')
550
542
result += ', '.join(self.aliases) + '\n'
551
543
plugin_name = self.plugin_name()
552
544
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
545
result += gettext(':From: plugin "%s"\n') % plugin_name
554
546
see_also = self.get_see_also(additional_see_also)
556
548
if not plain and see_also_as_links:
562
554
see_also_links.append(item)
564
556
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
557
link_text = gettext(":doc:`{0} <{1}-help>`").format(
566
559
see_also_links.append(link_text)
567
560
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
561
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
571
563
# If this will be rendered as plain text, convert it
573
import bzrlib.help_topics
574
result = bzrlib.help_topics.help_as_plain_text(result)
565
import breezy.help_topics
566
result = breezy.help_topics.help_as_plain_text(result)
653
645
def run_argv_aliases(self, argv, alias_argv=None):
654
646
"""Parse the command line and run with extra aliases in alias_argv."""
655
647
args, opts = parse_args(self, argv, alias_argv)
657
650
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
651
if 'help' in opts: # e.g. brz add --help
652
self.outf.write(self.get_help_text())
661
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
654
if 'usage' in opts: # e.g. brz add --usage
655
self.outf.write(self.get_help_text(verbose=False))
664
657
trace.set_verbosity_level(option._verbosity_level)
665
658
if 'verbose' in self.supported_std_options:
666
659
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
660
elif 'verbose' in opts:
668
661
del opts['verbose']
669
662
if 'quiet' in self.supported_std_options:
670
663
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
664
elif 'quiet' in opts:
672
665
del opts['quiet']
674
666
# mix arguments and options into one dictionary
675
667
cmdargs = _match_argform(self.name(), self.takes_args, args)
680
672
all_cmd_args = cmdargs.copy()
681
673
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
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)
687
685
def _setup_run(self):
688
686
"""Wrap the defined run method on self with a cleanup.
696
694
class_run = self.run
697
695
def run(*args, **kwargs):
696
for hook in Command.hooks['pre_command']:
698
698
self._operation = cleanup.OperationWithCleanups(class_run)
700
700
return self._operation.run_simple(*args, **kwargs)
702
702
del self._operation
703
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)
711
708
"""Actually run the command.
762
771
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
774
Hooks.__init__(self, "breezy.commands", "Command.hooks")
775
self.add_hook('extend_command',
767
776
"Called after creating a command object to allow modifications "
768
777
"such as adding or removing options, docs etc. Called with the "
769
"new bzrlib.commands.Command object.", (1, 13), None))
770
self.create_hook(HookPoint('get_command',
778
"new breezy.commands.Command object.", (1, 13))
779
self.add_hook('get_command',
771
780
"Called when creating a single command. Called with "
772
781
"(cmd_or_None, command_name). get_command should either return "
773
782
"the cmd_or_None parameter, or a replacement Command object that "
774
783
"should be used for the command. Note that the Command.hooks "
775
784
"hooks are core infrastructure. Many users will prefer to use "
776
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
785
"breezy.commands.register_command or plugin_cmds.register_lazy.",
787
self.add_hook('get_missing_command',
779
788
"Called when creating a single command if no command could be "
780
789
"found. Called with (command_name). get_missing_command should "
781
790
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
792
self.add_hook('list_commands',
784
793
"Called when enumerating commands. Called with a set of "
785
794
"cmd_name strings for all the commands found so far. This set "
786
795
" is safe to mutate - e.g. to remove a command. "
787
796
"list_commands should return the updated set of command names.",
798
self.add_hook('pre_command',
799
"Called prior to executing a command. Called with the command "
801
self.add_hook('post_command',
802
"Called after executing a command. Called with the command "
790
805
Command.hooks = CommandHooks()
808
options, args = parser.parse_args(args)
809
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
823
# for python 2.5 and later, optparse raises this exception if a non-ascii
824
# option name is given. See http://bugs.python.org/issue2931
826
options, args = parser.parse_args(args)
827
except UnicodeEncodeError as e:
828
raise errors.BzrCommandError(
829
gettext('Only ASCII permitted in option names'))
831
opts = dict([(k, v) for k, v in options.__dict__.items() if
810
832
v is not option.OptionParser.DEFAULT_VALUE])
811
833
return args, opts
828
850
argdict[argname + '_list'] = None
829
851
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
853
raise errors.BzrCommandError(gettext(
854
"command {0!r} needs one or more {1}").format(
855
cmd, argname.upper()))
834
857
argdict[argname + '_list'] = args[:]
836
859
elif ap[-1] == '$': # all but one
837
860
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
861
raise errors.BzrCommandError(
862
gettext("command {0!r} needs one or more {1}").format(
863
cmd, argname.upper()))
840
864
argdict[argname + '_list'] = args[:-1]
843
867
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
870
raise errors.BzrCommandError(
871
gettext("command {0!r} requires argument {1}").format(
872
cmd, argname.upper()))
849
874
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
877
raise errors.BzrCommandError( gettext(
878
"extra argument to command {0}: {1}").format(
857
883
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
884
# Cannot use "import trace", as that would import breezy.trace instead of
859
885
# the standard library's trace.
860
886
trace = __import__('trace')
907
933
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
934
except (KeyboardInterrupt, Exception) as e:
909
935
# used to handle AssertionError and KeyboardInterrupt
910
936
# specially here, but hopefully they're handled ok by the logger now
911
937
exc_info = sys.exc_info()
912
938
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
939
if os.environ.get('BRZ_PDB'):
940
print('**** entering debugger')
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])
942
pdb.post_mortem(exc_info[2])
940
946
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
947
from breezy.lsprof import profile
948
ret, stats = profile(exception_to_return_code, the_callable,
944
951
if filename is None:
947
954
stats.save(filename)
948
trace.note('Profile data written to "%s".', filename)
955
trace.note(gettext('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)
957
959
def get_alias(cmd, config=None):
958
960
"""Return an expanded alias, or None if no alias exists.
1015
1017
Specify the number of processes that can be run concurrently (selftest).
1017
trace.mutter("bazaar version: " + bzrlib.__version__)
1019
trace.mutter("bzr arguments: %r", argv)
1019
trace.mutter("breezy version: " + breezy.__version__)
1020
argv = _specified_or_unicode_argv(argv)
1021
trace.mutter("brz arguments: %r", argv)
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1023
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1024
opt_no_l10n = opt_no_aliases = False
1023
1025
opt_lsprof_file = opt_coverage_dir = None
1025
1027
# --no-plugins is handled specially at a very early stage. We need
1042
1045
opt_no_plugins = True
1043
1046
elif a == '--no-aliases':
1044
1047
opt_no_aliases = True
1048
elif a == '--no-l10n':
1045
1050
elif a == '--builtin':
1046
1051
opt_builtin = True
1047
1052
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1053
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1050
1055
elif a == '--coverage':
1051
1056
opt_coverage_dir = argv[i + 1]
1058
elif a == '--profile-imports':
1059
pass # already handled in startup script Bug #588277
1053
1060
elif a.startswith('-D'):
1054
1061
debug.debug_flags.add(a[2:])
1062
elif a.startswith('-O'):
1063
override_config.append(a[2:])
1056
1065
argv_copy.append(a)
1068
if breezy.global_state is None:
1069
# FIXME: Workaround for users that imported breezy but didn't call
1070
# breezy.initialize -- vila 2012-01-19
1071
cmdline_overrides = config.CommandLineStore()
1073
cmdline_overrides = breezy.global_state.cmdline_overrides
1074
cmdline_overrides._from_cmdline(override_config)
1059
1076
debug.set_debug_flags_from_config()
1061
1078
if not opt_no_plugins:
1077
1094
if not opt_no_aliases:
1078
1095
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]
1082
1097
argv[0] = alias_argv.pop(0)
1084
1099
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.
1089
1100
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1102
cmd_obj.l10n = False
1090
1103
run = cmd_obj.run_argv_aliases
1091
1104
run_argv = [argv, alias_argv]
1178
1194
def main(argv=None):
1179
1195
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1197
Typically `breezy.initialize` should be called first.
1183
1199
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
1200
argv[0] is script name usually, it will be ignored.
1185
1201
Don't pass here sys.argv because this list contains plain strings
1186
1202
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1204
:return: exit code of brz command.
1190
argv = _specified_or_unicode_argv(argv)
1206
if argv is not None:
1191
1208
_register_builtin_commands()
1192
1209
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
1210
trace.mutter("return code %d", ret)
1252
1267
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1268
"""Generic class to be overriden by plugins"""
1255
1270
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1271
"""Takes a command and returns the information for that plugin
1258
1273
:return: A dictionary with all the available information
1259
for the requested plugin
1274
for the requested plugin
1261
1276
raise NotImplementedError
1264
1279
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1280
"""This registry exists to allow other providers to exist"""
1267
1282
def __iter__(self):
1268
for key, provider in self.iteritems():
1283
for key, provider in self.items():
1271
1286
command_providers_registry = ProvidersRegistry()
added
removed
breezy/commands.py
