o U hS@sdZddlmZmZgdZddlZddlZddlmZm Z e Z e Z e Ze Ze ZejddZe Ze jZd Ze jZe jZe je j e j!fZ"e j#Z$e j%Z&e j'Z(e j)Z*e j+Z,e j-Z.e j/Z0e j1Z2e j3Z4e j5Z6e j7Z8e j9Z:e j3Z;e j5Ze j?Z@e jAZBe jCZDe jEZFe jGZHe jIZJe jKZLe jMZNe jOZPe jQZRe jSZTe jUZVe jWZXe jYZZe j[Z\e j]Z^e j_Z`e jaZbdZcdZddZedZfd d ZgGd d d ZhGdddZiGdddZjGdddZkGdddelZmddZnddZoGdddepZqddZrddZsd d!ZtGd"d#d#epZuGd$d%d%epZvGd&d'd'epZwGd(d)d)epZxGd*d+d+epZyGd,d-d-epZzd.d/Z{d0d1Z|d2d3Z}Gd4d5d5epZ~    6      dAd7d8ZGd9d:d:epZGd;d<dd>epZGd?d@d@epZdS)Bz=Python interface to the Zstandard (zstd) compression library.)absolute_importunicode_literals)F BufferSegmentBufferSegmentsBufferWithSegmentsBufferWithSegmentsCollectionZstdCompressionChunkerZstdCompressionDictZstdCompressionObjZstdCompressionParametersZstdCompressionReaderZstdCompressionWriterZstdCompressorZstdDecompressionObjZstdDecompressionReaderZstdDecompressionWriterZstdDecompressor ZstdErrorFrameParametersbackend_features#estimate_decompression_context_sizeframe_content_sizeframe_header_sizeget_frame_parameterstrain_dictionary FLUSH_BLOCK FLUSH_FRAMECOMPRESSOBJ_FLUSH_FINISHCOMPRESSOBJ_FLUSH_BLOCK ZSTD_VERSION FRAME_HEADERCONTENTSIZE_UNKNOWNCONTENTSIZE_ERRORMAX_COMPRESSION_LEVEL"COMPRESSION_RECOMMENDED_INPUT_SIZE#COMPRESSION_RECOMMENDED_OUTPUT_SIZE$DECOMPRESSION_RECOMMENDED_INPUT_SIZE%DECOMPRESSION_RECOMMENDED_OUTPUT_SIZE MAGIC_NUMBERBLOCKSIZELOG_MAX BLOCKSIZE_MAX WINDOWLOG_MIN WINDOWLOG_MAX CHAINLOG_MIN CHAINLOG_MAX HASHLOG_MIN HASHLOG_MAX MINMATCH_MIN MINMATCH_MAX SEARCHLOG_MIN SEARCHLOG_MAXSEARCHLENGTH_MINSEARCHLENGTH_MAXTARGETLENGTH_MINTARGETLENGTH_MAXLDM_MINMATCH_MINLDM_MINMATCH_MAXLDM_BUCKETSIZELOG_MAX STRATEGY_FASTSTRATEGY_DFASTSTRATEGY_GREEDY STRATEGY_LAZYSTRATEGY_LAZY2STRATEGY_BTLAZY2STRATEGY_BTOPTSTRATEGY_BTULTRASTRATEGY_BTULTRA2DICT_TYPE_AUTODICT_TYPE_RAWCONTENTDICT_TYPE_FULLDICT FORMAT_ZSTD1FORMAT_ZSTD1_MAGICLESSN)ffilibF)should_clear_after_allocs(/c CsHztpdWStyYnwztdWSttfy#YdSw)NrSC_NPROCESSORS_ONLN)os cpu_countAttributeErrorsysconf ValueErrorrTrTj/var/www/html/construction_image-detection-poc/venv/lib/python3.10/site-packages/zstandard/backend_cffi.py _cpu_counts  rVc@s,eZdZdZeddZddZddZdS) rzRepresents a segment within a ``BufferWithSegments``. This type is essentially a reference to N bytes within a ``BufferWithSegments``. The object conforms to the buffer protocol. cCt)z9The byte offset of this segment within its parent buffer.NotImplementedErrorselfrTrTrUoffsetzBufferSegment.offsetcCrW)z+Obtain the length of the segment, in bytes.rXrZrTrTrU__len__zBufferSegment.__len__cCrW)z"Obtain bytes copy of this segment.rXrZrTrTrUtobytesr_zBufferSegment.tobytesN)__name__ __module__ __qualname____doc__propertyr\r^r`rTrTrTrUrs   rc@seZdZdZdS)ra Represents an array of ``(offset, length)`` integers. This type is effectively an index used by :py:class:`BufferWithSegments`. The array members are 64-bit unsigned integers using host/native bit order. Instances conform to the buffer protocol. N)rarbrcrdrTrTrTrUrsrc@s<eZdZdZeddZddZddZdd Zd d Z d S) racA memory buffer containing N discrete items of known lengths. This type is essentially a fixed size memory address and an array of 2-tuples of ``(offset, length)`` 64-bit unsigned native-endian integers defining the byte offset and length of each segment within the buffer. Instances behave like containers. Instances also conform to the buffer protocol. So a reference to the backing bytes can be obtained via ``memoryview(o)``. A *copy* of the backing bytes can be obtained via ``.tobytes()``. This type exists to facilitate operations against N>1 items without the overhead of Python object creation and management. Used with APIs like :py:meth:`ZstdDecompressor.multi_decompress_to_buffer`, it is possible to decompress many objects in parallel without the GIL held, leading to even better performance. cCrW)z)Total sizein bytes of the backing buffer.rXrZrTrTrUsizer]zBufferWithSegments.sizecCrWNrXrZrTrTrUr^zBufferWithSegments.__len__cCrW)zObtains a segment within the buffer. The returned object references memory within this buffer. :param i: Integer index of segment to retrieve. :return: :py:class:`BufferSegment` rXr[irTrTrU __getitem__s zBufferWithSegments.__getitem__cCrW)zObtain the array of ``(offset, length)`` segments in the buffer. :return: :py:class:`BufferSegments` rXrZrTrTrUsegmentsszBufferWithSegments.segmentscCrW)z#Obtain bytes copy of this instance.rXrZrTrTrUr`r_zBufferWithSegments.tobytesN) rarbrcrdrerfr^rkrlr`rTrTrTrUrs  rc@s eZdZdZddZddZdS)ra.A virtual spanning view over multiple BufferWithSegments. Instances are constructed from 1 or more :py:class:`BufferWithSegments` instances. The resulting object behaves like an ordered sequence whose members are the segments within each ``BufferWithSegments``. If the object is composed of 2 ``BufferWithSegments`` instances with the first having 2 segments and the second have 3 segments, then ``b[0]`` and ``b[1]`` access segments in the first object and ``b[2]``, ``b[3]``, and ``b[4]`` access segments from the second. cCrW)z9The number of segments within all ``BufferWithSegments``.rXrZrTrTrUr^r_z$BufferWithSegmentsCollection.__len__cCrW)z*Obtain the ``BufferSegment`` at an offset.rXrirTrTrUrkr_z(BufferWithSegmentsCollection.__getitem__N)rarbrcrdr^rkrTrTrTrUr s rc@s eZdZdS)rN)rarbrcrTrTrTrUrsrcCstt|dS)Nutf-8)rKstringrLZSTD_getErrorNamedecode)zresultrTrTrU _zstd_error#srrcCst}|tjkr tt|tj}tj|jftj |j ftj |j ftj |jftj|jftj|jftj|jftj|jftj|jftj|jftj|jftj|jftj|j ftj!|j"ftj#|j$ftj%|j&ftj'|j(ftj)|j*ftj+|j,ftj-|j.ftj/|j0fg}|D] \}}t1|||q|Srg)2rLZSTD_createCCtxParamsrKNULL MemoryErrorgcZSTD_freeCCtxParams ZSTD_c_formatformatZSTD_c_compressionLevelcompression_levelZSTD_c_windowLog window_logZSTD_c_hashLoghash_logZSTD_c_chainLog chain_logZSTD_c_searchLog search_logZSTD_c_minMatch min_matchZSTD_c_targetLength target_lengthZSTD_c_strategystrategyZSTD_c_contentSizeFlagwrite_content_sizeZSTD_c_checksumFlagwrite_checksumZSTD_c_dictIDFlag write_dict_idZSTD_c_nbWorkersthreadsZSTD_c_jobSizejob_sizeZSTD_c_overlapLog overlap_logZSTD_c_forceMaxWindowforce_max_window!ZSTD_c_enableLongDistanceMatching enable_ldmZSTD_c_ldmHashLog ldm_hash_logZSTD_c_ldmMinMatch ldm_min_matchZSTD_c_ldmBucketSizeLogldm_bucket_size_logZSTD_c_ldmHashRateLogldm_hash_rate_log_set_compression_parameter)paramsresattrsparamvaluerTrTrU_make_cctx_params*s:                       rc@sVeZdZdZed6ddZ                     d7ddZed d Zed d Z ed dZ eddZ eddZ eddZ eddZeddZeddZeddZeddZedd Zed!d"Zed#d$Zed%d&Zed'd(Zed)d*Zed+d,Zed-d.Zed/d0Zed1d2Zd3d4Zd5S)8r aLow-level zstd compression parameters. This type represents a collection of parameters to control how zstd compression is performed. Instances can be constructed from raw parameters or derived from a base set of defaults specified from a compression level (recommended) via :py:meth:`ZstdCompressionParameters.from_level`. >>> # Derive compression settings for compression level 7. >>> params = zstandard.ZstdCompressionParameters.from_level(7) >>> # With an input size of 1MB >>> params = zstandard.ZstdCompressionParameters.from_level(7, source_size=1048576) Using ``from_level()``, it is also possible to override individual compression parameters or to define additional settings that aren't automatically derived. e.g.: >>> params = zstandard.ZstdCompressionParameters.from_level(4, window_log=10) >>> params = zstandard.ZstdCompressionParameters.from_level(5, threads=4) Or you can define low-level compression settings directly: >>> params = zstandard.ZstdCompressionParameters(window_log=12, enable_ldm=True) Once a ``ZstdCompressionParameters`` instance is obtained, it can be used to configure a compressor: >>> cctx = zstandard.ZstdCompressor(compression_params=params) Some of these are very low-level settings. It may help to consult the official zstandard documentation for their behavior. Look for the ``ZSTD_p_*`` constants in ``zstd.h`` (https://github.com/facebook/zstd/blob/dev/lib/zstd.h). rcKsXt|||}dddddddd}|D]\}}||vr$t||||<qtd i|S) auCreate compression parameters from a compression level. :param level: Integer compression level. :param source_size: Integer size in bytes of source to be compressed. :param dict_size: Integer size in bytes of compression dictionary to use. :return: :py:class:`ZstdCompressionParameters` windowLogchainLoghashLog searchLogminMatch targetLengthr)r}rrrrrrNrT)rLZSTD_getCParamsitemsgetattrr )level source_size dict_sizekwargsrargsargattrrTrTrU from_levelts  z$ZstdCompressionParameters.from_levelrJcCst}|tjkr tt|tj}||_|dkrt}t |tj |t |tj |t |tj |t |tj |t |tj|t |tj|t |tj|t |tj|t |tj|| dkrbd} t |tj| t |tj| t |tj| t |tj| t |tj| |dkrd}t |tj|t |tj|t |tj|t |tj|t |tj|t |tj||dkrd}t |tj|dS)Nrr)rLrsrKrtrurvrw_paramsrVrrrxrzr|r~rrrrrrrrrrrrrrrr)r[ryr{r}rrrrrrrrrrrrrrrrrrrrTrTrU__init__sh z"ZstdCompressionParameters.__init__cCt|jtjSrg)_get_compression_parameterrrLrxrZrTrTrUryz ZstdCompressionParameters.formatcCrrg)rrrLrzrZrTrTrUr{z+ZstdCompressionParameters.compression_levelcCrrg)rrrLr|rZrTrTrUr}rz$ZstdCompressionParameters.window_logcCrrg)rrrLr~rZrTrTrUrrz"ZstdCompressionParameters.hash_logcCrrg)rrrLrrZrTrTrUrrz#ZstdCompressionParameters.chain_logcCrrg)rrrLrrZrTrTrUrrz$ZstdCompressionParameters.search_logcCrrg)rrrLrrZrTrTrUrrz#ZstdCompressionParameters.min_matchcCrrg)rrrLrrZrTrTrUr rz'ZstdCompressionParameters.target_lengthcCrrg)rrrLrrZrTrTrUrrz"ZstdCompressionParameters.strategycCrrg)rrrLrrZrTrTrUrrz,ZstdCompressionParameters.write_content_sizecCrrg)rrrLrrZrTrTrUrrz(ZstdCompressionParameters.write_checksumcCrrg)rrrLrrZrTrTrUrrz'ZstdCompressionParameters.write_dict_idcCrrg)rrrLrrZrTrTrUr!rz"ZstdCompressionParameters.job_sizecCrrg)rrrLrrZrTrTrUr%rz%ZstdCompressionParameters.overlap_logcCrrg)rrrLrrZrTrTrUr)rz*ZstdCompressionParameters.force_max_windowcCrrg)rrrLrrZrTrTrUr/rz$ZstdCompressionParameters.enable_ldmcCrrg)rrrLrrZrTrTrUr5rz&ZstdCompressionParameters.ldm_hash_logcCrrg)rrrLrrZrTrTrUr9rz'ZstdCompressionParameters.ldm_min_matchcCrrg)rrrLrrZrTrTrUr=rz-ZstdCompressionParameters.ldm_bucket_size_logcCrrg)rrrLrrZrTrTrUrCrz+ZstdCompressionParameters.ldm_hash_rate_logcCrrg)rrrLrrZrTrTrUrIrz!ZstdCompressionParameters.threadscC t|jS)zAEstimated size in bytes needed to compress with these parameters.)rL%ZSTD_estimateCCtxSize_usingCCtxParamsrrZrTrTrU"estimated_compression_context_sizeMs z>> cctx = zstandard.ZstdCompressor(level=10) >>> compressor = cctx.stream_writer(fh) >>> compressor.write(b"chunk 0\n") >>> compressor.write(b"chunk 1\n") >>> compressor.flush() >>> # Receiver will be able to decode ``chunk 0\nchunk 1\n`` at this point. >>> # Receiver is also expecting more data in the zstd *frame*. >>> >>> compressor.write(b"chunk 2\n") >>> compressor.flush(zstandard.FLUSH_FRAME) >>> # Receiver will be able to decode ``chunk 0\nchunk 1\nchunk 2``. >>> # Receiver is expecting no more data, as the zstd frame is closed. >>> # Any future calls to ``write()`` at this point will construct a new >>> # zstd frame. Instances can be used as context managers. Exiting the context manager is the equivalent of calling ``close()``, which is equivalent to calling ``flush(zstandard.FLUSH_FRAME)``: >>> cctx = zstandard.ZstdCompressor(level=10) >>> with cctx.stream_writer(fh) as compressor: ... compressor.write(b'chunk 0') ... compressor.write(b'chunk 1') ... ... .. important:: If ``flush(FLUSH_FRAME)`` is not called, emitted data doesn't constitute a full zstd *frame* and consumers of this data may complain about malformed input. It is recommended to use instances as a context manager to ensure *frames* are properly finished. If the size of the data being fed to this streaming compressor is known, you can declare it before compression begins: >>> cctx = zstandard.ZstdCompressor() >>> with cctx.stream_writer(fh, size=data_len) as compressor: ... compressor.write(chunk0) ... compressor.write(chunk1) ... ... Declaring the size of the source data allows compression parameters to be tuned. And if ``write_content_size`` is used, it also results in the content size being written into the frame header of the output data. The size of chunks being ``write()`` to the destination can be specified: >>> cctx = zstandard.ZstdCompressor() >>> with cctx.stream_writer(fh, write_size=32768) as compressor: ... ... To see how much memory is being used by the streaming compressor: >>> cctx = zstandard.ZstdCompressor() >>> with cctx.stream_writer(fh) as compressor: ... ... ... byte_size = compressor.memory_size() Thte total number of bytes written so far are exposed via ``tell()``: >>> cctx = zstandard.ZstdCompressor() >>> with cctx.stream_writer(fh) as compressor: ... ... ... total_written = compressor.tell() ``stream_writer()`` accepts a ``write_return_read`` boolean argument to control the return value of ``write()``. When ``False`` (the default), ``write()`` returns the number of bytes that were ``write()``'en to the underlying object. When ``True``, ``write()`` returns the number of bytes read from the input that were subsequently written to the compressor. ``True`` is the *proper* behavior for ``write()`` as specified by the ``io.RawIOBase`` interface and will become the default value in a future release. TcCs||_||_||_t||_t||_d|_d|_d|_d|_ t d||_ t d|_ |j |j _t|j |j _d|j _t|j|}t|rPtdt|dS)NFrchar[]ZSTD_outBuffer *error setting source size: %s) _compressor_writer _write_sizebool_write_return_read_closefd_entered_closing_closed_bytes_compressedrKr _dst_buffer _out_bufferdstlenrfposrLZSTD_CCtx_setPledgedSrcSize_cctxrrrr)r[ compressorwriterr write_sizewrite_return_readclosefdrqrTrTrUrs(       zZstdCompressionWriter.__init__cC&|jrtd|jrtdd|_|SNstream is closedcannot __enter__ multiple timesTrrSrrrZrTrTrU __enter__ zZstdCompressionWriter.__enter__cCsd|_|d|_dSNF)rcloserr[exc_type exc_valueexc_tbrTrTrU__exit__szZstdCompressionWriter.__exit__cCtrgioUnsupportedOperationrZrTrTrU__iter__ zZstdCompressionWriter.__iter__cCrrgrrZrTrTrU__next__ rzZstdCompressionWriter.__next__cCt|jjSrg)rLZSTD_sizeof_CCtxrrrZrTrTrU memory_sizez!ZstdCompressionWriter.memory_sizecC t|jdd}|r |StdNfilenoz)fileno not available on underlying writerrrOSErrorr[frTrTrUrzZstdCompressionWriter.filenocCsd|jrdSzd|_|tWd|_d|_nd|_d|_wt|jdd}|jr.|r0|dSdSdSNTFr)rrflushrrrrrrTrTrUrs   zZstdCompressionWriter.closecC|jSrgrrZrTrTrUclosed*r_zZstdCompressionWriter.closedcCdSrrTrZrTrTrUisatty.zZstdCompressionWriter.isattycCr rrTrZrTrTrUreadable1r zZstdCompressionWriter.readablercCrrgrr[rfrTrTrUreadline4rzZstdCompressionWriter.readlinecCrrgrr[hintrTrTrU readlines7rzZstdCompressionWriter.readlinesNcCrrgrr[r\whencerTrTrUseek:rzZstdCompressionWriter.seekcCr rrTrZrTrTrUseekable=r zZstdCompressionWriter.seekablecCrrgrrrTrTrUtruncate@rzZstdCompressionWriter.truncatecCr NTrTrZrTrTrUwritableCr zZstdCompressionWriter.writablecCtd)Nz#writelines() is not yet implementedrXr[linesrTrTrU writelinesFrz ZstdCompressionWriter.writelinescCrrgrrrTrTrUreadIrzZstdCompressionWriter.readcCrrgrrZrTrTrUreadallLrzZstdCompressionWriter.readallcCrrgrr[brTrTrUreadintoOrzZstdCompressionWriter.readintocCs|jrtdd}t|}td}||_t||_d|_|j }d|_|j|jkrkt |j j ||t j}t |rBtdt||jre|jt|j|jdd||j7}|j|j7_d|_|j|jks*|jrq|jS|S)z=Send data to the compressor and possibly to the inner stream.rrZSTD_inBuffer *zstd compress error: %sN)rrSrK from_bufferrsrcrrfrrrLZSTD_compressStream2rrZSTD_e_continuerrrrrwritebufferrrr)r[data total_write data_buffer in_buffer out_bufferrqrTrTrUr*Rs@        zZstdCompressionWriter.writecCs|tkrtj}n|tkrtj}ntd||jrtdd}|j}d|_t d}t j |_ d|_ d|_ t|jj|||}t|rLtdt||jro|jt |j|jdd||j7}|j|j7_d|_|srnq5t|jdd}|r|js||S) aEvict data from compressor's internal state and write it to inner stream. Calling this method may result in 0 or more ``write()`` calls to the inner stream. This method will also call ``flush()`` on the inner stream, if such a method exists. :param flush_mode: How to flush the zstd compressor. ``zstandard.FLUSH_BLOCK`` will flush data already sent to the compressor but not emitted to the inner stream. The stream is still writable after calling this. This is the default behavior. See documentation for other ``zstandard.FLUSH_*`` constants for more flushing options. :return: Integer number of bytes written to the inner stream. zunknown flush_mode: %rrrr$Tr%Nr)rrL ZSTD_e_flushr ZSTD_e_endrSrrrrKrrtr'rfr(rrrrrrrr*r+rrrr)r[ flush_moderr-r0r/rqrrTrTrUr|sH       zZstdCompressionWriter.flushcCrrgrrZrTrTrUtellrhzZstdCompressionWriter.tellTrrg)rarbrcrdrrrrrrrrrer r rrrrrrrrrr r#r*rrr5rTrTrTrUr qs8o         * Dr c@s0eZdZdZefddZddZefddZdS) r aA compressor conforming to the API in Python's standard library. This type implements an API similar to compression types in Python's standard library such as ``zlib.compressobj`` and ``bz2.BZ2Compressor``. This enables existing code targeting the standard library API to swap in this type to achieve zstd compression. .. important:: The design of this API is not ideal for optimal performance. The reason performance is not optimal is because the API is limited to returning a single buffer holding compressed data. When compressing data, we don't know how much data will be emitted. So in order to capture all this data in a single buffer, we need to perform buffer reallocations and/or extra memory copies. This can add significant overhead depending on the size or nature of the compressed data how much your application calls this type. If performance is critical, consider an API like :py:meth:`ZstdCompressor.stream_reader`, :py:meth:`ZstdCompressor.stream_writer`, :py:meth:`ZstdCompressor.chunker`, or :py:meth:`ZstdCompressor.read_to_iter`, which result in less overhead managing buffers. Instances are obtained by calling :py:meth:`ZstdCompressor.compressobj`. Here is how this API should be used: >>> cctx = zstandard.ZstdCompressor() >>> cobj = cctx.compressobj() >>> data = cobj.compress(b"raw input 0") >>> data = cobj.compress(b"raw input 1") >>> data = cobj.flush() Or to flush blocks: >>> cctx.zstandard.ZstdCompressor() >>> cobj = cctx.compressobj() >>> data = cobj.compress(b"chunk in first block") >>> data = cobj.flush(zstandard.COMPRESSOBJ_FLUSH_BLOCK) >>> data = cobj.compress(b"chunk in second block") >>> data = cobj.flush() For best performance results, keep input chunks under 256KB. This avoids extra allocations for a large output object. It is possible to declare the input size of the data that will be fed into the compressor: >>> cctx = zstandard.ZstdCompressor() >>> cobj = cctx.compressobj(size=6) >>> data = cobj.compress(b"foobar") >>> data = cobj.flush() cCsD||_td|_td||_|j|j_||j_d|j_d|_dS)NrrrF) rrKr_outrrrfr _finished)r[rrrTrTrUrs   zZstdCompressionObj.__init__cCs|jrtdt|}td}||_t||_d|_g}|jt|kr^t |j j |j |t j}t |r>tdt||j jrW|t|j j|j jddd|j _|jt|ks%d|S)aSend data to the compressor. This method receives bytes to feed to the compressor and returns bytes constituting zstd compressed data. The zstd compressor accumulates bytes and the returned bytes may be substantially smaller or larger than the size of the input data on any given call. The returned value may be the empty byte string (``b""``). :param data: Data to write to the compressor. :return: Compressed data. z0cannot call compress() after compressor finishedr$rr%N)r9rrKr&rr'rrfrrLr(rrr8r)rrrappendr+rjoin)r[r,r.sourcechunksrqrTrTrUcompress s*     " zZstdCompressionObj.compresscCs|ttfvr td|jrtd|tkrtj}n|tkr$tj}d|_ntd|jj dks0Jt d}t j |_ d|_d|_ g} t|jj|j||}t|rZtdt||jj rs|t |jj|jj ddd|j_ |svnqBd |S) aEmit data accumulated in the compressor that hasn't been outputted yet. The ``flush_mode`` argument controls how to end the stream. ``zstandard.COMPRESSOBJ_FLUSH_FINISH`` (the default) ends the compression stream and finishes a zstd frame. Once this type of flush is performed, ``compress()`` and ``flush()`` can no longer be called. This type of flush **must** be called to end the compression context. If not called, the emitted data may be incomplete and may not be readable by a decompressor. ``zstandard.COMPRESSOBJ_FLUSH_BLOCK`` will flush a zstd block. This ensures that all data fed to this instance will have been omitted and can be decoded by a decompressor. Flushes of this type can be performed multiple times. The next call to ``compress()`` will begin a new zstd block. :param flush_mode: How to flush the zstd compressor. :return: Compressed data. zflush mode not recognizedz"compressor object already finishedTzunhandled flush moderr$#error ending compression stream: %sNr:)rrrSr9rrLr1r2r8rrKrrtr'rfr(rrrrrr;r+rr<)r[r3 z_flush_moder/r>rqrTrTrUr3sD   " zZstdCompressionObj.flushN) rarbrcrdr%rr?rrrTrTrTrUr s :  *r c@s0eZdZdZddZddZddZdd Zd S) rarCompress data to uniformly sized chunks. This type allows you to iteratively feed chunks of data into a compressor and produce output chunks of uniform size. ``compress()``, ``flush()``, and ``finish()`` all return an iterator of ``bytes`` instances holding compressed data. The iterator may be empty. Callers MUST iterate through all elements of the returned iterator before performing another operation on the object or else the compressor's internal state may become confused. This can result in an exception being raised or malformed data being emitted. All chunks emitted by ``compress()`` will have a length of the configured chunk size. ``flush()`` and ``finish()`` may return a final chunk smaller than the configured chunk size. Instances are obtained by calling :py:meth:`ZstdCompressor.chunker`. Here is how the API should be used: >>> cctx = zstandard.ZstdCompressor() >>> chunker = cctx.chunker(chunk_size=32768) >>> >>> with open(path, 'rb') as fh: ... while True: ... in_chunk = fh.read(32768) ... if not in_chunk: ... break ... ... for out_chunk in chunker.compress(in_chunk): ... # Do something with output chunk of size 32768. ... ... for out_chunk in chunker.finish(): ... # Do something with output chunks that finalize the zstd frame. This compressor type is often a better alternative to :py:class:`ZstdCompressor.compressobj` because it has better performance properties. ``compressobj()`` will emit output data as it is available. This results in a *stream* of output chunks of varying sizes. The consistency of the output chunk size with ``chunker()`` is more appropriate for many usages, such as sending compressed data to a socket. ``compressobj()`` may also perform extra memory reallocations in order to dynamically adjust the sizes of the output chunks. Since ``chunker()`` output chunks are all the same size (except for flushed or final chunks), there is less memory allocation/copying overhead. cCsj||_td|_td||_|j|j_||j_d|j_td|_tj |j_ d|j_d|j_d|_ dS)Nrrrr$F) rrKrr8rrrfr_inrtr'r9)r[r chunk_sizerTrTrUrs     zZstdCompressionChunker.__init__ccs|jrtd|jjtjkrtdt|}t|sdS||j_t||j_d|j_ |jj |jjkrt |j j |j|jt j}|jj |jjkrVtj|j_d|j_d|j_ t |rctdt||jj |jjkr~t|jj|jj ddVd|j_ |jj |jjks4dSdS)zFeed new input data into the compressor. :param data: Data to feed to compressor. :return: Iterator of ``bytes`` representing chunks of compressed data. z1cannot call compress() after compression finishedzHcannot perform operation before consuming output from previous operationNrr%)r9rrBr'rKrtr&rrfrrLr(rrr8r)rrrr+r)r[r,r.rqrTrTrUr?s:     zZstdCompressionChunker.compressccs|jrtd|jjtjkrtd t|jj |j |jtj }t |r.tdt ||j jrEt|j j|j jddVd|j _|sIdSq)z}Flushes all data currently in the compressor. :return: Iterator of ``bytes`` of compressed data. z.cannot call flush() after compression finishedzCcannot call flush() before consuming output from previous operationTr%Nr)r9rrBr'rKrtrLr(rrr8r1rrrrr+rr[rqrTrTrUrs*  zZstdCompressionChunker.flushccs|jrtd|jjtjkrtd t|jj |j |jtj }t |r.tdt ||j jrEt|j j|j jddVd|j _|sLd|_dSq)zSignals the end of input data. No new data can be compressed after this method is called. This method will flush buffered data and finish the zstd frame. :return: Iterator of ``bytes`` of compressed data. z/cannot call finish() after compression finishedzDcannot call finish() before consuming output from previous operationTr%Nr)r9rrBr'rKrtrLr(rrr8r2rrrrr+rrDrTrTrUfinishs,   zZstdCompressionChunker.finishN)rarbrcrdrr?rrErTrTrTrUrws 4- rc@seZdZdZd5ddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZeddZdd Zd!d"Zd#d$Zd%d&ZeZd'd(Zd)d*Zd6d,d-Zd6d.d/Zd0d1Zd2d3Zd4S)7r a3 Readable compressing stream wrapper. ``ZstdCompressionReader`` is a read-only stream interface for obtaining compressed data from a source. This type conforms to the ``io.RawIOBase`` interface and should be usable by any type that operates against a *file-object* (``typing.BinaryIO`` in Python type hinting speak). Instances are neither writable nor seekable (even if the underlying source is seekable). ``readline()`` and ``readlines()`` are not implemented because they don't make sense for compressed data. ``tell()`` returns the number of compressed bytes emitted so far. Instances are obtained by calling :py:meth:`ZstdCompressor.stream_reader`. In this example, we open a file for reading and then wrap that file handle with a stream from which compressed data can be ``read()``. >>> with open(path, 'rb') as fh: ... cctx = zstandard.ZstdCompressor() ... reader = cctx.stream_reader(fh) ... while True: ... chunk = reader.read(16384) ... if not chunk: ... break ... ... # Do something with compressed chunk. Instances can also be used as context managers: >>> with open(path, 'rb') as fh: ... cctx = zstandard.ZstdCompressor() ... with cctx.stream_reader(fh) as reader: ... while True: ... chunk = reader.read(16384) ... if not chunk: ... break ... ... # Do something with compressed chunk. When the context manager exits or ``close()`` is called, the stream is closed, underlying resources are released, and future operations against the compression stream will fail. ``stream_reader()`` accepts a ``size`` argument specifying how large the input stream is. This is used to adjust compression parameters so they are tailored to the source size. e.g. >>> with open(path, 'rb') as fh: ... cctx = zstandard.ZstdCompressor() ... with cctx.stream_reader(fh, size=os.stat(path).st_size) as reader: ... ... If the ``source`` is a stream, you can specify how large ``read()`` requests to that stream should be via the ``read_size`` argument. It defaults to ``zstandard.COMPRESSION_RECOMMENDED_INPUT_SIZE``. e.g. >>> with open(path, 'rb') as fh: ... cctx = zstandard.ZstdCompressor() ... # Will perform fh.read(8192) when obtaining data to feed into the ... # compressor. ... with cctx.stream_reader(fh, read_size=8192) as reader: ... ... TcCsL||_||_||_||_d|_d|_d|_d|_d|_t d|_ d|_ dSNFrr$) r_source _read_sizerrrr_finished_input_finished_outputrKr _in_buffer_source_buffer)r[rr= read_sizerrTrTrUrns  zZstdCompressionReader.__init__cC&|jrtd|jrtdd|_|SNrrTrrSrrZrTrTrUr}rzZstdCompressionReader.__enter__cCd|_d|_|d|_dSr)rrrrGrrTrTrUr zZstdCompressionReader.__exit__cCr rrTrZrTrTrUrr zZstdCompressionReader.readablecCr rrTrZrTrTrUrr zZstdCompressionReader.writablecCr rrTrZrTrTrUrr zZstdCompressionReader.seekablecCrrgrrZrTrTrUrrzZstdCompressionReader.readlinecCrrgrrZrTrTrUrrzZstdCompressionReader.readlinescCrNzstream is not writablerr[r,rTrTrUr*rzZstdCompressionReader.writecCrrSrT)r[ignoredrTrTrUrrz ZstdCompressionReader.writelinescCr rrTrZrTrTrUr r zZstdCompressionReader.isattycCdSrgrTrZrTrTrUrr zZstdCompressionReader.flushcC:|jrdSd|_t|jdd}|jr|r|dSdSdSNTrrrrGrrrTrTrUr  zZstdCompressionReader.closecCrrgr rZrTrTrUr r_zZstdCompressionReader.closedcCrrgr4rZrTrTrUr5rhzZstdCompressionReader.tellcC,g} |d}|s n||qd|SNTir:rr;r<r[r>chunkrTrTrUr    zZstdCompressionReader.readallcCrrgrrZrTrTrUrrzZstdCompressionReader.__iter__cCrrgrrZrTrTrUrrzZstdCompressionReader.__next__cCs|jrdSt|jdr1|j|j}|sd|_dSt||_|j|j_ t |j|j_ d|j_ dSt|j|_|j|j_ t |j|j_ d|j_ dSNrTr) rIhasattrrGrrHrKr&rLrKr'rrfrrUrTrTrU _read_inputs      z!ZstdCompressionReader._read_inputcCs|jj|jjkr dS|j}t|jj||jtj}|j|j|7_|jj|jjkrDt j |j_ d|j_d|j_d|_ t |jdsDd|_t|rPtdt||joX|j|jkS)NrrTr%)rKrrfrLr(rrr)rrKrtr'rLrcrGrIrrrr)r[r0old_posrqrTrTrU_compress_into_buffers(   z+ZstdCompressionReader._compress_into_bufferrcCs0|jrtd|dkrtd|dkr|S|js|dkr dStd|}td}||_||_d|_| |rEt |j|jddS|j s`| | |r]t |j|jddS|j rH|j}t |jj||jt j}|j|j|7_t |rtdt||dkrd |_t |j|jddS Nrr)cannot read negative amounts less than -1rr:rrr@T)rrSr rJrKrrrfrrfr+rIrdrLr(rrrKr2rrrrrr[rf dst_bufferr0rerqrTrTrUrs@     zZstdCompressionReader.readcCsX|jrtd|dkrtd|js|dkrdS|dkrt}td|}td}||_||_d|_| ||jrFt |j|jddS|j ss| | |r^t |j|jddS|jrp|j spt |j|jddS|j rI|j}t |jj||jt j}|j|j|7_t |rtdt||dkrd |_t |j|jddSrg)rrSrJr%rKrrrfrrfr+rIrdrLr(rrrKr2rrrrrrirTrTrUread11sF       zZstdCompressionReader.read1cCs|jrtd|jr dSt|}t|ddtd}||_t||_ d|_ | |r0|j S|j sB| | |r?|j S|j r3|j }t|jj||jtj}|j|j |7_t|rgtdt||dkrnd|_|j SNrrr:rr@TrrSrJrKr&memmoverrrrfrrfrIrdrLr(rrrKr2rrrrrr[r" dest_bufferr0rerqrTrTrUr#ss:      zZstdCompressionReader.readintocCs|jrtd|jr dSt|}t|ddtd}||_t||_ d|_ | ||j r3|j S|j sN| | |rB|j S|j rK|j sK|j S|j r6|j }t|jj||jtj}|j|j |7_t|rttdt||dkr{d|_|j SrlrmrorTrTrU readinto1s@         zZstdCompressionReader.readinto1Nr6r7)rarbrcrdrrrrrrrrr*rr rrrer r5r rrnextrdrfrrkr#rqrTrTrTrUr +s8 B     0B )r c@seZdZdZ       dddZddZd d Zd d Zd ddZd e fddZ d e e fddZ d e dfddZ d e ddfddZd e e fddZd ddZddZdS)!ra Create an object used to perform Zstandard compression. Each instance is essentially a wrapper around a ``ZSTD_CCtx`` from zstd's C API. An instance can compress data various ways. Instances can be used multiple times. Each compression operation will use the compression parameters defined at construction time. .. note: When using a compression dictionary and multiple compression operations are performed, the ``ZstdCompressionParameters`` derived from an integer compression ``level`` and the first compressed data's size will be reused for all subsequent operations. This may not be desirable if source data sizes vary significantly. ``compression_params`` is mutually exclusive with ``level``, ``write_checksum``, ``write_content_size``, ``write_dict_id``, and ``threads``. Assume that each ``ZstdCompressor`` instance can only handle a single logical compression operation at the same time. i.e. if you call a method like ``stream_reader()`` to obtain multiple objects derived from the same ``ZstdCompressor`` instance and attempt to use them simultaneously, errors will likely occur. If you need to perform multiple logical compression operations and you can't guarantee those operations are temporally non-overlapping, you need to obtain multiple ``ZstdCompressor`` instances. Unless specified otherwise, assume that no two methods of ``ZstdCompressor`` instances can be called from multiple Python threads simultaneously. In other words, assume instances are not thread safe unless stated otherwise. :param level: Integer compression level. Valid values are all negative integers through 22. Lower values generally yield faster operations with lower compression ratios. Higher values are generally slower but compress better. The default is 3, which is what the ``zstd`` CLI uses. Negative levels effectively engage ``--fast`` mode from the ``zstd`` CLI. :param dict_data: A ``ZstdCompressionDict`` to be used to compress with dictionary data. :param compression_params: A ``ZstdCompressionParameters`` instance defining low-level compression parameters. If defined, this will overwrite the ``level`` argument. :param write_checksum: If True, a 4 byte content checksum will be written with the compressed data, allowing the decompressor to perform content verification. :param write_content_size: If True (the default), the decompressed content size will be included in the header of the compressed data. This data will only be written if the compressor knows the size of the input data. :param write_dict_id: Determines whether the dictionary ID will be written into the compressed data. Defaults to True. Only adds content to the compressed data if a dictionary is being used. :param threads: Number of threads to use to compress data concurrently. When set, compression operations are performed on multiple threads. The default value (0) disables multi-threaded compression. A value of ``-1`` means to set the number of threads to the number of detected logical CPUs. Nrc Cs|tkrtdt|dkrt}|r|durtd|r)|dur)td|r3|dur3td|r;|r;td|rCt||_nR|durId}t}|tjkrUt t |tj |_t |jtj |t |jtj|durp|ndt |jtj|r|dndt |jtj|rdnd|rt |jtj|t} | tjkrt | |_||_z|Wtj | tjt| d |_dStj | tjt| d |_w) Nzlevel must be less than %drz3cannot define compression_params and write_checksumz7cannot define compression_params and write_content_sizez2cannot define compression_params and write_dict_idz,cannot define compression_params and threadsTrJrf)rLZSTD_maxCLevelrSrVrrrsrKrtrurvrwrrzrrrrZSTD_createCCtxr _dict_data _setup_cctx ZSTD_freeCCtxr) r[r dict_datacompression_paramsrrrrrcctxrTrTrUrsx             zZstdCompressor.__init__cCst|j|j}t|rtdt||j}|rC|jr&t |j|j}nt |j| t |tj |j}t|rEtdt|dSdS)Nz(could not set compression parameters: %sz)could not load compression dictionary: %s)rL&ZSTD_CCtx_setParametersUsingCCtxParamsrrrrrrrw_cdictZSTD_CCtx_refCDict!ZSTD_CCtx_loadDictionary_advancedas_bytesrZSTD_dlm_byRef _dict_type)r[rqrzrTrTrUrxjs8   zZstdCompressor._setup_cctxcCr)zObtain the memory usage of this compressor, in bytes. >>> cctx = zstandard.ZstdCompressor() >>> memory = cctx.memory_size() )rLrrrZrTrTrUr zZstdCompressor.memory_sizecCst|jtjt|}tt|}td|}t |jt|}t |r/t dt |t d}t d}||_||_d|_||_t||_d|_t|j||tj}t |rdt dt ||rjt dt||jddS) a Compress data in a single operation. This is the simplest mechanism to perform compression: simply pass in a value and get a compressed value back. It is almost the most prone to abuse. The input and output values must fit in memory, so passing in very large values can result in excessive memory usage. For this reason, one of the streaming based APIs is preferred for larger values. :param data: Source data to compress :return: Compressed data >>> cctx = zstandard.ZstdCompressor() >>> compressed = cctx.compress(b"data to compress") rrrr$rzcannot compress: %szunexpected partial frame flushN)rLZSTD_CCtx_resetrZSTD_reset_session_onlyrKr&ZSTD_compressBoundr new_nonzerorrrrrrrrfrr'r(r2r+)r[r,r. dest_sizeoutrqr0r/rTrTrUr?s2         zZstdCompressor.compressrcCsTt|jtj|dkrtj}t|j|}t|r#tdt|t |t }|S)a. Obtain a compressor exposing the Python standard library compression API. See :py:class:`ZstdCompressionObj` for the full documentation. :param size: Size in bytes of data that will be compressed. :return: :py:class:`ZstdCompressionObj` rr) rLrrrZSTD_CONTENTSIZE_UNKNOWNrrrrrr r%)r[rfrqcobjrTrTrU compressobjs    zZstdCompressor.compressobjcCsRt|jtj|dkrtj}t|j|}t|r#tdt|t ||dS)a Create an object for iterative compressing to same-sized chunks. This API is similar to :py:meth:`ZstdCompressor.compressobj` but has better performance properties. :param size: Size in bytes of data that will be compressed. :param chunk_size: Size of compressed chunks. :return: :py:class:`ZstdCompressionChunker` rr)rC) rLrrrrrrrrrr)r[rfrCrqrTrTrUchunkers   zZstdCompressor.chunkercCst|ds tdt|dstdt|jtj|dkr!tj}t|j|}t|r5t dt |t d}t d}t d |} | |_ ||_d|_d \} } ||} | s[nPt | } | t| 7} | |_t| |_d|_|j|jkrt|j||tj}t|rt d t ||jr|t |j |j| |j7} d|_|j|jkswqS t|j||tj}t|rt d t ||jr|t |j |j| |j7} d|_|dkr | | fSq)a" Copy data between 2 streams while compressing it. Data will be read from ``ifh``, compressed, and written to ``ofh``. ``ifh`` must have a ``read(size)`` method. ``ofh`` must have a ``write(data)`` method. >>> cctx = zstandard.ZstdCompressor() >>> with open(input_path, "rb") as ifh, open(output_path, "wb") as ofh: ... cctx.copy_stream(ifh, ofh) It is also possible to declare the size of the source stream: >>> cctx = zstandard.ZstdCompressor() >>> cctx.copy_stream(ifh, ofh, size=len_of_input) You can also specify how large the chunks that are ``read()`` and ``write()`` from and to the streams: >>> cctx = zstandard.ZstdCompressor() >>> cctx.copy_stream(ifh, ofh, read_size=32768, write_size=16384) The stream copier returns a 2-tuple of bytes read and written: >>> cctx = zstandard.ZstdCompressor() >>> read_count, write_count = cctx.copy_stream(ifh, ofh) :param ifh: Source stream to read from :param ofh: Destination stream to write to :param size: Size in bytes of the source stream. If defined, compression parameters will be tuned for this size. :param read_size: Chunk sizes that source stream should be ``read()`` from. :param write_size: Chunk sizes that destination stream should be ``write()`` to. :return: 2-tuple of ints of bytes read and written, respectively. r(first argument must have a read() methodr**second argument must have a write() methodrrr$rrrTr%r@)rcrSrLrrrrrrrrrrKrrrfrrr&rr'r(r)r*r+r2)r[ifhofhrfrMrrqr/r0rj total_readr-r,r.rTrTrU copy_streamst 3                    zZstdCompressor.copy_streamTcCsvt|jtjzt|}Wn tyYnw|dkrtj}t|j|}t|r3t dt |t ||||dS)a Wrap a readable source with a stream that can read compressed data. This will produce an object conforming to the ``io.RawIOBase`` interface which can be ``read()`` from to retrieve compressed data from a source. The source object can be any object with a ``read(size)`` method or an object that conforms to the buffer protocol. See :py:class:`ZstdCompressionReader` for type documentation and usage examples. :param source: Object to read source data from :param size: Size in bytes of source object. :param read_size: How many bytes to request when ``read()``'ing from the source. :param closefd: Whether to close the source stream when the returned stream is closed. :return: :py:class:`ZstdCompressionReader` rrr) rLrrrr Exceptionrrrrrrr )r[r=rfrMrrqrTrTrU stream_readervs     zZstdCompressor.stream_readercCsDt|ds tdt|jtj|dkrtj}t||||||dS)a Create a stream that will write compressed data into another stream. The argument to ``stream_writer()`` must have a ``write(data)`` method. As compressed data is available, ``write()`` will be called with the compressed data as its argument. Many common Python types implement ``write()``, including open file handles and ``io.BytesIO``. See :py:class:`ZstdCompressionWriter` for more documentation, including usage examples. :param writer: Stream to write compressed data to. :param size: Size in bytes of data to be compressed. If set, it will be used to influence compression parameter tuning and could result in the size being written into the header of the compressed data. :param write_size: How much data to ``write()`` to ``writer`` at a time. :param write_return_read: Whether ``write()`` should return the number of bytes that were consumed from the input. :param closefd: Whether to ``close`` the ``writer`` when this stream is closed. :return: :py:class:`ZstdCompressionWriter` r*)must pass an object with a write() methodrr)rcrSrLrrrrr )r[rrfrrrrTrTrU stream_writers # zZstdCompressor.stream_writerccs0t|dr d}nt|drd}d}t|}ntdt|jtj|dkr*tj}t|j|}t |r>t dt |t d}t d } t j|_d|_d|_t d |} | | _|| _d| _ | jdksiJ|rq||} nt||} t| |} |||| } || 7}| snPt | }||_t||_d|_|j|jkrt|j| |tj}t |rt d t || jrt | j| jd d }d| _|V|j|jks| jdksJqa | jdksJt|j| |tj}t |rt d t || jrt | j| jd d }d| _|V|dkrd Sq)a# Read uncompressed data from a reader and return an iterator Returns an iterator of compressed data produced from reading from ``reader``. This method provides a mechanism to stream compressed data out of a source as an iterator of data chunks. Uncompressed data will be obtained from ``reader`` by calling the ``read(size)`` method of it or by reading a slice (if ``reader`` conforms to the *buffer protocol*). The source data will be streamed into a compressor. As compressed data is available, it will be exposed to the iterator. Data is read from the source in chunks of ``read_size``. Compressed chunks are at most ``write_size`` bytes. Both values default to the zstd input and and output defaults, respectively. If reading from the source via ``read()``, ``read()`` will be called until it raises or returns an empty bytes (``b""``). It is perfectly valid for the source to deliver fewer bytes than were what requested by ``read(size)``. The caller is partially in control of how fast data is fed into the compressor by how it consumes the returned iterator. The compressor will not consume from the reader unless the caller consumes from the iterator. >>> cctx = zstandard.ZstdCompressor() >>> for chunk in cctx.read_to_iter(fh): ... # Do something with emitted data. ``read_to_iter()`` accepts a ``size`` argument declaring the size of the input stream: >>> cctx = zstandard.ZstdCompressor() >>> for chunk in cctx.read_to_iter(fh, size=some_int): >>> pass You can also control the size that data is ``read()`` from the source and the ideal size of output chunks: >>> cctx = zstandard.ZstdCompressor() >>> for chunk in cctx.read_to_iter(fh, read_size=16384, write_size=8192): >>> pass ``read_to_iter()`` does not give direct control over the sizes of chunks fed into the compressor. Instead, chunk sizes will be whatever the object being read from delivers. These will often be of a uniform size. :param reader: Stream providing data to be compressed. :param size: Size in bytes of input data. :param read_size: Controls how many bytes are ``read()`` from the source. :param write_size: Controls the output size of emitted chunks. :return: Iterator of ``bytes``. rTrkFrGmust pass an object with a read() method or conforms to buffer protocolrr$rrr%Nr@)rcrrSrLrrrrrrrrrrKrrtr'rfrrrminr&r(r)r+r2)r[readerrfrMr have_read buffer_offsetrqr/r0rj read_result remaining slice_size read_bufferr,rTrTrU read_to_iters F                     zZstdCompressor.read_to_itercCrW)a Compress multiple pieces of data as a single function call. (Experimental. Not yet supported by CFFI backend.) This function is optimized to perform multiple compression operations as as possible with as little overhead as possible. Data to be compressed can be passed as a ``BufferWithSegmentsCollection``, a ``BufferWithSegments``, or a list containing byte like objects. Each element of the container will be compressed individually using the configured parameters on the ``ZstdCompressor`` instance. The ``threads`` argument controls how many threads to use for compression. The default is ``0`` which means to use a single thread. Negative values use the number of logical CPUs in the machine. The function returns a ``BufferWithSegmentsCollection``. This type represents N discrete memory allocations, each holding 1 or more compressed frames. Output data is written to shared memory buffers. This means that unlike regular Python objects, a reference to *any* object within the collection keeps the shared buffer and therefore memory backing it alive. This can have undesirable effects on process memory usage. The API and behavior of this function is experimental and will likely change. Known deficiencies include: * If asked to use multiple threads, it will always spawn that many threads, even if the input is too small to use them. It should automatically lower the thread count when the extra threads would just add overhead. * The buffer allocation strategy is fixed. There is room to make it dynamic, perhaps even to allow one output buffer per input, facilitating a variation of the API to return a list without the adverse effects of shared memory buffers. :param data: Source to read discrete pieces of data to compress. Can be a ``BufferWithSegmentsCollection``, a ``BufferWithSegments``, or a ``list[bytes]``. :return: BufferWithSegmentsCollection holding compressed data. rX)r[r,rrTrTrUmulti_compress_to_buffer s/z'ZstdCompressor.multi_compress_to_buffercCst|j}|j|j|jfS)a Return information on how much work the compressor has done. Returns a 3-tuple of (ingested, consumed, produced). >>> cctx = zstandard.ZstdCompressor() >>> (ingested, consumed, produced) = cctx.frame_progression() )rLZSTD_getFrameProgressionringestedconsumedproduced)r[ progressionrTrTrUframe_progression s z ZstdCompressor.frame_progression)rsNNNNNrr7)rarbrcrdrrxrr?rr%rr$rrrrrrrTrTrTrUrsFE Y 7 } 5 2  * 1rc@seZdZdZddZdS)raInformation about a zstd frame. Instances have the following attributes: ``content_size`` Integer size of original, uncompressed content. This will be ``0`` if the original content size isn't written to the frame (controlled with the ``write_content_size`` argument to ``ZstdCompressor``) or if the input content size was ``0``. ``window_size`` Integer size of maximum back-reference distance in compressed data. ``dict_id`` Integer of dictionary ID used for compression. ``0`` if no dictionary ID was used or if the dictionary ID was ``0``. ``has_checksum`` Bool indicating whether a 4 byte content checksum is stored at the end of the frame. cCs(|j|_|j|_|j|_t|j|_dSrg) frameContentSize content_size windowSize window_sizedictIDdict_idr checksumFlag has_checksum)r[fparamsrTrTrUr szFrameParameters.__init__N)rarbrcrdrrTrTrTrUr s rcCs>t|}t|t|}|tjkrtd|tjkrdS|S)zObtain the decompressed size of a frame. The returned value is usually accurate. But strictly speaking it should not be trusted. :return: ``-1`` if size unknown and a non-negative integer otherwise. z#error when determining content sizer)rKr&rLZSTD_getFrameContentSizerZSTD_CONTENTSIZE_ERRORrr)r,r.rfrTrTrUr s   rcCs8t|}t|t|}t|rtdt||S)zSObtain the size of a frame header. :return: Integer size in bytes. z)could not determine frame header size: %s)rKr&rLZSTD_frameHeaderSizerrrrr)r,r.rqrTrTrUr s   rcCs\td}t|}t||t|}t|r tdt||r(td|t |dS)a Parse a zstd frame header into frame parameters. Depending on which fields are present in the frame and their values, the length of the frame parameters varies. If insufficient bytes are passed in to fully parse the frame parameters, ``ZstdError`` is raised. To ensure frame parameters can be parsed, pass in at least 18 bytes. :param data: Data from which to read frame parameters. :return: :py:class:`FrameParameters` ZSTD_frameHeader *zcannot get frame parameters: %sz3not enough data for frame parameters; need %d bytesr) rKrr&rLZSTD_getFrameHeaderrrrrrr)r,rr.rqrTrTrUr s     rc@sNeZdZdZeddfddZddZddZd d Zdd d Z e ddZ d S)r a Represents a computed compression dictionary. Instances are obtained by calling :py:func:`train_dictionary` or by passing bytes obtained from another source into the constructor. Instances can be constructed from bytes: >>> dict_data = zstandard.ZstdCompressionDict(data) It is possible to construct a dictionary from *any* data. If the data doesn't begin with a magic header, it will be treated as a *prefix* dictionary. *Prefix* dictionaries allow compression operations to reference raw data within the dictionary. It is possible to force the use of *prefix* dictionaries or to require a dictionary header: >>> dict_data = zstandard.ZstdCompressionDict(data, dict_type=zstandard.DICT_TYPE_RAWCONTENT) >>> dict_data = zstandard.ZstdCompressionDict(data, dict_type=zstandard.DICT_TYPE_FULLDICT) You can see how many bytes are in the dictionary by calling ``len()``: >>> dict_data = zstandard.train_dictionary(size, samples) >>> dict_size = len(dict_data) # will not be larger than ``size`` Once you have a dictionary, you can pass it to the objects performing compression and decompression: >>> dict_data = zstandard.train_dictionary(131072, samples) >>> cctx = zstandard.ZstdCompressor(dict_data=dict_data) >>> for source_data in input_data: ... compressed = cctx.compress(source_data) ... # Do something with compressed data. ... >>> dctx = zstandard.ZstdDecompressor(dict_data=dict_data) >>> for compressed_data in input_data: ... buffer = io.BytesIO() ... with dctx.stream_writer(buffer) as decompressor: ... decompressor.write(compressed_data) ... # Do something with raw data in ``buffer``. Dictionaries have unique integer IDs. You can retrieve this ID via: >>> dict_id = zstandard.dictionary_id(dict_data) You can obtain the raw data in the dict (useful for persisting and constructing a ``ZstdCompressionDict`` later) via ``as_bytes()``: >>> dict_data = zstandard.train_dictionary(size, samples) >>> raw_data = dict_data.as_bytes() By default, when a ``ZstdCompressionDict`` is *attached* to a ``ZstdCompressor``, each ``ZstdCompressor`` performs work to prepare the dictionary for use. This is fine if only 1 compression operation is being performed or if the ``ZstdCompressor`` is being reused for multiple operations. But if multiple ``ZstdCompressor`` instances are being used with the dictionary, this can add overhead. It is possible to *precompute* the dictionary so it can readily be consumed by multiple ``ZstdCompressor`` instances: >>> d = zstandard.ZstdCompressionDict(data) >>> # Precompute for compression level 3. >>> d.precompute_compress(level=3) >>> # Precompute with specific compression parameters. >>> params = zstandard.ZstdCompressionParameters(...) >>> d.precompute_compress(compression_params=params) .. note:: When a dictionary is precomputed, the compression parameters used to precompute the dictionary overwrite some of the compression parameters specified to ``ZstdCompressor``. :param data: Dictionary data. :param dict_type: Type of dictionary. One of the ``DICT_TYPE_*`` constants. rcCsFt|tsJ||_||_||_|tttfvrtd||_ d|_ dS)Nz@invalid dictionary load mode: %d; must use DICT_TYPE_* constants) isinstancebytes_datakdrErFrGrSrr~)r[r, dict_typerrrTrTrUrs s zZstdCompressionDict.__init__cCs t|jSrg)rrrZrTrTrUr^ s zZstdCompressionDict.__len__cCstt|jt|jS)z(Obtain the integer ID of the dictionary.)intrLZDICT_getDictIDrrrZrTrTrUr szZstdCompressionDict.dict_idcCr)z6Obtain the ``bytes`` representation of the dictionary.)rrZrTrTrUr r_zZstdCompressionDict.as_bytesNcCs|r|rtd|s|std|rt|dt|j}n!td}|j|_|j |_ |j |_ |j |_|j|_|j|_|j|_t|jt|jtj|j|tj}|tjkrXtdtj|tjt|d|_dS)zPrecompute a dictionary os it can be used by multiple compressors. Calling this method on an instance that will be used by multiple :py:class:`ZstdCompressor` instances will improve performance. z4must only specify one of level or compression_paramsz/must specify one of level or compression_paramsrZSTD_compressionParameterszunable to precompute dictionaryrtN)rSrLrrrrKrrrrrrrrrrrrr}rZSTD_createCDict_advancedrrZSTD_defaultCMemrtrrvZSTD_freeCDictZSTD_sizeof_CDictr~)r[rr{cparamscdictrTrTrUprecompute_compress s:   z'ZstdCompressionDict.precompute_compresscCsXt|jt|jtj|jtj}|tjkrt dtj |tj t |d}||j d<|S)Nz#could not create decompression dictrt_ddict)rLZSTD_createDDict_advancedrrrrrrKrtrrvZSTD_freeDDictZSTD_sizeof_DDict__dict__)r[ddictrTrTrUr s  zZstdCompressionDict._ddict)rN) rarbrcrdrErr^rrrrerrTrTrTrUr " sP )r c  Cst|ts td| dkrt} | s | s |pd}| pd} | pd} ttt|} td| } tdt|}d}t|D]"\}}t|t sFt dt|}t | |||||7}|||<q9td|}t d d}||_||_||_| |_| |_||_||_||j_||j_| |j_tt ||t | t |dt|t |}t|rt t|d }t d |t!t "||d d t#|j|jd S)a Train a dictionary from sample data using the COVER algorithm. A compression dictionary of size ``dict_size`` will be created from the iterable of ``samples``. The raw dictionary bytes will be returned. The dictionary training mechanism is known as *cover*. More details about it are available in the paper *Effective Construction of Relative Lempel-Ziv Dictionaries* (authors: Liao, Petri, Moffat, Wirth). The cover algorithm takes parameters ``k`` and ``d``. These are the *segment size* and *dmer size*, respectively. The returned dictionary instance created by this function has ``k`` and ``d`` attributes containing the values for these parameters. If a ``ZstdCompressionDict`` is constructed from raw bytes data (a content-only dictionary), the ``k`` and ``d`` attributes will be ``0``. The segment and dmer size parameters to the cover algorithm can either be specified manually or ``train_dictionary()`` can try multiple values and pick the best one, where *best* means the smallest compressed data size. This later mode is called *optimization* mode. Under the hood, this function always calls ``ZDICT_optimizeTrainFromBuffer_fastCover()``. See the corresponding C library documentation for more. If neither ``steps`` nor ``threads`` is defined, defaults for ``d``, ``steps``, and ``level`` will be used that are equivalent with what ``ZDICT_trainFromBuffer()`` would use. :param dict_size: Target size in bytes of the dictionary to generate. :param samples: A list of bytes holding samples the dictionary will be trained from. :param k: Segment size : constraint: 0 < k : Reasonable range [16, 2048+] :param d: dmer size : constraint: 0 < d <= k : Reasonable range [6, 16] :param f: log of size of frequency array : constraint: 0 < f <= 31 : 1 means default(20) :param split_point: Percentage of samples used for training: Only used for optimization. The first # samples * ``split_point`` samples will be used to training. The last # samples * (1 - split_point) samples will be used for testing. 0 means default (0.75), 1.0 when all samples are used for both training and testing. :param accel: Acceleration level: constraint: 0 < accel <= 10. Higher means faster and less accurate, 0 means default(1). :param dict_id: Integer dictionary ID for the produced dictionary. Default is 0, which uses a random value. :param steps: Number of steps through ``k`` values to perform when trying parameter variations. :param threads: Number of threads to use when trying parameter variations. Default is 0, which means to use a single thread. A negative value can be specified to use as many threads as there are detected logical CPUs. :param level: Integer target compression level when trying parameter variations. :param notifications: Controls writing of informational messages to ``stderr``. ``0`` (the default) means to write nothing. ``1`` writes errors. ``2`` writes progression info. ``3`` writes more details. And ``4`` writes all info. zsamples must be a listrrsrzsize_t[]zsamples must be byteszZDICT_fastCover_params_t *rmzcannot train dict: %sN)rrr)$rlist TypeErrorrVsummaprr enumeraterrSrKrnrrrrsteps nbThreads splitPointaccelzParamsnotificationLevelrcompressionLevelrL'ZDICT_optimizeTrainFromBuffer_fastCover addressof ZDICT_isErrorrnZDICT_getErrorNamerprr r+rG)rsamplesrrr split_pointr notificationsrrrr total_sizesamples_buffer sample_sizesr\rjsamplelrzdparamsrqmsgrTrTrUr s` R       rc@sNeZdZdZddZddZdddZed d Zed d Z ed dZ dS)raA standard library API compatible decompressor. This type implements a compressor that conforms to the API by other decompressors in Python's standard library. e.g. ``zlib.decompressobj`` or ``bz2.BZ2Decompressor``. This allows callers to use zstd compression while conforming to a similar API. Compressed data chunks are fed into ``decompress(data)`` and uncompressed output (or an empty bytes) is returned. Output from subsequent calls needs to be concatenated to reassemble the full decompressed byte sequence. If ``read_across_frames=False``, each instance is single use: once an input frame is decoded, ``decompress()`` will raise an exception. If ``read_across_frames=True``, instances can decode multiple frames. >>> dctx = zstandard.ZstdDecompressor() >>> dobj = dctx.decompressobj() >>> data = dobj.decompress(compressed_chunk_0) >>> data = dobj.decompress(compressed_chunk_1) By default, calls to ``decompress()`` write output data in chunks of size ``DECOMPRESSION_RECOMMENDED_OUTPUT_SIZE``. These chunks are concatenated before being returned to the caller. It is possible to define the size of these temporary chunks by passing ``write_size`` to ``decompressobj()``: >>> dctx = zstandard.ZstdDecompressor() >>> dobj = dctx.decompressobj(write_size=1048576) .. note:: Because calls to ``decompress()`` may need to perform multiple memory (re)allocations, this streaming decompression API isn't as efficient as other APIs. cCs"||_||_d|_||_d|_dS)NFr:) _decompressorrr9_read_across_frames _unused_input)r[ decompressorrread_across_framesrTrTrUr s  zZstdDecompressionObj.__init__cCsJ|jrtdtd}td}t|}t|dkrdS||_t||_d|_td|j }||_ t||_d|_g} t |j j||}t |rTtdt||jrf|t|j |jd d |dkr}|js}d|_d |_ ||j|j|_n#|dkr|jr|j|jkrnd|_n|j|jkr|j|jkrnd|_q>d|S) zSend compressed data to the decompressor and obtain decompressed data. :param data: Data to feed into the decompressor. :return: Decompressed bytes. z)cannot use a decompressobj multiple timesr$rrr:rTzstd decompressor error: %sN)r9rrKrr&rr'rfrrrrLZSTD_decompressStreamr_dctxrrrr;r+rrr<)r[r,r/r0r.rjr>rqrTrTrU decompress sP            -zZstdDecompressionObj.decompressrcCr )zEffectively a no-op. Implemented for compatibility with the standard library APIs. Safe to call at any time. :return: Empty bytes. r:rT)r[lengthrTrTrUr s zZstdDecompressionObj.flushcCr)zBytes past the end of compressed data. If ``decompress()`` is fed additional data beyond the end of a zstd frame, this value will be non-empty once ``decompress()`` fully decodes the input frame. )rrZrTrTrU unused_data sz ZstdDecompressionObj.unused_datacCr )z5Data that has not yet been fed into the decompressor.r:rTrZrTrTrUunconsumed_tail sz$ZstdDecompressionObj.unconsumed_tailcCr)z?Whether the end of the compressed data stream has been reached.)r9rZrTrTrUeof r]zZstdDecompressionObj.eofN)r) rarbrcrdrrrrerrrrTrTrTrUr^ s$ M  rc@seZdZdZ d7ddZddZddZd d Zd d Zd dZ d8ddZ d8ddZ ddZ ddZ ddZddZddZeddZd d!Zd"d#Zd$d%Zd&d'ZeZd(d)Zd*d+Zd8d,d-Zd.d/Zd8d0d1Zd2d3Zejfd4d5Z d6S)9ra Read only decompressor that pull uncompressed data from another stream. This type provides a read-only stream interface for performing transparent decompression from another stream or data source. It conforms to the ``io.RawIOBase`` interface. Only methods relevant to reading are implemented. >>> with open(path, 'rb') as fh: >>> dctx = zstandard.ZstdDecompressor() >>> reader = dctx.stream_reader(fh) >>> while True: ... chunk = reader.read(16384) ... if not chunk: ... break ... # Do something with decompressed chunk. The stream can also be used as a context manager: >>> with open(path, 'rb') as fh: ... dctx = zstandard.ZstdDecompressor() ... with dctx.stream_reader(fh) as reader: ... ... When used as a context manager, the stream is closed and the underlying resources are released when the context manager exits. Future operations against the stream will fail. The ``source`` argument to ``stream_reader()`` can be any object with a ``read(size)`` method or any object implementing the *buffer protocol*. If the ``source`` is a stream, you can specify how large ``read()`` requests to that stream should be via the ``read_size`` argument. It defaults to ``zstandard.DECOMPRESSION_RECOMMENDED_INPUT_SIZE``.: >>> with open(path, 'rb') as fh: ... dctx = zstandard.ZstdDecompressor() ... # Will perform fh.read(8192) when obtaining data for the decompressor. ... with dctx.stream_reader(fh, read_size=8192) as reader: ... ... Instances are *partially* seekable. Absolute and relative positions (``SEEK_SET`` and ``SEEK_CUR``) forward of the current position are allowed. Offsets behind the current read position and offsets relative to the end of stream are not allowed and will raise ``ValueError`` if attempted. ``tell()`` returns the number of decompressed bytes read so far. Not all I/O methods are implemented. Notably missing is support for ``readline()``, ``readlines()``, and linewise iteration support. This is because streams operate on binary data - not text data. If you want to convert decompressed output to text, you can chain an ``io.TextIOWrapper`` to the stream: >>> with open(path, 'rb') as fh: ... dctx = zstandard.ZstdDecompressor() ... stream_reader = dctx.stream_reader(fh) ... text_stream = io.TextIOWrapper(stream_reader, encoding='utf-8') ... for line in text_stream: ... ... TcCsZ||_||_||_t||_t||_d|_d|_d|_d|_ d|_ t d|_ d|_dSrF)rrGrHrrrrr_bytes_decompressedrIrJrKrrKrL)r[rr=rMrrrTrTrUr7 s    z ZstdDecompressionReader.__init__cCrNrOrPrZrTrTrUrM rz!ZstdDecompressionReader.__enter__cCrQr)rrrrGrrTrTrUrW rRz ZstdDecompressionReader.__exit__cCr rrTrZrTrTrUr_ r z ZstdDecompressionReader.readablecCr rrTrZrTrTrUrb r z ZstdDecompressionReader.writablecCr rrTrZrTrTrUre r z ZstdDecompressionReader.seekablercCrrgrrrTrTrUrh rz ZstdDecompressionReader.readlinecCrrgrrrTrTrUrk rz!ZstdDecompressionReader.readlinescCrrgrrUrTrTrUr*n rzZstdDecompressionReader.writecCrrgrrrTrTrUrq rz"ZstdDecompressionReader.writelinescCr rrTrZrTrTrUr t r zZstdDecompressionReader.isattycCrWrgrTrZrTrTrUrw r zZstdDecompressionReader.flushcCrXrYrZrrTrTrUrz r[zZstdDecompressionReader.closecCrrgr rZrTrTrUr  r_zZstdDecompressionReader.closedcCrrg)rrZrTrTrUr5 rhzZstdDecompressionReader.tellcCr\r]r^r_rTrTrUr  razZstdDecompressionReader.readallcCrrgrrZrTrTrUr rz ZstdDecompressionReader.__iter__cCrrgrrZrTrTrUr rz ZstdDecompressionReader.__next__cCs|jj|jjkr dS|jrdSt|jdr;|j|j}|s#d|_dSt ||_ |j |j_ t |j |j_d|j_dSt |j|_ |j |j_ t |j |j_d|j_dSrb) rKrrfrIrcrGrrHrKr&rLr'rrUrTrTrUrd s"      z#ZstdDecompressionReader._read_inputcCst|jj||j}|jj|jjkr+tj|j_ d|j_d|j_d|_ t |j ds+d|_ t|r8tdt||joH|j|jkpH|dkoH|j S)z|Decompress available input into an output buffer. Returns True if data in output buffer should be emitted. rNrTzstd decompress error: %s)rLrrrrKrrfrKrtr'rLrcrGrIrrrrr)r[r0rqrTrTrU_decompress_into_buffer s"     z/ZstdDecompressionReader._decompress_into_buffercCs|jrtd|dkrtd|dkr|S|js|dkr dStd|}td}||_||_d|_| | |rQ|j |j7_ t |j|jddS|j st| | |rq|j |j7_ t |j|jddS|j rT|j |j7_ t |j|jddSNrrrhrr:rr)rrSr rJrKrrrfrrdrrr+rIr[rfrjr0rTrTrUr s2    zZstdDecompressionReader.readcCs|jrtd|jr dSt|}t|ddtd}||_t||_ d|_ | | |r<|j |j 7_ |j S|jsV| | |rS|j |j 7_ |j S|jr?|j |j 7_ |j SNrrr:r)rrSrJrKr&rnrrrrfrrdrrrIr[r"rpr0rTrTrUr# s,     z ZstdDecompressionReader.readintocCs|jrtd|dkrtd|js|dkrdS|dkrt}td|}td}||_||_d|_|j sE| | ||jrBn|j r5|j |j7_ t |j|jddSr)rrSrJr'rKrrrfrrIrdrrr+rrTrTrUrk s*   zZstdDecompressionReader.read1cCs|jrtd|jr dSt|}t|ddtd}||_t||_ d|_ |j sA|jsA| | ||j r;n|j sA|jr.|j|j 7_|j Sr)rrSrJrKr&rnrrrrfrrIrdrrrrTrTrUrq; s$      z!ZstdDecompressionReader.readinto1cCs|jrtdd}|tjkr%|dkrtd||jkrtd||j}n|tjkr5|dkr2td|}n |tjkr>td|rV|t |t }|sN |jS|t |8}|s@|jS)Nrrz.cannot seek to negative position with SEEK_SETz/cannot seek zstd decompression stream backwardsz9zstd decompression streams cannot be seeked with SEEK_END) rrSrOSEEK_SETrrSEEK_CURSEEK_ENDrrr'r)r[rr read_amountrrTrTrUrU s>       zZstdDecompressionReader.seekNr6r7)!rarbrcrdrrrrrrrrr*rr rrrer r5r rrrrrdrrr#rkrqrOrrrTrTrTrUr s<D       $ "rc@seZdZdZ d5ddZddZddZd d Zd d Zd dZ ddZ e ddZ ddZ ddZddZddZd6ddZd6ddZd7d!d"Zd#d$Zd%d&Zd7d'd(Zd)d*Zd+d,Zd6d-d.Zd/d0Zd1d2Zd3d4Zd S)8ra Write-only stream wrapper that performs decompression. This type provides a writable stream that performs decompression and writes decompressed data to another stream. This type implements the ``io.RawIOBase`` interface. Only methods that involve writing will do useful things. Behavior is similar to :py:meth:`ZstdCompressor.stream_writer`: compressed data is sent to the decompressor by calling ``write(data)`` and decompressed output is written to the inner stream by calling its ``write(data)`` method: >>> dctx = zstandard.ZstdDecompressor() >>> decompressor = dctx.stream_writer(fh) >>> # Will call fh.write() with uncompressed data. >>> decompressor.write(compressed_data) Instances can be used as context managers. However, context managers add no extra special behavior other than automatically calling ``close()`` when they exit. Calling ``close()`` will mark the stream as closed and subsequent I/O operations will raise ``ValueError`` (per the documented behavior of ``io.RawIOBase``). ``close()`` will also call ``close()`` on the underlying stream if such a method exists and the instance was created with ``closefd=True``. The size of chunks to ``write()`` to the destination can be specified: >>> dctx = zstandard.ZstdDecompressor() >>> with dctx.stream_writer(fh, write_size=16384) as decompressor: >>> pass You can see how much memory is being used by the decompressor: >>> dctx = zstandard.ZstdDecompressor() >>> with dctx.stream_writer(fh) as decompressor: >>> byte_size = decompressor.memory_size() ``stream_writer()`` accepts a ``write_return_read`` boolean argument to control the return value of ``write()``. When ``True`` (the default)``, ``write()`` returns the number of bytes that were read from the input. When ``False``, ``write()`` returns the number of bytes that were ``write()`` to the inner stream. TcCsD|||_||_||_t||_t||_d|_d|_d|_ dSr) _ensure_dctxrrrrrrrrr)r[rrrrrrTrTrUr s   z ZstdDecompressionWriter.__init__cCrrrrZrTrTrUr s z!ZstdDecompressionWriter.__enter__cCsd|_|dSr)rrrrTrTrUr sz ZstdDecompressionWriter.__exit__cCrrgrrZrTrTrUr rz ZstdDecompressionWriter.__iter__cCrrgrrZrTrTrUr rz ZstdDecompressionWriter.__next__cCrrg)rLZSTD_sizeof_DCtxrrrZrTrTrUr rz#ZstdDecompressionWriter.memory_sizecCsb|jrdSzd|_|Wd|_d|_nd|_d|_wt|jdd}|jr-|r/|dSdSdSr)rrrrrrrrTrTrUr s   zZstdDecompressionWriter.closecCrrgr rZrTrTrUr  r_zZstdDecompressionWriter.closedcCrrrrrTrTrUr rzZstdDecompressionWriter.filenocCs4|jrtdt|jdd}|r|js|SdSdS)Nrr)rrSrrrrrTrTrUr s  zZstdDecompressionWriter.flushcCr rrTrZrTrTrUr  r zZstdDecompressionWriter.isattycCr rrTrZrTrTrUrr z ZstdDecompressionWriter.readablercCrrgrrrTrTrUrrz ZstdDecompressionWriter.readlinecCrrgrrrTrTrUrrz!ZstdDecompressionWriter.readlinesNcCrrgrrrTrTrUr rzZstdDecompressionWriter.seekcCr rrTrZrTrTrUrr z ZstdDecompressionWriter.seekablecCrrgrrZrTrTrUr5rzZstdDecompressionWriter.tellcCrrgrrrTrTrUrrz ZstdDecompressionWriter.truncatecCr rrTrZrTrTrUrr z ZstdDecompressionWriter.writablecCrrgrrrTrTrUrrz"ZstdDecompressionWriter.writelinescCrrgrrrTrTrUrrzZstdDecompressionWriter.readcCrrgrrZrTrTrUr  rzZstdDecompressionWriter.readallcCrrgrr!rTrTrUr##rz ZstdDecompressionWriter.readintoc Cs|jrtdd}td}td}t|}||_t||_d|_td|j }||_ t||_d|_|j j }|j|jkrtt |||}t |rStdt||jrn|jt|j |jdd||j7}d|_|j|jks?|jrz|jS|S)Nrrr$rrr)rrSrKrr&r'rrfrrrrrrLrrrrrrr*r+r) r[r,r-r/r0r.rjdctxrqrTrTrUr*&s<          zZstdDecompressionWriter.writer6r7rg)rarbrcrdrrrrrrrrer rrr rrrrrr5rrrrr r#r*rTrTrTrUr s86         rc@seZdZdZddefddZddZ   dd d Zedd fd d Z e dfddZ ee dfddZ e d d fddZ ee fddZddZ dddZdddZdS)ra Context for performing zstandard decompression. Each instance is essentially a wrapper around a ``ZSTD_DCtx`` from zstd's C API. An instance can compress data various ways. Instances can be used multiple times. The interface of this class is very similar to :py:class:`zstandard.ZstdCompressor` (by design). Assume that each ``ZstdDecompressor`` instance can only handle a single logical compression operation at the same time. i.e. if you call a method like ``decompressobj()`` to obtain multiple objects derived from the same ``ZstdDecompressor`` instance and attempt to use them simultaneously, errors will likely occur. If you need to perform multiple logical decompression operations and you can't guarantee those operations are temporally non-overlapping, you need to obtain multiple ``ZstdDecompressor`` instances. Unless specified otherwise, assume that no two methods of ``ZstdDecompressor`` instances can be called from multiple Python threads simultaneously. In other words, assume instances are not thread safe unless stated otherwise. :param dict_data: Compression dictionary to use. :param max_window_size: Sets an upper limit on the window size for decompression operations in kibibytes. This setting can be used to prevent large memory allocations for inputs using large compression windows. :param format: Set the format of data for the decoder. By default this is ``zstandard.FORMAT_ZSTD1``. It can be set to ``zstandard.FORMAT_ZSTD1_MAGICLESS`` to allow decoding frames without the 4 byte magic header. Not all decompression APIs support this mode. Nrc Csv||_||_||_t}|tjkrt||_z| Wtj |tj t |d|_dStj |tj t |d|_w)Nrt) rw_max_window_size_formatrLZSTD_createDCtxrKrtrurrrv ZSTD_freeDCtxr)r[rzmax_window_sizeryrrTrTrUrys   zZstdDecompressor.__init__cCr)zSize of decompression context, in bytes. >>> dctx = zstandard.ZstdDecompressor() >>> size = dctx.memory_size() )rLrrrZrTrTrUrrzZstdDecompressor.memory_sizeFTc CsV|rtd|t|}t|t|}|tjkr td|dkr&dS|tjkr<|s1tdt d|}|}d}nt d|}|}t d} || _ || _ d| _ t d} || _ t|| _ d| _ t|j| | } t| rwtd t| | r}td |r| j |krtd | |f|s| j | j kr| j | j } td | t|| j d d S)a Decompress data in a single operation. This method will decompress the input data in a single operation and return the decompressed data. The input bytes are expected to contain at least 1 full Zstandard frame (something compressed with :py:meth:`ZstdCompressor.compress` or similar). If the input does not contain a full frame, an exception will be raised. ``read_across_frames`` controls whether to read multiple zstandard frames in the input. When False, decompression stops after reading the first frame. This feature is not yet implemented but the argument is provided for forward API compatibility when the default is changed to True in a future release. For now, if you need to decompress multiple frames, use an API like :py:meth:`ZstdCompressor.stream_reader` with ``read_across_frames=True``. ``allow_extra_data`` controls how to handle extra input data after a fully decoded frame. If False, any extra data (which could be a valid zstd frame) will result in ``ZstdError`` being raised. If True, extra data is silently ignored. The default will likely change to False in a future release when ``read_across_frames`` defaults to True. If the input contains extra data after a full frame, that extra input data is silently ignored. This behavior is undesirable in many scenarios and will likely be changed or controllable in a future release (see #181). If the frame header of the compressed data does not contain the content size, ``max_output_size`` must be specified or ``ZstdError`` will be raised. An allocation of size ``max_output_size`` will be performed and an attempt will be made to perform decompression into that buffer. If the buffer is too small or cannot be allocated, ``ZstdError`` will be raised. The buffer will be resized if it is too large. Uncompressed data could be much larger than compressed data. As a result, calling this function could result in a very large memory allocation being performed to hold the uncompressed data. This could potentially result in ``MemoryError`` or system memory swapping. If you don't need the full output data in a single contiguous array in memory, consider using streaming decompression for more resilient memory behavior. Usage: >>> dctx = zstandard.ZstdDecompressor() >>> decompressed = dctx.decompress(data) If the compressed data doesn't have its content size embedded within it, decompression can be attempted by specifying the ``max_output_size`` argument: >>> dctx = zstandard.ZstdDecompressor() >>> uncompressed = dctx.decompress(data, max_output_size=1048576) Ideally, ``max_output_size`` will be identical to the decompressed output size. .. important:: If the exact size of decompressed data is unknown (not passed in explicitly and not stored in the zstd frame), for performance reasons it is encouraged to use a streaming API. :param data: Compressed data to decompress. :param max_output_size: Integer max size of response. If ``0``, there is no limit and we can attempt to allocate an output buffer of infinite size. :return: ``bytes`` representing decompressed output. z?ZstdDecompressor.read_across_frames=True is not yet implementedz0error determining content size from frame headerrr:z0could not determine content size in frame headerrrr$zdecompression error: %sz2decompression error: did not decompress full framez7decompression error: decompressed %d bytes; expected %dzFcompressed input contains %d bytes of unused data, which is disallowedN)rrrKr&rLrrrrrrrfrr'rrrrrr+) r[r,max_output_sizerallow_extra_datar. output_size result_buffer result_sizer0r/rqcountrTrTrUrshS          zZstdDecompressor.decompresscCs|t|||||dS)a\ Read-only stream wrapper that performs decompression. This method obtains an object that conforms to the ``io.RawIOBase`` interface and performs transparent decompression via ``read()`` operations. Source data is obtained by calling ``read()`` on a source stream or object implementing the buffer protocol. See :py:class:`zstandard.ZstdDecompressionReader` for more documentation and usage examples. :param source: Source of compressed data to decompress. Can be any object with a ``read(size)`` method or that conforms to the buffer protocol. :param read_size: Integer number of bytes to read from the source and feed into the compressor at a time. :param read_across_frames: Whether to read data across multiple zstd frames. If False, decompression is stopped at frame boundaries. :param closefd: Whether to close the source stream when this instance is closed. :return: :py:class:`zstandard.ZstdDecompressionReader`. r)rr)r[r=rMrrrTrTrUr&s  zZstdDecompressor.stream_readercCs&|dkrtd|t|||dS)aObtain a standard library compatible incremental decompressor. See :py:class:`ZstdDecompressionObj` for more documentation and usage examples. :param write_size: size of internal output buffer to collect decompressed chunks in. :param read_across_frames: whether to read across multiple zstd frames. If False, reading stops after 1 frame and subsequent decompress attempts will raise an exception. :return: :py:class:`zstandard.ZstdDecompressionObj` rJzwrite_size must be positive)rr)rSrr)r[rrrTrTrU decompressobjKs zZstdDecompressor.decompressobjccs||kr tdt|drd}nt|drd}d}t|}ntd|r7|r-||n ||kr5td|}|td }td } td |} | | _t| | _d| _ | j dks^J|rf||} n||} t | |} |||| } || 7}| sd St | }||_ t||_d|_ |j |jkr| j dksJt |j| |}t |rtd t|| j rt| j| j d d }d| _ |V|dkrd S|j |jksqV)a# Read compressed data to an iterator of uncompressed chunks. This method will read data from ``reader``, feed it to a decompressor, and emit ``bytes`` chunks representing the decompressed result. >>> dctx = zstandard.ZstdDecompressor() >>> for chunk in dctx.read_to_iter(fh): ... # Do something with original data. ``read_to_iter()`` accepts an object with a ``read(size)`` method that will return compressed bytes or an object conforming to the buffer protocol. ``read_to_iter()`` returns an iterator whose elements are chunks of the decompressed data. The size of requested ``read()`` from the source can be specified: >>> dctx = zstandard.ZstdDecompressor() >>> for chunk in dctx.read_to_iter(fh, read_size=16384): ... pass It is also possible to skip leading bytes in the input data: >>> dctx = zstandard.ZstdDecompressor() >>> for chunk in dctx.read_to_iter(fh, skip_bytes=1): ... pass .. tip:: Skipping leading bytes is useful if the source data contains extra *header* data. Traditionally, you would need to create a slice or ``memoryview`` of the data you want to decompress. This would create overhead. It is more efficient to pass the offset into this API. Similarly to :py:meth:`ZstdCompressor.read_to_iter`, the consumer of the iterator controls when data is decompressed. If the iterator isn't consumed, decompression is put on hold. When ``read_to_iter()`` is passed an object conforming to the buffer protocol, the behavior may seem similar to what occurs when the simple decompression API is used. However, this API works when the decompressed size is unknown. Furthermore, if feeding large inputs, the decompressor will work in chunks instead of performing a single operation. :param reader: Source of compressed data. Can be any object with a ``read(size)`` method or any object conforming to the buffer protocol. :param read_size: Integer size of data chunks to read from ``reader`` and feed into the decompressor. :param write_size: Integer size of data chunks to emit from iterator. :param skip_bytes: Integer number of bytes to skip over before sending data into the decompressor. :return: Iterator of ``bytes`` representing uncompressed data. z)skip_bytes must be smaller than read_sizerTrkFrrz(skip_bytes larger than first input chunkr$rrrN)rSrcrrrrKrrrfrrr&r'rLrrrrrrr+)r[rrMr skip_bytesrrrfr/r0rjrrrrrqr,rTrTrUrespD                zZstdDecompressor.read_to_itercCs$t|ds tdt|||||dS)a Push-based stream wrapper that performs decompression. This method constructs a stream wrapper that conforms to the ``io.RawIOBase`` interface and performs transparent decompression when writing to a wrapper stream. See :py:class:`zstandard.ZstdDecompressionWriter` for more documentation and usage examples. :param writer: Destination for decompressed output. Can be any object with a ``write(data)``. :param write_size: Integer size of chunks to ``write()`` to ``writer``. :param write_return_read: Whether ``write()`` should return the number of bytes of input consumed. If False, ``write()`` returns the number of bytes sent to the inner stream. :param closefd: Whether to ``close()`` the inner stream when this stream is closed. :return: :py:class:`zstandard.ZstdDecompressionWriter` r*rr)rcrSr)r[rrrrrTrTrUrs zZstdDecompressor.stream_writerc Cst|ds tdt|dstd|td}td}td|}||_||_d|_d \}} ||} | s@ || fSt | } |t | 7}| |_ t | |_d|_|j|jkrt |j||} t | rqtd t| |jr|t|j|j| |j7} d|_|j|jks\q4) a4 Copy data between streams, decompressing in the process. Compressed data will be read from ``ifh``, decompressed, and written to ``ofh``. >>> dctx = zstandard.ZstdDecompressor() >>> dctx.copy_stream(ifh, ofh) e.g. to decompress a file to another file: >>> dctx = zstandard.ZstdDecompressor() >>> with open(input_path, 'rb') as ifh, open(output_path, 'wb') as ofh: ... dctx.copy_stream(ifh, ofh) The size of chunks being ``read()`` and ``write()`` from and to the streams can be specified: >>> dctx = zstandard.ZstdDecompressor() >>> dctx.copy_stream(ifh, ofh, read_size=8192, write_size=16384) :param ifh: Source stream to read compressed data from. Must have a ``read()`` method. :param ofh: Destination stream to write uncompressed data to. Must have a ``write()`` method. :param read_size: The number of bytes to ``read()`` from the source in a single operation. :param write_size: The number of bytes to ``write()`` to the destination in a single operation. :return: 2-tuple of integers representing the number of bytes read and written, respectively. rrr*rr$rrrrTr)rcrSrrKrrrfrrr&rr'rLrrrrrrr*r+) r[rrrMrr/r0rjrr-r,r.rqrTrTrUr#sH /            zZstdDecompressor.copy_streamc Csvt|ts td|std|d}t|tstdt|}td}t ||t |}t |r8td|r>td|j tj krHtd|jd d td |j }td }||_t ||_d|_td }||_t ||_d|_t|j||}t |rtdt||rtdt |dkrt|t |ddSd} | t |kr/|| }t|tstd| t|}t ||t |}t |rtd| |rtd| |j tj krtd| td |j } | |_t | |_d|_||_t ||_d|_t|j||}t |rtdt||r#td| | }| d7} | t |kst|t |ddS)aW Decompress a series of frames using the content dictionary chaining technique. Such a list of frames is produced by compressing discrete inputs where each non-initial input is compressed with a *prefix* dictionary consisting of the content of the previous input. For example, say you have the following inputs: >>> inputs = [b"input 1", b"input 2", b"input 3"] The zstd frame chain consists of: 1. ``b"input 1"`` compressed in standalone/discrete mode 2. ``b"input 2"`` compressed using ``b"input 1"`` as a *prefix* dictionary 3. ``b"input 3"`` compressed using ``b"input 2"`` as a *prefix* dictionary Each zstd frame **must** have the content size written. The following Python code can be used to produce a *prefix dictionary chain*: >>> def make_chain(inputs): ... frames = [] ... ... # First frame is compressed in standalone/discrete mode. ... zctx = zstandard.ZstdCompressor() ... frames.append(zctx.compress(inputs[0])) ... ... # Subsequent frames use the previous fulltext as a prefix dictionary ... for i, raw in enumerate(inputs[1:]): ... dict_data = zstandard.ZstdCompressionDict( ... inputs[i], dict_type=zstandard.DICT_TYPE_RAWCONTENT) ... zctx = zstandard.ZstdCompressor(dict_data=dict_data) ... frames.append(zctx.compress(raw)) ... ... return frames ``decompress_content_dict_chain()`` returns the uncompressed data of the last element in the input chain. .. note:: It is possible to implement *prefix dictionary chain* decompression on top of other APIs. However, this function will likely be faster - especially for long input chains - as it avoids the overhead of instantiating and passing around intermediate objects between multiple functions. :param frames: List of ``bytes`` holding compressed zstd frames. :return: zargument must be a listzempty input chainrzchunk 0 must be bytesrz!chunk 0 is not a valid zstd framez,chunk 0 is too small to contain a zstd framez%chunk 0 missing content size in frameF) load_dictrrr$z could not decompress chunk 0: %sz%chunk 0 did not decompress full framerJNzchunk %d must be bytesz"chunk %d is not a valid zstd framez-chunk %d is too small to contain a zstd framez&chunk %d missing content size in framez!could not decompress chunk %d: %sz&chunk %d did not decompress full frame)rrrrSrrKr&rrLrrrrrrrrfrr'rrrrrr+) r[framesr` chunk_bufferrrq last_bufferr0r/rjrprTrTrUdecompress_content_dict_chains 5                            *z.ZstdDecompressor.decompress_content_dict_chaincCrW)aK Decompress multiple zstd frames to output buffers as a single operation. (Experimental. Not available in CFFI backend.) Compressed frames can be passed to the function as a ``BufferWithSegments``, a ``BufferWithSegmentsCollection``, or as a list containing objects that conform to the buffer protocol. For best performance, pass a ``BufferWithSegmentsCollection`` or a ``BufferWithSegments``, as minimal input validation will be done for that type. If calling from Python (as opposed to C), constructing one of these instances may add overhead cancelling out the performance overhead of validation for list inputs. Returns a ``BufferWithSegmentsCollection`` containing the decompressed data. All decompressed data is allocated in a single memory buffer. The ``BufferWithSegments`` instance tracks which objects are at which offsets and their respective lengths. >>> dctx = zstandard.ZstdDecompressor() >>> results = dctx.multi_decompress_to_buffer([b'...', b'...']) The decompressed size of each frame MUST be discoverable. It can either be embedded within the zstd frame or passed in via the ``decompressed_sizes`` argument. The ``decompressed_sizes`` argument is an object conforming to the buffer protocol which holds an array of 64-bit unsigned integers in the machine's native format defining the decompressed sizes of each frame. If this argument is passed, it avoids having to scan each frame for its decompressed size. This frame scanning can add noticeable overhead in some scenarios. >>> frames = [...] >>> sizes = struct.pack('=QQQQ', len0, len1, len2, len3) >>> >>> dctx = zstandard.ZstdDecompressor() >>> results = dctx.multi_decompress_to_buffer(frames, decompressed_sizes=sizes) .. note:: It is possible to pass a ``mmap.mmap()`` instance into this function by wrapping it with a ``BufferWithSegments`` instance (which will define the offsets of frames within the memory mapped region). This function is logically equivalent to performing :py:meth:`ZstdCompressor.decompress` on each input frame and returning the result. This function exists to perform decompression on multiple frames as fast as possible by having as little overhead as possible. Since decompression is performed as a single operation and since the decompressed output is stored in a single buffer, extra memory allocations, Python objects, and Python function calls are avoided. This is ideal for scenarios where callers know up front that they need to access data for multiple frames, such as when *delta chains* are being used. Currently, the implementation always spawns multiple threads when requested, even if the amount of work to do is small. In the future, it will be smarter about avoiding threads and their associated overhead when the amount of work to do is small. :param frames: Source defining zstd frames to decompress. :param decompressed_sizes: Array of integers representing sizes of decompressed zstd frames. :param threads: How many threads to use for decompression operations. Negative values will use the same number of threads as logical CPUs on the machine. Values ``0`` or ``1`` use a single thread. :return: ``BufferWithSegmentsCollection`` rX)r[rdecompressed_sizesrrTrTrUmulti_decompress_to_buffersLz+ZstdDecompressor.multi_decompress_to_buffercCst|jtj|jr t|j|j}t|r tdt|t |jtj |j }t|r7tdt||j rR|rTt |j|j j}t|rVtdt|dSdSdS)Nz!unable to set max window size: %sz!unable to set decoding format: %sz+unable to reference prepared dictionary: %s)rLZSTD_DCtx_resetrrrZSTD_DCtx_setMaxWindowSizerrrrZSTD_DCtx_setParameter ZSTD_d_formatrrwZSTD_DCtx_refDDictr)r[rrqrTrTrUres4       zZstdDecompressor._ensure_dctx)rFT)Nrr6)rarbrcrdrHrrrr&rr'rrrrrrrrTrTrTrUrOsB)   '   . _ Nr) rrrrrrrrrr)rd __future__rr__all__rrO_cffirKrLsetrZSTD_CStreamInSizer$ZSTD_CStreamOutSizer%ZSTD_DStreamInSizer&ZSTD_DStreamOutSizer' new_allocatorrrur#ZSTD_MAGICNUMBERr(r rr!rr"ZSTD_VERSION_MAJORZSTD_VERSION_MINORZSTD_VERSION_RELEASErZSTD_BLOCKSIZELOG_MAXr)ZSTD_BLOCKSIZE_MAXr*ZSTD_WINDOWLOG_MINr+ZSTD_WINDOWLOG_MAXr,ZSTD_CHAINLOG_MINr-ZSTD_CHAINLOG_MAXr.ZSTD_HASHLOG_MINr/ZSTD_HASHLOG_MAXr0ZSTD_MINMATCH_MINr1ZSTD_MINMATCH_MAXr2ZSTD_SEARCHLOG_MINr3ZSTD_SEARCHLOG_MAXr4r5r6ZSTD_TARGETLENGTH_MINr7ZSTD_TARGETLENGTH_MAXr8ZSTD_LDM_MINMATCH_MINr9ZSTD_LDM_MINMATCH_MAXr:ZSTD_LDM_BUCKETSIZELOG_MAXr; ZSTD_fastr< ZSTD_dfastr= ZSTD_greedyr> ZSTD_lazyr? ZSTD_lazy2r@ ZSTD_btlazy2rA ZSTD_btoptrB ZSTD_btultrarC ZSTD_btultra2rD ZSTD_dct_autorEZSTD_dct_rawContentrFZSTD_dct_fullDictrG ZSTD_f_zstd1rHZSTD_f_zstd1_magiclessrIrrrrrVrrrrrrrrrobjectr rrrr r rr rrrrrr rrrrrrTrTrTrUsJ  6%   U45%w1  Q