D 8 d Z dZddlZddlZddlZddlmZmZ ddlZddl Z ddl
Z
ddl Z ddl m
Z
mZmZ ddl mZmZ ddlmZ G d d e
Z G d
d e
Z G d d
Z G d de Z G d de Z G d de Z G d de Zd Zd Z d Z G d de Z d Z d Z d Z!d:d Z"d Z#d Z$d:d!Z%d" Z&d# Z'd$ Z(d% Z)d& Z*d' Z+d( Z,d) Z-d* Z.d+d+d,d,d,d,d-Z/ d. Z0d/ Z1d0 Z2d:d1Z3 G d2 d3 Z4d4d5d6d7d8Z5d:d9Z6dS );z:
Miscellaneous utilities for the documentation utilities.
reStructuredText N)PurePathPath)ApplicationError DataError__version_info__)ionodes)unescapec e Zd Zd ZdS )
SystemMessagec n t | | || _ d S N) Exception__init__astextlevel)selfsystem_messager s w/builddir/build/BUILD/imunify360-venv-2.6.2/opt/imunify360/venv/lib/python3.11/site-packages/docutils/utils/__init__.pyr zSystemMessage.__init__ s/ 4 !6!6!8!8999
N)__name__
__module__ __qualname__r r r r
r
s# r r
c e Zd ZdS )SystemMessagePropagationNr r r r r r r r ! s Dr r c e Zd ZdZd Z ed \ ZZZ Z
Z ddZ ddZ
d Zd
Zd Zd Zd
Zd Zd Zd Zd ZdS )Reporteraq
Info/warning/error reporter and ``system_message`` element generator.
Five levels of system messages are defined, along with corresponding
methods: `debug()`, `info()`, `warning()`, `error()`, and `severe()`.
There is typically one Reporter object per process. A Reporter object is
instantiated with thresholds for reporting (generating warnings) and
halting processing (raising exceptions), a switch to turn debug output on
or off, and an I/O stream for warnings. These are stored as instance
attributes.
When a system message is generated, its level is compared to the stored
thresholds, and a warning or error is generated as appropriate. Debug
messages are produced if the stored debug switch is on, independently of
other thresholds. Message output is sent to the stored warning stream if
not set to ''.
The Reporter class also employs a modified form of the "Observer" pattern
[GoF95]_ to track system messages generated. The `attach_observer` method
should be called before parsing, with a bound method or function which
accepts system messages. The observer can be removed with
`detach_observer`, and another added in its place.
.. [GoF95] Gamma, Helm, Johnson, Vlissides. *Design Patterns: Elements of
Reusable Object-Oriented Software*. Addison-Wesley, Reading, MA, USA,
1995.
z DEBUG INFO WARNING ERROR SEVERE NFbackslashreplacec || _ || _ || _ || _ || _ t |t j st
j ||| }|| _ |pt |dd | _
g | _ d| _ dS )a7
:Parameters:
- `source`: The path to or description of the source data.
- `report_level`: The level at or above which warning output will
be sent to `stream`.
- `halt_level`: The level at or above which `SystemMessage`
exceptions will be raised, halting execution.
- `debug`: Show debug (level=0) system messages?
- `stream`: Where warning output is sent. Can be file-like (has a
``.write`` method), a string (file name, opened for writing),
'' (empty string) or `False` (for discarding all stream messages)
or `None` (implies `sys.stderr`; default).
- `encoding`: The output encoding.
- `error_handler`: The error handler for stderr output encoding.
encodingasciiN)
source
error_handler
debug_flag report_level
halt_level
isinstancer ErrorOutputstreamgetattrr$ observers max_level)r r' r* r+ r. debugr$ r( s r r zReporter.__init__N s $ < *3 3 ( % . &".11 E^FHmDDF + HGFJ$H$H
, @@r c t j dt d || _ || _ t |t j s t
j || j | j }|| _
|| _ d S )Nzdocutils.utils.Reporter.set_conditions() deprecated; Will be removed in Docutils 0.21 or later. Set attributes via configuration settings or directly.
stacklevel) warningswarnDeprecationWarningr* r+ r, r r- r$ r( r. r) )r categoryr* r+ r. r2 s r set_conditionszReporter.set_conditions sx
O )Q 8 8 8 8 )$&".11 O^FDM4;MNNF r c : | j | dS )z
The `observer` parameter is a function or bound method which takes one
argument, a `nodes.system_message` instance.
N)r0 appendr observers r attach_observerzReporter.attach_observer s
h'''''r c : | j | d S r )r0 remover> s r detach_observerzReporter.detach_observer s h'''''r c 0 | j D ]
} || d S r )r0 )r messager? s r notify_observerszReporter.notify_observers s0 H HW r c t |t rt | }| }d|v rKt |d \ }}|d= || d| || d| d|vrP | | d \ }}n# t $ r d\ }}Y nw xY w|||d< |||d< | d| j t j |g|R || j | d|}| j
rW|| j k s | j r || j k s || j k r/| j
| dz || j k rt) || || j k s| j r| | t- || j | _ |S )zs
Return a system_message object.
Raise an exception or generate a warning if appropriate.
base_nodeNr' lineNN)r type
)r, r strcopyget_source_line
setdefaultget_source_and_linegetAttributeErrorr' r
r levelsr. r* r) DEBUG_LEVELr+ writer r
rF maxr1 ) r r rE childrenkwargs
attributesr' rI msgs r r zReporter.system_message s$ gy ) ) #'llG[[]]
& *6++>??LFD;'!%%h777 %%fd333 : % %
* # 7 7
v8N8N O O !
*
*
* )
*!'-
8$ %)
6" h 444"7 <$,< <%(, E(:< <0:< < ; 3ET%6 6 6 # 738D>DD$ii!mm Q 99 T!W "" Q
EJ77 #$:<@AB B
B 71:$$&&DD$<(((( r c 4 i }| D ]\ }}|| }|t | ||v rt d|z || ||< D# t t f$ r;}| d|d|dd |j d}~ww xY w|S )aa
Return a mapping of option names to values.
:Parameters:
- `option_list`: A list of (name, value) pairs (the output of
`extract_options()`).
- `options_spec`: Dictionary mapping known option names to a
conversion function such as `int` or `float`.
:Exceptions:
- `KeyError` for unknown option names.
- `DuplicateOptionError` for duplicate options.
- `ValueError` for invalid option values (raised by conversion
function).
- `TypeError` for invalid option value types (raised by conversion
function).
Nzduplicate option "%s"z
(option: "z
"; value: z)
)KeyErrorrv
ValueError TypeError __class__joinr^ )r| r{ optionsr value convertordetails r ry ry 4 s $ G"
K
K e & 4.. 7??&'>'EFF F K %Ie , ,GDMMI& K K K"""&*ddEEE388FK3H3H3H$J K K
K K Ns A B6BBc e Zd ZdS )NameValueErrorNr r r r r r U rp r r c b t | t r| S | t j d } nn# t
$ r | sY dS t
d| t $ rA | dd } n&# t $ r | dd } Y nw xY wY nw xY w| S )z
Ensure `path` is Unicode. Return `str` instance.
Decode file/path string in a failsafe manner if not already done.
strict z/`path` value must be a String or ``None``, not utf-8r% replace)r, rM decodesysgetfilesystemencodingrS r UnicodeDecodeError)paths r decode_pathr X s $ 3{{3466AA * * * 22 ) $) ) * * * 3 3 3 3;;w11DD! 3 3 3;;w 22DDD 33
Ks; 'A B,B,,BB, B&#B,%B&&B,+B,c g }| r| d }|dk rt d | d| }|dk s|st d | |dz d } | st d|z | d d v r| | d d }|dk r t d
|d | d d t | |dz k r9| |dz r t d
|d
| d d | d| }| |dz d } nI| d }|dk r| }d} n)| d| }| |dz d } | | |f | |S )z
Return a list of (name, value) from a line of the form "name=value ...".
:Exception:
`NameValueError` for invalid input (missing name, missing data, bad
quotes, etc.).
=r& z missing "="Nr z!missing attribute name before "="r zmissing value after "%s="z'"z attribute "z" missing end quote ()z
" end quote (z ) not followed by whitespacer r )findr striplstripr r= r )rI attlistequalsattnameendquoter spaces r extract_name_valuer p s G
03 R<< // /ww-%%'' Q;;g; 57 7
7F1HII%%'' 9 -79 9
9 7e yya!,,H2~~$n $q'''+, , , 4yy8a<''DA ,>,D,D,F,F'$n&-ggtAwww89 9 9 (
#D
$++--DDIIcNNE{{FUF|E!GHH~,,..
.///A 0B Nr c n t | |j |j |j |j |j |j }|S )z
Return a new Reporter object.
:Parameters:
`source` : string
The path to or description of the source text of the document.
`settings` : optparse.Values object
Runtime settings.
)r. r2 r$ r( )r r* r+ warning_streamr2 error_encoding error_encoding_error_handler) source_pathsettingsreporters r new_reporterr sB X*H,?&hn( ; = = =H
Or c ddl m} || }t | } t | | }t j ||| }| | d |S )a
Return a new empty document object.
:Parameters:
`source_path` : string
The path to or description of the source text of the document.
`settings` : optparse.Values object
Runtime settings. If none are provided, a default core set will
be used. If you will use the document object with any Docutils
components, you must provide their default settings as well.
For example, if parsing rST, at least provide the rst-parser
settings, obtainable as follows:
Defaults for parser component::
settings = docutils.frontend.get_default_settings(
docutils.parsers.rst.Parser)
Defaults and configuration file customizations::
settings = docutils.core.Publisher(
parser=docutils.parsers.rst.Parser).get_settings()
r )frontendN)r' r& )docutilsr get_default_settingsr r r
document note_source)r r r r r s r new_documentr sz 6 "!!!!!0022 k**KK22H~hEEEH b))) Or c t | dk rut | d t j rW| d }|D ]N\ }}| | }|r.t j | || | d< d S Kd S d S d S )Nr r )r r, r
r searchsub)r keyword_substitutionstextnodepattern substitutionmatchs r clean_rcs_keywordsr s
9~~z)A,
C C Q<%: !G\NN8,,E
$z'++lH*M*M N N !
r c t j | p t | d t j }t j | t j }|dd |dd k rd | S | | |rR|rP|d |d k r>| | |r|r|d |d k >| dgt | dz
z |z }d | S )a
Build and return a path to `target`, relative to `source` (both files).
Differences to `os.relpath()`:
* Inverse argument order.
* `source` expects path to a FILE (while os.relpath expects a dir)!
(Add a "dummy" file name if `source` points to a directory.)
* Always use Posix path separator ("/") for the output.
* Use `os.sep` for parsing the input (ignored by `os.relpath()`).
* If there is no common prefix, return the absolute path to `target`.
dummy_fileNr4 /r& z..r )
osr abspathrK rl sepr reversepopr )r' target source_parts target_partspartss r
relative_pathr sh 7??6#G\T&\\,-G-G % %%*U26]] 7??6**0088LBQB<+++ xx %%% L B <#333 L B <#333
Fc,''!+ ,| ;E 88E??r c t j dt d | j r/| j r
J d || j }t
|| j S | j S )z
Retrieve a stylesheet reference from the settings object.
Deprecated. Use get_stylesheet_list() instead to
enable specification of multiple stylesheets as a comma-separated
list.
zqutils.get_stylesheet_reference() is obsoleted by utils.get_stylesheet_list() and will be removed in Docutils 2.0.r4 r5 6stylesheet and stylesheet_path are mutually exclusive.)r7 r8 r9 stylesheet_path
stylesheet _destinationr )r relative_tos r get_stylesheet_referencer s
M : %4 4 4 4 #& F F D F F& "/K [(*BCCC""r c j r j r
J d j p j pg }t |t s d | d D } j r fd|D }|S )zJ
Retrieve list of stylesheet references from the settings object.
r c 6 g | ]}| S r )r ).0r s r
z'get_stylesheet_list..) s GGGtzz||GGGr ,c : g | ]}t |j S r )find_file_in_dirsstylesheet_dirs)r r r s r r z'get_stylesheet_list.., s6 0 0 0 )x/GHH 0 0 0r )r r r, listrl )r stylesheetss ` r get_stylesheet_listr s # F(@ F F DF F A*Gh.AGRK k4 ( ( HGG 0A0A#0F0FGGG 00 0 0 0#.0 0 0 r c > t | } | r| S |D ]P}t | | z }| r| c S Q| S )z}
Search for `path` in the list of directories `dirs`.
Return the first expansion that matches an existing file.
)r is_absoluteas_posix
expanduserexists)r dirsdfs r r r 1 s ::D }}
GG 4 ' 88:: ::<< ==??r c f | dd t | dd dk S | j S )z
Return whether or not to trim footnote space.
If trim_footnote_reference_space is not None, return it.
If trim_footnote_reference_space is None, return False unless the
footnote reference style is 'superscript'.
trim_footnote_reference_spaceNfootnote_references superscript)rP r/ r )r s r get_trim_footnote_ref_spacer A s< :DAAIx!6== NN55r c T | r%| j s| j r| j | j fS | j } | %dS )zk
Return the "source" and "line" attributes from the `node` given or from
its closest ancestor.
rJ )r' rI parent)nodes r rO rO P sF
; *$) *; ) ){ :r c : g }d} | d| }|dk r2| | |d d | S | | || | d| |dz |d z z |d z })
z;Return a string with escape-backslashes converted to nulls.r T\r& Nr r r4 )r r= r )textr startfounds r escape2nullr \ s E
E $&& B;; LLeff & & &775>> !
T%+&'''
Vd5757? 33444 r c z | d }d |D }t t j | S )zh
Split `text` on escaped whitespace (null+space or null+newline).
Return a list of strings.
z c 8 g | ]}| d S )z
)rl )r strings r r z,split_escaped_whitespace..p s$ <<<&v||H%%<<z(strip_combining_chars..v s2 CC+*?*B*BC1CCCCCCr )r r s r strip_combining_charsr
u s#
77CCdCCC C CCr c 4 d t | D S )u Return indices of all combining chars in Unicode string `text`.
>>> from docutils.utils import find_combining_chars
>>> find_combining_chars('A t̆ab̆lĕ')
[3, 6, 9]
c @ g | ]\ }}t j | | S r r )r ir s r r z(find_combining_chars.. s, F F F$!Q[-B1-E-E FA F F Fr ) enumerater s r find_combining_charsr y s G F)D// F F FFr c t t t | }t | D ]}d||< d |D S )u Indices of Unicode string `text` when skipping combining characters.
>>> from docutils.utils import column_indices
>>> column_indices('A t̆ab̆lĕ')
[0, 1, 2, 4, 5, 7, 8]
Nc g | ]}||S r r )r r
s r r z"column_indices.. s 7 7 7! A r )r rm r r )r string_indicesindexs r column_indicesr sW %D **++N%d++ % % $u 7 7~ 7 7 77r r4 r )WFNaHNAc v t d | D }|t t | z }|S )zqReturn the column width of text.
Correct ``len(text)`` for wide East Asian and combining Unicode chars.
c 3 T K | ]#}t t j | V $d S r )east_asian_widthsr east_asian_widthr s r r z column_width.. sF "+">q"A"AB r )sumr r )r widths r column_widthr! sQ
E
S%d++
,
,,E Lr c F g }| D ]}||vr| | |S r )r= )Lritems r uniqr& s4
A q==
HHTNNN Hr c | dd } t j dd| } d | d D }| d f}g }t
t | dd D ]E}t j || D ]-}|
d ||z .F||z
}|S )aW Return a list of normalized combinations for a `BCP 47` language tag.
Example:
>>> from docutils.utils import normalize_language_tag
>>> normalize_language_tag('de_AT-1901')
['de-at-1901', 'de-at', 'de-1901', 'de']
>>> normalize_language_tag('de-CH-x_altquot')
['de-ch-x-altquot', 'de-ch', 'de-x-altquot', 'de']
-_z_([a-zA-Z0-9])_z_\1-c g | ]}|S r r )r subtags r r z*normalize_language_tag.. s 333&v333r r r& ) r r rer rl r rm r r combinationsr= r )tagsubtagsbase_tagtaglistntagss r normalize_language_tagr4 s ))++
c3
'
'C
&#Wc
2
2C33CIIcNN333G A HG
3w<<B
'
' 4 4 *7A66 4 4D NN388HTM22 3 3 3 3 4 xG Nr c T | r | dk rd| d}nd}d| dS )z{Return an XML text declaration.
Include an encoding declaration, if `encoding`
is not 'unicode', '', or None.
unicodez encoding=""r z
)r )r$ encoding_declarations r xml_declarationr9 sL "HNN$$ 11 8X 8 8 8 ! ;!5 ; ; ;;r c 2 e Zd ZdZd dZd Zd Zd Zd ZdS )
DependencyListz
List of dependencies, with file recording support.
Note that the output file is not automatically closed. You have
to explicitly call the close() method.
Nr c d g | _ d| _ |r| | | j | dS )z
Initialize the dependency list, automatically setting the
output file to `output_file` (see `set_output()`) and adding
all supplied dependencies.
If output_file is None, no file output is done when calling add().
N)r file
set_outputadd)r output_file dependenciess r r zDependencyList.__init__ sA ) OOK ( ( (, r c n |r2|dk rt j | _ dS t |dd | _ dS dS )a
Set the output file and clear the list of already added
dependencies.
`output_file` must be a string. The specified file is
immediately overwritten.
If output_file is '-', the output will be written to stdout.
r( wr )r$ N)r stdoutr= openr r@ s r r> zDependencyList.set_output sK Ec!! J cG D D D E Er c |D ]r}t |t r| }|| j vr>| j | | j | j |dz sdS )z
Append `path` to `self.list` unless it is already there.
Also append to `self.file` unless it is already there
or `self.file is `None`.
NrL )r, r r r r= r= rV )r pathsr s r r? zDependencyList.add s / /D$))
'}}49$$ &&&9(IOODI...
/ /r c l | j t j ur| j d| _ dS )z(
Close the output file.
N)r= r rD close)r s r rJ zDependencyList.close s0 9CJ & & IOO r c v | j j }n# t $ r d }Y nw xY w| j j d|d| j dS )N(z, r )r= r rS r r r rF s r __repr__zDependencyList.__repr__ sX ).KK KKK #~ 6 6 6 TYYYOOs )Nr ) r r r rk r r> r? rJ rM r r r r; r; sv E E E
/
/
/ P P P P Pr r; abrcr )alphabeta candidatefinalc | t } | j r d| j z }nd}t | j }| j r| j }nd}| j rd}nd}| j d| j ||||}|S )a4
Return a version identifier string built from `version_info`, a
`docutils.VersionInfo` namedtuple instance or compatible tuple. If
`version_info` is not provided, by default return a version identifier
string based on `docutils.__version_info__` (i.e. the current Docutils
version).
Nz.%sr z.dev.)r microrelease_level_abbreviations releaselevelserialreleasemajorminor) version_inforW rY rZ devversions r version_identifierra ( s ' ** .|/HIL $
G Nr r )7rk
__docformat__r r os.pathpathlibr r r, r r7 r r r r r r r
docutils.nodesr r
r r ro rr rt rv r} rx ry r r r r r r r r r r r rO r r r
r r r r! r& r4 r9 r; rX ra r r r rf s
#
" " " " " " " " B B B B B B B B B B # # # # # # $ / JG JG JG JG JG JG JG JGZ , + + + +9 + + + 0 0 0 0 0) 0 0 0 4 4 4 4 4- 4 4 4 6 6 6 6 6/ 6 6 6; ; ;2 F B & % % % %Y % % % 0* * *Z $" " " "J D# # # #@ "
6 6 6 + + +D D DG G G
8
8
8
6
<
<
<
<CP CP CP CP CP CP CP CPN
r