_lzmamodule.c.h 8.61 KB
Newer Older
1
/*[clinic input]
2
preserve
3 4
[clinic start generated code]*/

5
PyDoc_STRVAR(_lzma_LZMACompressor_compress__doc__,
6 7 8
"compress($self, data, /)\n"
"--\n"
"\n"
9 10 11 12 13 14
"Provide data to the compressor object.\n"
"\n"
"Returns a chunk of compressed data if possible, or b\'\' otherwise.\n"
"\n"
"When you have finished providing data to the compressor, call the\n"
"flush() method to finish the compression process.");
15

16
#define _LZMA_LZMACOMPRESSOR_COMPRESS_METHODDEF    \
17
    {"compress", (PyCFunction)_lzma_LZMACompressor_compress, METH_O, _lzma_LZMACompressor_compress__doc__},
18

19 20
static PyObject *
_lzma_LZMACompressor_compress_impl(Compressor *self, Py_buffer *data);
21 22

static PyObject *
23
_lzma_LZMACompressor_compress(Compressor *self, PyObject *arg)
24
{
25 26
    PyObject *return_value = NULL;
    Py_buffer data = {NULL, NULL};
27

28
    if (!PyArg_Parse(arg, "y*:compress", &data)) {
29
        goto exit;
30
    }
31
    return_value = _lzma_LZMACompressor_compress_impl(self, &data);
32

33 34
exit:
    /* Cleanup for data */
35
    if (data.obj) {
36
       PyBuffer_Release(&data);
37
    }
38

39
    return return_value;
40 41
}

42
PyDoc_STRVAR(_lzma_LZMACompressor_flush__doc__,
43 44 45
"flush($self, /)\n"
"--\n"
"\n"
46 47 48 49 50
"Finish the compression process.\n"
"\n"
"Returns the compressed data left in internal buffers.\n"
"\n"
"The compressor object may not be used after this method is called.");
51

52 53
#define _LZMA_LZMACOMPRESSOR_FLUSH_METHODDEF    \
    {"flush", (PyCFunction)_lzma_LZMACompressor_flush, METH_NOARGS, _lzma_LZMACompressor_flush__doc__},
54

55 56
static PyObject *
_lzma_LZMACompressor_flush_impl(Compressor *self);
57 58

static PyObject *
59
_lzma_LZMACompressor_flush(Compressor *self, PyObject *Py_UNUSED(ignored))
60
{
61
    return _lzma_LZMACompressor_flush_impl(self);
62 63
}

64
PyDoc_STRVAR(_lzma_LZMADecompressor_decompress__doc__,
65
"decompress($self, /, data, max_length=-1)\n"
66 67
"--\n"
"\n"
68
"Decompress *data*, returning uncompressed data as bytes.\n"
69
"\n"
70 71 72 73
"If *max_length* is nonnegative, returns at most *max_length* bytes of\n"
"decompressed data. If this limit is reached and further output can be\n"
"produced, *self.needs_input* will be set to ``False``. In this case, the next\n"
"call to *decompress()* may provide *data* as b\'\' to obtain more of the output.\n"
74
"\n"
75 76 77 78 79 80 81
"If all of the input data was decompressed and returned (either because this\n"
"was less than *max_length* bytes, or because *max_length* was negative),\n"
"*self.needs_input* will be set to True.\n"
"\n"
"Attempting to decompress data after the end of stream is reached raises an\n"
"EOFError.  Any data found after the end of the stream is ignored and saved in\n"
"the unused_data attribute.");
82

83
#define _LZMA_LZMADECOMPRESSOR_DECOMPRESS_METHODDEF    \
84
    {"decompress", (PyCFunction)_lzma_LZMADecompressor_decompress, METH_FASTCALL, _lzma_LZMADecompressor_decompress__doc__},
85 86

static PyObject *
87 88
_lzma_LZMADecompressor_decompress_impl(Decompressor *self, Py_buffer *data,
                                       Py_ssize_t max_length);
89

90
static PyObject *
91
_lzma_LZMADecompressor_decompress(Decompressor *self, PyObject **args, Py_ssize_t nargs, PyObject *kwnames)
92
{
93
    PyObject *return_value = NULL;
94 95
    static const char * const _keywords[] = {"data", "max_length", NULL};
    static _PyArg_Parser _parser = {"y*|n:decompress", _keywords, 0};
96
    Py_buffer data = {NULL, NULL};
97
    Py_ssize_t max_length = -1;
98

99
    if (!_PyArg_ParseStackAndKeywords(args, nargs, kwnames, &_parser,
100
        &data, &max_length)) {
101
        goto exit;
102
    }
103
    return_value = _lzma_LZMADecompressor_decompress_impl(self, &data, max_length);
104

105 106
exit:
    /* Cleanup for data */
107
    if (data.obj) {
108
       PyBuffer_Release(&data);
109
    }
110

111
    return return_value;
112 113
}

114
PyDoc_STRVAR(_lzma_LZMADecompressor___init____doc__,
115 116 117
"LZMADecompressor(format=FORMAT_AUTO, memlimit=None, filters=None)\n"
"--\n"
"\n"
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
"Create a decompressor object for decompressing data incrementally.\n"
"\n"
"  format\n"
"    Specifies the container format of the input stream.  If this is\n"
"    FORMAT_AUTO (the default), the decompressor will automatically detect\n"
"    whether the input is FORMAT_XZ or FORMAT_ALONE.  Streams created with\n"
"    FORMAT_RAW cannot be autodetected.\n"
"  memlimit\n"
"    Limit the amount of memory used by the decompressor.  This will cause\n"
"    decompression to fail if the input cannot be decompressed within the\n"
"    given limit.\n"
"  filters\n"
"    A custom filter chain.  This argument is required for FORMAT_RAW, and\n"
"    not accepted with any other format.  When provided, this should be a\n"
"    sequence of dicts, each indicating the ID and options for a single\n"
"    filter.\n"
"\n"
"For one-shot decompression, use the decompress() function instead.");
136 137

