docutils.frontend.OptionParser Class Reference

Inheritance diagram for docutils.frontend.OptionParser:

Collaboration diagram for docutils.frontend.OptionParser:

Public Member Functions
	__init__ (self, components=(), defaults=None, read_config_files=False, *args, **kwargs)
	populate_from_components (self, components)
	get_standard_config_files (cls)
	get_standard_config_settings (self)
	get_config_file_settings (self, config_file)
	check_values (self, values, args)
	check_args (self, args)
	set_defaults_from_dict (self, defaults)
	get_default_values (self)
	get_option_by_dest (self, dest)

Public Attributes
	lists
	config_files
	relative_path_settings
	version
	components

Static Public Attributes
list	standard_config_files
str	threshold_choices = 'info 1 warning 2 error 3 severe 4 none 5'.split()
dict	thresholds = {'info': 1, 'warning': 2, 'error': 3, 'severe': 4, 'none': 5}
dict	booleans
tuple	default_error_encoding
str	default_error_encoding_error_handler = 'backslashreplace'
tuple	settings_spec
dict	settings_defaults
str	config_section = 'general'
tuple	version_template
Static Public Attributes inherited from docutils.SettingsSpec
tuple	settings_spec = ()
	settings_defaults = None
	settings_default_overrides = None
tuple	relative_path_settings = ()
	config_section = None
	config_section_dependencies = None

Detailed Description

Settings parser for command-line and library use.

The `settings_spec` specification here and in other Docutils components
are merged to build the set of command-line options and runtime settings
for this process.

Common settings (defined below) and component-specific settings must not
conflict.  Short options are reserved for common settings, and components
are restricted to using long options.

Deprecated.
Will be replaced by a subclass of `argparse.ArgumentParser`.

Constructor & Destructor Documentation

__init__()

docutils.frontend.OptionParser.__init__	(		self,
			components = (),
			defaults = None,
			read_config_files = False,
		*	args,
		**	kwargs
	)

Set up OptionParser instance.

`components` is a list of Docutils components each containing a
``.settings_spec`` attribute.
`defaults` is a mapping of setting default overrides.

Member Function Documentation

check_values()

docutils.frontend.OptionParser.check_values	(		self,
			values,
			args
	)

Store positional arguments as runtime settings.

get_config_file_settings()

docutils.frontend.OptionParser.get_config_file_settings	(		self,
			config_file
	)

Returns a dictionary containing appropriate config file settings.

get_default_values()

docutils.frontend.OptionParser.get_default_values

(

self

)

Needed to get custom `Values` instances.

get_option_by_dest()

docutils.frontend.OptionParser.get_option_by_dest	(		self,
			dest
	)

Get an option by its dest.

If you're supplying a dest which is shared by several options,
it is undefined which option of those is returned.

A KeyError is raised if there is no option with the supplied
dest.

get_standard_config_files()

docutils.frontend.OptionParser.get_standard_config_files

(

cls

)

Return list of config files, from environment or standard.

populate_from_components()

docutils.frontend.OptionParser.populate_from_components	(		self,
			components
	)

Collect settings specification from components.

For each component, populate from the `SettingsSpec.settings_spec`
structure, then from the `SettingsSpec.settings_defaults` dictionary.
After all components have been processed, check for and populate from
each component's `SettingsSpec.settings_default_overrides` dictionary.

Member Data Documentation

booleans

dict docutils.frontend.OptionParser.booleans

static

Initial value:

=  {'1': True, 'on': True, 'yes': True, 'true': True, '0': False,
                'off': False, 'no': False, 'false': False, '': False}

default_error_encoding

tuple docutils.frontend.OptionParser.default_error_encoding

static

Initial value:

=  (getattr(sys.stderr, 'encoding', None)
                              or io._locale_encoding  # noqa
                              or 'ascii')

settings_defaults

dict docutils.frontend.OptionParser.settings_defaults

static

Initial value:

=  {'_disable_config': None,
                         '_source': None,
                         '_destination': None,
                         '_config_files': None}

standard_config_files

list docutils.frontend.OptionParser.standard_config_files

static

Initial value:

=  [
        '/etc/docutils.conf',           # system-wide
        './docutils.conf',              # project-specific
        '~/.docutils']

version_template

tuple docutils.frontend.OptionParser.version_template

static

Initial value:

=  ('%%prog (Docutils %s%s, Python %s, on %s)'
                        % (docutils.__version__,
                           docutils.__version_details__
                           and ' [%s]'%docutils.__version_details__ or '',
                           sys.version.split()[0], sys.platform))

---

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

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