o Ni7X @sdZdZddlZddlZddlZddlZddlZddlZddlm Z z+e e de dp8e dZeZWdn1sGwYWndZYzeeWn eefyhdZYnwGdddeZGd d d eZd d Zd dZGddde ZGddde ZGdddZGdddeZGdddeZGdddeZGdddeZGdddeZGdd 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) TransformSpecignorec@ eZdZdS) InputErrorN__name__ __module__ __qualname__r r ?/home/ubuntu/.local/lib/python3.10/site-packages/docutils/io.pyr+ rc@r) OutputErrorNrr r r r r,rrc Cs4z t|jt|kWStttfyYdSw)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_encoding/s  rcCs|jjd|S)z5Return string representation of Exception `err`. z: ) __class__r )errr r r error_string?src@seZdZdZdZdZ  dddZddZd d Zd d Z e d Z e jdfe jdfe jdfe jdfe jdffZ ddZddZdS)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.) inputNstrictcCs6||_ ||_ ||_ ||_ |s|j|_d|_dSN)r error_handlersource source_pathdefault_source_pathsuccessful_encoding)selfr r!rrr r r __init__UszInput.__init__cCd|j|j|jfS)Nz%s: source=%r, source_path=%r)rr r!r$r r r __repr__is zInput.__repr__cCt)z,Return input as `str`. Define in subclasses.NotImplementedErrorr'r r r readmz Input.readc Cs|jr|jdkrt|tsJdt|tr|S|jr"|jg}n!||}|r-|g}ndg}tjdd}|rC|dkrC|||D]'}zt|||j}||_ |WSt t fyl}z|}WYd}~qEd}~wwt dd d d |Dd t |d ) 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 and the locale's preferred encoding. The client application should call ``locale.setlocale()`` at the beginning of processing:: locale.setlocale(locale.LC_ALL, '') Raise UnicodeError if unsuccessful. Provisional: encoding detection will be removed in Docutils 1.0. unicodez;input encoding is "unicode" but `data` is no `str` instancezutf-8F) do_setlocaleNz=Unable to decode input data. Tried the following encodings: z, css|]}t|VqdSr)repr).0encr r r szInput.decode... ())rlower isinstancestrdetermine_encoding_from_datalocalegetpreferredencodingappendrr# UnicodeErrorrjoinr) r$dataencoding_candidates data_encodingfallbackr2decodedrerrorr r r decodeqs:      z Input.decodescoding[:=]\s*([-\w.]+)zutf-32z utf-8-sigzutf-16cCs`|jD] \}}||r|Sq|ddD]}|j|}|r-|ddSqdS)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_slugsearchgrouprE)r$r? start_bytesrlinematchr r r r9s  z"Input.determine_encoding_from_datacC"z|jWStyYdSw)z>Return True, if the input source is connected to a TTY device.F)r isattyrr'r r r rR   z Input.isattyNNNr)r r r __doc__component_typer"r%r(r,rErecompilerKr BOM_UTF32_BE BOM_UTF32_LEBOM_UTF8 BOM_UTF16_BE BOM_UTF16_LErHr9rRr r r r rEs*   6 rc@s>eZdZdZdZdZ  d 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.) outputNrcCs8||_ |pd|_ ||_ ||_ |s|j|_dSdS)Nr)rr destinationdestination_pathdefault_destination_path)r$r`rarrr r r r%s  zOutput.__init__cCr&)Nz'%s: destination=%r, destination_path=%r)rr`rar'r r r r(szOutput.__repr__cCr))z#Write `data`. Define in subclasses.r*r$r?r r r writer-z Output.writecCsH|jr|jdkrt|tsJd|St|ts|S||j|jS)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.zrJrzrurcr r r r,s    zFileInput.readcCs|dS)zC Return lines of a single file as list of strings. T)r,rJr'r r r readlinesszFileInput.readlinescCs|jtjur |jdSdSr)r rjrrur'r r r rus zFileInput.close)NNNrTrw)r r r rUr%r,rrur r r r rvbs ( rvc@sBeZdZdZdZdZ   dddZd d Zd d Zd dZ dS) FileOutputz,Output for single, simple file-like objects.zriNrTcCst|||||d|_||_|durtjdtdd|dur"||_t|_ |dur5|r0d|_n t j |_ n|rPt |j drP||j jkrPtd|j j|f|j d |sez|j j|_WdStydYdSwdS) 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.rF) stacklevelFrz?Warning: Destination mode "%s" differs from specified mode "%s")file)r^r%openedrzwarningswarnDeprecationWarningrrfr{rjrsr`rprintrrar)r$r`rarrrzhandle_io_errorsrr r r r%sB      zFileOutput.__init__c Cspd|jvr |j|jd}ni}zt|j|jfi||_Wnty2}z t|j|j |jd}~wwd|_ dS)NbrxT) rrrrlrar`r|rr}r~r)r$kwargsrDr r r rls   zFileOutput.opencCsF|js|t|tr&t|j|jdur&tjdkr!| dtj}| |}zsz|j |Wn`t yt}z9t|t rjz |jj |Wn$tyit|j|jdurgtd|jd|jjd|jd|wWYd}~n d}~wttfy}ztd|jd t|dd}~wwW|jr||S|jr|ww) 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. Frz Encoding of z (z&) differs from specified encoding (r5Nz2Unable to encode output data. output-encoding is: r4)rrlr7r8rr`roslineseprhrerdrbytesrtr ValueErrorrar=rrrzru)r$r?rr r r rds\        zFileOutput.writecCs*|jtjtjfvr|jd|_dSdS)NF)r`rjrsrkrurr'r r r ru$s  zFileOutput.close)NNNrTNN) r r r rUrbrr%rlrdrur r r r rs / .rc@seZdZdZdZdS)BinaryFileOutputzL A version of docutils.io.FileOutput which writes to a binary file. wbN)r r r rUrr r r r r*src@eZdZdZdZddZdS) StringInputz'Input from a `str` or `bytes` instance.cCs ||jS)z`Return the source as `str` instance. Decode, if required (see `Input.decode`). )rEr r'r r r r,8s zStringInput.readNr r r rUr"r,r r r r r3s rc@r) 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). )rer`rcr r r rdHs zStringOutput.writeNr r r rUrbrdr r r r r@s rc@r) NullInputzDegenerate input: read nothing.z null inputcCdS)zReturn an empty string.rr r'r r r r,ar-zNullInput.readNrr r r r r[ rc@r) NullOutputz!Degenerate output: write nothing.z null outputcCr)zDo nothing, return None.Nr rcr r r rdlr-zNullOutput.writeNrr r r r rfrrc@r) DocTreeInputzm Adapter for document tree input. The document tree must be passed in the ``source`` parameter. z doctree inputcCs|jS)zReturn the document tree.)r r'r r r r,{szDocTreeInput.readNrr r r r rqs r)#rU __docformat__rr:rrWrjrdocutilsrcatch_warnings simplefilter getlocalegetdefaultlocalernr6rrrr|rrrrrr^rfrvrrrrrrrr r r r sR      >XK}