Merge pull request #31 from pycompression/windows

Add windows support.

Author: rhpvorderman

.github/workflows/ci.yml

@@ -9,6 +9,11 @@ on:
     tags:
       - "*"
 
+defaults:
+  run:
+    # This is needed for miniconda, see:
+    # https://github.com/marketplace/actions/setup-miniconda#important.
+    shell: bash -l {0}
 
 jobs:
   lint:
@@ -25,26 +30,14 @@ jobs:
         run: pip install tox
       - name: Lint
         run: tox -e lint
-  docs:
-    needs: lint
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/[email protected]
-        with:
-          submodules: recursive
-      - name: Set up Python 3.6
-        uses: actions/[email protected]
-        with:
-          python-version: 3.6
-      - name: Install isal
-        run: sudo apt-get install libisal-dev
-      - name: Install tox and upgrade setuptools and pip
-        run: pip install --upgrade tox setuptools pip
-      - name: Build docs
-        run: tox -e docs
-        env:
-          PYTHON_ISAL_LINK_DYNAMIC: True
-  mypy:
+
+  package-checks:
+    strategy:
+      matrix:
+        tox_env:
+          - docs
+          - mypy
+          - twine_check
     needs: lint
     runs-on: ubuntu-20.04
     steps:
@@ -59,38 +52,10 @@ jobs:
         run: sudo apt-get install libisal-dev
       - name: Install tox and upgrade setuptools and pip
         run: pip install --upgrade tox setuptools pip
-      - name: Mypy checks
-        run: tox -e mypy
+      - name: Run tox -e ${{ matrix.tox_env }}
+        run: tox -e ${{ matrix.tox_env }}
         env:
           PYTHON_ISAL_LINK_DYNAMIC: True
