← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-18 13:02:52 UTC
  • mfrom: (5830.3.6 i18n-msgfmt)
  • Revision ID: pqm@pqm.ubuntu.com-20110518130252-ky96qcvzt6o0zg3f
(mbp) add build_mo command to setup.py (INADA Naoki)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
36
36
    cmdline,
37
37
    debug,
38
38
    errors,
39
 
    i18n,
40
39
    option,
41
40
    osutils,
42
41
    trace,
45
44
""")
46
45
 
47
46
from bzrlib.hooks import Hooks
48
 
from bzrlib.i18n import gettext
49
47
# Compatibility - Option used to be in commands.
50
48
from bzrlib.option import Option
51
49
from bzrlib.plugin import disable_plugins, load_plugins
359
357
    summary, then a complete description of the command.  A grammar
360
358
    description will be inserted.
361
359
 
362
 
    :cvar aliases: Other accepted names for this command.
363
 
 
364
 
    :cvar takes_args: List of argument forms, marked with whether they are
365
 
        optional, repeated, etc.  Examples::
366
 
 
367
 
            ['to_location', 'from_branch?', 'file*']
368
 
 
369
 
        * 'to_location' is required
370
 
        * 'from_branch' is optional
371
 
        * 'file' can be specified 0 or more times
372
 
 
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().
376
 
 
377
 
    :cvar hidden: If true, this command isn't advertised.  This is typically
 
360
    aliases
 
361
        Other accepted names for this command.
 
362
 
 
363
    takes_args
 
364
        List of argument forms, marked with whether they are optional,
 
365
        repeated, etc.
 
366
 
 
367
                Examples:
 
368
 
 
369
                ['to_location', 'from_branch?', 'file*']
 
370
 
 
371
                'to_location' is required
 
372
                'from_branch' is optional
 
373
                'file' can be specified 0 or more times
 
374
 
 
375
    takes_options
 
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().
 
379
 
 
380
    hidden
 
381
        If true, this command isn't advertised.  This is typically
378
382
        for commands intended for expert users.
379
383
 
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
383
 
        encoded:
384
 
 
385
 
        * strict - abort if we cannot decode
386
 
        * replace - put in a bogus character (typically '?')
387
 
        * exact - do not encode sys.stdout
388
 
 
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.
393
 
 
394
 
    :cvar invoked_as:
 
384
    encoding_type
 
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
 
388
        be encoded
 
389
            strict - abort if we cannot decode
 
390
            replace - put in a bogus character (typically '?')
 
391
            exact - do not encode sys.stdout
 
392
 
 
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
 
397
            will not mangled.
 
398
 
 
399
    :ivar invoked_as:
395
400
        A string indicating the real name under which this command was
396
 
        invoked, before expansion of aliases.
 
401
        invoked, before expansion of aliases. 
397
402
        (This may be None if the command was constructed and run in-process.)
398
403
 
399
404
    :cvar hooks: An instance of CommandHooks.
400
405
 
401
 
    :cvar __doc__: The help shown by 'bzr help command' for this command.
 
406
    :ivar __doc__: The help shown by 'bzr help command' for this command.
402
407
        This is set by assigning explicitly to __doc__ so that -OO can
403
408
        be used::
404
409
 
405
 
            class Foo(Command):
406
 
                __doc__ = "My help goes here"
 
410
        class Foo(Command):
 
411
            __doc__ = "My help goes here"
407
412
    """
408
413
    aliases = []
409
414
    takes_args = []
410
415
    takes_options = []
411
416
    encoding_type = 'strict'
412
417
    invoked_as = None
413
 
    l10n = True
414
418
 
415
419
    hidden = False
416
420
 
488
492
            usage help (e.g. Purpose, Usage, Options) with a
489
493
            message explaining how to obtain full help.
