U [Sh@sNdZdZddlmZmZmZGdddeZGdddZGdd d eZd S) a This package contains modules for standard tree transforms available to Docutils components. Tree transforms serve a variety of purposes: - To tie up certain syntax-specific "loose ends" that remain after the initial parsing of the input plaintext. These transforms are used to supplement a limited syntax. - To automate the internal linking of the document tree (hyperlink references, footnote references, etc.). - To extract useful information from the document tree. These transforms may be used to construct (for example) indexes and tables of contents. Each transform is an optional step that a Docutils component may choose to perform on the parsed document. reStructuredText) languagesApplicationError TransformSpecc@s eZdZdS)TransformErrorN)__name__ __module__ __qualname__r r O/root/rtd-docs/venv/lib/python3.8/site-packages/docutils/transforms/__init__.pyrsrc@s&eZdZdZdZdddZddZdS) Transformz1Docutils transform component abstract base class.NcCs$||_||_t|jj|j|_dS)zA Initial setup for in-place document transforms. N)document startnoderZ get_languagesettingsZ language_codereporterlanguage)selfr rr r r __init__(szTransform.__init__cKs tddS)z5Override to apply the transform to the document tree.z"subclass must override this methodN)NotImplementedError)rkwargsr r r apply9szTransform.apply)N)rrr __doc__default_priorityrrr r r r r "s r c@sLeZdZdZddZdddZddZdd d Zd d Zd dZ ddZ dS) Transformera Store "transforms" and apply them to the document tree. Collect lists of `Transform` instances and "unknown_reference_resolvers" from Docutils components (`TransformSpec` instances). Apply collected "transforms" to the document tree. Also keeps track of components by component type name. https://docutils.sourceforge.io/docs/peps/pep-0258.html#transformer cCs.g|_g|_||_g|_d|_i|_d|_dS)NFr) transformsunknown_reference_resolversr appliedsorted componentsserialno)rr r r r rKszTransformer.__init__NcKs6|dkr|j}||}|j||d|fd|_dS)a+ Store a single transform. Use `priority` to override the default. `kwargs` is a dictionary whose contents are passed as keyword arguments to the `apply` method of the transform. This can be used to pass application-specific data to the transform instance. NF)rget_priority_stringrappendr)rtransform_classpriorityrpriority_stringr r r add_transformgs  zTransformer.add_transformcCs4|D]$}||j}|j||difqd|_dS)z3Store multiple transforms, with default priorities.NF)r rrr!r)rZtransform_listr"r$r r r add_transformsus zTransformer.add_transformscCs<|j}|dkr|j}||}|j|||ifd|_dS)z4Store a transform with an associated `pending` node.NF) transformrr rr!r)rpendingr#r"r$r r r add_pending~s  zTransformer.add_pendingcCs|jd7_d||jfS)z Return a string, `priority` combined with `self.serialno`. This ensures FIFO order on transforms with identical priority. z %03d-%03d)r)rr#r r r r szTransformer.get_priority_stringcCslg}|D]6}t|tsq||||j|j<||jqd|_dd}|j |d|j|7_dS)an Store each component's default transforms and reference resolvers Transforms are stored with default priorities for later sorting. "Unknown reference resolvers" are sorted and stored. Components that don't inherit from `TransformSpec` are ignored. Also, store components by type name in a mapping for later lookup. FcSs|jS)N)r#)fr r r keyfunsz4Transformer.populate_from_components..keyfun)keyN) isinstancerr&Zget_transformsrZcomponent_typeextendrrsort)rr resolvers componentr,r r r populate_from_componentss    z$Transformer.populate_from_componentscCsx|jj|jj|jrt|js2|jjddd|_|j\}}}}||j|d}|jf||j ||||fqdS)z6Apply all of the stored transforms, in priority order.T)reverse)rN) r rZattach_observerZnote_transform_messagerrr0poprrr!)rr#r"r(rr'r r r apply_transformss zTransformer.apply_transforms)N)N) rrr rrr%r&r)r r3r6r r r r r>s    rN) r __docformat__Zdocutilsrrrrr rr r r r s