← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
25
25
from bzrlib import (
26
26
    errors,
27
27
    revisionspec,
 
28
    i18n,
28
29
    )
29
30
""")
30
31
 
312
313
 
313
314
    def __init__(self, name, help, registry=None, converter=None,
314
315
        value_switches=False, title=None, enum_switch=True,
315
 
        lazy_registry=None):
 
316
        lazy_registry=None, short_name=None, short_value_switches=None):
316
317
        """
317
318
        Constructor.
318
319
 
328
329
            which takes a value.
329
330
        :param lazy_registry: A tuple of (module name, attribute name) for a
330
331
            registry to be lazily loaded.
 
332
        :param short_name: The short name for the enum switch, if any
 
333
        :param short_value_switches: A dict mapping values to short names
331
334
        """
332
 
        Option.__init__(self, name, help, type=self.convert)
 
335
        Option.__init__(self, name, help, type=self.convert, short_name=short_name)
333
336
        self._registry = registry
334
337
        if registry is None:
335
338
            if lazy_registry is None:
344
347
        self.converter = converter
345
348
        self.value_switches = value_switches
346
349
        self.enum_switch = enum_switch
 
350
        self.short_value_switches = short_value_switches
347
351
        self.title = title
348
352
        if self.title is None:
349
353
            self.title = name
387
391
                    help = optparse.SUPPRESS_HELP
388
392
                else:
389
393
                    help = self.registry.get_help(key)
 
394
                if (self.short_value_switches and
 
395
                    key in self.short_value_switches):
 
396
                    option_strings.append('-%s' %
 
397
                                          self.short_value_switches[key])
390
398
                parser.add_option(action='callback',
391
399
                              callback=self._optparse_value_callback(key),
392
400
                                  help=help,
422
430
 
423
431
    DEFAULT_VALUE = object()
424
432
 
 
433
    def __init__(self):
 
434
        optparse.OptionParser.__init__(self)
 
435
        self.formatter = GettextIndentedHelpFormatter()
 
436
 
425
437
    def error(self, message):
426
438
        raise errors.BzrCommandError(message)
427
439
 
 
440
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
 
441
    """Adds gettext() call to format_option()"""
 
442
    def __init__(self):
 
443
        optparse.IndentedHelpFormatter.__init__(self)
 
444
 
 
445
    def format_option(self, option):
 
446
        """code taken from Python's optparse.py"""
 
447
        if option.help:
 
448
            option.help = i18n.gettext(option.help)
 
449
        return optparse.IndentedHelpFormatter.format_option(self, option)
428
450
 
429
451
def get_optparser(options):
430
452
    """Generate an optparse parser for bzrlib-style options"""
555
577
_global_option('update')
556
578
_global_registry_option('log-format', "Use specified log format.",
557
579
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
558
 
                        value_switches=True, title='Log format')
 
580
                        value_switches=True, title='Log format',
 
581
                        short_value_switches={'short': 'S'})
559
582
_global_option('long', help='Use detailed log format. Same as --log-format long',
560
583
               short_name='l')
561
584
_global_option('short', help='Use moderately short log format. Same as --log-format short')