490
494
        """
491
 
        if self.l10n and not i18n.installed():
492
 
            i18n.install()  # Install i18n only for get_help_text for now.
493
495
        doc = self.help()
494
 
        if doc:
495
 
            # Note: If self.gettext() translates ':Usage:\n', the section will
496
 
            # be shown after "Description" section and we don't want to
497
 
            # translate the usage string.
498
 
            # Though, bzr export-pot don't exports :Usage: section and it must
499
 
            # not be translated.
500
 
            doc = self.gettext(doc)
501
 
        else:
502
 
            doc = gettext("No help for this command.")
 
496
        if not doc:
 
497
            doc = "No help for this command."
503
498
 
504
499
        # Extract the summary (purpose) and sections out from the text
505
500
        purpose,sections,order = self._get_help_parts(doc)
512
507
 
513
508
        # The header is the purpose and usage
514
509
        result = ""
515
 
        result += gettext(':Purpose: %s\n') % (purpose,)
 
510
        result += ':Purpose: %s\n' % purpose
516
511
        if usage.find('\n') >= 0:
517
 
            result += gettext(':Usage:\n%s\n') % (usage,)
 
512
            result += ':Usage:\n%s\n' % usage
518
513
        else:
519
 
            result += gettext(':Usage:   %s\n') % (usage,)
 
514
            result += ':Usage:   %s\n' % usage
520
515
        result += '\n'
521
516
 
522
517
        # Add the options
524
519
        # XXX: optparse implicitly rewraps the help, and not always perfectly,
525
520
        # so we get <https://bugs.launchpad.net/bzr/+bug/249908>.  -- mbp
526
521
        # 20090319
527
 
        parser = option.get_optparser(self.options())
528
 
        options = parser.format_option_help()
 
522
        options = option.get_optparser(self.options()).format_option_help()
529
523
        # FIXME: According to the spec, ReST option lists actually don't
530
524
        # support options like --1.14 so that causes syntax errors (in Sphinx
531
525
        # at least).  As that pattern always appears in the commands that
535
529
        if not plain and options.find('  --1.14  ') != -1:
536
530
            options = options.replace(' format:\n', ' format::\n\n', 1)
537
531
        if options.startswith('Options:'):
538
 
            result += gettext(':Options:%s') % (options[len('options:'):],)
 
532
            result += ':' + options
 
533
        elif options.startswith('options:'):
 
534
            # Python 2.4 version of optparse
 
535
            result += ':Options:' + options[len('options:'):]
539
536
        else:
540
537
            result += options
541
538
        result += '\n'
546
543
            if sections.has_key(None):
547
544
                text = sections.pop(None)
548
545
                text = '\n  '.join(text.splitlines())
549
 
                result += gettext(':Description:\n  %s\n\n') % (text,)
 
546
                result += ':%s:\n  %s\n\n' % ('Description',text)
550
547
 
551
548
            # Add the custom sections (e.g. Examples). Note that there's no need
552
549
            # to indent these as they must be indented already in the source.
553
550
            if sections:
554
551
                for label in order:
555
 
                    if label in sections:
556
 
                        result += ':%s:\n%s\n' % (label, sections[label])
 
552
                    if sections.has_key(label):
 
553
                        result += ':%s:\n%s\n' % (label,sections[label])
557
554
                result += '\n'
558
555
        else:
559
 
            result += (gettext("See bzr help %s for more details and examples.\n\n")
 
556
            result += ("See bzr help %s for more details and examples.\n\n"
560
557
                % self.name())
561
558
 
562
559
        # Add the aliases, source (plug-in) and see also links, if any
563
560
        if self.aliases:
564
 
            result += gettext(':Aliases:  ')
 
561
            result += ':Aliases:  '
565
562
            result += ', '.join(self.aliases) + '\n'
566
563
        plugin_name = self.plugin_name()
567
564
        if plugin_name is not None:
568
 
            result += gettext(':From:     plugin "%s"\n') % plugin_name
 
565
            result += ':From:     plugin "%s"\n' % plugin_name
569
566
        see_also = self.get_see_also(additional_see_also)
570
567
        if see_also:
571
568
            if not plain and see_also_as_links:
577
574
                        see_also_links.append(item)
578
575
                    else:
579
576
                        # Use a Sphinx link for this entry
580
 
                        link_text = gettext(":doc:`%s <%s-help>`") % (item, item)
 
577
                        link_text = ":doc:`%s <%s-help>`" % (item, item)
581
578
                        see_also_links.append(link_text)
582
579
                see_also = see_also_links
583
 
            result += gettext(':See also: %s') % ', '.join(see_also) + '\n'
 
580
            result += ':See also: '
 
581
            result += ', '.join(see_also) + '\n'
584
582
 
585
583
        # If this will be rendered as plain text, convert it
586
584
        if plain:
667
665
    def run_argv_aliases(self, argv, alias_argv=None):
668
666
        """Parse the command line and run with extra aliases in alias_argv."""
669
667
        args, opts = parse_args(self, argv, alias_argv)
670
 
        self._setup_outf()
671
668
 
672
669
        # Process the standard options
673
670
        if 'help' in opts:  # e.g. bzr add --help
674
 
            self.outf.write(self.get_help_text())
 
671
            sys.stdout.write(self.get_help_text())
675
672
            return 0
676
673
        if 'usage' in opts:  # e.g. bzr add --usage
677
 
            self.outf.write(self.get_help_text(verbose=False))
 
674
            sys.stdout.write(self.get_help_text(verbose=False))
678
675
            return 0
679
676
        trace.set_verbosity_level(option._verbosity_level)
680
677
        if 'verbose' in self.supported_std_options:
695
692
        all_cmd_args = cmdargs.copy()
696
693
        all_cmd_args.update(cmdopts)
697
694
 
 
695
        self._setup_outf()
 
696
 
698
697
        try:
699
698
            return self.run(**all_cmd_args)
700
699
        finally:
759
758
            return None
760
759
        return getdoc(self)
761
760
 
762
 
    def gettext(self, message):
763
 
        """Returns the gettext function used to translate this command's help.
