docutils.frontend.ConfigParser Class Reference

Inheritance diagram for docutils.frontend.ConfigParser:

Collaboration diagram for docutils.frontend.ConfigParser:

Public Member Functions
	read (self, filenames, option_parser=None)
	handle_old_config (self, filename)
	validate_settings (self, filename, option_parser)
	optionxform (self, optionstr)
	get_section (self, section)

Public Attributes
	old_warning

Static Public Attributes
dict	old_settings
tuple	old_warning
str	not_utf8_error

Detailed Description

Parser for Docutils configuration files.

See https://docutils.sourceforge.io/docs/user/config.html.

Option key normalization includes conversion of '-' to '_'.

Config file encoding is "utf-8". Encoding errors are reported
and the affected file(s) skipped.

This class is provisional and will change in future versions.

Member Function Documentation

get_section()

docutils.frontend.ConfigParser.get_section	(		self,
			section
	)

Return a given section as a dictionary.

Return empty dictionary if the section doesn't exist.

Deprecated. Use the configparser "Mapping Protocol Access" and
catch KeyError.

optionxform()

docutils.frontend.ConfigParser.optionxform	(		self,
			optionstr
	)

Lowercase and transform '-' to '_'.

So the cmdline form of option names can be used in config files.

validate_settings()

docutils.frontend.ConfigParser.validate_settings	(		self,
			filename,
			option_parser
	)

Call the validator function and implement overrides on all applicable
settings.

Member Data Documentation

not_utf8_error

str docutils.frontend.ConfigParser.not_utf8_error

static

Initial value:

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

old_settings

dict docutils.frontend.ConfigParser.old_settings

static

Initial value:

=  {
        'pep_stylesheet': ('pep_html writer', 'stylesheet'),
        'pep_stylesheet_path': ('pep_html writer', 'stylesheet_path'),
        'pep_template': ('pep_html writer', 'template')}

old_warning

tuple docutils.frontend.ConfigParser.old_warning

static

Initial value:

=  (
        'The "[option]" section is deprecated.\n'
        'Support for old-format configuration files will be removed in '
        'Docutils 2.0.  Please revise your configuration files.  '
        'See <https://docutils.sourceforge.io/docs/user/config.html>, '
        'section "Old-Format Configuration Files".')

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/frontend.py