1- /*
2- Low level interface to Meta's zstd library for use in the compression.zstd
3- Python module.
4- */
1+ /* Low level interface to the Zstandard algorthm & the zstd library. */
52
63#ifndef Py_BUILD_CORE_BUILTIN
74# define Py_BUILD_CORE_MODULE 1
@@ -34,17 +31,17 @@ set_zstd_error(const _zstd_state* const state,
3431switch (type )
3532 {
3633case ERR_DECOMPRESS :
37- msg = "Unable to decompresszstd data: %s" ;
34+ msg = "Unable to decompressZstandard data: %s" ;
3835break ;
3936case ERR_COMPRESS :
40- msg = "Unable to compresszstd data: %s" ;
37+ msg = "Unable to compressZstandard data: %s" ;
4138break ;
4239
4340case ERR_LOAD_D_DICT :
44- msg = "Unable to loadzstd dictionary or prefix for decompression: %s" ;
41+ msg = "Unable to loadZstandard dictionary or prefix for decompression: %s" ;
4542break ;
4643case ERR_LOAD_C_DICT :
47- msg = "Unable to loadzstd dictionary or prefix for compression: %s" ;
44+ msg = "Unable to loadZstandard dictionary or prefix for compression: %s" ;
4845break ;
4946
5047case ERR_GET_C_BOUNDS :
@@ -58,10 +55,10 @@ set_zstd_error(const _zstd_state* const state,
5855break ;
5956
6057case ERR_TRAIN_DICT :
61- msg = "Unable to trainzstd dictionary: %s" ;
58+ msg = "Unable to trainthe Zstandard dictionary: %s" ;
6259break ;
6360case ERR_FINALIZE_DICT :
64- msg = "Unable to finalizezstd dictionary: %s" ;
61+ msg = "Unable to finalizethe Zstandard dictionary: %s" ;
6562break ;
6663
6764default :
@@ -152,7 +149,7 @@ set_parameter_error(const _zstd_state* const state, int is_compress,
152149 }
153150if (ZSTD_isError (bounds .error )) {
154151PyErr_Format (state -> ZstdError ,
155- "Zstd %s parameter \"%s\" is invalid ." ,
152+ "Invalid zstd %s parameter \"%s\"." ,
156153type ,name );
157154return ;
158155 }
@@ -187,13 +184,13 @@ _zstd.train_dict
187184 The size of the dictionary.
188185 /
189186
190- Internal function, train a zstd dictionary on sample data.
187+ Train a Zstandard dictionary on sample data.
191188[clinic start generated code]*/
192189
193190static PyObject *
194191_zstd_train_dict_impl (PyObject * module ,PyBytesObject * samples_bytes ,
195192PyObject * samples_sizes ,Py_ssize_t dict_size )
196- /*[clinic end generated code: output=8e87fe43935e8f77 input=70fcd8937f2528b6 ]*/
193+ /*[clinic end generated code: output=8e87fe43935e8f77 input=d20dedb21c72cb62 ]*/
197194{
198195// TODO(emmatyping): The preamble and suffix to this function and _finalize_dict
199196// are pretty similar. We should see if we can refactor them to share that code.
@@ -258,7 +255,7 @@ _zstd_train_dict_impl(PyObject *module, PyBytesObject *samples_bytes,
258255chunk_sizes , (uint32_t )chunks_number );
259256Py_END_ALLOW_THREADS
260257
261- /* Checkzstd dict error */
258+ /* CheckZstandard dict error */
262259if (ZDICT_isError (zstd_ret )) {
263260_zstd_state * const mod_state = get_zstd_state (module );
264261set_zstd_error (mod_state ,ERR_TRAIN_DICT ,zstd_ret );
@@ -292,18 +289,18 @@ _zstd.finalize_dict
292289 dict_size: Py_ssize_t
293290 The size of the dictionary.
294291 compression_level: int
295- Optimize for a specificzstd compression level, 0 means default.
292+ Optimize for a specificZstandard compression level, 0 means default.
296293 /
297294
298- Internal function, finalize a zstd dictionary.
295+ Finalize a Zstandard dictionary.
299296[clinic start generated code]*/
300297
301298static PyObject *
302299_zstd_finalize_dict_impl (PyObject * module ,PyBytesObject * custom_dict_bytes ,
303300PyBytesObject * samples_bytes ,
304301PyObject * samples_sizes ,Py_ssize_t dict_size ,
305302int compression_level )
306- /*[clinic end generated code: output=f91821ba5ae85bda input=130d1508adb55ba1 ]*/
303+ /*[clinic end generated code: output=f91821ba5ae85bda input=3c7e2480aa08fb56 ]*/
307304{
308305Py_ssize_t chunks_number ;
309306size_t * chunk_sizes = NULL ;
@@ -360,7 +357,7 @@ _zstd_finalize_dict_impl(PyObject *module, PyBytesObject *custom_dict_bytes,
360357
361358/* Parameters */
362359
363- /* Optimize for a specificzstd compression level, 0 means default. */
360+ /* Optimize for a specificZstandard compression level, 0 means default. */
364361params .compressionLevel = compression_level ;
365362/* Write log to stderr, 0 = none. */
366363params .notificationLevel = 0 ;
@@ -376,7 +373,7 @@ _zstd_finalize_dict_impl(PyObject *module, PyBytesObject *custom_dict_bytes,
376373 (uint32_t )chunks_number ,params );
377374Py_END_ALLOW_THREADS
378375
379- /* Checkzstd dict error */
376+ /* CheckZstandard dict error */
380377if (ZDICT_isError (zstd_ret )) {
381378_zstd_state * const mod_state = get_zstd_state (module );
382379set_zstd_error (mod_state ,ERR_FINALIZE_DICT ,zstd_ret );
@@ -407,12 +404,12 @@ _zstd.get_param_bounds
407404 is_compress: bool
408405 True for CompressionParameter, False for DecompressionParameter.
409406
410- Internal function, get CompressionParameter/DecompressionParameter bounds.
407+ Get CompressionParameter/DecompressionParameter bounds.
411408[clinic start generated code]*/
412409
413410static PyObject *
414411_zstd_get_param_bounds_impl (PyObject * module ,int parameter ,int is_compress )
415- /*[clinic end generated code: output=4acf5a876f0620ca input=84e669591e487008 ]*/
412+ /*[clinic end generated code: output=4acf5a876f0620ca input=45742ef0a3531b65 ]*/
416413{
417414ZSTD_bounds bound ;
418415if (is_compress ) {
@@ -442,24 +439,22 @@ _zstd.get_frame_size
442439 A bytes-like object, it should start from the beginning of a frame,
443440 and contains at least one complete frame.
444441
445- Get the size of a zstd frame, including frame header and 4-byte checksum if it has one.
446-
447- It will iterate all blocks' headers within a frame, to accumulate the frame size.
442+ Get the size of a Zstandard frame, including the header and optional checksum.
448443[clinic start generated code]*/
449444
450445static PyObject *
451446_zstd_get_frame_size_impl (PyObject * module ,Py_buffer * frame_buffer )
452- /*[clinic end generated code: output=a7384c2f8780f442 input=7d3ad24311893bf3 ]*/
447+ /*[clinic end generated code: output=a7384c2f8780f442 input=3b9f73f8c8129d38 ]*/
453448{
454449size_t frame_size ;
455450
456451frame_size = ZSTD_findFrameCompressedSize (frame_buffer -> buf ,frame_buffer -> len );
457452if (ZSTD_isError (frame_size )) {
458453_zstd_state * const mod_state = get_zstd_state (module );
459454PyErr_Format (mod_state -> ZstdError ,
460- "Error when finding the compressed size of azstd frame. "
461- "Make sure the frame_buffer argument starts from the "
462- "beginning of a frame, and its length not less than this "
455+ "Error when finding the compressed size of aZstandard frame. "
456+ "Ensure the frame_buffer argument starts from the "
457+ "beginning of a frame, and its lengthis not less than this "
463458"complete frame. Zstd error message: %s." ,
464459ZSTD_getErrorName (frame_size ));
465460return NULL ;
@@ -472,14 +467,14 @@ _zstd_get_frame_size_impl(PyObject *module, Py_buffer *frame_buffer)
472467_zstd.get_frame_info
473468
474469 frame_buffer: Py_buffer
475- A bytes-like object, containing the header of azstd frame.
470+ A bytes-like object, containing the header of aZstandard frame.
476471
477- Internal function, get zstd frame infomation from a frame header.
472+ Get Zstandard frame infomation from a frame header.
478473[clinic start generated code]*/
479474
480475static PyObject *
481476_zstd_get_frame_info_impl (PyObject * module ,Py_buffer * frame_buffer )
482- /*[clinic end generated code: output=56e033cf48001929 input=1816f14656b6aa22 ]*/
477+ /*[clinic end generated code: output=56e033cf48001929 input=94b240583ae22ca5 ]*/
483478{
484479uint64_t decompressed_size ;
485480uint32_t dict_id ;
@@ -494,9 +489,9 @@ _zstd_get_frame_info_impl(PyObject *module, Py_buffer *frame_buffer)
494489_zstd_state * const mod_state = get_zstd_state (module );
495490PyErr_SetString (mod_state -> ZstdError ,
496491"Error when getting information from the header of "
497- "azstd frame.Make sure the frame_buffer argument "
492+ "aZstandard frame.Ensure the frame_buffer argument "
498493"starts from the beginning of a frame, and its length "
499- "not less than the frame header (6~18 bytes)." );
494+ "is not less than the frame header (6~18 bytes)." );
500495return NULL ;
501496 }
502497
@@ -518,13 +513,13 @@ _zstd.set_parameter_types
518513 d_parameter_type: object(subclass_of='&PyType_Type')
519514 DecompressionParameter IntEnum type object
520515
521- Internal function, set CompressionParameter/ DecompressionParameter types for validity check.
516+ Set CompressionParameter and DecompressionParameter types for validity check.
522517[clinic start generated code]*/
523518
524519static PyObject *
525520_zstd_set_parameter_types_impl (PyObject * module ,PyObject * c_parameter_type ,
526521PyObject * d_parameter_type )
527- /*[clinic end generated code: output=f3313b1294f19502 input=30402523871b8280 ]*/
522+ /*[clinic end generated code: output=f3313b1294f19502 input=75d7a953580fae5f ]*/
528523{
529524_zstd_state * const mod_state = get_zstd_state (module );
530525