| Server IP : 3.111.61.48 / Your IP : 216.73.216.67 Web Server : Apache System : Linux ip-10-0-5-176 6.8.0-1057-aws #60~22.04.1-Ubuntu SMP Wed May 27 08:16:59 UTC 2026 x86_64 User : ubuntu ( 1000) PHP Version : 8.2.31 Disable Function : exec,passthru,shell_exec,system MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /lib/python3/dist-packages/docutils/transforms/__pycache__/ |
Upload File : |
o
"5p`�N � @ s� d Z dZddlZddlZddlmZmZ ddlmZm Z ej
dkr#e Z G dd� de �Z
G d d
� d
e
�ZG d d � d e
�ZG d
d� de �ZdS )a4
Transforms related to the front matter of a document or a section
(information found before the main text):
- `DocTitle`: Used to transform a lone top level section's title to
the document title, promote a remaining lone top-level section's
title to the document subtitle, and determine the document's title
metadata (document['title']) based on the document title and/or the
"title" setting.
- `SectionSubTitle`: Used to transform a lone subsection into a
subtitle.
- `DocInfo`: Used to transform a bibliographic field list into docinfo
elements.
�reStructuredText� N)�nodes�utils)�TransformError� Transform)� r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �
TitlePromoterzJ
Abstract base class for DocTitle and SectionSubTitle transforms.
c C s� t |tj�s
td��t|�rt |d tj�rJ �| �|�\}}|du r%dS |j|ddd� |dd� |d|� |dd� |dd�< t |d tj�sMJ �dS )a
Transform the following tree::
<node>
<section>
<title>
...
into ::
<node>
<title>
...
`node` is normally a document.
�%node must be of Element-derived type.r NFT��replace�
and_source� )�
isinstancer �Element� TypeError�len�title�candidate_index� update_all_atts_concatenating)�self�node�section�index� r �A/usr/lib/python3/dist-packages/docutils/transforms/frontmatter.py�
promote_title) s
�
�zTitlePromoter.promote_titlec C s� t |tj�s
td��| �|�\}}|du rdS t�� }|j|ddd� |d dd� |dd�< |dd� |g |d|� |dd� |dd�< dS )a
Transform the following node tree::
<node>
<title>
<section>
<title>
...
into ::
<node>
<title>
<subtitle>
...
r NFTr
r r
)r r r r r �subtitler )r r �
subsectionr r r r r �promote_subtitleS s
�
�
�z TitlePromoter.promote_subtitlec C sD |� tj�}|du st|�|d kst|| tj�s dS || |fS )z�
Find and return the promotion candidate and its index.
Return (None, None) if no valid candidate was found.
Nr
)NN)� first_child_not_matching_classr �PreBibliographicr r r )r r r r r r r s �� z TitlePromoter.candidate_indexN)�__name__�
__module__� __qualname__�__doc__r r r r r r r r # s
* ,r c @ s$ e Zd ZdZdZdd� Zdd� ZdS )�DocTitlea�
In reStructuredText_, there is no way to specify a document title
and subtitle explicitly. Instead, we can supply the document title
(and possibly the subtitle as well) implicitly, and use this
two-step transform to "raise" or "promote" the title(s) (and their
corresponding section contents) to the document level.
1. If the document contains a single top-level section as its
first non-comment element, the top-level section's title
becomes the document's title, and the top-level section's
contents become the document's immediate contents. The lone
top-level section header must be the first non-comment element
in the document.
For example, take this input text::
=================
Top-Level Title
=================
A paragraph.
Once parsed, it looks like this::
<document>
<section names="top-level title">
<title>
Top-Level Title
<paragraph>
A paragraph.
After running the DocTitle transform, we have::
<document names="top-level title">
<title>
Top-Level Title
<paragraph>
A paragraph.
2. If step 1 successfully determines the document title, we
continue by checking for a subtitle.
If the lone top-level section itself contains a single
second-level section as its first non-comment element, that
section's title is promoted to the document's subtitle, and
that section's contents become the document's immediate
contents. Given this input text::
=================
Top-Level Title
=================
Second-Level Title
~~~~~~~~~~~~~~~~~~
A paragraph.
After parsing and running the Section Promotion transform, the
result is::
<document names="top-level title">
<title>
Top-Level Title
<subtitle names="second-level title">
Second-Level Title
<paragraph>
A paragraph.
(Note that the implicit hyperlink target generated by the
"Second-Level Title" is preserved on the "subtitle" element
itself.)
Any comment elements occurring before the document title or
subtitle are accumulated and inserted as the first body elements
after the title(s).
This transform also sets the document's metadata title
(document['title']).
.. _reStructuredText: http://docutils.sf.net/rst.html
i@ c C sn | j �d�s1| j jjdur| j jj| j d< dS t| j �r3t| j d tj�r5| j d �� | j d< dS dS dS dS )a
Set document['title'] metadata title from the following
sources, listed in order of priority:
* Existing document['title'] attribute.
* "title" setting.
* Document title node (as promoted by promote_title).
r Nr )�document�hasattr�settingsr r r r �astext�r r r r � set_metadata� s �zDocTitle.set_metadatac C s4 | j j�dd�r| �| j �r| �| j � | �� d S )N�doctitle_xformT)r& r( �
setdefaultr r r+ r* r r r �apply� s zDocTitle.applyN)r! r" r# r$ �default_priorityr+ r. r r r r r% � s
R r% c @ s e Zd ZdZdZdd� ZdS )�SectionSubTitlea�
This works like document subtitles, but for sections. For example, ::
<section>
<title>
Title
<section>
<title>
Subtitle
...
is transformed into ::
<section>
<title>
Title
<subtitle>
Subtitle
...
For details refer to the docstring of DocTitle.
i^ c C s6 | j j�dd�s
d S | j �tj�D ]}| �|� qd S )N�sectsubtitle_xformT)r& r( r- � _traverser r r )r r r r r r. s
�zSectionSubTitle.applyN)r! r" r# r$ r/ r. r r r r r0 � s r0 c
@ s� e Zd ZdZdZejejejej ej
ej ej ej
ejejejejd� Z dd� Zdd� Zdd � Zd
d � Ze�d ej�d
fe�dej�dfe�d�dfgZdd� Zdd� Zdd� Z dd� Z dS )�DocInfoaT
This transform is specific to the reStructuredText_ markup syntax;
see "Bibliographic Fields" in the `reStructuredText Markup
Specification`_ for a high-level description. This transform
should be run *after* the `DocTitle` transform.
Given a field list as the first non-comment element after the
document title and subtitle (if present), registered bibliographic
field names are transformed to the corresponding DTD elements,
becoming child elements of the "docinfo" element (except for a
dedication and/or an abstract, which become "topic" elements after
"docinfo").
For example, given this document fragment after parsing::
<document>
<title>
Document Title
<field_list>
<field>
<field_name>
Author
<field_body>
<paragraph>
A. Name
<field>
<field_name>
Status
<field_body>
<paragraph>
$RCSfile$
...
After running the bibliographic field list transform, the
resulting document tree would look like this::
<document>
<title>
Document Title
<docinfo>
<author>
A. Name
<status>
frontmatter.py
...
The "Status" field contained an expanded RCS keyword, which is
normally (but optionally) cleaned up by the transform. The sole
contents of the field body must be a paragraph containing an
expanded RCS keyword of the form "$keyword: expansion text $". Any
RCS keyword can be processed in any bibliographic field. The
dollar signs and leading RCS keyword name are removed. Extra
processing is done for the following RCS keywords:
- "RCSfile" expands to the name of the file in the RCS or CVS
repository, which is the name of the source file with a ",v"
suffix appended. The transform will remove the ",v" suffix.
- "Date" expands to the format "YYYY/MM/DD hh:mm:ss" (in the UTC
time zone). The RCS Keywords transform will extract just the
date itself and transform it to an ISO 8601 format date, as in
"2000-12-31".
(Since the source file for this text is itself stored under CVS,
we can't show an example of the "Date" RCS keyword because we
can't prevent any RCS keywords used in this explanation from
being expanded. Only the "RCSfile" keyword is stable; its
expansion text changes only if the file name changes.)
.. _reStructuredText: http://docutils.sf.net/rst.html
.. _reStructuredText Markup Specification:
http://docutils.sf.net/docs/ref/rst/restructuredtext.html
iT ) �author�authors� organization�address�contact�version�revision�status�date� copyright�
dedication�abstractc C s| | j j�dd�s
d S | j }|�tj�}|d u rd S || }t|tj�r<|�tjtj f�}| �
|�}||= ||||�< d S d S )N�
docinfo_xformT) r& r( r- r r r r �
field_list�Titular�
Decorative�extract_bibliographic)r r& r � candidate� biblioindex�nodelistr r r r. � s" �
�
�z
DocInfo.applyc C s@ t �� }| jj}| jj}d d d�}|D ]�}z�|d d �� }t �|�}t|�dkr3||v r3| �||�s5t �|| } | j
| }
t |
t j �rh| �
||�sLt �t�|d d | j� |�|
ddg|d d �R � � n[t |
t j�rv| �|||� nMt |
t j�r�|| r�|d | jjjd| |d�7 < t �t �||| �} || | d _|
d| g|d j�R d | gi�|| < n|�|
dg|d j�R � � W q t y� t|d �dkr�t|d d t j �r�t�|d d | j� t � |�} | r�|d �| � |�|� Y qw g }
t|�dk�r |
�|� dD ]}|| �r |
�|| � �q|
S )
N)r> r? r � r
� ���z!There can only be one "%s" field.�� base_node�classes) r �docinfo�language�bibliographic_fields�labelsr) �fully_normalize_namer �check_empty_biblio_fieldr � biblio_nodes�
issubclass� TextElement�check_compound_biblio_fieldr �clean_rcs_keywords�rcs_keyword_substitutions�appendr5 �extract_authors�topicr& �reporter�warningr � rawsource�childrenr � paragraph�make_id)r rA rN � bibliofieldsrQ �topics�field�name�
normedname� canonical� biblioclassr �
classvaluerG r r r rD � sz
�
�"
��� � � ��
�
�z DocInfo.extract_bibliographicc C s: t |d �dk r|d | jjjd| |d�7 < d S dS )NrJ r
z.Cannot extract empty bibliographic field "%s".rK )r r& r] r^ �r re rf r r r rS � s
�z DocInfo.check_empty_biblio_fieldc C st t |d �dkr|d | jjjd| |d�7 < d S t|d d tj�s8|d | jjjd| |d�7 < d S dS )NrJ r
z1Cannot extract compound bibliographic field "%s".rK r zZCannot extract bibliographic field "%s" containing anything other than a single paragraph.)r r& r] r^ r r ra rk r r r rW � s
��
�z#DocInfo.check_compound_biblio_fieldz8\$Date: (\d\d\d\d)[-/](\d\d)[-/](\d\d)[ T][\d:]+[^$]* \$z\1-\2-\3z\$RCSfile: (.+),v \$z\1z\$[a-zA-Z]+: (.+) \$c C s� zMt |d �dkr+t|d d tj�r| �|�}nt|d d tj�r)| �|�}nt�| �|�}dd� |D �}t |�dkrL|� tj
dg|�R � � W d S t� tym |d | j j j
d|d�| jj�f |d�7 < � w ) Nr
r c S s$ g | ]}|rt jd d g|�R � �qS )rI )r r4 )�.0r4 r r r �
<listcomp>� s �z+DocInfo.extract_authors.<locals>.<listcomp>rI rJ z�Bibliographic field "%s" incompatible with extraction: it must contain either a single paragraph (with authors separated by one of "%s"), multiple paragraphs (one per author), or a bullet list with one paragraph (one author) per item.rK )r r r ra �authors_from_one_paragraph� bullet_list�authors_from_bullet_listr �authors_from_paragraphsrZ r5 r& r] r^ �joinrO �author_separators)r re rf rN r5 � authornodesr r r r[ � s.
� �
��zDocInfo.extract_authorsc C sz d� dd� |d �tj�D ��}|st�| jjD ]}d| }t�||�}t |�dkr, nqdd� |D �}dd� |D �}|S ) z~Return list of Text nodes for authornames.
The set of separators is locale dependent (default: ";"- or ",").
rI c s s � | ]}t |�V qd S �N)�unicode)rl r r r r � <genexpr> s � �z5DocInfo.authors_from_one_paragraph.<locals>.<genexpr>r
z(?<! )%sc s s � | ]}|� � V qd S ru )�strip�rl rf r r r rw
s � c S s& g | ]}|rt �|t�|d ��g�qS )T)r �Textr �unescapery r r r rm s �z6DocInfo.authors_from_one_paragraph.<locals>.<listcomp>)
rr �traverser rz r rO rs �re�splitr )r re �text� authorsep�pattern� authornamesr5 r r r rn � s
� ��z"DocInfo.authors_from_one_paragraphc C s` g }|d d D ]!}t |tj�rqt|�dks t |d tj�s!t�|�|d j� q|s.t�|S )Nr
r )r r �commentr ra r rZ r` )r re r5 �itemr r r rp s z DocInfo.authors_from_bullet_listc C s: |d D ]
}t |tjtjf�st�qdd� |d D �}|S )Nr
c S s g | ] }t |tj�s|j�qS r )r r r� r` )rl r� r r r rm " s
�z3DocInfo.authors_from_paragraphs.<locals>.<listcomp>)r r ra r� r )r re r� r5 r r r rq s �z DocInfo.authors_from_paragraphsN) r! r" r# r$ r/ r r4 r5 r6 r7 r8 r9 r: r; r< r= r\ rT r. rD rS rW r} �compile�
IGNORECASErY r[ rn rp rq r r r r r3 # sB J�
4�� � r3 )r$ �
__docformat__r} �sys�docutilsr r �docutils.transformsr r � version_info�strrv r r% r0 r3 r r r r �<module> s
kp%