$ d Z dZddlZddlmZmZmZ ddlmZm Z G d de Z
G d d e
Z G d
d e
Z G d d
e Z
dS )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)nodesparsersutils)TransformError Transformc $ e Zd ZdZd Zd Zd ZdS )
TitlePromoterzJ
Abstract base class for DocTitle and SectionSubTitle transforms.
c t |t j st d t | r"t |d t j rJ | | \ }}|dS | |dd |dd |d| z |dd z |dd< t |d t j sJ dS )a
Transform the following tree::
...
into ::
<node>
<title>
...
`node` is normally a document.
%node must be of Element-derived type.r NFTreplace
and_source )
isinstancer Element TypeErrorlentitlecandidate_index update_all_atts_concatenating)selfnodesectionindexs /builddir/build/BUILD/imunify360-venv-2.6.2/opt/imunify360/venv/lib/python3.11/site-packages/docutils/transforms/frontmatter.py
promote_titlezTitlePromoter.promote_title$ s $ $
.. E CDD D IIC*T!Wek"B"BCCC --d33 =5
**7D6: + < < < 2A2;&5&\" QRR[!QQQ $q'5;/////t c b t |t j st d | | \ }}|dS t j }| |dd |d dd |dd< |dd |gz |d| z |dd z |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 s r promote_subtitlez TitlePromoter.promote_subtitleO s $ $
.. E CDD D 0 0 6 6
E =5>## ..z4:> / @ @ @
!mAAA& 8 Z !E']#
^ $QQQ tr c | t j }|6t | |dz k s t || t j sdS || |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 s r r z TitlePromoter.candidate_index| sd 33 "$ $ MSYY%!) 4 4 d5k5=99 5 :;% %r N)__name__
__module__ __qualname____doc__r r" r r r r
r
sM ) ) )V+ + +Z & & & & &r r
c " e Zd ZdZdZd Zd 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: https://docutils.sourceforge.io/rst.html
i@ c ^ | j d s| j j j | j j j | j d< dS t | j rPt | j d t j r-| 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 )documenthasattrsettingsr r r r astextr s r set_metadatazDocTitle.set_metadata s }$$W-- C}%+7)- )?)E
g&&&T]##
C
4=3C38;)@ )@
C)- q)9)@)@)B)B
g&&& C C
C
C
C
Cr c | j j dd r4| | j r| | j | d S )Ndoctitle_xformT)r. r0
setdefaultr r" r3 r2 s r applyzDocTitle.apply sh = ! , ,-=t D D 5!!$-00
5 %%dm444 r N)r& r' r( r) default_priorityr3 r7 r* r r r, r, sJ P Pd C C C r r, c e Zd ZdZdZd 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 | j j dd sd S | j t j D ]}| | d S )Nsectsubtitle_xformT)r. r0 r6 findallr r r" )r r s r r7 zSectionSubTitle.apply si }%001EtLL F},,U];; + +G
! !' * * * * + +r N)r& r' r( r) r8 r7 r* r r r: r: s5 . + + + + +r r: c
` e Zd ZdZdZej ej ej ej ej
ej ej ej
ej ej ej ej d Z d Zd Zd Zd Z ej dej d f ej d
ej d f ej d d fgZd
Zd Zd Z d Z dS )DocInfoaf
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: https://docutils.sourceforge.io/rst.html
.. _reStructuredText Markup Specification:
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
iT ) authorauthors organizationaddresscontactversionrevisionstatusdate copyright
dedicationabstractc | j j dd sd S | j }| t j }|d S || }t
|t j rW| t j t j t j
f }| | }||= ||||< d S d S )N
docinfo_xformT) r. r0 r6 r$ r r% r
field_listTitular
Decorativemetaextract_bibliographic)r r. r candidate biblioindexnodelists r r7 z
DocInfo.apply s }%00 $GG F=77$& & = F UO i!1 2 2 9"AA=%"2EJ?A AK11)<<H08H[, - - - 9 9r c t j }| j j }| j j }d d d}|D ]} |d d }t j | }t | dk r||v r| || st || } | j
| }
t |
t j rm|
|| st t j |d d | j | |
ddg|d d R nt |
t j r| ||| nt |
t j r|| r9|dxx | j j d|z | z
cc< t t j ||| } || | d _ |
d| g|d j R d | gi|| < n'| |
dg|d j R # t $ r t |d dk rLt7 |d d t j r&t j |d d | j t j | } | r|d | | | Y w xY wg }
t | dk r|
| dD ]%}|| r|
|| &|
S )
N)rJ rK r r z!There can only be one "%s" field. base_nodeclasses) r docinfolanguagebibliographic_fieldslabelsr1 fully_normalize_namer check_empty_biblio_fieldr biblio_nodes
issubclass TextElementcheck_compound_biblio_fieldr clean_rcs_keywordsrcs_keyword_substitutionsappendrA extract_authorstopicr. reporterwarningr rawsourcechildrenr paragraphmake_id)r rN r] bibliofieldsr` topicsfieldname
normedname canonical biblioclassr
classvaluerU s r rR z DocInfo.extract_bibliographic s -//}9 % $$77 & & & &E%
& Qx{))++ " 7 = =
E
aJ,,F,F 9 9% F F -G(( ( 4 " / : k5+<== H ;;E4HH - ,,, (1+t'EG G GNN;;r2#Da #D#D#DEEEE U];;
H((g>>>> U[99 H i( - b T]%;%C%C ?$ F&+ &D &- &- - -, !KfY.? @ @E)/ ):E!H&(3 E)L9>q9J)L )L )L,5;)L )LF9%% NN;;r#FE!H4E#F#F#FGGG!
&
&
&uRy>>Q&&%eBilEODD ', b ! d&DF F F #]: 6 6
8)$++J777u%%%%%
& w<<1 OOG $ $ $. . .Dd|
.t ---s HH<<B5K54K5c t |d dk r5|dxx | j j d| d| z
cc< dS dS )NrY r z*Cannot extract empty bibliographic field "z".rZ FT)r r. rl rm )r rt ru s r rb z DocInfo.check_empty_biblio_field sf uRy>>A "III /77GtGGG ! 8 # #
#III 5tr c . |d }t | dk r"t |d t j rdS t |d t j rd|j vrt j d|j j
}t j
}| d|j z | t |j dk r3t |j d t j r|j |_ dS d |j D }t | dk r d d
| z d z }n d |d z }|| j j d
| d| d| z
}dS )NrY r r T
z*DocInfo transform*\c $ g | ]
}d |j dS )<>)tagname).0es r
<listcomp>z7DocInfo.check_compound_biblio_field.<locals>.<listcomp> s& ===#qy###===r [z, ]za zBibliographic field "z)"
must contain a single <paragraph>, not .rZ F)r r r rp enumerated_listrn stripr new_documentr. r0 r rstParserparsero joinrl rm )r rt ru f_body _documentparsercontents r rf z#DocInfo.check_compound_biblio_field s r v;;!
6!9eo F F 4
vay%"7 8 8
F , 2 2 4 444 *+@+0>+BD DI [''))F LLf .. : : :I&''1,, y 1! 4eoFF -"+"4t==V_=== w<<! DIIg . ..4GGWQZ'G$-(00>d > >3:> > > % 1 ' ' ' ur z8\$Date: (\d\d\d\d)[-/](\d\d)[-/](\d\d)[ T][\d:]+[^$]* \$z\1-\2-\3z\$RCSfile: (.+),v \$z\1z\$[a-zA-Z]+: (.+) \$c t |d dk rt |d d t j r| | }nXt |d d t j r| | }n t | | }d |D }t | dk r'| t j
dg|R d S t # t $ rX |dxx | j j
d| d| dd | j j d |
z
cc< w xY w) Nr r c 8 g | ]}|t j d d g|R S )rX )r r@ )r r@ s r r z+DocInfo.extract_authors.<locals>.<listcomp> s@ < < < %F<5<B8888 < < <r rX rY zCannot extract "z1" from bibliographic field:
Bibliographic field "zR" must contain either
a single paragraph (with author names separated by one of "z"),
multiple paragraphs (one per author),
or a bullet list with one author name per item.
Note: Leading initials can cause (mis)recognizing names as enumerated list.rZ )r r r rp authors_from_one_paragraph bullet_listauthors_from_bullet_listr authors_from_paragraphsri rA r. rl rm r r^ author_separators)r rt ru r] rA authornodess r rj zDocInfo.extract_authors s 58}}!! eAhqk5?;; ) " = =e D DGG a U->?? ) " ; ;E B BGG(( 66u==< <)0< < <K; 1$$u}R >+ > > >?????$$ "III /77&4 & &(,& & GGDM ;<<& & & 8 ! !
!III
s C1C< 5C< <A"E c D d d |d t j D }|st | j j D ]1}d|z }t j || }t | dk r n2d |D }d |D S )zReturn list of Text nodes with author names in `field`.
Author names must be separated by one of the "autor separators"
defined for the document language (default: ";" or ",").
rX c 3 4 K | ]}t | V d S N)str)r r s r <genexpr>z5DocInfo.authors_from_one_paragraph.<locals>.<genexpr> sD A A 4yy A A A A A Ar r z(?<! )%sc 3 > K | ]}| V d S r )r r ru s r r z5DocInfo.authors_from_one_paragraph.<locals>.<genexpr> s* <<tzz||<<<<<<r c < g | ]}|t j | gS r* )r Textr s r r z6DocInfo.authors_from_one_paragraph.<locals>.<listcomp>! s* CCCtdCD!!"CCCr )
r r= r r r r^ r resplitr )r rt text authorseppattern authornamess r r z"DocInfo.authors_from_one_paragraph s ww A A#(8#3#3EJ#?#?A A A A A ! 8 I#i/G (7D11K; !## $<< <<< CC{CCCCr c ( g }|d d D ]w}t |t j r t | dk s t |d t j st
| |d j x|st
|S )Nr r )r r commentr rp r ri ro )r rt rA items r r z DocInfo.authors_from_bullet_list# s !HQK - -D$
..
4yyA~~ZQ %I%I~$$ NN47+ , , , , ! r c |d D ]/}t |t j t j f st 0d |d D }|S )Nr c P g | ]#}t |t j |j $S r* )r r r ro )r r s r r z3DocInfo.authors_from_paragraphs.<locals>.<listcomp>3 s: ; ; ;T$T5=99;4= ; ; ;r )r r rp r r )r rt r rA s r r z DocInfo.authors_from_paragraphs/ sa !H % %D dU_em$DEE
%$$
%; ;U1X ; ; ;r N) r& r' r( r) r8 r r@ rA rB rC rD rE rF rG rH rI rk rc r7 rR rb rf r compile
IGNORECASErh rj r r r r* r r r? r? ! sR H HT L] ,]]]nL* k # #L*9 9 9 2 2 2h B 2: "#%= 2 23> @ 2:12= A A5
I 2:- . .
6 !8 <D D D(
r r? )r)
__docformat__r docutilsr r r docutils.transformsr r r
r, r: r? r* r r <module>r s$
" #
* * * * * * * * * * 9 9 9 9 9 9 9 9j& j& j& j& j&I j& j& j&Zn n n n n } n n n b"+ "+ "+ "+ "+m "+ "+ "+JT T T T Ti T T T T Tr