static int
138 139
_lzma_LZMADecompressor___init___impl(Decompressor *self, int format,
                                     PyObject *memlimit, PyObject *filters);
140

141
static int
142
_lzma_LZMADecompressor___init__(PyObject *self, PyObject *args, PyObject *kwargs)
143
{
144
    int return_value = -1;
145 146
    static const char * const _keywords[] = {"format", "memlimit", "filters", NULL};
    static _PyArg_Parser _parser = {"|iOO:LZMADecompressor", _keywords, 0};
147 148 149
    int format = FORMAT_AUTO;
    PyObject *memlimit = Py_None;
    PyObject *filters = Py_None;
150

151
    if (!_PyArg_ParseTupleAndKeywordsFast(args, kwargs, &_parser,
152
        &format, &memlimit, &filters)) {
153
        goto exit;
154
    }
155
    return_value = _lzma_LZMADecompressor___init___impl((Decompressor *)self, format, memlimit, filters);
156

157 158
exit:
    return return_value;
159 160
}

161
PyDoc_STRVAR(_lzma_is_check_supported__doc__,
162 163 164
"is_check_supported($module, check_id, /)\n"
"--\n"
"\n"
165
"Test whether the given integrity check is supported.\n"
166
"\n"
167
"Always returns True for CHECK_NONE and CHECK_CRC32.");
168

169
#define _LZMA_IS_CHECK_SUPPORTED_METHODDEF    \
170
    {"is_check_supported", (PyCFunction)_lzma_is_check_supported, METH_O, _lzma_is_check_supported__doc__},
171 172

static PyObject *
173
_lzma_is_check_supported_impl(PyObject *module, int check_id);
174

175
static PyObject *
176
_lzma_is_check_supported(PyObject *module, PyObject *arg)
177
{
178 179
    PyObject *return_value = NULL;
    int check_id;
180

181
    if (!PyArg_Parse(arg, "i:is_check_supported", &check_id)) {
182
        goto exit;
183
    }
184
    return_value = _lzma_is_check_supported_impl(module, check_id);
185

186 187
exit:
    return return_value;
188 189
}

190
PyDoc_STRVAR(_lzma__encode_filter_properties__doc__,
191 192 193
"_encode_filter_properties($module, filter, /)\n"
"--\n"
"\n"
194 195 196
"Return a bytes object encoding the options (properties) of the filter specified by *filter* (a dict).\n"
"\n"
"The result does not include the filter ID itself, only the options.");
197

198
#define _LZMA__ENCODE_FILTER_PROPERTIES_METHODDEF    \
199
    {"_encode_filter_properties", (PyCFunction)_lzma__encode_filter_properties, METH_O, _lzma__encode_filter_properties__doc__},
200

201
static PyObject *
202
_lzma__encode_filter_properties_impl(PyObject *module, lzma_filter filter);
203 204

static PyObject *
205
_lzma__encode_filter_properties(PyObject *module, PyObject *arg)
206
{
207 208
    PyObject *return_value = NULL;
    lzma_filter filter = {LZMA_VLI_UNKNOWN, NULL};
209

210
    if (!PyArg_Parse(arg, "O&:_encode_filter_properties", lzma_filter_converter, &filter)) {
211
        goto exit;
212
    }
213
    return_value = _lzma__encode_filter_properties_impl(module, filter);
214

215 216 217 218
exit:
    /* Cleanup for filter */
    if (filter.id != LZMA_VLI_UNKNOWN)
       PyMem_Free(filter.options);
219

220
    return return_value;
221 222
}

223
PyDoc_STRVAR(_lzma__decode_filter_properties__doc__,
224 225 226
"_decode_filter_properties($module, filter_id, encoded_props, /)\n"
"--\n"
"\n"
227 228 229
"Return a bytes object encoding the options (properties) of the filter specified by *filter* (a dict).\n"
"\n"
"The result does not include the filter ID itself, only the options.");
230

231
#define _LZMA__DECODE_FILTER_PROPERTIES_METHODDEF    \
232
    {"_decode_filter_properties", (PyCFunction)_lzma__decode_filter_properties, METH_FASTCALL, _lzma__decode_filter_properties__doc__},
233 234

static PyObject *
235
_lzma__decode_filter_properties_impl(PyObject *module, lzma_vli filter_id,
236
                                     Py_buffer *encoded_props);
237

238
static PyObject *
239
_lzma__decode_filter_properties(PyObject *module, PyObject **args, Py_ssize_t nargs, PyObject *kwnames)
240
{
241 242 243
    PyObject *return_value = NULL;
    lzma_vli filter_id;
    Py_buffer encoded_props = {NULL, NULL};
244

245
    if (!_PyArg_ParseStack(args, nargs, "O&y*:_decode_filter_properties",
246
        lzma_vli_converter, &filter_id, &encoded_props)) {
247
        goto exit;
248
    }
249 250 251 252

    if (!_PyArg_NoStackKeywords("_decode_filter_properties", kwnames)) {
        goto exit;
    }
253
    return_value = _lzma__decode_filter_properties_impl(module, filter_id, &encoded_props);
254

255 256
exit:
    /* Cleanup for encoded_props */
257
    if (encoded_props.obj) {
258
       PyBuffer_Release(&encoded_props);
259
    }
260

261
    return return_value;
262
}
263
/*[clinic end generated code: output=5f7a915fb7e41453 input=a9049054013a1b77]*/