docutils.parsers.Parser Class Reference

Inheritance diagram for docutils.parsers.Parser:

Collaboration diagram for docutils.parsers.Parser:

Public Member Functions
	parse (self, inputstring, document)
	setup_parse (self, inputstring, document)
	finish_parse (self)
Public Member Functions inherited from docutils.Component
	supports (self, format)
Public Member Functions inherited from docutils.TransformSpec
	get_transforms (self)

Public Attributes
	inputstring
	document
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
tuple	settings_spec
str	component_type = 'parser'
str	config_section = 'parsers'
Static Public Attributes inherited from docutils.Component
	component_type = None
tuple	supported = ()
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
Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()
tuple	unknown_reference_resolvers = ()

Member Function Documentation

finish_parse()

docutils.parsers.Parser.finish_parse

(

self

)

Finalize parse details.  Call at end of `self.parse()`.

parse()

docutils.parsers.Parser.parse	(		self,
			inputstring,
			document
	)

Override to parse `inputstring` into document tree `document`.

Reimplemented in docutils.parsers.null.Parser, docutils.parsers.rst.Parser, and sphinx.parsers.RSTParser.

setup_parse()

docutils.parsers.Parser.setup_parse	(		self,
			inputstring,
			document
	)

Initial parse setup.  Call at start of `self.parse()`.

Member Data Documentation

settings_spec

tuple docutils.parsers.Parser.settings_spec

static

Initial value:

=  (
        'Generic Parser Options',
        None,
        (('Disable directives that insert the contents of an external file; '
          'replaced with a "warning" system message.',
          ['--no-file-insertion'],
          {'action': 'store_false', 'default': 1,
           'dest': 'file_insertion_enabled',
           'validator': frontend.validate_boolean}),
         ('Enable directives that insert the contents '
          'of an external file. (default)',
          ['--file-insertion-enabled'],
          {'action': 'store_true'}),
         ('Disable the "raw" directive; '
          'replaced with a "warning" system message.',
          ['--no-raw'],
          {'action': 'store_false', 'default': 1, 'dest': 'raw_enabled',
           'validator': frontend.validate_boolean}),
         ('Enable the "raw" directive. (default)',
          ['--raw-enabled'],
          {'action': 'store_true'}),
         ('Maximal number of characters in an input line. Default 10 000.',
          ['--line-length-limit'],
          {'metavar': '<length>', 'type': 'int', 'default': 10000,
           'validator': frontend.validate_nonnegative_int}),
         )
        )

---

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

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