-  twine_check:
-    needs: lint
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        python-version:
-          - 3.6
-        os: ["ubuntu-latest" ]
-    steps:
-      - uses: actions/[email protected]
-        with:
-         submodules: recursive
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/[email protected]
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install build dependencies (Linux)  # Yasm in pypa/manylinux images.
-        run: sudo apt install yasm
-        if: runner.os == 'Linux'
-      - name: Install build dependencies (Macos)
-        run: brew install yasm automake autoconf
-        if: runner.os == 'macOS'
-      - name: Install twine, cython wheel and upgrade setuptools
-        run: pip install --upgrade twine cython wheel setuptools
-      - name: create dists
-        run: python setup.py sdist bdist_wheel
-      - name: check dists
-        run: twine check dist/*
 
   test-static:
     needs: lint
@@ -105,48 +70,55 @@ jobs:
         os: ["ubuntu-latest"]
         include:
           - os: "macos-latest"
-            python-version: 3.8
+            python-version: 3.6
+          - os: "windows-latest"
+            python-version: 3.6
     steps:
       - uses: actions/[email protected]
         with:
           submodules: recursive
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2.2.1
+      - name: Install miniconda.
+        uses: conda-incubator/setup-miniconda@v2.0.1 # https://github.com/conda-incubator/setup-miniconda.
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install tox and upgrade setuptools
-        run: pip install --upgrade tox setuptools
-      - name: Install build dependencies (Linux)  # Yasm in pypa/manylinux images.
-        run: sudo apt install yasm
-        if: runner.os == 'Linux'
-      - name: Install build dependencies (Macos)
-        run: brew install yasm automake autoconf
+          channels: conda-forge,defaults
+      - name: Install requirements (MacOS)
+        run: conda install python=${{ matrix.python-version }} tox make automake autoconf libtool nasm
         if: runner.os == 'macOS'
+      - name: Install requirements (Linux)
+        run: conda install python=${{ matrix.python-version }} tox make automake autoconf libtool yasm # Yasm in pypa/manylinux images.
+        if: runner.os == 'Linux'
+      - name: install requirements (Windows)
+        run: conda install python=${{ matrix.python-version }} tox nasm
+        if: runner.os == 'Windows'
+      - name: Set MSVC developer prompt
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
       - name: Run tests
         run: tox -e py3
       - name: Upload coverage report
         uses: codecov/codecov-action@v1
 
+  # Test if the python-isal conda package can be build. Which is linked
+  # dynamically to the conda isa-l package.
   test-dynamic:
     runs-on: ${{ matrix.os }}
     needs: lint
     strategy:
       matrix:
-        python-version:
-          - 3.6
-        os: ["ubuntu-20.04"]
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
     steps:
       - uses: actions/[email protected]
         with:
           submodules: recursive
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2.2.1
+      - name: Install miniconda.
+        uses: conda-incubator/setup-miniconda@v2.0.1 # https://github.com/conda-incubator/setup-miniconda.
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install isal
-        run: sudo apt-get install libisal-dev
-      - name: Install tox and upgrade setuptools and pip
-        run: pip install --upgrade tox setuptools pip
+          channels: conda-forge,defaults
+      - name: Install requirements (universal)
+        run: conda install isa-l python tox
+      - name: Set MSVC developer prompt
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
       - name: Run tests (dynamic link)
         run: tox -e py3
         env:
@@ -155,21 +127,29 @@ jobs:
   deploy:
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     runs-on: ${{ matrix.os }}
-    needs: [lint, docs, test-static, test-dynamic, twine_check]
+    needs: [lint, package-checks, test-static, test-dynamic]
     strategy:
       matrix:
-        os: [ "macos-latest", "ubuntu-latest" ]
+        os: ["macos-latest", "ubuntu-latest", "windows-latest"]
     steps:
       - uses: actions/[email protected]
         with:
           submodules: recursive
-      - uses: actions/setup-python@v2
-        name: Install Python
-      - name: Install cibuildwheel twine
-        run: python -m pip install cibuildwheel twine
+      - name: Install miniconda.
+        uses: conda-incubator/[email protected] # https://github.com/conda-incubator/setup-miniconda.
+        with:
+          channels: conda-forge,defaults
       - name: Install build dependencies (Macos)
-        run: brew install yasm automake autoconf
+        run: conda install nasm automake autoconf python
         if: runner.os == 'macOS'
+      - name: Install build dependencies (Windows)
+        run: conda install nasm python
+        if: runner.os == 'Windows'
+      - name: Set MSVC developer prompt
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
+      - name: Install cibuildwheel twine
+        run: python -m pip install cibuildwheel twine
       - name: Build wheels
         run: cibuildwheel --output-dir dist
         env:

CHANGELOG.rst

@@ -7,6 +7,11 @@ Changelog
 .. This document is user facing. Please word the changes in such a way
 .. that users understand how the changes affect the new version.
 
+version 0.6.0-dev
+-----------------
++ Installation on Windows is now supported. Wheels are provided for Windows as
+  well.
+
 version 0.5.0
 -----------------
 + Fix a bug where negative integers were not allowed for the ``adler32`` and

README.rst

@@ -71,12 +71,12 @@ Installation
 Installation with pip
 .....................
 
-+ Linux and MacOS: ``pip install isal``. Wheels are provided, so installation should
-  be almost instantaneous.
-+ Windows: Installation is not supported yet.
++ ``pip install isal``
 
-The installation will include a staticallly linked version of isa-l. On Linux
-and MacOS, wheels are provided. If a wheel is not provided for your system the
+Installation is supported on Linux, MacOS and Windows. On x86-64 (amd64)
+platforms wheels are provided, so installation should be almost instantaneous.
+The installation will include a staticallly linked version of isa-l.
+If a wheel is not provided for your system the
 installation will build ISA-L first in a temporary directory. Please check the
 `ISA-L homepage <https://github.com/intel/isa-l>`_ for the build requirements.
 

setup.py

@@ -30,12 +30,21 @@
 
 ISA_L_SOURCE = os.path.join("src", "isal", "isa-l")
 
+SYSTEM_IS_UNIX = (sys.platform.startswith("linux") or
+                  sys.platform.startswith("darwin"))
+SYSTEM_IS_WINDOWS = sys.platform.startswith("win")
+
 
 class IsalExtension(Extension):
     """Custom extension to allow for targeted modification."""
     pass
 
 
+MODULES = [IsalExtension("isal.isal_zlib", ["src/isal/isal_zlib.pyx"])]
+if SYSTEM_IS_UNIX:
+    MODULES.append(IsalExtension("isal._isal", ["src/isal/_isal.pyx"]))
+
+
 class BuildIsalExt(build_ext):
     def build_extension(self, ext):
         if not isinstance(ext, IsalExtension):
@@ -50,19 +59,37 @@ def build_extension(self, ext):
             # installing in a conda environment.
             possible_prefixes = [sys.exec_prefix, sys.base_exec_prefix]
             for prefix in possible_prefixes:
-                if os.path.exists(os.path.join(prefix, "include", "isa-l")):
-                    ext.include_dirs = [
-                        os.path.join(prefix, "include")]
-                    break  # Only one include directory is needed.
-            ext.libraries = ["isal"]
+                if Path(prefix, "include", "isa-l").exists():
+                    ext.include_dirs = [os.path.join(prefix, "include")]
+                    break   # Only one include directory is needed.
+                # On windows include is in Library apparently
+                elif Path(prefix, "Library", "include", "isa-l").exists():
+                    ext.include_dirs = [os.path.join(prefix, "Library",
+                                                     "include")]
+                    ext.library_dirs = [os.path.join(prefix, "Library", "lib")]
+                    break
+            if SYSTEM_IS_UNIX:
+                ext.libraries = ["isal"]  # libisal.so*
+            elif SYSTEM_IS_WINDOWS:
+                ext.libraries = ["isa-l"]  # isa-l.dll
+            else:
+                raise NotImplementedError(
+                    f"Unsupported platform: {sys.platform}")
         else:
             isa_l_prefix_dir = build_isa_l()
+            if SYSTEM_IS_UNIX:
+                ext.extra_objects = [
+                    os.path.join(isa_l_prefix_dir, "lib", "libisal.a")]
+            elif SYSTEM_IS_WINDOWS:
+                ext.extra_objects = [
+                    os.path.join(isa_l_prefix_dir, "isa-l_static.lib")]
+            else:
+                raise NotImplementedError(
+                    f"Unsupported platform: {sys.platform}")
             ext.include_dirs = [os.path.join(isa_l_prefix_dir,
                                              "include")]
             # -fPIC needed for proper static linking
             ext.extra_compile_args = ["-fPIC"]
-            ext.extra_objects = [
-                os.path.join(isa_l_prefix_dir, "lib", "libisal.a")]
 
         if os.getenv("CYTHON_COVERAGE") is not None:
             # Import cython here so python setup.py can be used without
@@ -102,12 +129,23 @@ def build_isa_l():
     else:  # sched_getaffinity not available on all platforms
         cpu_count = os.cpu_count() or 1  # os.cpu_count() can return None
     run_args = dict(cwd=build_dir, env=build_env)
-    subprocess.run(os.path.join(build_dir, "autogen.sh"), **run_args)
-    subprocess.run([os.path.join(build_dir, "configure"),
-                    "--prefix", temp_prefix], **run_args)
-    subprocess.run(["make", "-j", str(cpu_count)],
-                   **run_args)
-    subprocess.run(["make", "install"], **run_args)
+    if SYSTEM_IS_UNIX:
+        subprocess.run(os.path.join(build_dir, "autogen.sh"), **run_args)
+        subprocess.run([os.path.join(build_dir, "configure"),
+                        "--prefix", temp_prefix], **run_args)
+        subprocess.run(["make", "-j", str(cpu_count)],
+                       **run_args)
+        subprocess.run(["make", "install"], **run_args)
+    elif SYSTEM_IS_WINDOWS:
+        subprocess.run(["nmake", "/f", "Makefile.nmake"], **run_args)
+        Path(temp_prefix, "include").mkdir()
+        print(temp_prefix, file=sys.stderr)
+        shutil.copytree(os.path.join(build_dir, "include"),
+                        Path(temp_prefix, "include", "isa-l"))
+        shutil.copy(os.path.join(build_dir, "isa-l_static.lib"),
+                    os.path.join(temp_prefix, "isa-l_static.lib"))
+    else:
+        raise NotImplementedError(f"Unsupported platform: {sys.platform}")
     shutil.rmtree(build_dir)
     return temp_prefix
 
@@ -149,8 +187,5 @@ def build_isa_l():
         "Operating System :: MacOS"
     ],
     python_requires=">=3.6",
-    ext_modules=[
-        IsalExtension("isal.isal_zlib", ["src/isal/isal_zlib.pyx"]),
-        IsalExtension("isal._isal", ["src/isal/_isal.pyx"]),
-    ]
+    ext_modules=MODULES
 )

src/isal/__init__.py

@@ -17,9 +17,19 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
+from typing import Optional
 
-from ._isal import ISAL_MAJOR_VERSION, ISAL_MINOR_VERSION, \
-    ISAL_PATCH_VERSION, ISAL_VERSION
+try:
+    from . import _isal
+    ISAL_MAJOR_VERSION: Optional[int] = _isal.ISAL_MAJOR_VERSION
+    ISAL_MINOR_VERSION: Optional[int] = _isal.ISAL_MINOR_VERSION
+    ISAL_PATCH_VERSION: Optional[int] = _isal.ISAL_PATCH_VERSION
+    ISAL_VERSION: Optional[str] = _isal.ISAL_VERSION
+except ImportError:  # isa-l.h not available on windows
+    ISAL_MAJOR_VERSION = None
+    ISAL_MINOR_VERSION = None
+    ISAL_PATCH_VERSION = None
+    ISAL_VERSION = None
 
 __all__ = [
     "ISAL_MAJOR_VERSION",

tests/test_gzip_compliance.py

@@ -58,7 +58,11 @@ def seek(self, *args):
 
 
 class BaseTest(unittest.TestCase):
-    fileno, filename = tempfile.mkstemp()
+
+    def __init__(self, methodName):
+        fileno, self.filename = tempfile.mkstemp()
+        os.close(fileno)
+        super().__init__(methodName)
 
     def setUp(self):
         if os.path.exists(self.filename):
@@ -391,7 +395,8 @@ def test_metadata(self):
             self.assertEqual(isizeBytes, struct.pack('<i', len(data1)))
 
     def test_metadata_ascii_name(self):
-        self.filename = tempfile.mkstemp()[1]
+        fd, self.filename = tempfile.mkstemp()
+        os.close(fd)
         self.test_metadata()
 
     def test_compresslevel_metadata(self):