Turn crc32c module into a package

The package's __init__ module exposes the same objects that the module does, so this change is fully backwards compatible in terms of the import logic used by the users. However, it has a few advantages over the previous implementation: * It allows us to organise our source code better * It opens the door to adding typing stub files for our C extension * Opens the door for providing other modules (C or Python) alongside what we currently provide Signed-off-by: Rodrigo Tobar <[email protected]>
ICRAR · Aug 6, 2024 · 9deaac5 · 9deaac5
1 parent 5db7c19
commit 9deaac5
Show file tree

Hide file tree

Showing 14 changed files with 11 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * Release GIL during the computation of the CRC32C hash. A new `gil_release_mode` argument lets users choose between always/never/automatically releasing it (#47).
 * Add keyword support to `crc32c` function (`crc32c(data, value=0, gil_release_mode=-1)`).
+* Turned ``crc32c`` from a module-only distribution into a package.
 * Adding explicit fallthrough annotations
   in several ``switch`` C statements
   for clarity, and to avoid potential warnings (#46).

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,3 @@
-include *.h
 include LICENSE*
 include AUTHORS*
+include crc32c/ext/*.h
diff --git a/crc32c/__init__.py b/crc32c/__init__.py
@@ -0,0 +1 @@
+from ._crc32c import big_endian, crc32, crc32c, hardware_based
diff --git a/_crc32c.c → crc32c/ext/_crc32c.c b/_crc32c.c → crc32c/ext/_crc32c.c
@@ -135,7 +135,7 @@ static const char *import_error_msg = "\n\n"
 
 /* Support for Python 2/3 */
 #if PY_MAJOR_VERSION >= 3
-static struct PyModuleDef moduledef = {PyModuleDef_HEAD_INIT, "crc32c", "crc32c implementation in hardware and software", -1, CRC32CMethods};
+static struct PyModuleDef moduledef = {PyModuleDef_HEAD_INIT, "_crc32c", "crc32c implementation in hardware and software", -1, CRC32CMethods};
 	#define MOD_INIT(name) PyMODINIT_FUNC PyInit_##name(void)
 	#define MOD_DEF(m, name, doc, methods) \
 		m = PyModule_Create(&moduledef);
@@ -147,7 +147,7 @@ static struct PyModuleDef moduledef = {PyModuleDef_HEAD_INIT, "crc32c", "crc32c
 	#define MOD_VAL(v)
 #endif
 
-MOD_INIT(crc32c)
+MOD_INIT(_crc32c)
 {
 	PyObject *m;
 	PyObject *hardware_based;
@@ -183,7 +183,7 @@ MOD_INIT(crc32c)
 
 	is_big_endian = (*(const char *)(&n) == 0);
 
-	MOD_DEF(m, "crc32c", "crc32c implementation in hardware and software", CRC32CMethods);
+	MOD_DEF(m, "_crc32c", "crc32c implementation in hardware and software", CRC32CMethods);
 	if (m == NULL) {
 		return MOD_VAL(NULL);
 	}

diff --git a/checkarm.c → crc32c/ext/checkarm.c b/checkarm.c → crc32c/ext/checkarm.c
diff --git a/checkarm.h → crc32c/ext/checkarm.h b/checkarm.h → crc32c/ext/checkarm.h
diff --git a/checksse42.c → crc32c/ext/checksse42.c b/checksse42.c → crc32c/ext/checksse42.c
diff --git a/checksse42.h → crc32c/ext/checksse42.h b/checksse42.h → crc32c/ext/checksse42.h
diff --git a/common.h → crc32c/ext/common.h b/common.h → crc32c/ext/common.h
diff --git a/crc32c.h → crc32c/ext/crc32c.h b/crc32c.h → crc32c/ext/crc32c.h
diff --git a/crc32c_adler.c → crc32c/ext/crc32c_adler.c b/crc32c_adler.c → crc32c/ext/crc32c_adler.c
diff --git a/crc32c_arm64.c → crc32c/ext/crc32c_arm64.c b/crc32c_arm64.c → crc32c/ext/crc32c_arm64.c
diff --git a/crc32c_sw.c → crc32c/ext/crc32c_sw.c b/crc32c_sw.c → crc32c/ext/crc32c_sw.c
diff --git a/setup.py b/setup.py
@@ -27,12 +27,12 @@
 from setuptools.command.build_ext import build_ext
 
 
-crcmod_ext = Extension('crc32c',
+crcmod_ext = Extension('crc32c._crc32c',
                        define_macros=[('NDEBUG', None)],
-                       depends=glob.glob('*.h'),
+                       depends=glob.glob('crc32c/ext/*.h'),
                        language='c',
-                       sources=['_crc32c.c', 'checkarm.c', 'checksse42.c', 'crc32c_adler.c', 'crc32c_arm64.c', 'crc32c_sw.c'],
-                       include_dirs=['.'])
+                       sources=glob.glob('crc32c/ext/*.c'),
+                       include_dirs=['cc32c/ext/'])
 
 classifiers = [
     # There's no more specific classifier for LGPLv2.1+
@@ -59,6 +59,7 @@
 
 setup(name='crc32c',
       author='The ICRAR DIA Team',
+      packages=['crc32c'],
       url='https://github.com/ICRAR/crc32c',
       author_email='[email protected]',
       version='2.4.1',