764
 
 
765
 
        Commands provided by plugins should override this to use their
766
 
        own i18n system.
767
 
        """
768
 
        return i18n.gettext_per_paragraph(message)
769
 
 
770
761
    def name(self):
771
762
        """Return the canonical name for this command.
772
763
 
1057
1048
    argv = _specified_or_unicode_argv(argv)
1058
1049
    trace.mutter("bzr arguments: %r", argv)
1059
1050
 
1060
 
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin = \
1061
 
            opt_no_l10n = opt_no_aliases = False
 
1051
    opt_lsprof = opt_profile = opt_no_plugins = opt_builtin =  \
 
1052
                opt_no_aliases = False
1062
1053
    opt_lsprof_file = opt_coverage_dir = None
1063
1054
 
1064
1055
    # --no-plugins is handled specially at a very early stage. We need
1081
1072
            opt_no_plugins = True
1082
1073
        elif a == '--no-aliases':
1083
1074
            opt_no_aliases = True
1084
 
        elif a == '--no-l10n':
1085
 
            opt_no_l10n = True
1086
1075
        elif a == '--builtin':
1087
1076
            opt_builtin = True
1088
1077
        elif a == '--concurrency':
1124
1113
 
1125
1114
    cmd = argv.pop(0)
1126
1115
    cmd_obj = get_cmd_object(cmd, plugins_override=not opt_builtin)
1127
 
    if opt_no_l10n:
1128
 
        cmd.l10n = False
1129
1116
    run = cmd_obj.run_argv_aliases
1130
1117
    run_argv = [argv, alias_argv]
1131
1118
 
1288
1275
 
1289
1276
 
1290
1277
class Provider(object):
1291
 
    """Generic class to be overriden by plugins"""
 
1278
    '''Generic class to be overriden by plugins'''
1292
1279
 
1293
1280
    def plugin_for_command(self, cmd_name):
1294
 
        """Takes a command and returns the information for that plugin
 
1281
        '''Takes a command and returns the information for that plugin
1295
1282
 
1296
1283
        :return: A dictionary with all the available information
1297
 
            for the requested plugin
1298
 
        """
 
1284
        for the requested plugin
 
1285
        '''
1299
1286
        raise NotImplementedError
1300
1287
 
1301
1288
 
1302
1289
class ProvidersRegistry(registry.Registry):
1303
 
    """This registry exists to allow other providers to exist"""
 
1290
    '''This registry exists to allow other providers to exist'''
1304
1291
 
1305
1292
    def __iter__(self):
1306
1293
        for key, provider in self.iteritems():