docutils.transforms.components.Filter Class Reference

Inheritance diagram for docutils.transforms.components.Filter:

Collaboration diagram for docutils.transforms.components.Filter:

Public Member Functions
	apply (self)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Static Public Attributes
int	default_priority = 780
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Additional Inherited Members
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Detailed Description

Include or exclude elements which depend on a specific Docutils component.

For use with `nodes.pending` elements.  A "pending" element's dictionary
attribute ``details`` must contain the keys "component" and "format".  The
value of ``details['component']`` must match the type name of the
component the elements depend on (e.g. "writer").  The value of
``details['format']`` is the name of a specific format or context of that
component (e.g. "html").  If the matching Docutils component supports that
format or context, the "pending" element is replaced by the contents of
``details['nodes']`` (a list of nodes); otherwise, the "pending" element
is removed.

For example, up to version 0.17, the reStructuredText "meta"
directive created a "pending" element containing a "meta" element
(in ``pending.details['nodes']``).
Only writers (``pending.details['component'] == 'writer'``)
supporting the "html", "latex", or "odf" formats
(``pending.details['format'] == 'html,latex,odf'``) included the
"meta" element; it was deleted from the output of all other writers.

This transform is no longer used by Docutils, it may be removed in future.

Member Function Documentation

apply()

docutils.transforms.components.Filter.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

---

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

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