U ZSh] @sdZdZddlZddlZddlZddlZddlZddlZddlm Z zBe 0e de dppe dZeZW5QRXWnDek rZzdejkrdZndZW5dZ[XYndZYnXzeeWneefk rdZYnXGd d d eZGd d d eZd dZddZGddde ZGddde ZGdddZGdddeZGdddeZGdddeZ GdddeZ!Gdd d eZ"Gd!d"d"eZ#Gd#d$d$eZ$Gd%d&d&eZ%dS)'z I/O classes provide a uniform API for low-level input and output. Subclasses exist for a variety of input/output mechanisms. reStructuredTextN) TransformSpecignorezunknown locale: UTF-8utf-8c@s eZdZdS) InputErrorN__name__ __module__ __qualname__r r >/root/rtd-docs/venv/lib/python3.8/site-packages/docutils/io.pyr3src@s eZdZdS) OutputErrorNrr r r r r4src Cs:zt|jt|kWStttfk r4YdSXdS)aNTest, whether the encoding of `stream` matches `encoding`. Returns :None: if `encoding` or `stream.encoding` are not a valid encoding argument (e.g. ``None``) or `stream.encoding is missing. :True: if the encoding argument resolves to the same value as `encoding`, :False: if the encodings differ. N)codecslookupencoding LookupErrorAttributeError TypeError)streamrr r r check_encoding7s rcCs|jjd|S)z5Return string representation of Exception `err`. z: ) __class__r )errr r r error_stringGsrc@speZdZdZdZdZdddZddZd d Zd d Z e d Z e jdfe jdfe jdffZddZddZdS)Inputah Abstract base class for input wrappers. Docutils input objects must provide a `read()` method that returns the source, typically as `str` instance. Inheriting `TransformSpec` allows input objects to add "transforms" and "unknown_reference_resolvers" to the "Transformer". (Optional for custom input objects since Docutils 0.19.) inputNstrictcCs.||_||_||_||_|s$|j|_d|_dSN)r error_handlersource source_pathdefault_source_pathsuccessful_encoding)selfrr rrr r r __init__]szInput.__init__cCsd|j|j|jfS)Nz%s: source=%r, source_path=%r)rrr r#r r r __repr__qs zInput.__repr__cCstdS)z,Return input as `str`. Define in subclasses.NNotImplementedErrorr%r r r readusz Input.readc Cs |jr&|jdkr&t|ts&tdt|tr4|S|jrD|jg}n<||}|rZ|g}n&dg}trvtdkrv|t|d|D]V}z&t|||j}||_ | ddWSt t fk r}z|}W5d}~XYqXqt dd d d |Dd t|d dS)a Decode `data` if required. Return Unicode `str` instances unchanged (nothing to decode). If `self.encoding` is None, determine encoding from data or try UTF-8, locale encoding, and (as last ressort) 'latin-1'. The client application should call ``locale.setlocale`` at the beginning of processing:: locale.setlocale(locale.LC_ALL, '') Raise UnicodeError if unsuccessful. Provisional: - Raise UnicodeError (instead of falling back to the locale encoding) if decoding the source with the default encoding (UTF-8) fails and Python is started in `UTF-8 mode`. Raise UnicodeError (instead of falling back to "latin1") if both, default and locale encoding, fail. - Only remove BOM (U+FEFF ZWNBSP at start of data), no other ZWNBSPs. unicodez;input encoding is "unicode" but `data` is no `str` instancerzlatin-1uNz=Unable to decode input data. Tried the following encodings: z, css|]}t|VqdSr)repr).0encr r r szInput.decode... ())rlower isinstancestrAssertionErrordetermine_encoding_from_data_locale_encodingappendrr"replace UnicodeErrorrjoinr)r#dataZencoding_candidates data_encodingr.decodedrerrorr r r decodeys.      $z Input.decodescoding[:=]\s*([-\w.]+)rz utf-16-bez utf-16-lecCs`|jD]\}}||r|Sq|ddD](}|j|}|r2|ddSq2dS)z Try to determine the encoding of `data` by looking *in* `data`. Check for a byte order mark (BOM) or an encoding declaration. Nrascii)byte_order_marks startswith splitlines coding_slugsearchgroupr@)r#r<Z start_bytesrlinematchr r r r6s   z"Input.determine_encoding_from_datacCs(z |jWStk r"YdSXdS)z>Return True, if the input source is connected to a TTY device.FN)risattyrr%r r r rKs z Input.isatty)NNNr)r r r __doc__component_typer!r$r&r)r@recompilerFrBOM_UTF8 BOM_UTF16_BE BOM_UTF16_LErCr6rKr r r r rMs   F rc@s:eZdZdZdZdZd ddZddZd d Zd d Z dS)Outputak Abstract base class for output wrappers. Docutils output objects must provide a `write()` method that expects and handles one argument (the output). Inheriting `TransformSpec` allows output objects to add "transforms" and "unknown_reference_resolvers" to the "Transformer". (Optional for custom output objects since Docutils 0.19.) outputNrcCs,||_|p d|_||_||_|s(|j|_dS)Nr)rr destinationdestination_pathdefault_destination_path)r#rUrVrrr r r r$s  zOutput.__init__cCsd|j|j|jfS)Nz'%s: destination=%r, destination_path=%r)rrUrVr%r r r r&szOutput.__repr__cCstdS)z#Write `data`. Define in subclasses.Nr'r#r<r r r writesz Output.writecCsL|jr*|jdkr*t|ts&td|St|ts8|S||j|jSdS)a? Encode and return `data`. If `data` is a `bytes` instance, it is returned unchanged. Otherwise it is encoded with `self.encoding`. Provisional: If `self.encoding` is set to the pseudo encoding name "unicode", `data` must be a `str` instance and is returned unchanged. r*z|jtjtjfkrdSz|jWntk r8YnXdS)z Close the error-output stream. Ignored if the destination is` sys.stderr` or `sys.stdout` or has no close() method. N)rUr^rfr_closerr%r r r rhas zErrorOutput.closecCs(z |jWStk r"YdSXdS)z=Return True, if the destination is connected to a TTY device.FN)rUrKrr%r r r rKos zErrorOutput.isatty)NNr\r9)r r r rLr$rYrhrKr r r r r[s !r[c@s2eZdZdZdddZdd Zd d Zd d ZdS) FileInputz5 Input for single, simple file-like objects. NrTrc Cst|||||||_t|_|dkr|rzt|||jpr]NrTcCst|||||d|_||_|dk r6tjdtdd|dk rD||_t|_ |dkrj|r`d|_qt j |_ n6|rt |j dr||j jkrtd|j j|f|j d |sz|j j|_Wntk rYnXdS) aA :Parameters: - `destination`: either a file-like object (which is written directly) or `None` (which implies `sys.stdout` if no `destination_path` given). - `destination_path`: a path to a file, which is opened and then written. - `encoding`: the text encoding of the output file. - `error_handler`: the encoding error handler to use. - `autoclose`: close automatically after write (except when `sys.stdout` or `sys.stderr` is the destination). - `handle_io_errors`: ignored, deprecated, will be removed. - `mode`: how the file is to be opened (see standard function `open`). The default is 'w', providing universal newline support for text files. TNz_io.FileOutput: init argument "handle_io_errors" is ignored and will be removed in Docutils 2.0.rA) stacklevelFrtz?Warning: Destination mode "%s" differs from specified mode "%s")file)rSr$openedrmwarningswarnDeprecationWarningrtr[rnr^rfrUhasattrprintrsrVr)r#rUrVrrrmZhandle_io_errorsrtr r r r$sD     zFileOutput.__init__c Csvd|jkr|j|jd}ni}zt|j|jf||_Wn4tk rj}zt|j|j |jW5d}~XYnXd|_ dS)NbrkT) rtrrr`rVrUrorrprqr{)r#kwargsr?r r r r`s  zFileOutput.opencCsL|js|t|trLt|j|jdkrLtjdkrB| dtj}| |}zz|j |Wntk r}zrt|trz|jj |WnPtk rt|j|jdkrtd|jd|jjd|jdn|YnXW5d}~XYnDttfk r0}z td|jd t|dW5d}~XYnXW5|j rF| X|S) aBWrite `data` to a single file, also return it. `data` can be a `str` or `bytes` instance. If writing `bytes` fails, an attempt is made to write to the low-level interface ``self.destination.buffer``. If `data` is a `str` instance and `self.encoding` and `self.destination.encoding` are set to different values, `data` is encoded to a `bytes` instance using `self.encoding`. Provisional: future versions may raise an error if `self.encoding` and `self.destination.encoding` are set to different values. Frvz Encoding of z (z&) differs from specified encoding (r1Nz2Unable to encode output data. output-encoding is: r0)r{r`r3r4rrUroslinesepr9rZrmrhrYrbytesrgr ValueErrorrVr:rr)r#r<rr r r rYs>     zFileOutput.writecCs&|jtjtjfkr"|jd|_dS)NF)rUr^rfr_rhr{r%r r r rh?s zFileOutput.close)NNNrTNN) r r r rLrWrtr$r`rYrhr r r r rxs /.rxc@seZdZdZdZdS)BinaryFileOutputzL A version of docutils.io.FileOutput which writes to a binary file. wbN)r r r rLrtr r r r rEsrc@seZdZdZdZddZdS) StringInputz'Input from a `str` or `bytes` instance.cCs ||jS)z`Return the source as `str` instance. Decode, if required (see `Input.decode`). )r@rr%r r r r)SszStringInput.readNr r r rLr!r)r r r r rNsrc@seZdZdZdZddZdS) StringOutputz=Output to a `bytes` or `str` instance. Provisional. rcCs|||_|jS)avStore `data` in `self.destination`, and return it. If `self.encoding` is set to the pseudo encoding name "unicode", `data` must be a `str` instance and is stored/returned unchanged (cf. `Output.encode`). Otherwise, `data` can be a `bytes` or `str` instance and is stored/returned as a `bytes` instance (`str` data is encoded with `self.encode()`). Attention: the `output_encoding`_ setting may affect the content of the output (e.g. an encoding declaration in HTML or XML or the representation of characters as LaTeX macro vs. literal character). )rZrUrXr r r rYcs zStringOutput.writeNr r r rLrWrYr r r r r[src@seZdZdZdZddZdS) NullInputzDegenerate input: read nothing.z null inputcCsdS)zReturn an empty string.r+r r%r r r r)|szNullInput.readNrr r r r rvsrc@seZdZdZdZddZdS) NullOutputz!Degenerate output: write nothing.z null outputcCsdS)zDo nothing, return None.Nr rXr r r rYszNullOutput.writeNrr r r r rsrc@seZdZdZdZddZdS) DocTreeInputzm Adapter for document tree input. The document tree must be passed in the ``source`` parameter. z doctree inputcCs|jS)zReturn the document tree.)rr%r r r r)szDocTreeInput.readNrr r r r rsr)&rL __docformat__rlocalerrNr^r|Zdocutilsrcatch_warnings simplefilter getlocalegetdefaultlocaler7r2rr?argsrrrrorrrrrrSr[rirxrrrrrrr r r r sR        >XQ}