o /bS @sdZdZddlZddlZddlZddlZddlZddlZddlm Z ze dp.e dZ e Z Wn!eyPZzdejvrDdZ ndZ WYdZ[n dZ[wdZ Yzee Wn eefyjdZ YnwGdd d eZGd d d eZd d ZddZGddde ZGddde ZGdddZGdddeZGdddeZGdddeZGdddeZGdddeZ 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. ZreStructuredTextN) TransformSpeczunknown locale: UTF-8utf-8c@ eZdZdS) InputErrorN__name__ __module__ __qualname__r r /usr/lib/python3.10/site-packages/docutils/io.pyr0 rc@r) OutputErrorNrr r r r r1r rc 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_encoding4s  rcCs|jjd|S)z5Return string representation of Exception `err`. z: ) __class__r)errr r r error_stringDsrc@sxeZdZdZdZdZ  dddZddZd d Zd d Z e d Z e jdfe jdfe jdffZ ddZddZdS)Inputz1 Abstract base class for input wrappers. inputNstrictcCs6||_ ||_ ||_ ||_ |s|j|_d|_dSN)r error_handlersource source_pathdefault_source_pathsuccessful_encoding)selfrr rrr r r __init__TszInput.__init__cCd|j|j|jfS)Nz%s: source=%r, source_path=%r)rrr r#r r r __repr__hs zInput.__repr__cCtrNotImplementedErrorr&r r r readlsz Input.readc Cs|jr|jdkrt|tsJdt|tr|S|jr"|jg}n||}|r-|g}ndg}tr;tdkr;|t|d|D]+}zt|||j}||_| ddWSt t fym}z|}WYd}~qBd}~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, 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. unicodez;input encoding is "unicode" but input is not a `str` objectrzlatin-1uNz=Unable to decode input data. Tried the following encodings: z, css|]}t|VqdSr)repr).0encr r r szInput.decode..z. ())rlower isinstancestrdetermine_encoding_from_data_locale_encodingappendrr"replace UnicodeErrorrjoinr)r#dataZencoding_candidates data_encodingr0decodedrerrorr r r decodeos:      z Input.decodescoding[:=]\s*([-\w.]+)rz utf-16-bez utf-16-lecCs`|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_slugsearchgroupr@)r#r<Z start_bytesrlinematchr r r r6s  z"Input.determine_encoding_from_datacC"z|jWStyYdSwNF)risattyrr&r r r rM   z Input.isattyNNNr)rr r __doc__component_typer!r$r'r+r@recompilerFrBOM_UTF8 BOM_UTF16_BE BOM_UTF16_LErCr6rMr r r r rJs&  : rc@s>eZdZdZdZdZ  d ddZddZd d Zd d Z dS)Outputz2 Abstract base class for output wrappers. outputNrcCs8||_ |pd|_ ||_ ||_ |s|j|_dSdS)Nr)rr destinationdestination_pathdefault_destination_path)r#rYrZrrr r r r$s  zOutput.__init__cCr%)Nz'%s: destination=%r, destination_path=%r)rrYrZr&r r r r'szOutput.__repr__cCr()z;`data` is a Unicode string, to be encoded by `self.encode`.r)r#r<r r r writez Output.writecCsH|jr|jdkrt|tsJd|St|ts|S||j|jS)Nr,zFthe encoding given is "unicode" but the output is not a Unicode string)rr3r4r5encoderr\r r r r_s  z Output.encoderO) rr r rPrQr[r$r'r]r_r r r r rWs  rWc@s8eZdZdZ   d ddZddZd d Zd d ZdS) ErrorOutputz Wrapper class for file-like error streams with failsafe de- and encoding of `str`, `bytes`, `unicode` and `Exception` instances. Nbackslashreplacer9cCsd|durtj}n|s d}n t|trt|d}||_ |p&t|ddp&tp&d|_ ||_ ||_ dS)a :Parameters: - `destination`: a file-like object, a string (path to a file), `None` (write to `sys.stderr`, default), or evaluating to `False` (write() requests are ignored). - `encoding`: `destination` text encoding. Guessed if None. - `encoding_errors`: how to treat encoding errors. NFwrrB) sysstderrr4r5openrYgetattrr7rencoding_errorsdecoding_errors)r#rYrrgrhr r r r$s$   zErrorOutput.__init__c Cs|jsdSt|trt|}z |j|WdSty-|j||j|jYdSt yit|trG|j||j|jYdS|jt j t j fvrZ|jj |YdS|jt||j|jYdSw)z Write `data` to self.destination. Ignore, if self.destination is False. `data` can be a `bytes`, `str`, or `Exception` instance. N)rYr4 Exceptionr5r]UnicodeEncodeErrorr_rrgrrcrdstdoutbufferrhr\r r r r]"s*      zErrorOutput.writecCs<|jtjtjfvr dSz|jWdStyYdSw)z Close the error-output stream. Ignored if the destination is` sys.stderr` or `sys.stdout` or has no close() method. N)rYrcrkrdcloserr&r r r rm<s zErrorOutput.closecCrKrL)rYrMrr&r r r rMJrNzErrorOutput.isatty)NNrar9)rr r rPr$r]rmrMr r r r r`s ! r`c@s8eZdZdZ   dddZdd Zd d Zd d ZdS) FileInputz5 Input for single, simple file-like objects. NrTrc Cst|||||||_t|_|dur?|r:zt|||jpd|jd|_Wn-t y9}zt |j |j |d}~wwt j|_nt|j|jdurStd|j|jjf|shz|jj|_WdStygYdSwdS)a :Parameters: - `source`: either a file-like object (which is read directly), or `None` (which implies `sys.stdin` if no `source_path` given). - `source_path`: a path to a file, which is opened and then read. - `encoding`: the expected text encoding of the input file. - `error_handler`: the encoding error handler to use. - `autoclose`: close automatically after read (except when `sys.stdin` is the source). - `mode`: how the file is to be opened (see standard function `open`). The default is read only ('r'). Nz utf-8-sigrerrorsFzOEncoding clash: encoding given is "%s" but source is opened with encoding "%s".)rr$ autocloser`_stderrrerrrOSErrorrerrnostrerrorrcstdinrr:namer r)r#rr rrrrmoder?r r r r$Vs4    zFileInput.__init__c Csz?z|jtjur|jj}n|j}Wn!ttfy6|js3|jr3t |jd}|}| nYnwW|j r?| n |j rH| ww| |}d |dgS)zU Read and decode a single file and return the data (Unicode string). rb r-)rrcrwrlr+r:rrr rermrrr@r;rE)r#r<Zb_sourcer r r r+~s,        zFileInput.readcCs|dS)zK Return lines of a single file as list of Unicode strings. T)r+rEr&r r r readlinesszFileInput.readlinescCs|jtjur |jdSdSr)rrcrwrmr&r r r rms zFileInput.close)NNNrTro)rr r rPr$r+r|rmr r r r rnQs ( rnc@s>eZdZdZdZ   dddZdd Zd d Zd d ZdS) FileOutputz6 Output for single, simple file-like objects. rbNrTcCst|||||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.rA) stacklevelFryz?Warning: Destination mode "%s" differs from specified mode "%s")file)rWr$openedrrwarningswarnDeprecationWarningryr`rsrcrkrYhasattrprintrxrZr)r#rYrZrrrrZhandle_io_errorsryr r r r$sB      zFileOutput.__init__c Cspd|jvr |j|jd}ni}zt|j|jfi||_Wnty2}z t|j|j |jd}~wwd|_ dS)NbrpT) ryrrrerZrYrtrrurvr)r#kwargsr?r r r res   zFileOutput.openc Cs@|js|d|jvr)t|j|jdur)||}tjdkr)| dt tjd}zmz|j |WnZt yt}z6t |t rjz |jj |Wn!tyit|j|jdurgtd|jp^d|jj|jf|wWYd}~nd}~wttfy}z td |jt|fd}~wwW|jr||S|jr|ww) zEncode `data`, write it to a single file, and return it. With Python 3 or binary output mode, `data` is returned unchanged, except when specified encoding and output encoding differ. rFr{ rBz;Encoding of %s (%s) differs from specified encoding (%s)rYNz:Unable to encode output data. output-encoding is: %s. (%s))rreryrrYrr_oslinesepr9bytesr]rr4rlr ValueErrorrZr:rrrrrm)r#r<rr r r r]sZ        zFileOutput.writecCs*|jtjtjfvr|jd|_dSdSrL)rYrcrkrdrmrr&r r r rms  zFileOutput.close)NNNrTNN) rr r rPryr$rer]rmr r r r r}s / (r}c@seZdZdZdZdS)BinaryFileOutputzL A version of docutils.io.FileOutput which writes to a binary file. wbN)rr r rPryr r r r rsrc@eZdZdZdZddZdS) StringInputz Direct string input. cCs ||jS)z$Decode and return the source string.)r@rr&r r r r+*s zStringInput.readNrr r rPr!r+r r r r r" rc@r) StringOutputz Direct string output. rcCs|||_|jS)z=Encode `data`, store it in `self.destination`, and return it.)r_rYr\r r r r]7s zStringOutput.writeNrr r rPr[r]r r r r r/rrc@r) NullInputz) Degenerate input: read nothing. z null inputcCdS)zReturn a null string.r-r r&r r r r+Er^zNullInput.readNrr r r r r=rrc@r) NullOutputz+ Degenerate output: write nothing. z null outputcCr)z6Do nothing ([don't even] send data to the bit bucket).Nr r\r r r r]Rr^zNullOutput.writeNrr r r r rJrrc@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.)rr&r r r r+aszDocTreeInput.readNrr r r r rWs r)$rPZ __docformat__rlocalerrRrcrdocutilsr getlocalegetdefaultlocaler7r3rr?argsrrrrtrrrrrrWr`rnr}rrrrrrr r r r sP    0WQw