File: //usr/lib/python3.6/site-packages/docutils/__pycache__/core.cpython-36.pyc
3
t2�e�s � @ sT d Z dZddlZddlZddlmZmZmZ ddlmZm Z m
Z
m Z m Z ddl
mZ ddlmZ ddlmZmZ ddlZG d d
� d
�Zd Zd Zdd
ddddddddddeefdd�Zd"dd�Zd#dd�Zde jddd
dddddddddfdd�Z de jdd
dddddddf dd�Z d$d d �Z dd
ddddddddddeede j fd d �Z d 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: http://docutils.sf.net/docs/api/publisher.html
ZreStructuredText� N)� __version__�__version_details__� SettingsSpec)�frontend�io�utils�readers�writers)� OptionParser)� Transformer)� ErrorOutput� ErrorStringc @ s� e Zd ZdZddddejdejdfdd�Zdd� Zdd� Z d d
� Z
d&d d �Z d'd
d�Z dd� Z
d(dd�Zd)dd�Zd*dd�Zd+dd�Zdd� Zd,d d �Zd d � Zd d!� Zd"d#� Zd$d%� ZdS )-� PublisherzK
A facade encapsulating the high-level logic of a Docutils system.
Nc
C sz d| _ || _|| _|| _x6dD ].} tt| | �t� s tdt| | �| | f ��q W || _|| _ || _
|| _ || _ t
� | _dS )z�
Initial setup. If any of `reader`, `parser`, or `writer` are not
specified, the corresponding ``set_...`` method should be called with
a component name (`set_reader` sets the parser as well).
N�reader�parser�writerz�passed string "%s" as "%s" parameter; pass an instance, or use the "%s_name" parameter instead (in docutils.core.publish_* convenience functions).)r r r )�documentr r r �
isinstance�getattr�str�AssertionError�source� source_class� destination�destination_class�settingsr �_stderr)
�selfr r r r r r r r Z component� r �/usr/lib/python3.6/core.py�__init__ s
zPublisher.__init__c C s$ t j|�}|||�| _| jj| _dS )zSet `self.reader` by name.N)r Zget_reader_classr r )r � reader_namer � parser_nameZ reader_classr r r �
set_readerP s
zPublisher.set_readerc C s t j|�}|� | _dS )zSet `self.writer` by name.N)r Zget_writer_classr )r � writer_nameZ writer_classr r r �
set_writerV s
zPublisher.set_writerc C s^ | j d kr| j|| j|� | jd krF| j jd kr<| j j|� | j j| _| jd krZ| j|� d S )N)r r# r Z
set_parserr r% )r r! r" r$ r r r �set_components[ s
zPublisher.set_componentsc K s` |r<|st � }||_|j� }t|�dkr<|d dkr<dg|_t| j| j| j|f|d||d�}|S )N� Z applicationZ applicationsT)Z
components�defaultsZread_config_files�usage� description���) r �config_section�split�lenZconfig_section_dependenciesr
r r r )r r) r* �
settings_specr, r( �parts�
option_parserr r r �setup_option_parsere s
z Publisher.setup_option_parserc K s$ | j ||||f|�}|j� | _| jS )a
Set and return default settings (overrides in `defaults` dict).
Set components first (`self.set_reader` & `self.set_writer`).
Explicitly setting `self.settings` disables command line option
processing from `self.publish()`.
)r2 Zget_default_valuesr )r r) r* r/ r, r( r1 r r r � get_settingsv s
zPublisher.get_settingsc C s< | j d kr8|pi j� }|jdd� | jf ||d�|�� d S )N� tracebackT)r/ r, )r �copy�
setdefaultr3 )r r/ �settings_overridesr, r( r r r � process_programmatic_settings� s
z'Publisher.process_programmatic_settingsc s` | j ||||f|�}|dkrPtjdd� }tjdk rPtjp<d� � fdd�|D �}|j|�| _dS ) z�
Pass an empty list to `argv` to avoid reading `sys.argv` (the
default).
Set components first (`self.set_reader` & `self.set_writer`).
Nr' � r �asciic s g | ]}|j � ��qS r )�decode)�.0�a)�
argv_encodingr r �
<listcomp>� s z2Publisher.process_command_line.<locals>.<listcomp>)r9 r )r2 �sys�argv� version_infor Zlocale_encoding�
parse_argsr )r rA r) r* r/ r, r( r1 r )r> r �process_command_line� s
z Publisher.process_command_linec C s0 | j d kr| j|d� | jd kr,| j|d� d S )N)� source_path)�destination_path)r �
set_sourcer �set_destination)r rE rF r r r �set_io� s
zPublisher.set_ioc C sd |d kr| j j}n|| j _y| j||| j jd�| _W n* tk
r^ | j||| j jd�| _Y nX d S )N)r rE �encoding)r �_sourcer Zinput_encodingr � TypeError)r r rE r r r rG � s
zPublisher.set_sourcec C s: |d kr| j j}n|| j _| j||| j j| j jd�| _d S )N)r rF rJ Z
error_handler)r Z _destinationr �output_encoding� output_encoding_error_handlerr )r r rF r r r rH � s
zPublisher.set_destinationc C s4 | j jj| j| j| jj| j| jf� | j jj� d S )N) r � transformerZpopulate_from_componentsr r r r r �apply_transforms)r r r r rP � s
zPublisher.apply_transformsFc C s> d}yl| j dkr*| j|||||f|p&i � | j� | jj| j| j| j �| _| j� | j j
| j| j �} | j j � W nx t
k
r� }
zd}|
j} W Y dd}
~
X nN tk
r� }
z2| j s�� | j jr�| j� � | j|
� d}d} W Y dd}
~
X nX | j� |�r*| j�r*| jjj| j jk�r*tj| jjjd � n|�r:tj| � | 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.
Nr' T�
)r rD rI r �readr r r rP r �writer Zassemble_parts�
SystemExit�code� Exceptionr4 �debugging_dumps�report_ExceptionZreporterZ max_levelZexit_status_levelr@ �exit) r rA r) r* r/ r7 r, �enable_exit_statusrY �output�errorZ exit_statusr r r �publish� s@
zPublisher.publishc C s� | j s
d S | jjr8td| jd� ttj| jj�| jd� | jjrftd| jd� ttj| j j�| jd� | jj r�td| jd� td| jd� ttjdd� | j j
j D ��| jd� | jj r�td| jd� t| j j� j
d �| jd� d S )
Nz
::: Runtime settings:)�filez
::: Document internals:z
::: Transforms applied:z@ (priority, transform class, pending node details, keyword args)c S s2 g | ]*\}}}}|d |j |jf |o(|j|f�qS )z%s.%s)�
__module__�__name__Zdetails)r< ZpriorityZxclass�pending�kwargsr r r r? s z-Publisher.debugging_dumps.<locals>.<listcomp>z
::: Pseudo-XML:Zraw_unicode_escape)r r Z
dump_settings�printr �pprintZpformat�__dict__Zdump_internalsZdump_transformsrO ZappliedZdump_pseudo_xml�encode)r r r r rW � s&
zPublisher.debugging_dumpsc C s� t |tj�r| j|� n�t |t�r.| j|� n�t |tj�rP| jj dt
|� � njt |tj �rr| jj dt
|� � nHt dt
|� | jd� t dt
tjr�dtj p�dtjj� d f | jd� d S ) Nz-Unable to open source file for reading:
%s
z2Unable to open destination file for writing:
%s
z%s)r^ z�Exiting due to error. Use "--traceback" to diagnose.
Please report errors to <[email protected]>.
Include "--traceback" output, Docutils version (%s%s),
Python version (%s), your OS type & version, and the
command line used.z [%s]� r )r r Z
SystemMessage�report_SystemMessage�UnicodeEncodeError�report_UnicodeErrorr Z
InputErrorr rS r
Z OutputErrorrc r �docutilsr r@ �versionr- )r r\ r r r rX s"
zPublisher.report_Exceptionc C s& t d|jtjj|j f | jd� d S )Nz,Exiting due to level-%s (%s) system message.)r^ )rc �levelr ZReporterZlevelsr )r r\ r r r rh ! s z Publisher.report_SystemMessagec
C sZ |j |j|j� }| jjdt|�| jj|jdd�|jdd�| jj t
t j j
� d f � d S )Na� %s
The specified output encoding (%s) cannot
handle all of the output.
Try setting "--output-encoding-error-handler" to
* "xmlcharrefreplace" (for HTML & XML output);
the output will contain "%s" and should be usable.
* "backslashreplace" (for other output formats);
look for "%s" in the output.
* "replace"; look for "?" in the output.
"--output-encoding-error-handler" is currently set to "%s".
Exiting due to error. Use "--traceback" to diagnose.
If the advice above doesn't eliminate the error,
please report it to <[email protected]>.
Include "--traceback" output, Docutils version (%s),
Python version (%s), your OS type & version, and the
command line used.
r: �xmlcharrefreplace�backslashreplacer )�object�start�endr rS r
r rM rf rN r r@ rl r- )r r\ �datar r r rj & s
z Publisher.report_UnicodeError)NNNN)NNNN)NNNNN)NN)NN)NN)NNNNNNF)r` r_ � __qualname__�__doc__r � FileInput�
FileOutputr r# r% r& r2 r3 r8 rD rI rG rH rP r] rW rX rh rj r r r r r s4 -
'r z*%prog [options] [<source> [<destination>]]z�Reads from <source> (default is stdin) and writes to <destination> (default is stdout). See <http://docutils.sf.net/docs/user/config.html> for the full reference.�
standalone�restructuredtext� pseudoxmlTc C s: t | |||d�}|j|||� |j| | |
||| |
d�}|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). Return the
encoded string output also.
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, rZ )r r& r] )r r! r r" r r$ r r/ r7 r, rZ rA r) r* �pubr[ r r r �publish_cmdlineJ s
r| Fc C s6 t tj| |tj|||||||| |
| | |
|d�\}}|S )z�
Set up & run a `Publisher` for programmatic use with file-like I/O.
Return the encoded string output also.
Parameters: see `publish_programmatically`.
)r r rE r r rF r r! r r" r r$ r r/ r7 r, rZ )�publish_programmaticallyr rv rw )r rE r rF r r! r r" r r$ r r/ r7 r, rZ r[ r{ r r r � publish_filee s
r~ c C s6 t tj| |tjd|||||||| |
| | |
d�\}}|S )aB
Set up & run a `Publisher` for programmatic use with string I/O. Return
the encoded string or Unicode string output.
For encoded string output, be sure to set the 'output_encoding' setting to
the desired encoding. Set it to 'unicode' for unencoded Unicode string
output. Here's one way::
publish_string(..., settings_overrides={'output_encoding': 'unicode'})
Similarly for Unicode string input (`source`)::
publish_string(..., settings_overrides={'input_encoding': 'unicode'})
Parameters: see `publish_programmatically`.
N)r r rE r r rF r r! r r" r r$ r r/ r7 r, rZ )r} r � StringInput� StringOutput)r rE rF r r! r r" r r$ r r/ r7 r, rZ r[ r{ r r r �publish_string s r� c C s8 t | ||tjd||||||| |
| | |
|d�\}}|jjS )a
Set up & run a `Publisher`, and return a dictionary of document parts.
Dictionary keys are the names of parts, and values are Unicode strings;
encoding is up to the client. For programmatic use with string I/O.
For encoded string input, be sure to set the 'input_encoding' setting to
the desired encoding. Set it to 'unicode' for unencoded Unicode string
input. Here's how::
publish_parts(..., settings_overrides={'input_encoding': 'unicode'})
Parameters: see `publish_programmatically`.
N)r rE r r r rF r r! r r" r r$ r r/ r7 r, rZ )r} r r� r r0 )r rE r rF r r! r r" r r$ r r/ r7 r, rZ r[ r{ r r r �
publish_parts� s r� c C s\ t ||d||tjd�} | j||d� | j|| |
� | j| |� | jdd� | j| d�}
| jS )a�
Set up & run a `Publisher` for programmatic use with string I/O.
Return the document tree.
For encoded string input, be sure to set the 'input_encoding' setting to
the desired encoding. Set it to 'unicode' for unencoded Unicode string
input. Here's one way::
publish_doctree(..., settings_overrides={'input_encoding': 'unicode'})
Parameters: see `publish_programmatically`.
N)r r r r r r �null)rZ ) r r Z
NullOutputr& r8 rG rH r] r )r rE r r r! r r" r r/ r7 r, rZ r{ r[ r r r �publish_doctree� s
r� c C sf t jjjdd�} t| d|tj| �tj|d�}
| r@|r@|
j|� |
j |||� |
j
d|� |
j |d�S )aJ
Set up & run a `Publisher` to render from an existing document
tree data structure, for programmatic use with string I/O. Return
the encoded string output.
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.
For encoded string output, be sure to set the 'output_encoding' setting to
the desired encoding. Set it to 'unicode' for unencoded Unicode string
output. Here's one way::
publish_from_doctree(
..., settings_overrides={'output_encoding': 'unicode'})
Parameters: `document` is a `docutils.nodes.document` object, an existing
document tree.
Other parameters: see `publish_programmatically`.
r� )r" N)r r r )rZ ) rk r Zdoctree�Readerr r Z DocTreeInputr� r% r8 rH r] ) r rF r r$ r r/ r7 r, rZ r r{ r r r �publish_from_doctree� s
r� c C s< t | ||||d�}|j|||� |j| | |
||| |
d�}|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). Return the
encoded string output also.
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, rZ )r r& r] )r r! r r" r r$ r r/ r7 r, rZ rA r) r* r r r{ r[ r r r �publish_cmdline_to_binary s
r� c C s\ t |||
| | |d�}|j|| | � |j|
||� |j||� |j||� |j|d�}||fS )a7
Set up & run a `Publisher` for custom programmatic use. Return the
encoded string output 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
<http://docutils.sf.net/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
string, either an encoded 8-bit string (set the
'input_encoding' setting to the correct encoding) or a Unicode
string (set the 'input_encoding' setting to 'unicode').
* `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 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 )rZ )r r& r8 rG rH r] )r r rE r r rF r r! r r" r r$ r r/ r7 r, rZ r{ r[ r r r r} , s d
r} )NNNNNrx Nry Nrz NNNNF)
NNNrx Nry Nrz NNNNF)NNrz NNNNF)"ru Z
__docformat__r@ rd rk r r r r r r r r Zdocutils.frontendr
Zdocutils.transformsr Z docutils.utils.error_reportingr r
Zdocutils.readers.doctreer Z
default_usageZdefault_descriptionr| r~ r� r r� r� r� ZBinaryFileOutputr� r} r r r r �<module>
s� ,
#