argo_navis: venv/lib/python2.7/site-packages/docutils/frontend.py annotate

author	bcclaywell
date	Mon, 12 Oct 2015 17:43:33 -0400
parents
children

rev	line source
0 d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	1 # $Id: frontend.py 7584 2013-01-01 20:00:21Z milde $
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	2 # Author: David Goodger <goodger@python.org>
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	3 # Copyright: This module has been placed in the public domain.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	4
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	5 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	6 Command-line and common processing for Docutils front-end tools.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	7
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	8 Exports the following classes:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	9
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	10 * `OptionParser`: Standard Docutils command-line processing.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	11 * `Option`: Customized version of `optparse.Option`; validation support.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	12 * `Values`: Runtime settings; objects are simple structs
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	13 (``object.attribute``). Supports cumulative list settings (attributes).
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	14 * `ConfigParser`: Standard Docutils config file processing.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	15
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	16 Also exports the following functions:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	17
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	18 * Option callbacks: `store_multiple`, `read_config_file`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	19 * Setting validators: `validate_encoding`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	20 `validate_encoding_error_handler`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	21 `validate_encoding_and_error_handler`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	22 `validate_boolean`, `validate_ternary`, `validate_threshold`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	23 `validate_colon_separated_string_list`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	24 `validate_comma_separated_string_list`,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	25 `validate_dependency_file`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	26 * `make_paths_absolute`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	27 * SettingSpec manipulation: `filter_settings_spec`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	28 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	29
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	30 __docformat__ = 'reStructuredText'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	31
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	32 import os
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	33 import os.path
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	34 import sys
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	35 import warnings
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	36 import ConfigParser as CP
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	37 import codecs
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	38 import optparse
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	39 from optparse import SUPPRESS_HELP
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	40 import docutils
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	41 import docutils.utils
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	42 import docutils.nodes
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	43 from docutils.utils.error_reporting import locale_encoding, ErrorOutput, ErrorString
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	44
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	45
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	46 def store_multiple(option, opt, value, parser, args, *kwargs):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	47 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	48 Store multiple values in `parser.values`. (Option callback.)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	49
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	50 Store `None` for each attribute named in `args`, and store the value for
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	51 each key (attribute name) in `kwargs`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	52 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	53 for attribute in args:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	54 setattr(parser.values, attribute, None)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	55 for key, value in kwargs.items():
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	56 setattr(parser.values, key, value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	57
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	58 def read_config_file(option, opt, value, parser):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	59 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	60 Read a configuration file during option processing. (Option callback.)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	61 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	62 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	63 new_settings = parser.get_config_file_settings(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	64 except ValueError, error:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	65 parser.error(error)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	66 parser.values.update(new_settings, parser)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	67
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	68 def validate_encoding(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	69 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	70 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	71 codecs.lookup(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	72 except LookupError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	73 raise (LookupError('setting "%s": unknown encoding: "%s"'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	74 % (setting, value)),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	75 None, sys.exc_info()[2])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	76 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	77
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	78 def validate_encoding_error_handler(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	79 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	80 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	81 codecs.lookup_error(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	82 except LookupError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	83 raise (LookupError(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	84 'unknown encoding error handler: "%s" (choices: '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	85 '"strict", "ignore", "replace", "backslashreplace", '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	86 '"xmlcharrefreplace", and possibly others; see documentation for '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	87 'the Python ``codecs`` module)' % value),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	88 None, sys.exc_info()[2])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	89 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	90
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	91 def validate_encoding_and_error_handler(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	92 setting, value, option_parser, config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	93 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	94 Side-effect: if an error handler is included in the value, it is inserted
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	95 into the appropriate place as if it was a separate setting/option.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	96 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	97 if ':' in value:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	98 encoding, handler = value.split(':')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	99 validate_encoding_error_handler(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	100 setting + '_error_handler', handler, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	101 config_parser, config_section)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	102 if config_parser:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	103 config_parser.set(config_section, setting + '_error_handler',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	104 handler)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	105 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	106 setattr(option_parser.values, setting + '_error_handler', handler)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	107 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	108 encoding = value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	109 validate_encoding(setting, encoding, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	110 config_parser, config_section)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	111 return encoding
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	112
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	113 def validate_boolean(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	114 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	115 """Check/normalize boolean settings:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	116 True: '1', 'on', 'yes', 'true'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	117 False: '0', 'off', 'no','false', ''
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	118 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	119 if isinstance(value, bool):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	120 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	121 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	122 return option_parser.booleans[value.strip().lower()]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	123 except KeyError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	124 raise (LookupError('unknown boolean value: "%s"' % value),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	125 None, sys.exc_info()[2])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	126
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	127 def validate_ternary(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	128 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	129 """Check/normalize three-value settings:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	130 True: '1', 'on', 'yes', 'true'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	131 False: '0', 'off', 'no','false', ''
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	132 any other value: returned as-is.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	133 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	134 if isinstance(value, bool) or value is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	135 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	136 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	137 return option_parser.booleans[value.strip().lower()]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	138 except KeyError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	139 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	140
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	141 def validate_nonnegative_int(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	142 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	143 value = int(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	144 if value < 0:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	145 raise ValueError('negative value; must be positive or zero')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	146 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	147
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	148 def validate_threshold(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	149 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	150 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	151 return int(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	152 except ValueError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	153 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	154 return option_parser.thresholds[value.lower()]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	155 except (KeyError, AttributeError):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	156 raise (LookupError('unknown threshold: %r.' % value),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	157 None, sys.exc_info[2])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	158
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	159 def validate_colon_separated_string_list(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	160 setting, value, option_parser, config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	161 if not isinstance(value, list):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	162 value = value.split(':')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	163 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	164 last = value.pop()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	165 value.extend(last.split(':'))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	166 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	167
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	168 def validate_comma_separated_list(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	169 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	170 """Check/normalize list arguments (split at "," and strip whitespace).
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	171 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	172 # `value` is already a ``list`` when given as command line option
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	173 # and "action" is "append" and ``unicode`` or ``str`` else.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	174 if not isinstance(value, list):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	175 value = [value]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	176 # this function is called for every option added to `value`
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	177 # -> split the last item and append the result:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	178 last = value.pop()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	179 items = [i.strip(u' \t\n') for i in last.split(u',') if i.strip(u' \t\n')]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	180 value.extend(items)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	181 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	182
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	183 def validate_url_trailing_slash(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	184 setting, value, option_parser, config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	185 if not value:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	186 return './'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	187 elif value.endswith('/'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	188 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	189 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	190 return value + '/'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	191
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	192 def validate_dependency_file(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	193 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	194 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	195 return docutils.utils.DependencyList(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	196 except IOError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	197 return docutils.utils.DependencyList(None)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	198
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	199 def validate_strip_class(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	200 config_parser=None, config_section=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	201 # value is a comma separated string list:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	202 value = validate_comma_separated_list(setting, value, option_parser,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	203 config_parser, config_section)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	204 # validate list elements:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	205 for cls in value:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	206 normalized = docutils.nodes.make_id(cls)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	207 if cls != normalized:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	208 raise ValueError('invalid class value %r (perhaps %r?)'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	209 % (cls, normalized))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	210 return value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	211
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	212 def make_paths_absolute(pathdict, keys, base_path=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	213 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	214 Interpret filesystem path settings relative to the `base_path` given.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	215
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	216 Paths are values in `pathdict` whose keys are in `keys`. Get `keys` from
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	217 `OptionParser.relative_path_settings`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	218 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	219 if base_path is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	220 base_path = os.getcwdu() # type(base_path) == unicode
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	221 # to allow combining non-ASCII cwd with unicode values in `pathdict`
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	222 for key in keys:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	223 if key in pathdict:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	224 value = pathdict[key]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	225 if isinstance(value, list):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	226 value = [make_one_path_absolute(base_path, path)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	227 for path in value]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	228 elif value:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	229 value = make_one_path_absolute(base_path, value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	230 pathdict[key] = value
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	231
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	232 def make_one_path_absolute(base_path, path):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	233 return os.path.abspath(os.path.join(base_path, path))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	234
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	235 def filter_settings_spec(settings_spec, exclude, *replace):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	236 """Return a copy of `settings_spec` excluding/replacing some settings.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	237
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	238 `settings_spec` is a tuple of configuration settings with a structure
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	239 described for docutils.SettingsSpec.settings_spec.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	240
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	241 Optional positional arguments are names of to-be-excluded settings.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	242 Keyword arguments are option specification replacements.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	243 (See the html4strict writer for an example.)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	244 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	245 settings = list(settings_spec)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	246 # every third item is a sequence of option tuples
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	247 for i in range(2, len(settings), 3):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	248 newopts = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	249 for opt_spec in settings[i]:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	250 # opt_spec is ("<help>", [<option strings>], {<keyword args>})
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	251 opt_name = [opt_string[2:].replace('-', '_')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	252 for opt_string in opt_spec[1]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	253 if opt_string.startswith('--')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	254 ][0]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	255 if opt_name in exclude:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	256 continue
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	257 if opt_name in replace.keys():
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	258 newopts.append(replace[opt_name])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	259 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	260 newopts.append(opt_spec)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	261 settings[i] = tuple(newopts)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	262 return tuple(settings)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	263
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	264
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	265 class Values(optparse.Values):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	266
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	267 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	268 Updates list attributes by extension rather than by replacement.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	269 Works in conjunction with the `OptionParser.lists` instance attribute.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	270 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	271
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	272 def __init__(self, args, *kwargs):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	273 optparse.Values.__init__(self, args, *kwargs)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	274 if (not hasattr(self, 'record_dependencies')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	275 or self.record_dependencies is None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	276 # Set up dependency list, in case it is needed.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	277 self.record_dependencies = docutils.utils.DependencyList()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	278
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	279 def update(self, other_dict, option_parser):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	280 if isinstance(other_dict, Values):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	281 other_dict = other_dict.__dict__
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	282 other_dict = other_dict.copy()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	283 for setting in option_parser.lists.keys():
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	284 if (hasattr(self, setting) and setting in other_dict):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	285 value = getattr(self, setting)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	286 if value:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	287 value += other_dict[setting]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	288 del other_dict[setting]
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	289 self._update_loose(other_dict)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	290
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	291 def copy(self):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	292 """Return a shallow copy of `self`."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	293 return self.__class__(defaults=self.__dict__)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	294
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	295
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	296 class Option(optparse.Option):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	297
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	298 ATTRS = optparse.Option.ATTRS + ['validator', 'overrides']
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	299
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	300 def process(self, opt, value, values, parser):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	301 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	302 Call the validator function on applicable settings and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	303 evaluate the 'overrides' option.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	304 Extends `optparse.Option.process`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	305 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	306 result = optparse.Option.process(self, opt, value, values, parser)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	307 setting = self.dest
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	308 if setting:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	309 if self.validator:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	310 value = getattr(values, setting)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	311 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	312 new_value = self.validator(setting, value, parser)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	313 except Exception, error:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	314 raise (optparse.OptionValueError(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	315 'Error in option "%s":\n %s'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	316 % (opt, ErrorString(error))),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	317 None, sys.exc_info()[2])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	318 setattr(values, setting, new_value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	319 if self.overrides:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	320 setattr(values, self.overrides, None)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	321 return result
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	322
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	323
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	324 class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	325
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	326 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	327 Parser for command-line and library use. The `settings_spec`
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	328 specification here and in other Docutils components are merged to build
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	329 the set of command-line options and runtime settings for this process.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	330
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	331 Common settings (defined below) and component-specific settings must not
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	332 conflict. Short options are reserved for common settings, and components
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	333 are restrict to using long options.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	334 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	335
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	336 standard_config_files = [
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	337 '/etc/docutils.conf', # system-wide
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	338 './docutils.conf', # project-specific
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	339 '~/.docutils'] # user-specific
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	340 """Docutils configuration files, using ConfigParser syntax. Filenames
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	341 will be tilde-expanded later. Later files override earlier ones."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	342
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	343 threshold_choices = 'info 1 warning 2 error 3 severe 4 none 5'.split()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	344 """Possible inputs for for --report and --halt threshold values."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	345
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	346 thresholds = {'info': 1, 'warning': 2, 'error': 3, 'severe': 4, 'none': 5}
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	347 """Lookup table for --report and --halt threshold values."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	348
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	349 booleans={'1': True, 'on': True, 'yes': True, 'true': True,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	350 '0': False, 'off': False, 'no': False, 'false': False, '': False}
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	351 """Lookup table for boolean configuration file settings."""
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	352
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	353 default_error_encoding = getattr(sys.stderr, 'encoding',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	354 None) or locale_encoding or 'ascii'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	355
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	356 default_error_encoding_error_handler = 'backslashreplace'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	357
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	358 settings_spec = (
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	359 'General Docutils Options',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	360 None,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	361 (('Specify the document title as metadata.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	362 ['--title'], {}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	363 ('Include a "Generated by Docutils" credit and link.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	364 ['--generator', '-g'], {'action': 'store_true',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	365 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	366 ('Do not include a generator credit.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	367 ['--no-generator'], {'action': 'store_false', 'dest': 'generator'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	368 ('Include the date at the end of the document (UTC).',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	369 ['--date', '-d'], {'action': 'store_const', 'const': '%Y-%m-%d',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	370 'dest': 'datestamp'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	371 ('Include the time & date (UTC).',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	372 ['--time', '-t'], {'action': 'store_const',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	373 'const': '%Y-%m-%d %H:%M UTC',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	374 'dest': 'datestamp'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	375 ('Do not include a datestamp of any kind.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	376 ['--no-datestamp'], {'action': 'store_const', 'const': None,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	377 'dest': 'datestamp'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	378 ('Include a "View document source" link.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	379 ['--source-link', '-s'], {'action': 'store_true',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	380 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	381 ('Use <URL> for a source link; implies --source-link.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	382 ['--source-url'], {'metavar': '<URL>'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	383 ('Do not include a "View document source" link.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	384 ['--no-source-link'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	385 {'action': 'callback', 'callback': store_multiple,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	386 'callback_args': ('source_link', 'source_url')}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	387 ('Link from section headers to TOC entries. (default)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	388 ['--toc-entry-backlinks'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	389 {'dest': 'toc_backlinks', 'action': 'store_const', 'const': 'entry',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	390 'default': 'entry'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	391 ('Link from section headers to the top of the TOC.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	392 ['--toc-top-backlinks'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	393 {'dest': 'toc_backlinks', 'action': 'store_const', 'const': 'top'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	394 ('Disable backlinks to the table of contents.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	395 ['--no-toc-backlinks'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	396 {'dest': 'toc_backlinks', 'action': 'store_false'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	397 ('Link from footnotes/citations to references. (default)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	398 ['--footnote-backlinks'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	399 {'action': 'store_true', 'default': 1,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	400 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	401 ('Disable backlinks from footnotes and citations.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	402 ['--no-footnote-backlinks'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	403 {'dest': 'footnote_backlinks', 'action': 'store_false'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	404 ('Enable section numbering by Docutils. (default)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	405 ['--section-numbering'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	406 {'action': 'store_true', 'dest': 'sectnum_xform',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	407 'default': 1, 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	408 ('Disable section numbering by Docutils.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	409 ['--no-section-numbering'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	410 {'action': 'store_false', 'dest': 'sectnum_xform'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	411 ('Remove comment elements from the document tree.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	412 ['--strip-comments'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	413 {'action': 'store_true', 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	414 ('Leave comment elements in the document tree. (default)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	415 ['--leave-comments'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	416 {'action': 'store_false', 'dest': 'strip_comments'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	417 ('Remove all elements with classes="<class>" from the document tree. '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	418 'Warning: potentially dangerous; use with caution. '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	419 '(Multiple-use option.)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	420 ['--strip-elements-with-class'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	421 {'action': 'append', 'dest': 'strip_elements_with_classes',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	422 'metavar': '<class>', 'validator': validate_strip_class}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	423 ('Remove all classes="<class>" attributes from elements in the '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	424 'document tree. Warning: potentially dangerous; use with caution. '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	425 '(Multiple-use option.)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	426 ['--strip-class'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	427 {'action': 'append', 'dest': 'strip_classes',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	428 'metavar': '<class>', 'validator': validate_strip_class}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	429 ('Report system messages at or higher than <level>: "info" or "1", '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	430 '"warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5"',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	431 ['--report', '-r'], {'choices': threshold_choices, 'default': 2,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	432 'dest': 'report_level', 'metavar': '<level>',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	433 'validator': validate_threshold}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	434 ('Report all system messages. (Same as "--report=1".)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	435 ['--verbose', '-v'], {'action': 'store_const', 'const': 1,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	436 'dest': 'report_level'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	437 ('Report no system messages. (Same as "--report=5".)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	438 ['--quiet', '-q'], {'action': 'store_const', 'const': 5,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	439 'dest': 'report_level'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	440 ('Halt execution at system messages at or above <level>. '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	441 'Levels as in --report. Default: 4 (severe).',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	442 ['--halt'], {'choices': threshold_choices, 'dest': 'halt_level',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	443 'default': 4, 'metavar': '<level>',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	444 'validator': validate_threshold}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	445 ('Halt at the slightest problem. Same as "--halt=info".',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	446 ['--strict'], {'action': 'store_const', 'const': 1,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	447 'dest': 'halt_level'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	448 ('Enable a non-zero exit status for non-halting system messages at '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	449 'or above <level>. Default: 5 (disabled).',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	450 ['--exit-status'], {'choices': threshold_choices,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	451 'dest': 'exit_status_level',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	452 'default': 5, 'metavar': '<level>',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	453 'validator': validate_threshold}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	454 ('Enable debug-level system messages and diagnostics.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	455 ['--debug'], {'action': 'store_true', 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	456 ('Disable debug output. (default)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	457 ['--no-debug'], {'action': 'store_false', 'dest': 'debug'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	458 ('Send the output of system messages to <file>.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	459 ['--warnings'], {'dest': 'warning_stream', 'metavar': '<file>'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	460 ('Enable Python tracebacks when Docutils is halted.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	461 ['--traceback'], {'action': 'store_true', 'default': None,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	462 'validator': validate_boolean}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	463 ('Disable Python tracebacks. (default)',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	464 ['--no-traceback'], {'dest': 'traceback', 'action': 'store_false'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	465 ('Specify the encoding and optionally the '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	466 'error handler of input text. Default: <locale-dependent>:strict.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	467 ['--input-encoding', '-i'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	468 {'metavar': '<name[:handler]>',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	469 'validator': validate_encoding_and_error_handler}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	470 ('Specify the error handler for undecodable characters. '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	471 'Choices: "strict" (default), "ignore", and "replace".',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	472 ['--input-encoding-error-handler'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	473 {'default': 'strict', 'validator': validate_encoding_error_handler}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	474 ('Specify the text encoding and optionally the error handler for '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	475 'output. Default: UTF-8:strict.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	476 ['--output-encoding', '-o'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	477 {'metavar': '<name[:handler]>', 'default': 'utf-8',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	478 'validator': validate_encoding_and_error_handler}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	479 ('Specify error handler for unencodable output characters; '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	480 '"strict" (default), "ignore", "replace", '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	481 '"xmlcharrefreplace", "backslashreplace".',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	482 ['--output-encoding-error-handler'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	483 {'default': 'strict', 'validator': validate_encoding_error_handler}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	484 ('Specify text encoding and error handler for error output. '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	485 'Default: %s:%s.'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	486 % (default_error_encoding, default_error_encoding_error_handler),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	487 ['--error-encoding', '-e'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	488 {'metavar': '<name[:handler]>', 'default': default_error_encoding,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	489 'validator': validate_encoding_and_error_handler}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	490 ('Specify the error handler for unencodable characters in '
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	491 'error output. Default: %s.'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	492 % default_error_encoding_error_handler,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	493 ['--error-encoding-error-handler'],
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	494 {'default': default_error_encoding_error_handler,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	495 'validator': validate_encoding_error_handler}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	496 ('Specify the language (as BCP 47 language tag). Default: en.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	497 ['--language', '-l'], {'dest': 'language_code', 'default': 'en',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	498 'metavar': '<name>'}),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	499 ('Write output file dependencies to <file>.',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	500 ['--record-dependencies'],

0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1 # $Id: frontend.py 7584 2013-01-01 20:00:21Z milde $

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

2 # Author: David Goodger <goodger@python.org>

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

3 # Copyright: This module has been placed in the public domain.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

4

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

5 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

6 Command-line and common processing for Docutils front-end tools.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

7

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

8 Exports the following classes:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

9

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

10 * `OptionParser`: Standard Docutils command-line processing.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

11 * `Option`: Customized version of `optparse.Option`; validation support.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

12 * `Values`: Runtime settings; objects are simple structs

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

13 (``object.attribute``). Supports cumulative list settings (attributes).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

14 * `ConfigParser`: Standard Docutils config file processing.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

15

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

16 Also exports the following functions:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

17

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

18 * Option callbacks: `store_multiple`, `read_config_file`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

19 * Setting validators: `validate_encoding`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

20 `validate_encoding_error_handler`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

21 `validate_encoding_and_error_handler`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

22 `validate_boolean`, `validate_ternary`, `validate_threshold`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

23 `validate_colon_separated_string_list`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

24 `validate_comma_separated_string_list`,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

25 `validate_dependency_file`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

26 * `make_paths_absolute`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

27 * SettingSpec manipulation: `filter_settings_spec`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

28 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

29

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

30 __docformat__ = 'reStructuredText'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

31

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

32 import os

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

33 import os.path

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

34 import sys

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

35 import warnings

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

36 import ConfigParser as CP

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

37 import codecs

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

38 import optparse

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

39 from optparse import SUPPRESS_HELP

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

40 import docutils

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

41 import docutils.utils

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

42 import docutils.nodes

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

43 from docutils.utils.error_reporting import locale_encoding, ErrorOutput, ErrorString

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

44

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

45

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

46 def store_multiple(option, opt, value, parser, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

47 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

48 Store multiple values in `parser.values`. (Option callback.)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

49

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

50 Store `None` for each attribute named in `args`, and store the value for

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

51 each key (attribute name) in `kwargs`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

52 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

53 for attribute in args:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

54 setattr(parser.values, attribute, None)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

55 for key, value in kwargs.items():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

56 setattr(parser.values, key, value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

57

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

58 def read_config_file(option, opt, value, parser):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

59 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

60 Read a configuration file during option processing. (Option callback.)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

61 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

62 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

63 new_settings = parser.get_config_file_settings(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

64 except ValueError, error:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

65 parser.error(error)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

66 parser.values.update(new_settings, parser)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

67

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

68 def validate_encoding(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

69 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

70 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

71 codecs.lookup(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

72 except LookupError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

73 raise (LookupError('setting "%s": unknown encoding: "%s"'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

74 % (setting, value)),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

75 None, sys.exc_info()[2])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

76 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

77

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

78 def validate_encoding_error_handler(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

79 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

80 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

81 codecs.lookup_error(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

82 except LookupError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

83 raise (LookupError(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

84 'unknown encoding error handler: "%s" (choices: '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

85 '"strict", "ignore", "replace", "backslashreplace", '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

86 '"xmlcharrefreplace", and possibly others; see documentation for '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

87 'the Python ``codecs`` module)' % value),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

88 None, sys.exc_info()[2])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

89 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

90

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

91 def validate_encoding_and_error_handler(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

92 setting, value, option_parser, config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

93 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

94 Side-effect: if an error handler is included in the value, it is inserted

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

95 into the appropriate place as if it was a separate setting/option.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

96 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

97 if ':' in value:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

98 encoding, handler = value.split(':')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

99 validate_encoding_error_handler(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

100 setting + '_error_handler', handler, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

101 config_parser, config_section)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

102 if config_parser:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

103 config_parser.set(config_section, setting + '_error_handler',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

104 handler)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

105 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

106 setattr(option_parser.values, setting + '_error_handler', handler)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

107 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

108 encoding = value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

109 validate_encoding(setting, encoding, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

110 config_parser, config_section)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

111 return encoding

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

112

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

113 def validate_boolean(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

114 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

115 """Check/normalize boolean settings:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

116 True: '1', 'on', 'yes', 'true'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

117 False: '0', 'off', 'no','false', ''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

118 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

119 if isinstance(value, bool):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

120 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

121 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

122 return option_parser.booleans[value.strip().lower()]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

123 except KeyError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

124 raise (LookupError('unknown boolean value: "%s"' % value),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

125 None, sys.exc_info()[2])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

126

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

127 def validate_ternary(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

128 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

129 """Check/normalize three-value settings:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

130 True: '1', 'on', 'yes', 'true'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

131 False: '0', 'off', 'no','false', ''

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

132 any other value: returned as-is.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

133 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

134 if isinstance(value, bool) or value is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

135 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

136 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

137 return option_parser.booleans[value.strip().lower()]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

138 except KeyError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

139 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

140

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

141 def validate_nonnegative_int(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

142 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

143 value = int(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

144 if value < 0:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

145 raise ValueError('negative value; must be positive or zero')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

146 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

147

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

148 def validate_threshold(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

149 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

150 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

151 return int(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

152 except ValueError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

153 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

154 return option_parser.thresholds[value.lower()]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

155 except (KeyError, AttributeError):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

156 raise (LookupError('unknown threshold: %r.' % value),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

157 None, sys.exc_info[2])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

158

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

159 def validate_colon_separated_string_list(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

160 setting, value, option_parser, config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

161 if not isinstance(value, list):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

162 value = value.split(':')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

163 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

164 last = value.pop()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

165 value.extend(last.split(':'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

166 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

167

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

168 def validate_comma_separated_list(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

169 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

170 """Check/normalize list arguments (split at "," and strip whitespace).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

171 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

172 # `value` is already a ``list`` when given as command line option

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

173 # and "action" is "append" and ``unicode`` or ``str`` else.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

174 if not isinstance(value, list):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

175 value = [value]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

176 # this function is called for every option added to `value`

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

177 # -> split the last item and append the result:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

178 last = value.pop()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

179 items = [i.strip(u' \t\n') for i in last.split(u',') if i.strip(u' \t\n')]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

180 value.extend(items)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

181 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

182

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

183 def validate_url_trailing_slash(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

184 setting, value, option_parser, config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

185 if not value:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

186 return './'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

187 elif value.endswith('/'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

188 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

189 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

190 return value + '/'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

191

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

192 def validate_dependency_file(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

193 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

194 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

195 return docutils.utils.DependencyList(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

196 except IOError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

197 return docutils.utils.DependencyList(None)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

198

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

199 def validate_strip_class(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

200 config_parser=None, config_section=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

201 # value is a comma separated string list:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

202 value = validate_comma_separated_list(setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

203 config_parser, config_section)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

204 # validate list elements:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

205 for cls in value:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

206 normalized = docutils.nodes.make_id(cls)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

207 if cls != normalized:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

208 raise ValueError('invalid class value %r (perhaps %r?)'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

209 % (cls, normalized))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

210 return value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

211

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

212 def make_paths_absolute(pathdict, keys, base_path=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

213 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

214 Interpret filesystem path settings relative to the `base_path` given.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

215

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

216 Paths are values in `pathdict` whose keys are in `keys`. Get `keys` from

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

217 `OptionParser.relative_path_settings`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

218 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

219 if base_path is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

220 base_path = os.getcwdu() # type(base_path) == unicode

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

221 # to allow combining non-ASCII cwd with unicode values in `pathdict`

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

222 for key in keys:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

223 if key in pathdict:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

224 value = pathdict[key]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

225 if isinstance(value, list):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

226 value = [make_one_path_absolute(base_path, path)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

227 for path in value]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

228 elif value:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

229 value = make_one_path_absolute(base_path, value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

230 pathdict[key] = value

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

231

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

232 def make_one_path_absolute(base_path, path):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

233 return os.path.abspath(os.path.join(base_path, path))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

234

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

235 def filter_settings_spec(settings_spec, *exclude, **replace):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

236 """Return a copy of `settings_spec` excluding/replacing some settings.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

237

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

238 `settings_spec` is a tuple of configuration settings with a structure

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

239 described for docutils.SettingsSpec.settings_spec.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

240

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

241 Optional positional arguments are names of to-be-excluded settings.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

242 Keyword arguments are option specification replacements.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

243 (See the html4strict writer for an example.)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

244 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

245 settings = list(settings_spec)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

246 # every third item is a sequence of option tuples

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

247 for i in range(2, len(settings), 3):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

248 newopts = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

249 for opt_spec in settings[i]:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

250 # opt_spec is ("<help>", [<option strings>], {<keyword args>})

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

251 opt_name = [opt_string[2:].replace('-', '_')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

252 for opt_string in opt_spec[1]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

253 if opt_string.startswith('--')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

254 ][0]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

255 if opt_name in exclude:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

256 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

257 if opt_name in replace.keys():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

258 newopts.append(replace[opt_name])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

259 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

260 newopts.append(opt_spec)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

261 settings[i] = tuple(newopts)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

262 return tuple(settings)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

263

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

264

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

265 class Values(optparse.Values):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

266

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

267 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

268 Updates list attributes by extension rather than by replacement.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

269 Works in conjunction with the `OptionParser.lists` instance attribute.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

270 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

271

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

272 def __init__(self, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

273 optparse.Values.__init__(self, *args, **kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

274 if (not hasattr(self, 'record_dependencies')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

275 or self.record_dependencies is None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

276 # Set up dependency list, in case it is needed.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

277 self.record_dependencies = docutils.utils.DependencyList()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

278

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

279 def update(self, other_dict, option_parser):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

280 if isinstance(other_dict, Values):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

281 other_dict = other_dict.__dict__

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

282 other_dict = other_dict.copy()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

283 for setting in option_parser.lists.keys():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

284 if (hasattr(self, setting) and setting in other_dict):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

285 value = getattr(self, setting)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

286 if value:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

287 value += other_dict[setting]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

288 del other_dict[setting]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

289 self._update_loose(other_dict)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

290

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

291 def copy(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

292 """Return a shallow copy of `self`."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

293 return self.__class__(defaults=self.__dict__)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

294

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

295

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

296 class Option(optparse.Option):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

297

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

298 ATTRS = optparse.Option.ATTRS + ['validator', 'overrides']

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

299

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

300 def process(self, opt, value, values, parser):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

301 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

302 Call the validator function on applicable settings and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

303 evaluate the 'overrides' option.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

304 Extends `optparse.Option.process`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

305 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

306 result = optparse.Option.process(self, opt, value, values, parser)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

307 setting = self.dest

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

308 if setting:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

309 if self.validator:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

310 value = getattr(values, setting)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

311 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

312 new_value = self.validator(setting, value, parser)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

313 except Exception, error:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

314 raise (optparse.OptionValueError(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

315 'Error in option "%s":\n %s'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

316 % (opt, ErrorString(error))),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

317 None, sys.exc_info()[2])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

318 setattr(values, setting, new_value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

319 if self.overrides:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

320 setattr(values, self.overrides, None)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

321 return result

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

322

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

323

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

324 class OptionParser(optparse.OptionParser, docutils.SettingsSpec):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

325

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

326 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

327 Parser for command-line and library use. The `settings_spec`

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

328 specification here and in other Docutils components are merged to build

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

329 the set of command-line options and runtime settings for this process.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

330

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

331 Common settings (defined below) and component-specific settings must not

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

332 conflict. Short options are reserved for common settings, and components

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

333 are restrict to using long options.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

334 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

335

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

336 standard_config_files = [

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

337 '/etc/docutils.conf', # system-wide

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

338 './docutils.conf', # project-specific

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

339 '~/.docutils'] # user-specific

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

340 """Docutils configuration files, using ConfigParser syntax. Filenames

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

341 will be tilde-expanded later. Later files override earlier ones."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

342

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

343 threshold_choices = 'info 1 warning 2 error 3 severe 4 none 5'.split()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

344 """Possible inputs for for --report and --halt threshold values."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

345

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

346 thresholds = {'info': 1, 'warning': 2, 'error': 3, 'severe': 4, 'none': 5}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

347 """Lookup table for --report and --halt threshold values."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

348

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

349 booleans={'1': True, 'on': True, 'yes': True, 'true': True,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

350 '0': False, 'off': False, 'no': False, 'false': False, '': False}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

351 """Lookup table for boolean configuration file settings."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

352

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

353 default_error_encoding = getattr(sys.stderr, 'encoding',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

354 None) or locale_encoding or 'ascii'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

355

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

356 default_error_encoding_error_handler = 'backslashreplace'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

357

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

358 settings_spec = (

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

359 'General Docutils Options',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

360 None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

361 (('Specify the document title as metadata.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

362 ['--title'], {}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

363 ('Include a "Generated by Docutils" credit and link.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

364 ['--generator', '-g'], {'action': 'store_true',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

365 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

366 ('Do not include a generator credit.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

367 ['--no-generator'], {'action': 'store_false', 'dest': 'generator'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

368 ('Include the date at the end of the document (UTC).',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

369 ['--date', '-d'], {'action': 'store_const', 'const': '%Y-%m-%d',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

370 'dest': 'datestamp'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

371 ('Include the time & date (UTC).',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

372 ['--time', '-t'], {'action': 'store_const',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

373 'const': '%Y-%m-%d %H:%M UTC',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

374 'dest': 'datestamp'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

375 ('Do not include a datestamp of any kind.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

376 ['--no-datestamp'], {'action': 'store_const', 'const': None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

377 'dest': 'datestamp'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

378 ('Include a "View document source" link.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

379 ['--source-link', '-s'], {'action': 'store_true',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

380 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

381 ('Use <URL> for a source link; implies --source-link.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

382 ['--source-url'], {'metavar': '<URL>'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

383 ('Do not include a "View document source" link.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

384 ['--no-source-link'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

385 {'action': 'callback', 'callback': store_multiple,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

386 'callback_args': ('source_link', 'source_url')}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

387 ('Link from section headers to TOC entries. (default)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

388 ['--toc-entry-backlinks'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

389 {'dest': 'toc_backlinks', 'action': 'store_const', 'const': 'entry',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

390 'default': 'entry'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

391 ('Link from section headers to the top of the TOC.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

392 ['--toc-top-backlinks'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

393 {'dest': 'toc_backlinks', 'action': 'store_const', 'const': 'top'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

394 ('Disable backlinks to the table of contents.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

395 ['--no-toc-backlinks'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

396 {'dest': 'toc_backlinks', 'action': 'store_false'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

397 ('Link from footnotes/citations to references. (default)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

398 ['--footnote-backlinks'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

399 {'action': 'store_true', 'default': 1,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

400 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

401 ('Disable backlinks from footnotes and citations.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

402 ['--no-footnote-backlinks'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

403 {'dest': 'footnote_backlinks', 'action': 'store_false'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

404 ('Enable section numbering by Docutils. (default)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

405 ['--section-numbering'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

406 {'action': 'store_true', 'dest': 'sectnum_xform',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

407 'default': 1, 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

408 ('Disable section numbering by Docutils.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

409 ['--no-section-numbering'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

410 {'action': 'store_false', 'dest': 'sectnum_xform'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

411 ('Remove comment elements from the document tree.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

412 ['--strip-comments'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

413 {'action': 'store_true', 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

414 ('Leave comment elements in the document tree. (default)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

415 ['--leave-comments'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

416 {'action': 'store_false', 'dest': 'strip_comments'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

417 ('Remove all elements with classes="<class>" from the document tree. '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

418 'Warning: potentially dangerous; use with caution. '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

419 '(Multiple-use option.)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

420 ['--strip-elements-with-class'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

421 {'action': 'append', 'dest': 'strip_elements_with_classes',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

422 'metavar': '<class>', 'validator': validate_strip_class}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

423 ('Remove all classes="<class>" attributes from elements in the '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

424 'document tree. Warning: potentially dangerous; use with caution. '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

425 '(Multiple-use option.)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

426 ['--strip-class'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

427 {'action': 'append', 'dest': 'strip_classes',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

428 'metavar': '<class>', 'validator': validate_strip_class}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

429 ('Report system messages at or higher than <level>: "info" or "1", '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

430 '"warning"/"2" (default), "error"/"3", "severe"/"4", "none"/"5"',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

431 ['--report', '-r'], {'choices': threshold_choices, 'default': 2,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

432 'dest': 'report_level', 'metavar': '<level>',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

433 'validator': validate_threshold}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

434 ('Report all system messages. (Same as "--report=1".)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

435 ['--verbose', '-v'], {'action': 'store_const', 'const': 1,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

436 'dest': 'report_level'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

437 ('Report no system messages. (Same as "--report=5".)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

438 ['--quiet', '-q'], {'action': 'store_const', 'const': 5,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

439 'dest': 'report_level'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

440 ('Halt execution at system messages at or above <level>. '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

441 'Levels as in --report. Default: 4 (severe).',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

442 ['--halt'], {'choices': threshold_choices, 'dest': 'halt_level',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

443 'default': 4, 'metavar': '<level>',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

444 'validator': validate_threshold}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

445 ('Halt at the slightest problem. Same as "--halt=info".',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

446 ['--strict'], {'action': 'store_const', 'const': 1,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

447 'dest': 'halt_level'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

448 ('Enable a non-zero exit status for non-halting system messages at '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

449 'or above <level>. Default: 5 (disabled).',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

450 ['--exit-status'], {'choices': threshold_choices,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

451 'dest': 'exit_status_level',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

452 'default': 5, 'metavar': '<level>',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

453 'validator': validate_threshold}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

454 ('Enable debug-level system messages and diagnostics.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

455 ['--debug'], {'action': 'store_true', 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

456 ('Disable debug output. (default)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

457 ['--no-debug'], {'action': 'store_false', 'dest': 'debug'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

458 ('Send the output of system messages to <file>.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

459 ['--warnings'], {'dest': 'warning_stream', 'metavar': '<file>'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

460 ('Enable Python tracebacks when Docutils is halted.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

461 ['--traceback'], {'action': 'store_true', 'default': None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

462 'validator': validate_boolean}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

463 ('Disable Python tracebacks. (default)',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

464 ['--no-traceback'], {'dest': 'traceback', 'action': 'store_false'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

465 ('Specify the encoding and optionally the '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

466 'error handler of input text. Default: <locale-dependent>:strict.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

467 ['--input-encoding', '-i'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

468 {'metavar': '<name[:handler]>',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

469 'validator': validate_encoding_and_error_handler}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

470 ('Specify the error handler for undecodable characters. '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

471 'Choices: "strict" (default), "ignore", and "replace".',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

472 ['--input-encoding-error-handler'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

473 {'default': 'strict', 'validator': validate_encoding_error_handler}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

474 ('Specify the text encoding and optionally the error handler for '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

475 'output. Default: UTF-8:strict.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

476 ['--output-encoding', '-o'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

477 {'metavar': '<name[:handler]>', 'default': 'utf-8',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

478 'validator': validate_encoding_and_error_handler}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

479 ('Specify error handler for unencodable output characters; '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

480 '"strict" (default), "ignore", "replace", '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

481 '"xmlcharrefreplace", "backslashreplace".',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

482 ['--output-encoding-error-handler'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

483 {'default': 'strict', 'validator': validate_encoding_error_handler}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

484 ('Specify text encoding and error handler for error output. '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

485 'Default: %s:%s.'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

486 % (default_error_encoding, default_error_encoding_error_handler),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

487 ['--error-encoding', '-e'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

488 {'metavar': '<name[:handler]>', 'default': default_error_encoding,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

489 'validator': validate_encoding_and_error_handler}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

490 ('Specify the error handler for unencodable characters in '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

491 'error output. Default: %s.'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

492 % default_error_encoding_error_handler,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

493 ['--error-encoding-error-handler'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

494 {'default': default_error_encoding_error_handler,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

495 'validator': validate_encoding_error_handler}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

496 ('Specify the language (as BCP 47 language tag). Default: en.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

497 ['--language', '-l'], {'dest': 'language_code', 'default': 'en',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

498 'metavar': '<name>'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

499 ('Write output file dependencies to <file>.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

500 ['--record-dependencies'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

501 {'metavar': '<file>', 'validator': validate_dependency_file,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

502 'default': None}), # default set in Values class

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

503 ('Read configuration settings from <file>, if it exists.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

504 ['--config'], {'metavar': '<file>', 'type': 'string',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

505 'action': 'callback', 'callback': read_config_file}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

506 ("Show this program's version number and exit.",

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

507 ['--version', '-V'], {'action': 'version'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

508 ('Show this help message and exit.',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

509 ['--help', '-h'], {'action': 'help'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

510 # Typically not useful for non-programmatical use:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

511 (SUPPRESS_HELP, ['--id-prefix'], {'default': ''}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

512 (SUPPRESS_HELP, ['--auto-id-prefix'], {'default': 'id'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

513 # Hidden options, for development use only:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

514 (SUPPRESS_HELP, ['--dump-settings'], {'action': 'store_true'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

515 (SUPPRESS_HELP, ['--dump-internals'], {'action': 'store_true'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

516 (SUPPRESS_HELP, ['--dump-transforms'], {'action': 'store_true'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

517 (SUPPRESS_HELP, ['--dump-pseudo-xml'], {'action': 'store_true'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

518 (SUPPRESS_HELP, ['--expose-internal-attribute'],

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

519 {'action': 'append', 'dest': 'expose_internals',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

520 'validator': validate_colon_separated_string_list}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

521 (SUPPRESS_HELP, ['--strict-visitor'], {'action': 'store_true'}),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

522 ))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

523 """Runtime settings and command-line options common to all Docutils front

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

524 ends. Setting specs specific to individual Docutils components are also

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

525 used (see `populate_from_components()`)."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

526

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

527 settings_defaults = {'_disable_config': None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

528 '_source': None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

529 '_destination': None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

530 '_config_files': None}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

531 """Defaults for settings that don't have command-line option equivalents."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

532

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

533 relative_path_settings = ('warning_stream',)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

534

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

535 config_section = 'general'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

536

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

537 version_template = ('%%prog (Docutils %s [%s], Python %s, on %s)'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

538 % (docutils.__version__, docutils.__version_details__,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

539 sys.version.split()[0], sys.platform))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

540 """Default version message."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

541

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

542 def __init__(self, components=(), defaults=None, read_config_files=None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

543 *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

544 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

545 `components` is a list of Docutils components each containing a

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

546 ``.settings_spec`` attribute. `defaults` is a mapping of setting

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

547 default overrides.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

548 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

549

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

550 self.lists = {}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

551 """Set of list-type settings."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

552

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

553 self.config_files = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

554 """List of paths of applied configuration files."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

555

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

556 optparse.OptionParser.__init__(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

557 self, option_class=Option, add_help_option=None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

558 formatter=optparse.TitledHelpFormatter(width=78),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

559 *args, **kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

560 if not self.version:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

561 self.version = self.version_template

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

562 # Make an instance copy (it will be modified):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

563 self.relative_path_settings = list(self.relative_path_settings)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

564 self.components = (self,) + tuple(components)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

565 self.populate_from_components(self.components)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

566 self.set_defaults_from_dict(defaults or {})

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

567 if read_config_files and not self.defaults['_disable_config']:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

568 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

569 config_settings = self.get_standard_config_settings()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

570 except ValueError, error:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

571 self.error(error)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

572 self.set_defaults_from_dict(config_settings.__dict__)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

573

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

574 def populate_from_components(self, components):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

575 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

576 For each component, first populate from the `SettingsSpec.settings_spec`

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

577 structure, then from the `SettingsSpec.settings_defaults` dictionary.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

578 After all components have been processed, check for and populate from

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

579 each component's `SettingsSpec.settings_default_overrides` dictionary.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

580 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

581 for component in components:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

582 if component is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

583 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

584 settings_spec = component.settings_spec

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

585 self.relative_path_settings.extend(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

586 component.relative_path_settings)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

587 for i in range(0, len(settings_spec), 3):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

588 title, description, option_spec = settings_spec[i:i+3]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

589 if title:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

590 group = optparse.OptionGroup(self, title, description)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

591 self.add_option_group(group)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

592 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

593 group = self # single options

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

594 for (help_text, option_strings, kwargs) in option_spec:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

595 option = group.add_option(help=help_text, *option_strings,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

596 **kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

597 if kwargs.get('action') == 'append':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

598 self.lists[option.dest] = 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

599 if component.settings_defaults:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

600 self.defaults.update(component.settings_defaults)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

601 for component in components:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

602 if component and component.settings_default_overrides:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

603 self.defaults.update(component.settings_default_overrides)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

604

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

605 def get_standard_config_files(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

606 """Return list of config files, from environment or standard."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

607 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

608 config_files = os.environ['DOCUTILSCONFIG'].split(os.pathsep)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

609 except KeyError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

610 config_files = self.standard_config_files

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

611

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

612 # If 'HOME' is not set, expandvars() requires the 'pwd' module which is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

613 # not available under certain environments, for example, within

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

614 # mod_python. The publisher ends up in here, and we need to publish

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

615 # from within mod_python. Therefore we need to avoid expanding when we

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

616 # are in those environments.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

617 expand = os.path.expanduser

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

618 if 'HOME' not in os.environ:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

619 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

620 import pwd

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

621 except ImportError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

622 expand = lambda x: x

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

623 return [expand(f) for f in config_files if f.strip()]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

624

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

625 def get_standard_config_settings(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

626 settings = Values()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

627 for filename in self.get_standard_config_files():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

628 settings.update(self.get_config_file_settings(filename), self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

629 return settings

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

630

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

631 def get_config_file_settings(self, config_file):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

632 """Returns a dictionary containing appropriate config file settings."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

633 parser = ConfigParser()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

634 parser.read(config_file, self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

635 self.config_files.extend(parser._files)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

636 base_path = os.path.dirname(config_file)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

637 applied = {}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

638 settings = Values()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

639 for component in self.components:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

640 if not component:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

641 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

642 for section in (tuple(component.config_section_dependencies or ())

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

643 + (component.config_section,)):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

644 if section in applied:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

645 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

646 applied[section] = 1

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

647 settings.update(parser.get_section(section), self)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

648 make_paths_absolute(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

649 settings.__dict__, self.relative_path_settings, base_path)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

650 return settings.__dict__

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

651

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

652 def check_values(self, values, args):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

653 """Store positional arguments as runtime settings."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

654 values._source, values._destination = self.check_args(args)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

655 make_paths_absolute(values.__dict__, self.relative_path_settings)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

656 values._config_files = self.config_files

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

657 return values

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

658

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

659 def check_args(self, args):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

660 source = destination = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

661 if args:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

662 source = args.pop(0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

663 if source == '-': # means stdin

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

664 source = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

665 if args:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

666 destination = args.pop(0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

667 if destination == '-': # means stdout

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

668 destination = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

669 if args:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

670 self.error('Maximum 2 arguments allowed.')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

671 if source and source == destination:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

672 self.error('Do not specify the same file for both source and '

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

673 'destination. It will clobber the source file.')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

674 return source, destination

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

675

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

676 def set_defaults_from_dict(self, defaults):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

677 self.defaults.update(defaults)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

678

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

679 def get_default_values(self):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

680 """Needed to get custom `Values` instances."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

681 defaults = Values(self.defaults)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

682 defaults._config_files = self.config_files

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

683 return defaults

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

684

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

685 def get_option_by_dest(self, dest):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

686 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

687 Get an option by its dest.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

688

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

689 If you're supplying a dest which is shared by several options,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

690 it is undefined which option of those is returned.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

691

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

692 A KeyError is raised if there is no option with the supplied

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

693 dest.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

694 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

695 for group in self.option_groups + [self]:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

696 for option in group.option_list:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

697 if option.dest == dest:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

698 return option

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

699 raise KeyError('No option with dest == %r.' % dest)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

700

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

701

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

702 class ConfigParser(CP.RawConfigParser):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

703

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

704 old_settings = {

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

705 'pep_stylesheet': ('pep_html writer', 'stylesheet'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

706 'pep_stylesheet_path': ('pep_html writer', 'stylesheet_path'),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

707 'pep_template': ('pep_html writer', 'template')}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

708 """{old setting: (new section, new setting)} mapping, used by

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

709 `handle_old_config`, to convert settings from the old [options] section."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

710

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

711 old_warning = """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

712 The "[option]" section is deprecated. Support for old-format configuration

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

713 files may be removed in a future Docutils release. Please revise your

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

714 configuration files. See <http://docutils.sf.net/docs/user/config.html>,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

715 section "Old-Format Configuration Files".

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

716 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

717

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

718 not_utf8_error = """\

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

719 Unable to read configuration file "%s": content not encoded as UTF-8.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

720 Skipping "%s" configuration file.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

721 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

722

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

723 def __init__(self, *args, **kwargs):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

724 CP.RawConfigParser.__init__(self, *args, **kwargs)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

725

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

726 self._files = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

727 """List of paths of configuration files read."""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

728

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

729 self._stderr = ErrorOutput()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

730 """Wrapper around sys.stderr catching en-/decoding errors"""

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

731

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

732 def read(self, filenames, option_parser):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

733 if type(filenames) in (str, unicode):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

734 filenames = [filenames]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

735 for filename in filenames:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

736 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

737 # Config files must be UTF-8-encoded:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

738 fp = codecs.open(filename, 'r', 'utf-8')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

739 except IOError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

740 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

741 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

742 if sys.version_info < (3,2):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

743 CP.RawConfigParser.readfp(self, fp, filename)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

744 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

745 CP.RawConfigParser.read_file(self, fp, filename)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

746 except UnicodeDecodeError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

747 self._stderr.write(self.not_utf8_error % (filename, filename))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

748 fp.close()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

749 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

750 fp.close()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

751 self._files.append(filename)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

752 if self.has_section('options'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

753 self.handle_old_config(filename)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

754 self.validate_settings(filename, option_parser)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

755

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

756 def handle_old_config(self, filename):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

757 warnings.warn_explicit(self.old_warning, ConfigDeprecationWarning,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

758 filename, 0)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

759 options = self.get_section('options')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

760 if not self.has_section('general'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

761 self.add_section('general')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

762 for key, value in options.items():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

763 if key in self.old_settings:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

764 section, setting = self.old_settings[key]

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

765 if not self.has_section(section):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

766 self.add_section(section)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

767 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

768 section = 'general'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

769 setting = key

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

770 if not self.has_option(section, setting):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

771 self.set(section, setting, value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

772 self.remove_section('options')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

773

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

774 def validate_settings(self, filename, option_parser):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

775 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

776 Call the validator function and implement overrides on all applicable

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

777 settings.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

778 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

779 for section in self.sections():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

780 for setting in self.options(section):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

781 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

782 option = option_parser.get_option_by_dest(setting)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

783 except KeyError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

784 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

785 if option.validator:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

786 value = self.get(section, setting)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

787 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

788 new_value = option.validator(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

789 setting, value, option_parser,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

790 config_parser=self, config_section=section)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

791 except Exception, error:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

792 raise (ValueError(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

793 'Error in config file "%s", section "[%s]":\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

794 ' %s\n'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

795 ' %s = %s'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

796 % (filename, section, ErrorString(error),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

797 setting, value)), None, sys.exc_info()[2])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

798 self.set(section, setting, new_value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

799 if option.overrides:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

800 self.set(section, option.overrides, None)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

801

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

802 def optionxform(self, optionstr):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

803 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

804 Transform '-' to '_' so the cmdline form of option names can be used.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

805 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

806 return optionstr.lower().replace('-', '_')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

807

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

808 def get_section(self, section):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

809 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

810 Return a given section as a dictionary (empty if the section

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

811 doesn't exist).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

812 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

813 section_dict = {}

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

814 if self.has_section(section):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

815 for option in self.options(section):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

816 section_dict[option] = self.get(section, option)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

817 return section_dict

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

818

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

819

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

820 class ConfigDeprecationWarning(DeprecationWarning):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

821 """Warning for deprecated configuration file features."""

Mercurial > repos > bcclaywell > argo_navis

annotate venv/lib/python2.7/site-packages/docutils/frontend.py @ 0:d67268158946 draft