28
29
from bzrlib.lazy_import import lazy_import
29
30
lazy_import(globals(), """
33
from warnings import warn
36
35
from bzrlib import (
49
from bzrlib.hooks import HookPoint, Hooks
49
from bzrlib.hooks import Hooks
50
from bzrlib.i18n import gettext
50
51
# Compatibility - Option used to be in commands.
51
52
from bzrlib.option import Option
52
53
from bzrlib.plugin import disable_plugins, load_plugins
53
54
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
61
57
class CommandInfo(object):
357
346
summary, then a complete description of the command. A grammar
358
347
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
349
:cvar aliases: Other accepted names for this command.
351
:cvar takes_args: List of argument forms, marked with whether they are
352
optional, repeated, etc. Examples::
354
['to_location', 'from_branch?', 'file*']
356
* 'to_location' is required
357
* 'from_branch' is optional
358
* 'file' can be specified 0 or more times
360
:cvar takes_options: List of options that may be given for this command.
361
These can be either strings, referring to globally-defined options, or
362
option objects. Retrieve through options().
364
:cvar hidden: If true, this command isn't advertised. This is typically
382
365
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
367
:cvar encoding_type: Command objects will get a 'outf' attribute, which has
368
been setup to properly handle encoding of unicode strings.
369
encoding_type determines what will happen when characters cannot be
372
* strict - abort if we cannot decode
373
* replace - put in a bogus character (typically '?')
374
* exact - do not encode sys.stdout
376
NOTE: by default on Windows, sys.stdout is opened as a text stream,
377
therefore LF line-endings are converted to CRLF. When a command uses
378
encoding_type = 'exact', then sys.stdout is forced to be a binary
379
stream, and line-endings will not mangled.
382
A string indicating the real name under which this command was
383
invoked, before expansion of aliases.
384
(This may be None if the command was constructed and run in-process.)
399
386
:cvar hooks: An instance of CommandHooks.
388
:cvar __doc__: The help shown by 'bzr help command' for this command.
389
This is set by assigning explicitly to __doc__ so that -OO can
393
__doc__ = "My help goes here"
403
397
takes_options = []
404
398
encoding_type = 'strict'
408
404
def __init__(self):
409
405
"""Construct an instance of this command."""
410
if self.__doc__ == Command.__doc__:
411
warn("No help message set for %r" % self)
412
406
# List of standard options directly supported
413
407
self.supported_std_options = []
414
408
self._setup_run()
481
462
usage help (e.g. Purpose, Usage, Options) with a
482
463
message explaining how to obtain full help.
466
i18n.install() # Install i18n only for get_help_text for now.
484
467
doc = self.help()
486
raise NotImplementedError("sorry, no detailed help yet for %r" % self.name())
469
# Note: If self.gettext() translates ':Usage:\n', the section will
470
# be shown after "Description" section and we don't want to
471
# translate the usage string.
472
# Though, bzr export-pot don't exports :Usage: section and it must
474
doc = self.gettext(doc)
476
doc = gettext("No help for this command.")
488
478
# Extract the summary (purpose) and sections out from the text
489
479
purpose,sections,order = self._get_help_parts(doc)
508
498
# XXX: optparse implicitly rewraps the help, and not always perfectly,
509
499
# 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:
501
parser = option.get_optparser(self.options())
502
options = parser.format_option_help()
503
# FIXME: According to the spec, ReST option lists actually don't
504
# support options like --1.14 so that causes syntax errors (in Sphinx
505
# at least). As that pattern always appears in the commands that
506
# break, we trap on that and then format that block of 'format' options
507
# as a literal block. We use the most recent format still listed so we
508
# don't have to do that too often -- vila 20110514
509
if not plain and options.find(' --1.14 ') != -1:
518
510
options = options.replace(' format:\n', ' format::\n\n', 1)
519
511
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:'):]
512
result += gettext(':Options:%s') % (options[len('options:'):],)
525
514
result += options
531
520
if sections.has_key(None):
532
521
text = sections.pop(None)
533
522
text = '\n '.join(text.splitlines())
534
result += ':%s:\n %s\n\n' % ('Description',text)
523
result += gettext(':Description:\n %s\n\n') % (text,)
536
525
# Add the custom sections (e.g. Examples). Note that there's no need
537
526
# to indent these as they must be indented already in the source.
539
528
for label in order:
540
if sections.has_key(label):
541
result += ':%s:\n%s\n' % (label,sections[label])
529
if label in sections:
530
result += ':%s:\n%s\n' % (label, sections[label])
544
result += ("See bzr help %s for more details and examples.\n\n"
533
result += (gettext("See bzr help %s for more details and examples.\n\n")
547
536
# Add the aliases, source (plug-in) and see also links, if any
549
result += ':Aliases: '
538
result += gettext(':Aliases: ')
550
539
result += ', '.join(self.aliases) + '\n'
551
540
plugin_name = self.plugin_name()
552
541
if plugin_name is not None:
553
result += ':From: plugin "%s"\n' % plugin_name
542
result += gettext(':From: plugin "%s"\n') % plugin_name
554
543
see_also = self.get_see_also(additional_see_also)
556
545
if not plain and see_also_as_links:
562
551
see_also_links.append(item)
564
553
# Use a Sphinx link for this entry
565
link_text = ":doc:`%s <%s-help>`" % (item, item)
554
link_text = gettext(":doc:`{0} <{1}-help>`").format(
566
556
see_also_links.append(link_text)
567
557
see_also = see_also_links
568
result += ':See also: '
569
result += ', '.join(see_also) + '\n'
558
result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
571
560
# If this will be rendered as plain text, convert it
653
642
def run_argv_aliases(self, argv, alias_argv=None):
654
643
"""Parse the command line and run with extra aliases in alias_argv."""
655
644
args, opts = parse_args(self, argv, alias_argv)
657
647
# Process the standard options
658
648
if 'help' in opts: # e.g. bzr add --help
659
sys.stdout.write(self.get_help_text())
649
self.outf.write(self.get_help_text())
661
651
if 'usage' in opts: # e.g. bzr add --usage
662
sys.stdout.write(self.get_help_text(verbose=False))
652
self.outf.write(self.get_help_text(verbose=False))
664
654
trace.set_verbosity_level(option._verbosity_level)
665
655
if 'verbose' in self.supported_std_options:
680
669
all_cmd_args = cmdargs.copy()
681
670
all_cmd_args.update(cmdopts)
685
return self.run(**all_cmd_args)
673
return self.run(**all_cmd_args)
675
# reset it, so that other commands run in the same process won't
676
# inherit state. Before we reset it, log any activity, so that it
677
# gets properly tracked.
678
ui.ui_factory.log_transport_activity(
679
display=('bytes' in debug.debug_flags))
680
trace.set_verbosity_level(0)
687
682
def _setup_run(self):
688
683
"""Wrap the defined run method on self with a cleanup.
762
764
These are all empty initially, because by default nothing should get
766
self.create_hook(HookPoint('extend_command',
767
Hooks.__init__(self, "bzrlib.commands", "Command.hooks")
768
self.add_hook('extend_command',
767
769
"Called after creating a command object to allow modifications "
768
770
"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',
771
"new bzrlib.commands.Command object.", (1, 13))
772
self.add_hook('get_command',
771
773
"Called when creating a single command. Called with "
772
774
"(cmd_or_None, command_name). get_command should either return "
773
775
"the cmd_or_None parameter, or a replacement Command object that "
774
776
"should be used for the command. Note that the Command.hooks "
775
777
"hooks are core infrastructure. Many users will prefer to use "
776
778
"bzrlib.commands.register_command or plugin_cmds.register_lazy.",
778
self.create_hook(HookPoint('get_missing_command',
780
self.add_hook('get_missing_command',
779
781
"Called when creating a single command if no command could be "
780
782
"found. Called with (command_name). get_missing_command should "
781
783
"either return None, or a Command object to be used for the "
782
"command.", (1, 17), None))
783
self.create_hook(HookPoint('list_commands',
785
self.add_hook('list_commands',
784
786
"Called when enumerating commands. Called with a set of "
785
787
"cmd_name strings for all the commands found so far. This set "
786
788
" is safe to mutate - e.g. to remove a command. "
787
789
"list_commands should return the updated set of command names.",
790
792
Command.hooks = CommandHooks()
808
options, args = parser.parse_args(args)
810
# for python 2.5 and later, optparse raises this exception if a non-ascii
811
# option name is given. See http://bugs.python.org/issue2931
813
options, args = parser.parse_args(args)
814
except UnicodeEncodeError,e:
815
raise errors.BzrCommandError(
816
gettext('Only ASCII permitted in option names'))
809
818
opts = dict([(k, v) for k, v in options.__dict__.iteritems() if
810
819
v is not option.OptionParser.DEFAULT_VALUE])
811
820
return args, opts
828
837
argdict[argname + '_list'] = None
829
838
elif ap[-1] == '+':
831
raise errors.BzrCommandError("command %r needs one or more %s"
832
% (cmd, argname.upper()))
840
raise errors.BzrCommandError(gettext(
841
"command {0!r} needs one or more {1}").format(
842
cmd, argname.upper()))
834
844
argdict[argname + '_list'] = args[:]
836
846
elif ap[-1] == '$': # all but one
837
847
if len(args) < 2:
838
raise errors.BzrCommandError("command %r needs one or more %s"
839
% (cmd, argname.upper()))
848
raise errors.BzrCommandError(
849
gettext("command {0!r} needs one or more {1}").format(
850
cmd, argname.upper()))
840
851
argdict[argname + '_list'] = args[:-1]
843
854
# just a plain arg
846
raise errors.BzrCommandError("command %r requires argument %s"
847
% (cmd, argname.upper()))
857
raise errors.BzrCommandError(
858
gettext("command {0!r} requires argument {1}").format(
859
cmd, argname.upper()))
849
861
argdict[argname] = args.pop(0)
852
raise errors.BzrCommandError("extra argument to command %s: %s"
864
raise errors.BzrCommandError( gettext(
865
"extra argument to command {0}: {1}").format(
940
953
def apply_lsprofiled(filename, the_callable, *args, **kwargs):
941
954
from bzrlib.lsprof import profile
942
ret, stats = profile(exception_to_return_code, the_callable, *args, **kwargs)
955
ret, stats = profile(exception_to_return_code, the_callable,
944
958
if filename is None:
947
961
stats.save(filename)
948
trace.note('Profile data written to "%s".', filename)
962
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
966
def get_alias(cmd, config=None):
958
967
"""Return an expanded alias, or None if no alias exists.
1050
1062
elif a == '--coverage':
1051
1063
opt_coverage_dir = argv[i + 1]
1065
elif a == '--profile-imports':
1066
pass # already handled in startup script Bug #588277
1053
1067
elif a.startswith('-D'):
1054
1068
debug.debug_flags.add(a[2:])
1069
elif a.startswith('-O'):
1070
override_config.append(a[2:])
1056
1072
argv_copy.append(a)
1075
if bzrlib.global_state is None:
1076
# FIXME: Workaround for users that imported bzrlib but didn't call
1077
# bzrlib.initialize -- vila 2012-01-19
1078
cmdline_overrides = config.CommandLineStore()
1080
cmdline_overrides = bzrlib.global_state.cmdline_overrides
1081
cmdline_overrides._from_cmdline(override_config)
1059
1083
debug.set_debug_flags_from_config()
1061
1085
if not opt_no_plugins:
1077
1101
if not opt_no_aliases:
1078
1102
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
1104
argv[0] = alias_argv.pop(0)
1084
1106
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
1107
cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1090
1110
run = cmd_obj.run_argv_aliases
1091
1111
run_argv = [argv, alias_argv]
1252
1274
class Provider(object):
1253
'''Generic class to be overriden by plugins'''
1275
"""Generic class to be overriden by plugins"""
1255
1277
def plugin_for_command(self, cmd_name):
1256
'''Takes a command and returns the information for that plugin
1278
"""Takes a command and returns the information for that plugin
1258
1280
:return: A dictionary with all the available information
1259
for the requested plugin
1281
for the requested plugin
1261
1283
raise NotImplementedError
1264
1286
class ProvidersRegistry(registry.Registry):
1265
'''This registry exists to allow other providers to exist'''
1287
"""This registry exists to allow other providers to exist"""
1267
1289
def __iter__(self):
1268
1290
for key, provider in self.iteritems():