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
48
from .hooks import Hooks
49
from .i18n import gettext
50
50
# 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 (
51
from .option import Option
52
from .plugin import disable_plugins, load_plugins, plugin_name
53
from . import errors, registry
59
class BzrOptionError(errors.BzrCommandError):
61
_fmt = "Error in command line options"
61
64
class CommandInfo(object):
62
65
"""Information about a command."""
165
168
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
171
def _register_builtin_commands():
179
172
if builtin_command_registry.keys():
182
import bzrlib.builtins
183
for cmd_class in _scan_module_for_commands(bzrlib.builtins).values():
175
import breezy.builtins
176
for cmd_class in _scan_module_for_commands(breezy.builtins):
184
177
builtin_command_registry.register(cmd_class)
185
bzrlib.builtins._register_lazy_builtins()
178
breezy.builtins._register_lazy_builtins()
188
181
def _scan_module_for_commands(module):
190
for name, obj in module.__dict__.iteritems():
182
module_dict = module.__dict__
183
for name in module_dict:
191
184
if name.startswith("cmd_"):
192
real_name = _unsquish_command_name(name)
185
yield module_dict[name]
197
188
def _list_bzr_commands(names):
230
222
return plugin_cmds.keys()
225
# Overrides for common mispellings that heuristics get wrong
227
'ic': {'ci': 0}, # heuristic finds nick
231
def guess_command(cmd_name):
232
"""Guess what command a user typoed.
234
:param cmd_name: Command to search for
235
:return: None if no command was found, name of a command otherwise
238
for name in all_command_names():
240
cmd = get_cmd_object(name)
241
names.update(cmd.aliases)
242
# candidate: modified levenshtein distance against cmd_name.
244
from . import patiencediff
245
for name in sorted(names):
246
matcher = patiencediff.PatienceSequenceMatcher(None, cmd_name, name)
248
opcodes = matcher.get_opcodes()
249
for opcode, l1, l2, r1, r2 in opcodes:
250
if opcode == 'delete':
252
elif opcode == 'replace':
253
distance += max(l2-l1, r2-l1)
254
elif opcode == 'insert':
256
elif opcode == 'equal':
257
# Score equal ranges lower, making similar commands of equal
258
# length closer than arbitrary same length commands.
259
distance -= 0.1 * (l2-l1)
260
costs[name] = distance
261
costs.update(_GUESS_OVERRIDES.get(cmd_name, {}))
262
costs = sorted((value, key) for key, value in costs.iteritems())
267
candidate = costs[0][1]
233
271
def get_cmd_object(cmd_name, plugins_override=True):
234
272
"""Return the command object for a command.
240
278
return _get_cmd_object(cmd_name, plugins_override)
242
raise errors.BzrCommandError('unknown command "%s"' % cmd_name)
280
# No command found, see if this was a typo
281
candidate = guess_command(cmd_name)
282
if candidate is not None:
283
raise errors.BzrCommandError(
284
gettext('unknown command "%s". Perhaps you meant "%s"')
285
% (cmd_name, candidate))
286
raise errors.BzrCommandError(gettext('unknown command "%s"')
245
290
def _get_cmd_object(cmd_name, plugins_override=True, check_missing=True):
357
404
summary, then a complete description of the command. A grammar
358
405
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
407
:cvar aliases: Other accepted names for this command.
409
:cvar takes_args: List of argument forms, marked with whether they are
410
optional, repeated, etc. Examples::
412
['to_location', 'from_branch?', 'file*']
414
* 'to_location' is required
415
* 'from_branch' is optional
416
* 'file' can be specified 0 or more times
418
:cvar takes_options: List of options that may be given for this command.
419
These can be either strings, referring to globally-defined options, or
420
option objects. Retrieve through options().
422
:cvar hidden: If true, this command isn't advertised. This is typically
382
423
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
425
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
426
been setup to properly handle encoding of unicode strings.
427
encoding_type determines what will happen when characters cannot be
430
* strict - abort if we cannot decode
431
* replace - put in a bogus character (typically '?')
432
* exact - do not encode sys.stdout
434
NOTE: by default on Windows, sys.stdout is opened as a text stream,
435
therefore LF line-endings are converted to CRLF. When a command uses
436
encoding_type = 'exact', then sys.stdout is forced to be a binary
437
stream, and line-endings will not mangled.
440
A string indicating the real name under which this command was
441
invoked, before expansion of aliases.
442
(This may be None if the command was constructed and run in-process.)
399
444
:cvar hooks: An instance of CommandHooks.
446
:cvar __doc__: The help shown by 'brz help command' for this command.
447
This is set by assigning explicitly to __doc__ so that -OO can
451
__doc__ = "My help goes here"
403
455
takes_options = []
404
456
encoding_type = 'strict'
408
462
def __init__(self):
409
463
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
412
464
# List of standard options directly supported
413
465
self.supported_std_options = []
414
466
self._setup_run()
436
488
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
490
def _usage(self):
452
491
"""Return single-line grammar for this command.
454
493
Only describes arguments, not options.
456
s = 'bzr ' + self.name() + ' '
495
s = 'brz ' + self.name() + ' '
457
496
for aname in self.takes_args:
458
497
aname = aname.upper()
459
498
if aname[-1] in ['$', '+']:
481
520
usage help (e.g. Purpose, Usage, Options) with a
482
521
message explaining how to obtain full help.
524
i18n.install() # Install i18n only for get_help_text for now.
484
525
doc = self.help()
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
527
# Note: If self.gettext() translates ':Usage:\n', the section will
528
# be shown after "Description" section and we don't want to
529
# translate the usage string.
530
# Though, brz export-pot don't exports :Usage: section and it must
532
doc = self.gettext(doc)
534
doc = gettext("No help for this command.")
488
536
# Extract the summary (purpose) and sections out from the text
489
537
purpose,sections,order = self._get_help_parts(doc)
491
539
# If a custom usage section was provided, use it
492
if sections.has_key('Usage'):
540
if 'Usage' in sections:
493
541
usage = sections.pop('Usage')
495
543
usage = self._usage()
497
545
# The header is the purpose and usage
499
result += ':Purpose: %s\n' % purpose
547
result += gettext(':Purpose: %s\n') % (purpose,)
500
548
if usage.find('\n') >= 0:
501
result += ':Usage:\n%s\n' % usage
549
result += gettext(':Usage:\n%s\n') % (usage,)
503
result += ':Usage: %s\n' % usage
551
result += gettext(':Usage: %s\n') % (usage,)
506
554
# Add the options
508
556
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
557
# 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:
559
parser = option.get_optparser(self.options())
560
options = parser.format_option_help()
561
# FIXME: According to the spec, ReST option lists actually don't
562
# support options like --1.14 so that causes syntax errors (in Sphinx
563
# at least). As that pattern always appears in the commands that
564
# break, we trap on that and then format that block of 'format' options
565
# as a literal block. We use the most recent format still listed so we
566
# don't have to do that too often -- vila 20110514
567
if not plain and options.find(' --1.14 ') != -1:
518
568
options = options.replace(' format:\n', ' format::\n\n', 1)
519
569
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:'):]
570
result += gettext(':Options:%s') % (options[len('options:'):],)
525
572
result += options
529
576
# Add the description, indenting it 2 spaces
530
577
# to match the indentation of the options
531
if sections.has_key(None):
532
579
text = sections.pop(None)
533
580
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
581
result += gettext(':Description:\n %s\n\n') % (text,)
536
583
# Add the custom sections (e.g. Examples). Note that there's no need
537
584
# to indent these as they must be indented already in the source.
539
586
for label in order:
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
587
if label in sections:
588
result += ':%s:\n%s\n' % (label, sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
591
result += (gettext("See brz help %s for more details and examples.\n\n")
547
594
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
596
result += gettext(':Aliases: ')
550
597
result += ', '.join(self.aliases) + '\n'
551
598
plugin_name = self.plugin_name()
552
599
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
600
result += gettext(':From: plugin "%s"\n') % plugin_name
554
601
see_also = self.get_see_also(additional_see_also)
556
603
if not plain and see_also_as_links:
562
609
see_also_links.append(item)
564
611
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
612
link_text = gettext(":doc:`{0} <{1}-help>`").format(
566
614
see_also_links.append(link_text)
567
615
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
616
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
571
618
# 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)
620
import breezy.help_topics
621
result = breezy.help_topics.help_as_plain_text(result)
653
700
def run_argv_aliases(self, argv, alias_argv=None):
654
701
"""Parse the command line and run with extra aliases in alias_argv."""
655
702
args, opts = parse_args(self, argv, alias_argv)
657
705
# Process the standard options
658
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
706
if 'help' in opts: # e.g. brz add --help
707
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))
709
if 'usage' in opts: # e.g. brz add --usage
710
self.outf.write(self.get_help_text(verbose=False))
664
712
trace.set_verbosity_level(option._verbosity_level)
665
713
if 'verbose' in self.supported_std_options:
666
714
opts['verbose'] = trace.is_verbose()
667
elif opts.has_key('verbose'):
715
elif 'verbose' in opts:
668
716
del opts['verbose']
669
717
if 'quiet' in self.supported_std_options:
670
718
opts['quiet'] = trace.is_quiet()
671
elif opts.has_key('quiet'):
719
elif 'quiet' in opts:
672
720
del opts['quiet']
674
721
# mix arguments and options into one dictionary
675
722
cmdargs = _match_argform(self.name(), self.takes_args, args)
680
727
all_cmd_args = cmdargs.copy()
681
728
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
731
return self.run(**all_cmd_args)
733
# reset it, so that other commands run in the same process won't
734
# inherit state. Before we reset it, log any activity, so that it
735
# gets properly tracked.
736
ui.ui_factory.log_transport_activity(
737
display=('bytes' in debug.debug_flags))
738
trace.set_verbosity_level(0)
687
740
def _setup_run(self):
688
741
"""Wrap the defined run method on self with a cleanup.
696
749
class_run = self.run
697
750
def run(*args, **kwargs):
751
for hook in Command.hooks['pre_command']:
698
753
self._operation = cleanup.OperationWithCleanups(class_run)
700
755
return self._operation.run_simple(*args, **kwargs)
702
757
del self._operation
758
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
763
"""Actually run the command.
762
822
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
825
Hooks.__init__(self, "breezy.commands", "Command.hooks")
826
self.add_hook('extend_command',
767
827
"Called after creating a command object to allow modifications "
768
828
"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',
829
"new breezy.commands.Command object.", (1, 13))
830
self.add_hook('get_command',
771
831
"Called when creating a single command. Called with "
772
832
"(cmd_or_None, command_name). get_command should either return "
773
833
"the cmd_or_None parameter, or a replacement Command object that "
774
834
"should be used for the command. Note that the Command.hooks "
775
835
"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',
836
"breezy.commands.register_command or plugin_cmds.register_lazy.",
838
self.add_hook('get_missing_command',
779
839
"Called when creating a single command if no command could be "
780
840
"found. Called with (command_name). get_missing_command should "
781
841
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
843
self.add_hook('list_commands',
784
844
"Called when enumerating commands. Called with a set of "
785
845
"cmd_name strings for all the commands found so far. This set "
786
846
" is safe to mutate - e.g. to remove a command. "
787
847
"list_commands should return the updated set of command names.",
849
self.add_hook('pre_command',
850
"Called prior to executing a command. Called with the command "
852
self.add_hook('post_command',
853
"Called after executing a command. Called with the command "
790
856
Command.hooks = CommandHooks()
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])
874
# for python 2.5 and later, optparse raises this exception if a non-ascii
875
# option name is given. See http://bugs.python.org/issue2931
877
options, args = parser.parse_args(args)
878
except UnicodeEncodeError as e:
879
raise errors.BzrCommandError(
880
gettext('Only ASCII permitted in option names'))
882
opts = dict((k, v) for k, v in options.__dict__.items() if
883
v is not option.OptionParser.DEFAULT_VALUE)
811
884
return args, opts
828
901
argdict[argname + '_list'] = None
829
902
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
904
raise errors.BzrCommandError(gettext(
905
"command {0!r} needs one or more {1}").format(
906
cmd, argname.upper()))
834
908
argdict[argname + '_list'] = args[:]
836
910
elif ap[-1] == '$': # all but one
837
911
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
912
raise errors.BzrCommandError(
913
gettext("command {0!r} needs one or more {1}").format(
914
cmd, argname.upper()))
840
915
argdict[argname + '_list'] = args[:-1]
843
918
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
921
raise errors.BzrCommandError(
922
gettext("command {0!r} requires argument {1}").format(
923
cmd, argname.upper()))
849
925
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
928
raise errors.BzrCommandError( gettext(
929
"extra argument to command {0}: {1}").format(
857
934
def apply_coveraged(dirname, the_callable, *args, **kwargs):
858
# Cannot use "import trace", as that would import bzrlib.trace instead of
935
# Cannot use "import trace", as that would import breezy.trace instead of
859
936
# the standard library's trace.
860
937
trace = __import__('trace')
907
984
return the_callable(*args, **kwargs)
908
except (KeyboardInterrupt, Exception), e:
985
except (KeyboardInterrupt, Exception) as e:
909
986
# used to handle AssertionError and KeyboardInterrupt
910
987
# specially here, but hopefully they're handled ok by the logger now
911
988
exc_info = sys.exc_info()
912
989
exitcode = trace.report_exception(exc_info, sys.stderr)
913
if os.environ.get('BZR_PDB'):
914
print '**** entering debugger'
990
if os.environ.get('BRZ_PDB'):
991
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])
993
pdb.post_mortem(exc_info[2])
940
997
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)
998
from breezy.lsprof import profile
999
ret, stats = profile(exception_to_return_code, the_callable,
944
1002
if filename is None:
947
1005
stats.save(filename)
948
trace.note('Profile data written to "%s".', filename)
1006
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
1010
def get_alias(cmd, config=None):
958
1011
"""Return an expanded alias, or None if no alias exists.
1015
1068
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)
1070
trace.mutter("breezy version: " + breezy.__version__)
1071
argv = _specified_or_unicode_argv(argv)
1072
trace.mutter("brz arguments: %r", argv)
1021
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1022
opt_no_aliases = False
1074
opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1075
opt_no_l10n = opt_no_aliases = False
1023
1076
opt_lsprof_file = opt_coverage_dir = None
1025
1078
# --no-plugins is handled specially at a very early stage. We need
1042
1096
opt_no_plugins = True
1043
1097
elif a == '--no-aliases':
1044
1098
opt_no_aliases = True
1099
elif a == '--no-l10n':
1045
1101
elif a == '--builtin':
1046
1102
opt_builtin = True
1047
1103
elif a == '--concurrency':
1048
os.environ['BZR_CONCURRENCY'] = argv[i + 1]
1104
os.environ['BRZ_CONCURRENCY'] = argv[i + 1]
1050
1106
elif a == '--coverage':
1051
1107
opt_coverage_dir = argv[i + 1]
1109
elif a == '--profile-imports':
1110
pass # already handled in startup script Bug #588277
1053
1111
elif a.startswith('-D'):
1054
1112
debug.debug_flags.add(a[2:])
1113
elif a.startswith('-O'):
1114
override_config.append(a[2:])
1056
1116
argv_copy.append(a)
1119
if breezy.global_state is None:
1120
# FIXME: Workaround for users that imported breezy but didn't call
1121
# breezy.initialize -- vila 2012-01-19
1122
cmdline_overrides = config.CommandLineStore()
1124
cmdline_overrides = breezy.global_state.cmdline_overrides
1125
cmdline_overrides._from_cmdline(override_config)
1059
1127
debug.set_debug_flags_from_config()
1061
1129
if not opt_no_plugins:
1077
1145
if not opt_no_aliases:
1078
1146
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
1148
argv[0] = alias_argv.pop(0)
1084
1150
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
1151
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1153
cmd_obj.l10n = False
1090
1154
run = cmd_obj.run_argv_aliases
1091
1155
run_argv = [argv, alias_argv]
1178
1245
def main(argv=None):
1179
1246
"""Main entry point of command-line interface.
1181
Typically `bzrlib.initialize` should be called first.
1248
Typically `breezy.initialize` should be called first.
1183
1250
:param argv: list of unicode command-line arguments similar to sys.argv.
1184
1251
argv[0] is script name usually, it will be ignored.
1185
1252
Don't pass here sys.argv because this list contains plain strings
1186
1253
and not unicode; pass None instead.
1188
:return: exit code of bzr command.
1255
:return: exit code of brz command.
1190
argv = _specified_or_unicode_argv(argv)
1257
if argv is not None:
1191
1259
_register_builtin_commands()
1192
1260
ret = run_bzr_catch_errors(argv)
1193
bzrlib.ui.ui_factory.log_transport_activity(
1194
display=('bytes' in debug.debug_flags))
1195
1261
trace.mutter("return code %d", ret)
1252
1318
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1319
"""Generic class to be overriden by plugins"""
1255
1321
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1322
"""Takes a command and returns the information for that plugin
1258
1324
:return: A dictionary with all the available information
1259
for the requested plugin
1325
for the requested plugin
1261
1327
raise NotImplementedError
1264
1330
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1331
"""This registry exists to allow other providers to exist"""
1267
1333
def __iter__(self):
1268
for key, provider in self.iteritems():
1334
for key, provider in self.items():
1271
1337
command_providers_registry = ProvidersRegistry()
added
removed
breezy/commands.py
