Merge pull request #74 from pycompression/profile

Refactor setup.py so compiler directives can be set globally.

Author: rhpvorderman

.github/workflows/ci.yml

@@ -30,7 +30,6 @@ jobs:
       matrix:
         tox_env:
           - docs
-          - mypy
           - twine_check
     needs: lint
     runs-on: ubuntu-20.04

profile_igzipreader.py

@@ -0,0 +1,16 @@
+import cProfile
+import sys
+
+from isal import igzip
+
+
+def main():
+    with igzip.open(sys.argv[1], mode="rb") as gzip_h:
+        while True:
+            block = gzip_h.read(32*1024)
+            if block == b"":
+                return
+
+
+if __name__ == "__main__":
+    cProfile.run("main()")

setup.py

@@ -36,6 +36,11 @@
 SYSTEM_IS_WINDOWS = sys.platform.startswith("win")
 
 
+def default_compiler_directives():
+    return dict(language_level="3",
+                binding=True)
+
+
 class IsalExtension(Extension):
     """Custom extension to allow for targeted modification."""
     pass
@@ -106,21 +111,22 @@ def build_extension(self, ext):
             # -fPIC needed for proper static linking
             ext.extra_compile_args = ["-fPIC"]
 
-        if os.getenv("CYTHON_COVERAGE") is not None:
-            # Import cython here so python setup.py can be used without
-            # installing cython.
-            from Cython.Build import cythonize
-            # Add cython directives and macros for coverage support.
-            cythonized_exts = cythonize(ext, compiler_directives=dict(
-                linetrace=True
-            ))
-            for cython_ext in cythonized_exts:
+        # Import cython here so python setup.py can be used without
+        # installing cython.
+        from Cython.Build import cythonize
+        compiler_directives = default_compiler_directives()
+        line_tracing_enabled = os.getenv("CYTHON_COVERAGE") is not None
+        if line_tracing_enabled:
+            # Add cython directives for coverage support.
+            compiler_directives.update(linetrace=True)
+        cythonized_exts = cythonize(
+            ext, compiler_directives=compiler_directives)
+
+        for cython_ext in cythonized_exts:
+            if line_tracing_enabled:
                 cython_ext.define_macros = [("CYTHON_TRACE_NOGIL", "1")]
-                cython_ext._needs_stub = False
-                super().build_extension(cython_ext)
-            return
-
-        super().build_extension(ext)
+            cython_ext._needs_stub = False
+            super().build_extension(cython_ext)
 
 
 # Use a cache to prevent isa-l from being build twice. According to the

src/isal/_isal.pyx

@@ -18,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# cython: language_level=3
-
 from .version cimport ISAL_MAJOR_VERSION as C_ISAL_MAJOR_VERSION
 from .version cimport ISAL_MINOR_VERSION as C_ISAL_MINOR_VERSION
 from .version cimport ISAL_PATCH_VERSION as C_ISAL_PATCH_VERSION

src/isal/crc.pxd

@@ -18,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# cython: language_level=3
-
 cdef extern from "<isa-l/crc.h>":
     cdef unsigned int crc32_gzip_refl(
     unsigned int init_crc,          #!< initial CRC value, 32 bits

src/isal/igzip_lib.pxd

@@ -18,8 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# cython: language_level=3
-
 cdef extern from "<isa-l/igzip_lib.h>":
     # Deflate compression standard defines
     int ISAL_DEF_MAX_HDR_SIZE

src/isal/igzip_lib.pyx

@@ -18,9 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# cython: language_level=3
-# cython: binding=True
-
 """
 Pythonic interface to ISA-L's igzip_lib.
 

src/isal/isal_zlib.pyx

@@ -18,9 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# cython: language_level=3
-# cython: binding=True
-
 """
 Implementation of the zlib module using the ISA-L libraries.
 """

tox.ini

@@ -42,16 +42,12 @@ commands=
 [testenv:lint]
 deps=flake8
      flake8-import-order
+     mypy
+     pytest
 skip_install=True
 commands =
     flake8 src tests setup.py benchmark.py
-
-[testenv:mypy]
-# pytest dep needed for mypy check
-deps=mypy
-     pytest
-commands =
-    mypy src/ tests/
+    mypy src/ tests
 
 [testenv:twine_check]
 deps=wheel