Rename lzma.check_is_supported() to is_check_supported() to avoid grammatical confusion.

This commit is contained in:
Nadeem Vawda 2012-05-06 23:01:51 +02:00
parent f55b329edc
commit bc459bb484
4 changed files with 12 additions and 12 deletions

View File

@ -225,7 +225,7 @@ Compressing and decompressing data in memory
Miscellaneous
-------------
.. function:: check_is_supported(check)
.. function:: is_check_supported(check)
Returns true if the given integrity check is supported on this system.

View File

@ -18,7 +18,7 @@ __all__ = [
"MODE_FAST", "MODE_NORMAL", "PRESET_DEFAULT", "PRESET_EXTREME",
"LZMACompressor", "LZMADecompressor", "LZMAFile", "LZMAError",
"compress", "decompress", "check_is_supported",
"compress", "decompress", "is_check_supported",
"encode_filter_properties", "decode_filter_properties",
]

View File

@ -935,14 +935,14 @@ class MiscellaneousTestCase(unittest.TestCase):
def test_is_check_supported(self):
# CHECK_NONE and CHECK_CRC32 should always be supported,
# regardless of the options liblzma was compiled with.
self.assertTrue(lzma.check_is_supported(lzma.CHECK_NONE))
self.assertTrue(lzma.check_is_supported(lzma.CHECK_CRC32))
self.assertTrue(lzma.is_check_supported(lzma.CHECK_NONE))
self.assertTrue(lzma.is_check_supported(lzma.CHECK_CRC32))
# The .xz format spec cannot store check IDs above this value.
self.assertFalse(lzma.check_is_supported(lzma.CHECK_ID_MAX + 1))
self.assertFalse(lzma.is_check_supported(lzma.CHECK_ID_MAX + 1))
# This value should not be a valid check ID.
self.assertFalse(lzma.check_is_supported(lzma.CHECK_UNKNOWN))
self.assertFalse(lzma.is_check_supported(lzma.CHECK_UNKNOWN))
def test_encode_filter_properties(self):
with self.assertRaises(TypeError):

View File

@ -1075,19 +1075,19 @@ static PyTypeObject Decompressor_type = {
/* Module-level functions. */
PyDoc_STRVAR(check_is_supported_doc,
"check_is_supported(check_id) -> bool\n"
PyDoc_STRVAR(is_check_supported_doc,
"is_check_supported(check_id) -> bool\n"
"\n"
"Test whether the given integrity check is supported.\n"
"\n"
"Always returns True for CHECK_NONE and CHECK_CRC32.\n");
static PyObject *
check_is_supported(PyObject *self, PyObject *args)
is_check_supported(PyObject *self, PyObject *args)
{
int check_id;
if (!PyArg_ParseTuple(args, "i:check_is_supported", &check_id))
if (!PyArg_ParseTuple(args, "i:is_check_supported", &check_id))
return NULL;
return PyBool_FromLong(lzma_check_is_supported(check_id));
@ -1182,8 +1182,8 @@ decode_filter_properties(PyObject *self, PyObject *args)
/* Module initialization. */
static PyMethodDef module_methods[] = {
{"check_is_supported", (PyCFunction)check_is_supported,
METH_VARARGS, check_is_supported_doc},
{"is_check_supported", (PyCFunction)is_check_supported,
METH_VARARGS, is_check_supported_doc},
{"encode_filter_properties", (PyCFunction)encode_filter_properties,
METH_VARARGS, encode_filter_properties_doc},
{"decode_filter_properties", (PyCFunction)decode_filter_properties,