]j d Z dZddlZddlZddlZddlZddlZddlmZm Z m
Z
m Z m Z m
Z
mZ ddlmZ ddlmZ G d d Zd Zd
Zdd dd dd
ddddddeefdZ d$dZ d%dZde j ddd dd dd
dddddfdZde j dd dd dddddf dZ d&dZ dd dd dd
ddddddeede j fdZ d Z d'dZ d Z!d Z"d Z#d Z$d Z%d Z&d Z'd! Z(d" Z)d# Z*dS )(a
Calling the ``publish_*`` convenience functions (or instantiating a
`Publisher` object) with component names will result in default
behavior. For custom behavior (setting component options), create
custom component objects first, and pass *them* to
``publish_*``/`Publisher`. See `The Docutils Publisher`_.
.. _The Docutils Publisher:
https://docutils.sourceforge.io/docs/api/publisher.html
reStructuredText N) __version____version_details__ SettingsSpecioutilsreaderswriters) OptionParser)doctreec e Zd ZdZddddej dej dfdZd Zd Z d Z
ddZ d Z dd Z
d
Z dd Zdd Zdd
ZddZd Z ddZd Zd Zd Zd Zd ZdS ) PublisherzK
A facade encapsulating the high-level logic of a Docutils system.
Nc Z d| _ || _ || _ || _ dD ]G} t t | | t r"J dt | | d| d| d H|| _ || _ || _ || _
|| _ t j
| _ dS )a
Initial setup. If any of `reader`, `parser`, or `writer` are not
specified, ``set_components()`` or the corresponding ``set_...()``
method should be called with component names
(`set_reader` sets the parser as well).
N)readerparserwriterzpassed string "z" as "z+" parameter; pass an instance, or use the "zL_name" parameter instead (in docutils.core.publish_* convenience functions).)documentr r r
isinstancegetattrstrsource source_class destinationdestination_classsettingsr ErrorOutput_stderr)
selfr r r r r r r r components
m/builddir/build/BUILD/imunify360-venv-2.6.3/opt/imunify360/venv/lib/python3.11/site-packages/docutils/core.py__init__zPublisher.__init__$ s
; 3 3 35 D DI!'$ ":":C@@
D
D
D 4++++YYY C
D
D@
D G (?& "3 D
J ~'' c r t j | } ||| | _ | j j | _ dS )zSet `self.reader` by name.N)r get_reader_classr r )r reader_namer parser_name reader_classs r
set_readerzPublisher.set_readerU s5 / << "l6;77 k( r" c L t j | } | | _ dS )zSet `self.writer` by name.N)r
get_writer_classr )r writer_name writer_classs r
set_writerzPublisher.set_writer[ s# / << "lnn r" c | j | || j | | j 7| j j | j | | j j | _ | j | | d S d S N)r r( r
set_parserr r- )r r% r& r+ s r set_componentszPublisher.set_components` s ; OOKk B B B ; {!) &&{333 +,DK ; OOK ( ( ( ( ( r" c 0 t j dt d |rR|st }||_ | }t
| dk r|d dk rdg|_ t | j | j
| j |f|d|| S )
NzRPublisher.setup_option_parser is deprecated, and will be removed in Docutils 0.21. )
stacklevel application applicationsT)
componentsdefaultsread_config_filesusage description) warningswarnDeprecationWarningr config_sectionsplitlenconfig_section_dependenciesr r r r )r r< r=
settings_specrA r: partss r setup_option_parserz Publisher.setup_option_parserj s
>(Q 8 8 8 8 M
/ ,
+9M ("((**E5zzA~~%)}"<"<=K<L
9 T[$+}M [2 2 2 2r" c t j 5 t j dt | j |i |cd d d S # 1 swxY w Y d S )Nignore)category)r> catch_warningsfilterwarningsr@ rG )r argskwargss r _setup_settings_parserz Publisher._setup_settings_parser} s
$
&
& = = #H7I J J J J+4+T<V<< = = = = = = = = = = = = = = = = = =s (A A
A
c d | j ||||fi |}| | _ | j S )a
Return settings from components and config files.
Please set components first (`self.set_reader` & `self.set_writer`).
Use keyword arguments to override component defaults
(before updating from configuration files).
Calling this function also sets `self.settings` which makes
`self.publish()` skip parsing command line options.
)rO get_default_valuesr )r r< r= rE rA r:
option_parsers r get_settingszPublisher.get_settings sM 43 ;
~K KAIK K
%88::
} r" c | j @|r| ni }| dd | j d||d| d S d S )N tracebackT)rE rA )r copy
setdefaultrS )r rE settings_overridesrA r: s r process_programmatic_settingsz'Publisher.process_programmatic_settings s~ = 4FN)..000BH T 2 2 2 D
*M-;
*
* (
*
*
*
*
* ! r" c | j ||||fi |}|t j dd }| | | _ dS )z
Parse command line arguments and set ``self.settings``.
Pass an empty sequence to `argv` to avoid reading `sys.argv`
(the default behaviour).
Set components first (`self.set_reader` & `self.set_writer`).
Nr5 )rO sysargv
parse_argsr )r r] r< r= rE rA r: rR s r process_command_linez Publisher.process_command_line s_ 43 ;
~K KAIK K
<8ABB<D%0066
r" c ~ | j | | | j | | d S d S )N) source_path)destination_path)r
set_sourcer set_destination)r ra rb s r set_iozPublisher.set_io sM ; OO O 4 4 4 # 2B C C C C C $ #r" c |
| j j }n || j _ | ||| j j | j j | _ d S )N)r ra encoding
error_handler)r _sourcer input_encoding input_encoding_error_handlerr )r r ra s r rc zPublisher.set_source sU -/KK$/DM !''{]1 -D ( F F r" c p |u| j j r5| j j r)| j j | j j k rt d | j j dk r d | j _ | j j p | j j }|| j _ | ||| j j | j j | _ d S )NziThe positional argument <destination> is obsoleted by the --output option. You cannot use them together.-)r rb rg rh )r output _destination
SystemExitr output_encoding output_encoding_error_handlerr )r r rb s r rd zPublisher.set_destination s #
$
B )C
BM(DM,FFF "A B B B }#s**'+
$ $
4 !>#'=#=
%5
" 11# -]2 -E 2 G Gr" c | j j | j | j | j j | j | j f | j j d S r/ ) r transformerpopulate_from_componentsr r r r r apply_transformsr s r rv zPublisher.apply_transforms s]
!::
[$+t{'94;
!2244444r" Fc r d} | j | j |||||fi |pi | | | j | j | j | j | _ | | j
| j | j } | j
nt# t $ r}
d}|
j } Y d}
~
n\d}
~
wt $ rL}
| j s | j j r| | |
d}d} Y d}
~
nd}
~
ww xY w| |rM| j rF| j j j | j j k r't/ j | j j j dz n|rt/ j | | S )z
Process command line options and arguments (if `self.settings` not
already set), run `self.reader` and then `self.writer`. Return
`self.writer`'s output.
NTr5
)r r_ re promptr readr r r rv r writer assemble_partsrp code ExceptionrU debugging_dumpsreport_Exceptionreporter max_levelexit_status_levelr\ exit) r r] r< r= rE rY rA enable_exit_statusr rn error exit_statuss r publishzPublisher.publish s }$))%m^2 2)/R2 2 2
KKMMM KKMMM K , ,T[$+-1] < <DM ! ! # # #[&&t}d6FGGF K & & ( ( ( ( % % %D *KKKKKK =
}&
$$&&& ! !% ( ( (DKKKKKK
"4= " '1M34 4 HT]+5: ; ; ; ;
" H[ ! ! !
s% CC
D; C""
D;/AD66D;c " | j sd S | j j rHt d| j t t j | j j | j | j j rHt d| j t t j | j j | j | j j rmt d| j t d| j t t j d | j j
j D | j | j j rXt d| j t | j
d | j d S d S ) Nz
::: Runtime settings:filez
::: Document internals:z
::: Transforms applied:z@ (priority, transform class, pending node details, keyword args)c P g | ]#\ }}}}||j d |j |o|j |f$S ).)
__module____name__details).0priorityxclasspendingrN s r
<listcomp>z-Publisher.debugging_dumps.<locals>.<listcomp> sU 7 7 76Xvw v'8'8'8&// J-gov7 7 7 7r" z
::: Pseudo-XML:raw_unicode_escape)r r
dump_settingsprintr pprintpformat__dict__dump_internalsdump_transformsrt applieddump_pseudo_xmlencoderw s r r zPublisher.debugging_dumps s } F = & M +$, ? ? ? ? &. !788t| L L L L = ' M -DL A A A A &. !788t| L L L L = ( L -DL A A A A "(,
6
6
6
6 &.7 7 M-57 7 78 8 ?Cl
L
L
L
L
= ( : %DL 9 9 9 9 $-''))00$& &,0L
:
:
:
:
:
: : :r" c | j r| j sdS n# t $ r Y dS w xY wt j dk rdnd}d}d} | j j d }| j j d }n# t t f$ r Y nw xY wt dt d | d
| d | d | j
dS )z=Print info and prompt when waiting for input from a terminal.NntzCtrl+ZzCtrl+D zuseful formatsr z Docutils z/ <https://docutils.sourceforge.io>
converting "z" into "zT".
Call with option "--help" for more info.
.. Waiting for source text (finish with z on an empty line):r ) r isattyr AttributeErrorosnamer supportedr
IndexErrorr r )r eot_key in_format
out_formats r rz zPublisher.prompt s- K&&((
T\-@-@-B-B
FF goo((8 %
-a0I .q1JJ
+ D
#+ # # &# #0:# # :A# # #
< ! ! ! ! ! !s! 27
AA!$B BBc t |t j r| | d S t |t r| | d S t |t j r1| j dt
j
| z d S t |t j r1| j dt
j
| z d S t dt
j
| z | j t dt t r dt dnd d t j d
d | j d S ) Nz-Unable to open source file for reading:
%s
z2Unable to open destination file for writing:
%s
z%sr zExiting due to error. Use "--traceback" to diagnose.
Please report errors to <docutils-users@lists.sourceforge.net>.
Include "--traceback" output, Docutils version (z []r ),
Python version (r z5), your OS type & version, and the command line used.)r r
SystemMessagereport_SystemMessageUnicodeEncodeErrorreport_UnicodeErrorr
InputErrorr r| error_string OutputErrorr r r r\ versionrB r r s r r zPublisher.report_Exception1 s eU 0 1 1 2 % %e , , , , ,
1
2
2 2 $ $U + + + + +
r}
-
- 2 L (*,/%*@*@ A
B
B
B
B
B
r~
.
. 2 L ?5112
3
3
3
3
3
$ ///dl C C C C 2= !4;
""$$Q' %)L
2
2
2
2
2
2r" c ~ t d|j dt j j |j d| j d S )NzExiting due to level-z (z) system message.r )r levelr Reporterlevelsr r s r r z Publisher.report_SystemMessageG sM
+++u~ 4U[ A A AC< ! ! ! ! ! !r" c |j |j |j }| j t j | d| j j d| dd d| dd d| j j
dt d t j
d
d d S ) Nz!
The specified output encoding (z) cannot
handle all of the output.
Try setting "--output-encoding-error-handler" to
* "xmlcharrefreplace" (for HTML & XML output);
the output will contain "asciixmlcharrefreplacezU" and should be usable.
* "backslashreplace" (for other output formats);
look for "backslashreplacezr" in the output.
* "replace"; look for "?" in the output.
"--output-encoding-error-handler" is currently set to "z".
Exiting due to error. Use "--traceback" to diagnose.
If the advice above doesn't eliminate the error,
please report it to <docutils-users@lists.sourceforge.net>.
Include "--traceback" output, Docutils version (r r z6), your OS type & version, and the
command line used.
)objectstartendr r| r r r rq r rr r r\ r rB )r r datas r r z Publisher.report_UnicodeErrorL s |EK 12 * u%%%%},,,{{7$78888{{7$67777}:::{{CK - - / / 2 2 23
4 5 5 5 5 5r" )NNNN)NNNNN)NN)NNNNNNF)r r __qualname____doc__r FileInput
FileOutputr! r( r- r1 rG rO rS rZ r_ re rc rd rv r r rz r r r rV r" r r r s #4 2< !R] /( /( /( /(b) ) ) % % %
) ) ) ;??C2 2 2 2&= = = 488< " * * * GK@D7 7 7 7"D D D D F F F FG G G G$5 5 5 :>7;8=( ( ( (T: : :.! ! !,2 2 2,! ! !
5 5 5 5 5r" r z*%prog [options] [<source> [<destination>]]zReads from <source> (default is stdin) and writes to <destination> (default is stdout). See https://docutils.sourceforge.io/docs/user/config.html for a detailed settings reference.
standalonerestructuredtext pseudoxmlTc t | ||| }| ||| | | | |
||| |
}|S )aT
Set up & run a `Publisher` for command-line-based file I/O (input and
output file paths taken automatically from the command line).
Also return the output as `str` or `bytes` (for binary output document
formats).
Parameters: see `publish_programmatically()` for the remainder.
- `argv`: Command-line argument list to use instead of ``sys.argv[1:]``.
- `usage`: Usage string, output if there's a problem parsing the command
line.
- `description`: Program description, output for the "--help" option
(along with command-line option descriptions).
)r rA r r r1 r )r r% r r& r r+ r rE rY rA r r] r< r= publisherrn s r publish_cmdliner { sg * &&&8DDDI
[+{CCC
e[-1C%:L N NF Mr" Fc t di dt j d| d|dt j d|d|d|d|d |d
|d |d | d
|
d| d| d|
d|\ }}|S )z
Set up & run a `Publisher` for programmatic use with file-like I/O.
Also return the output as `str` or `bytes` (for binary output document
formats).
Parameters: see `publish_programmatically()`.
r r ra r r rb r r% r r& r r+ r rE rY rA r rV )publish_programmaticallyr r r )r ra r rb r r% r r& r r+ r rE rY rA r rn r s r publish_filer s 1
/
/
/\\
/*0&
/>Ik
/ --
/ K
/ 3C2B
/ v
/ $/;
/
v
/
$/;
/ v
/ $/;
/
/ *7
/ .-
/ &~
/ .-
/FI Mr" c t di dt j d| d|dt j ddd|d|d |d
|d |d |d
|d| d|
d| d| d|
\ }}|S )uC
Set up & run a `Publisher` for programmatic use with string I/O.
Accepts a `bytes` or `str` instance as `source`.
The output is encoded according to the `output_encoding`_ setting;
the return value is a `bytes` instance (unless `output_encoding`_ is
"unicode", cf. `docutils.io.StringOutput.write()`).
Parameters: see `publish_programmatically()`.
This function is provisional because in Python 3 name and behaviour
no longer match.
.. _output_encoding:
https://docutils.sourceforge.io/docs/user/config.html#output-encoding
r r ra r r Nrb r r% r r& r r+ r rE rY rA r rV )r r StringInput StringOutput)r ra rb r r% r r& r r+ r rE rY rA r rn r s r publish_stringr s 0 1
/
/
/^^
/,2F
/@K
/ //
/ D
/ ,<+;
/ v
/ $/;
/
v
/
$/;
/ v
/ $/;
/
/ *7
/ .-
/ &~
/ .-
/FI Mr" c t di d| d|d|dt j ddd|d|d |d
|d |d |d
| d|
d| d| d|
d|\ }}|j j S )a
Set up & run a `Publisher`, and return a dictionary of document parts.
Dictionary keys are the names of parts.
Dictionary values are `str` instances; encoding is up to the client,
e.g.::
parts = publish_parts(...)
body = parts['body'].encode(parts['encoding'], parts['errors'])
See the `API documentation`__ for details on the provided parts.
Parameters: see `publish_programmatically()`.
__ https://docutils.sourceforge.io/docs/api/publisher.html#publish-parts
r ra r r r Nrb r r% r r& r r+ r rE rY rA r rV )r r r r rF )r ra r rb r r% r r& r r+ r rE rY rA r rn r s r
publish_partsr s 0 1
/
/
/v
/#.;
/=I\
/ //
/ D
/ ,<+;
/ v
/ $/;
/
v
/
$/;
/ v
/ $/;
/
/ *7
/ .-
/ &~
/ .-
/FI !!r" c t di d| d|d|dddddt j d|d |d
|d |d dd
dd|d|d| d|
d| \ } }
|
j S )z
Set up & run a `Publisher` for programmatic use. Return a document tree.
Parameters: see `publish_programmatically()`.
r ra r r Nrb r r r% r r& r r+ nullr rE rY rA r rV )r r
NullOutputr )r ra r r r% r r& r rE rY rA r _outputr s r publish_doctreer s 2
/
/
/v
/#.;
/!\
/ D
/ ,04
/ --
/
v
/
$/;
/ v
/ $/;
/ t
/ "(
/
/ *7
/ .-
/ ?Mn
/ .-
/GY r" c F t j d } t | d|t j | t j | }
|s|r|
| |
||| |
d| |
| S )u
Set up & run a `Publisher` to render from an existing document tree
data structure. For programmatic use with string output
(`bytes` or `str`, cf. `publish_string()`).
Note that ``document.settings`` is overridden; if you want to use the
settings of the original `document`, pass ``settings=document.settings``.
Also, new `document.transformer` and `document.reporter` objects are
generated.
Parameters: `document` is a `docutils.nodes.document` object, an existing
document tree.
Other parameters: see `publish_programmatically()`.
This function is provisional because in Python 3 name and behaviour
of the `io.StringOutput` class no longer match.
r )r& N)r r r r )
r Readerr r DocTreeInputr r- rZ rd r ) r rb r r+ r rE rY rA r r r s r publish_from_doctreer s 0 ^
/
/
/F&$!# !:!:,.O#+- - -I *k * [)))
++)>; ; ;
d$4555 0B C CCr" c t | |||| }| ||| | | | |
||| |
}|S )a
Set up & run a `Publisher` for command-line-based file I/O (input and
output file paths taken automatically from the command line).
Also return the output as `bytes`.
This is just like publish_cmdline, except that it uses
io.BinaryFileOutput instead of io.FileOutput.
Parameters: see `publish_programmatically()` for the remainder.
- `argv`: Command-line argument list to use instead of ``sys.argv[1:]``.
- `usage`: Usage string, output if there's a problem parsing the command
line.
- `description`: Program description, output for the "--help" option
(along with command-line option descriptions).
)r r r r )r r% r r& r r+ r rE rY rA r r] r< r= r r r rn s r publish_cmdline_to_binaryr ? sp : &&&8,=? ? ?I
[+{CCC
e[-1C%:L N NF Mr" c t |||
| | | }| || | | |
|| | || | || | | }||fS )a^
Set up & run a `Publisher` for custom programmatic use.
Return the output (as `str` or `bytes`, depending on `destination_class`,
writer, and the "output_encoding" setting) and the Publisher object.
Applications should not need to call this function directly. If it does
seem to be necessary to call this function directly, please write to the
Docutils-develop mailing list
<https://docutils.sourceforge.io/docs/user/mailing-lists.html#docutils-develop>.
Parameters:
* `source_class` **required**: The class for dynamically created source
objects. Typically `io.FileInput` or `io.StringInput`.
* `source`: Type depends on `source_class`:
- If `source_class` is `io.FileInput`: Either a file-like object
(must have 'read' and 'close' methods), or ``None``
(`source_path` is opened). If neither `source` nor
`source_path` are supplied, `sys.stdin` is used.
- If `source_class` is `io.StringInput` **required**:
The input as either a `bytes` object (ensure the 'input_encoding'
setting matches its encoding) or a `str` object.
* `source_path`: Type depends on `source_class`:
- `io.FileInput`: Path to the input file, opened if no `source`
supplied.
- `io.StringInput`: Optional. Path to the file or name of the
object that produced `source`. Only used for diagnostic output.
* `destination_class` **required**: The class for dynamically created
destination objects. Typically `io.FileOutput` or `io.StringOutput`.
* `destination`: Type depends on `destination_class`:
- `io.FileOutput`: Either a file-like object (must have 'write' and
'close' methods), or ``None`` (`destination_path` is opened). If
neither `destination` nor `destination_path` are supplied,
`sys.stdout` is used.
- `io.StringOutput`: Not used; pass ``None``.
* `destination_path`: Type depends on `destination_class`:
- `io.FileOutput`: Path to the output file. Opened if no `destination`
supplied.
- `io.StringOutput`: Path to the file or object which will receive the
output; optional. Used for determining relative paths (stylesheets,
source links, etc.).
* `reader`: A `docutils.readers.Reader` object.
* `reader_name`: Name or alias of the Reader class to be instantiated if
no `reader` supplied.
* `parser`: A `docutils.parsers.Parser` object.
* `parser_name`: Name or alias of the Parser class to be instantiated if
no `parser` supplied.
* `writer`: A `docutils.writers.Writer` object.
* `writer_name`: Name or alias of the Writer class to be instantiated if
no `writer` supplied.
* `settings`: A runtime settings (`docutils.frontend.Values`) object, for
dotted-attribute access to runtime settings. It's the end result of the
`SettingsSpec`, config file, and option processing. If `settings` is
passed, it's assumed to be complete and no further setting/config/option
processing is done.
* `settings_spec`: A `docutils.SettingsSpec` subclass or object. Provides
extra application-specific settings definitions independently of
components. In other words, the application becomes a component, and
its settings data is processed along with that of the other components.
Used only if no `settings` specified.
* `settings_overrides`: A dictionary containing application-specific
settings defaults that override the defaults of other components.
Used only if no `settings` specified.
* `config_section`: A string, the name of the configuration file section
for this application. Overrides the ``config_section`` attribute
defined by `settings_spec`. Used only if no `settings` specified.
* `enable_exit_status`: Boolean; enable exit status at end of processing?
)r r r r )r r1 rZ rc rd r )r r ra r r rb r r% r r& r r+ r rE rY rA r r rn s r r r e s J &&&8'3,=? ? ?I [+{CCC
++)>; ; ;
---
k+;<<<
2D
E
EF 9 r" r c d| d| dt z }t j t j d t | | d S )Nz Generate zZ documents from standalone reStructuredText sources <https://docutils.sourceforge.io/docs/z>. r )r+ r= )default_descriptionlocale setlocaleLC_ALLr )r documenttypedoc_pathr= s r
rst2somethingr sj @L @ @19 @ @ @
V]B'''K@@@@@@r" c ( t ddd d S )NhtmlHTMLzuser/html.html#htmlr rV r" r rst2htmlr s &&"788888r" c ( t ddd d S )Nhtml4z XHTML 1.1zuser/html.html#html4css1r rV r" r rst2html4r s ';(BCCCCCr" c ( t ddd d S )Nhtml5HTML5z user/html.html#html5-polyglotr rV r" r rst2html5r s '7$CDDDDDr" c ( t ddd d S )NlatexLaTeXuser/latex.htmlr rV r" r rst2latexr s '7$566666r" c ( t ddd d S )NmanpagezUnix manual (troff)zuser/manpage.htmlr rV r" r rst2manr s ) 24GHHHHHr" c ( t ddd d S )NodtzOpenDocument text (ODT)z
user/odt.htmlr rV r" r rst2odtr s %2ODDDDDr" c ( t ddd d S )Nr zpseudo-XML (test)ref/doctree.htmlr rV r" r
rst2pseudoxmlr s + 24FGGGGGr" c ( t ddd d S )Ns5zS5 HTML slideshowzuser/slide-shows.htmlr rV r" r rst2s5r s $+-DEEEEEr" c ( t ddd d S )NxetexzLaTeX (XeLaTeX/LuaLaTeX)r r rV r" r rst2xetexr s '57HIIIIIr" c ( t ddd d S )NxmlzDocutils-native XMLr r rV r" r rst2xmlr s %.0BCCCCCr" )NNNNNr Nr Nr NNNNF)
NNNr Nr Nr NNNNF)NNr NNNNF)r )+r
__docformat__r r r r\ r> docutilsr r r r r r r
docutils.frontendr docutils.readersr r
default_usager r r r r r r r BinaryFileOutputr r r r r r r r r r r r r rV r" r <module>r sa
#
3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 * * * * * * $ $ $ $ $ $J5 J5 J5 J5 J5 J5 J5 J5Z
=
) \ -? [ !'+D'+$'5H
: +/48*6*<*5GK9>
8 ?C,8,>,704;?&+
# # # #L '+ #' < += ; t%)$%*#" #" #" #"L )-!# \ -? !'+D',
4 592=6:AE,1 "D "D "D "DJ &*|%)7I%){'+,015-115#'$1*=*.020C# # # #Ln n n h A A A A 9 9 9D D DE E E7 7 7I I IE E EH H HF F FJ J JD D D D Dr"