Merge pull request #3 from ramonaoptics/test_windows

Try to fixup windows failures

Author: hmaarrfk

.github/workflows/tests.yml

@@ -17,10 +17,16 @@ jobs:
         include:
           - os: "ubuntu-latest"
             installer-url: "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh"
+            python-version: "3.13"
+          - os: "ubuntu-latest"
+            installer-url: "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh"
+            python-version: "3.10"
           - os: "macos-latest"
             installer-url: "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-x86_64.sh"
-          - os: "windows-latest"
-            installer-url: "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe"
+            python-version: "3.9"
+         #  - os: "windows-latest"
+         #    installer-url: "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe"
+         #    python-version: "3.12"
       max-parallel: 8
       fail-fast: false
 
@@ -41,32 +47,31 @@ jobs:
           auto-update-conda: true
           installer-url: ${{ matrix.installer-url }}
           python-version: ${{ matrix.python-version }}
-      - name: Conda info
+
+      - name: Install and Test Package (Unix)
+        if: matrix.os != 'windows-latest'
         shell: bash -el {0}
         run: |
-          conda config --remove channels defaults
-          conda config --add channels mark.harfouche
           conda info
-      - name: Conda list
-        shell: pwsh
-        run: |
           conda list
-
-      - name: Install dependencies
-        shell: bash -el {0}
-        run: |
           conda install compilers pybind11 numpy openjph setuptools pytest --yes
-
-      - name: Install package
-        shell: bash -el {0}
-        run: |
           export OJPH_GIT_DESCRIBE=${{ steps.ghd.outputs.describe }}
-          python -m pip install -e . -vvv
+          python -m pip install -e . -vvv --no-deps --no-build-isolation
+          python --version
+          pip check
+          python -c "import ojph; print(ojph.__version__)"
+          pytest
 
-      - name: Run tests
-        shell: bash -el {0}
+      - name: Install and Test Package (Windows)
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
         run: |
-          export OJPH_GIT_DESCRIBE=${{ steps.ghd.outputs.describe }}
+          conda info
+          conda list
+          conda install --yes compilers pybind11 numpy openjph setuptools pytest git
+          set "OJPH_GIT_DESCRIBE=${{ steps.ghd.outputs.describe }}"
+          setx OJPH_GIT_DESCRIBE ${{ steps.ghd.outputs.describe }}
+          python -m pip install -e . -vvv --no-deps --no-build-isolation
           python --version
           pip check
           python -c "import ojph; print(ojph.__version__)"

ojph/__init__.py

@@ -1,6 +1,6 @@
-from ._version import __version__
+from ._version import __version__   # noqa
 
 from ._imwrite import imwrite
 from ._imread import imread
 
-__all__ = ["imwrite", "imread"]
+__all__ = ["imwrite", "imread"]

ojph/_imread.py

@@ -1,4 +1,3 @@
-import os
 import numpy as np
 import ctypes
 from .ojph_bindings import J2CInfile, Codestream
@@ -19,13 +18,19 @@ def imread(uri, *, index=None, plugin=None, extension=None, format_hint=None, **
 
 
 class OJPHImageFile:
-    def __init__(self, filename):
+    def __init__(self, filename, *, mode='r'):
+        if mode != 'r':
+            raise ValueError(f"We only support mode = 'r' for now. Got {mode}.")
         self._codestream = None
         self._ojph_file = None
         self._filename = filename
 
-        self._ojph_file = J2CInfile()
-        self._ojph_file.open(str(filename))
+        ojph_file = J2CInfile()
+        ojph_file.open(str(filename))
+        # An exception can occur and if we call close in our destructor because
+        # we think the file has been opened successfully then it breaks things
+        # the C++ destructor will check if the filehandle is not None
+        self._ojph_file = ojph_file
         self._codestream = Codestream()
         self._codestream.read_headers(self._ojph_file)
 
@@ -52,6 +57,14 @@ def __init__(self, filename):
         else:
             raise ValueError("Unsupported bit depth")
 
+    @property
+    def shape(self):
+        return self._shape
+
+    @property
+    def dtype(self):
+        return self._dtype
+
     def _open_file(self):
         self._ojph_file = J2CInfile()
         self._ojph_file.open(self._filename)
@@ -99,4 +112,4 @@ def _close_codestream_and_file(self):
         self._ojph_file = None
 
     def __del__(self):
-        self._close_codestream_and_file()
+        self._close_codestream_and_file()

ojph/_imwrite.py

@@ -38,7 +38,7 @@ def imwrite(filename, image):
     bit_depth = image.dtype.itemsize * 8
     # Is there a better way to detect signed dtypes???
     is_signed = image.dtype.kind != 'u'
-    siz.set_num_components(num_components);
+    siz.set_num_components(num_components)
     for i in range(num_components):
         # is it necessary to do this in a loop?
         siz.set_component(
@@ -75,7 +75,7 @@ def imwrite(filename, image):
                 line_array[...] = image[i, :]
             else:
                 line_array[...] = image[i, :, c]
-            c_before = c
+            # c_before = c
             line = codestream.exchange(line, c)
 
     codestream.flush()

setup.py

@@ -64,6 +64,7 @@ def get_version_and_cmdclass(pkg_path):
         'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
@@ -72,7 +73,7 @@ def get_version_and_cmdclass(pkg_path):
         'Topic :: Software Development :: Libraries :: Python Modules',
     ],
     packages=find_packages(exclude=["tests*"]),
-    python_requires='>=3.10',
+    python_requires='>=3.9',
     install_requires=[
         'numpy>=1.24.0',
     ],

tests/test_imread_failures.py

@@ -0,0 +1,9 @@
+from ojph import imread
+import pytest
+
+
+def test_imread_file_does_not_exist(tmp_path):
+    # A double free can cause a segmentation fault. So make sure just an error
+    # is raised and not a full interpreter shutdown.
+    with pytest.raises(RuntimeError):
+        imread(tmp_path / 'does_not_exist.j2c')