allowed import if C module is unavailable (for building docs) (#100)

bigcat88 · web-flow · commit 5ac66d1b89d1 · 2023-07-07T14:46:35.000+03:00
* allowed import if C module is unavailable (for building docs)
diff --git a/.github/.codecov.yml b/.github/.codecov.yml
@@ -1,3 +1,7 @@
+codecov:
+  notify:
+    after_n_builds: 3
+
 comment:
   require_changes: true
   layout: "diff, files"
diff --git a/.github/workflows/analysis-coverage.yml b/.github/workflows/analysis-coverage.yml
@@ -300,3 +300,32 @@ jobs:
 
       - name: Perform tests
         run: sudo -H PH_LIGHT_ACTION=1 EXP_PH_LIBHEIF_VERSION="" python3 -m pytest -rs
+
+  coverage-import-error:
+    runs-on: macos-12
+    name: Coverage(ImportError)
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install from source
+        run: |
+          python3 -m pip -v install .
+          python3 -m pip install pytest coverage
+
+      - name: Generate coverage report
+        run: coverage run -m pytest -rs tests/import_error_test.py && coverage xml && coverage html
+
+      - name: HTML coverage to artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage_macos_imp_err
+          path: ./htmlcov
+          if-no-files-found: error
+
+      - name: Upload report to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: ./coverage.xml
+          fail_ci_if_error: true
+          verbose: true
diff --git a/.github/workflows/test-src-build-linux.yml b/.github/workflows/test-src-build-linux.yml
@@ -36,7 +36,7 @@ jobs:
       fail-fast: false
       matrix:
         arch: ["amd64", "arm64", "arm/v7"]
-        docker_file: ["Alpine_3_15", "Alpine_3_17", "Debian_11", "Ubuntu_22_04"]
+        docker_file: ["Alpine_3_15", "Alpine_3_17", "Alpine_3_18", "Debian_11", "Debian_12", "Ubuntu_22_04"]
 
     steps:
       - uses: actions/checkout@v3
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -4,8 +4,6 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.9"
-  apt_packages:
-    - libheif-dev
 
 python:
   install:
diff --git a/docker/from_src/Alpine_3_15.Dockerfile b/docker/from_src/Alpine_3_15.Dockerfile
@@ -29,5 +29,5 @@ RUN \
   fi && \
   echo "**** Build Done ****" && \
   python3 -c "import pillow_heif; print(pillow_heif.libheif_info())" && \
-  pytest -s pillow_heif && \
+  pytest -rs pillow_heif && \
   echo "**** Test Done ****"
diff --git a/docker/from_src/Alpine_3_17.Dockerfile b/docker/from_src/Alpine_3_17.Dockerfile
@@ -28,5 +28,5 @@ RUN \
   fi && \
   echo "**** Build Done ****" && \
   python3 -c "import pillow_heif; print(pillow_heif.libheif_info())" && \
-  pytest -s pillow_heif && \
+  pytest -rs pillow_heif && \
   echo "**** Test Done ****"
diff --git a/docker/from_src/Alpine_3_18.Dockerfile b/docker/from_src/Alpine_3_18.Dockerfile
@@ -0,0 +1,28 @@
+FROM alpine:3.18 as base
+
+RUN \
+  apk add --no-cache \
+    python3-dev \
+    py3-pip \
+    alpine-sdk \
+    libheif-dev \
+    py3-numpy \
+    py3-pillow
+
+RUN \
+  python3 -m pip install --upgrade pip
+
+FROM base as build_test
+
+COPY . /pillow_heif
+
+RUN \
+  if [ `getconf LONG_BIT` = 64 ]; then \
+    python3 -m pip install -v "pillow_heif/.[tests]"; \
+  else \
+    python3 -m pip install -v "pillow_heif/.[tests-min]"; \
+  fi && \
+  echo "**** Build Done ****" && \
+  python3 -c "import pillow_heif; print(pillow_heif.libheif_info())" && \
+  pytest -rs pillow_heif && \
+  echo "**** Test Done ****"
diff --git a/docker/from_src/Debian_11.Dockerfile b/docker/from_src/Debian_11.Dockerfile
@@ -35,5 +35,5 @@ RUN \
   fi && \
   echo "**** Build Done ****" && \
   python3 -c "import pillow_heif; print(pillow_heif.libheif_info())" && \
-  pytest -s pillow_heif && \
+  pytest -rs pillow_heif && \
   echo "**** Test Done ****"
diff --git a/docker/from_src/Debian_12.Dockerfile b/docker/from_src/Debian_12.Dockerfile
@@ -0,0 +1,40 @@
+FROM debian:bullseye-slim as base
+
+RUN \
+  apt-get -qq update && \
+  apt-get -y -q install \
+    python3-pip \
+    libfribidi-dev \
+    libharfbuzz-dev \
+    libjpeg-dev \
+    liblcms2-dev \
+    libffi-dev \
+    libtool \
+    git \
+    cmake \
+    nasm \
+    wget \
+    libde265-dev \
+    libx265-dev
+
+RUN \
+  python3 -m pip install --upgrade pip
+
+RUN \
+  python3 -m pip install Pillow==9.2.0
+
+FROM base as build_test
+
+COPY . /pillow_heif
+
+RUN \
+  if [ `getconf LONG_BIT` = 64 ]; then \
+    python3 -m pip install -v "pillow_heif/.[tests]"; \
+  else \
+    python3 -m pip install -v "pillow_heif/.[tests-min]"; \
+    export PH_TESTS_NO_HEVC_ENC=1; \
+  fi && \
+  echo "**** Build Done ****" && \
+  python3 -c "import pillow_heif; print(pillow_heif.libheif_info())" && \
+  pytest -rs pillow_heif && \
+  echo "**** Test Done ****"
diff --git a/docker/from_src/Ubuntu_22_04.Dockerfile b/docker/from_src/Ubuntu_22_04.Dockerfile
@@ -1,8 +1,9 @@
-FROM ghcr.io/linuxserver/baseimage-ubuntu:jammy as base
+FROM ubuntu:jammy as base
 
 RUN \
   apt-get -qq update && \
   apt-get -y -q install \
+    curl \
     python3-pip \
     libfribidi-dev \
     libharfbuzz-dev \
@@ -13,6 +14,7 @@ RUN \
     git \
     cmake \
     nasm \
+    libde265-dev \
     libaom-dev
 
 RUN \
@@ -33,5 +35,5 @@ RUN \
   fi && \
   echo "**** Build Done ****" && \
   python3 -c "import pillow_heif; print(pillow_heif.libheif_info())" && \
-  pytest -s pillow_heif && \
+  pytest -rs pillow_heif && \
   echo "**** Test Done ****"
diff --git a/pillow_heif/_deffered_error.py b/pillow_heif/_deffered_error.py
@@ -0,0 +1,13 @@
+"""
+DeferredError class taken from PIL._util.py file.
+"""
+
+
+class DeferredError:  # pylint: disable=too-few-public-methods
+    """Allow failing import for doc purposes, as C module will be not build at `.readthedocs`"""
+
+    def __init__(self, ex):
+        self.ex = ex
+
+    def __getattr__(self, elt):
+        raise self.ex
diff --git a/pillow_heif/_lib_info.py b/pillow_heif/_lib_info.py
@@ -2,13 +2,18 @@
 Functions to get versions of underlying libraries.
 """
 
-from _pillow_heif import lib_info
+try:
+    import _pillow_heif
+except ImportError as ex:
+    from ._deffered_error import DeferredError
+
+    _pillow_heif = DeferredError(ex)
 
 
 def libheif_version() -> str:
     """Returns ``libheif`` version."""
 
-    return lib_info["libheif"]
+    return _pillow_heif.lib_info["libheif"]
 
 
 def libheif_info() -> dict:
@@ -20,4 +25,4 @@ def libheif_info() -> dict:
      'AVIF': 'AOMedia Project AV1 Encoder 3.5.0'
     }"""
 
-    return lib_info
+    return _pillow_heif.lib_info
diff --git a/pillow_heif/as_plugin.py b/pillow_heif/as_plugin.py
@@ -6,7 +6,6 @@
 from typing import Union
 from warnings import warn
 
-from _pillow_heif import lib_info
 from PIL import Image, ImageFile, ImageSequence
 from PIL import __version__ as pil_version
 
@@ -24,6 +23,13 @@
     set_orientation,
 )
 
+try:
+    import _pillow_heif
+except ImportError as ex:
+    from ._deffered_error import DeferredError
+
+    _pillow_heif = DeferredError(ex)
+
 
 class _LibHeifImageFile(ImageFile.ImageFile):
     """Base class with all functionality for ``HeifImageFile`` and ``AvifImageFile`` classes."""
@@ -169,7 +175,7 @@ def register_heif_opener(**kwargs) -> None:
 
     __options_update(**kwargs)
     Image.register_open(HeifImageFile.format, HeifImageFile, _is_supported_heif)
-    if lib_info["HEIF"]:
+    if _pillow_heif.lib_info["HEIF"]:
         Image.register_save(HeifImageFile.format, _save_heif)
         Image.register_save_all(HeifImageFile.format, _save_all_heif)
     extensions = [".heic", ".heics", ".heif", ".heifs", ".hif"]
@@ -210,7 +216,7 @@ def register_avif_opener(**kwargs) -> None:
     :param kwargs: dictionary with values to set in options. See: :ref:`options`.
     """
 
-    if not lib_info["AVIF"]:
+    if not _pillow_heif.lib_info["AVIF"]:
         warn("This version of `pillow-heif` was built without AVIF support.")
         return
     __options_update(**kwargs)
diff --git a/pillow_heif/heif.py b/pillow_heif/heif.py
@@ -6,7 +6,6 @@
 from io import SEEK_SET
 from typing import Any, Dict, List, Optional, Tuple
 
-from _pillow_heif import lib_info, load_file
 from PIL import Image
 
 from . import options
@@ -27,6 +26,13 @@
     set_orientation,
 )
 
+try:
+    import _pillow_heif
+except ImportError as ex:
+    from ._deffered_error import DeferredError
+
+    _pillow_heif = DeferredError(ex)
+
 
 class HeifImage:
     """Class represents one image in a :py:class:`~pillow_heif.HeifFile`"""
@@ -182,7 +188,7 @@ def __init__(self, fp=None, convert_hdr_to_8bit=True, bgr_mode=False, **kwargs):
         else:
             fp_bytes = _get_bytes(fp)
             mimetype = get_file_mimetype(fp_bytes)
-            images = load_file(
+            images = _pillow_heif.load_file(
                 fp_bytes,
                 options.DECODE_THREADS,
                 convert_hdr_to_8bit,
@@ -499,7 +505,7 @@ def encode(mode: str, size: tuple, data, fp, **kwargs) -> None:
 def _encode_images(images: List[HeifImage], fp, **kwargs) -> None:
     compression = kwargs.get("format", "HEIF")
     compression_format = HeifCompressionFormat.AV1 if compression == "AVIF" else HeifCompressionFormat.HEVC
-    if not lib_info[compression]:
+    if not _pillow_heif.lib_info[compression]:
         raise RuntimeError(f"No {compression} encoder found.")
     images_to_save: List[HeifImage] = images + kwargs.get("append_images", [])
     if not kwargs.get("save_all", True):
diff --git a/pillow_heif/misc.py b/pillow_heif/misc.py
@@ -13,13 +13,20 @@
 from struct import pack, unpack
 from typing import List, Optional
 
-from _pillow_heif import CtxWrite
 from PIL import Image
 from PIL import __version__ as pil_version
 
 from . import options
 from .constants import HeifChroma, HeifColorspace, HeifCompressionFormat
 
+try:
+    import _pillow_heif
+except ImportError as ex:
+    from ._deffered_error import DeferredError
+
+    _pillow_heif = DeferredError(ex)
+
+
 MODE_INFO = {
     # name -> [channels, bits per pixel channel, colorspace, chroma]
     "BGRA;16": (4, 16, HeifColorspace.RGB, HeifChroma.INTERLEAVED_RRGGBBAA_LE),
@@ -298,7 +305,7 @@ def _get_primary_index(some_iterator, primary_index: Optional[int]) -> int:
 class CtxEncode:
     def __init__(self, compression_format: HeifCompressionFormat, **kwargs):
         quality = kwargs.get("quality", options.QUALITY)
-        self.ctx_write = CtxWrite(compression_format, -2 if quality is None else quality)
+        self.ctx_write = _pillow_heif.CtxWrite(compression_format, -2 if quality is None else quality)
         enc_params = kwargs.get("enc_params", {})
         chroma = kwargs.get("chroma", None)
         if chroma:
diff --git a/pyproject.toml b/pyproject.toml
@@ -53,6 +53,7 @@ design.max-attributes = 8
 design.max-branches = 16
 design.max-locals = 18
 design.max-returns = 8
+similarities.min-similarity-lines = 6
 basic.good-names = [
     "a", "b", "c", "d", "e", "f", "i", "j", "k", "v",
     "ex", "_", "fp", "im", "HeifImagePlugin", "AvifImagePlugin",
diff --git a/setup.py b/setup.py
@@ -137,8 +137,11 @@ def _add_directory(paths: List, subdir):
                 paths.append(subdir)
 
 
-setup(
-    version=get_version(),
-    cmdclass={"build_ext": PillowHeifBuildExt},
-    ext_modules=[Extension("_pillow_heif", ["pillow_heif/_pillow_heif.c"])],
-)
+if getenv("READTHEDOCS", "False") == "True":
+    setup(version=get_version())
+else:
+    setup(
+        version=get_version(),
+        cmdclass={"build_ext": PillowHeifBuildExt},
+        ext_modules=[Extension("_pillow_heif", ["pillow_heif/_pillow_heif.c"])],
+    )
diff --git a/tests/import_error_test.py b/tests/import_error_test.py
@@ -0,0 +1,28 @@
+import sys
+from unittest import mock
+
+import pytest
+
+# This test should be run in separate interpreter, and needed mostly only for coverage.
+if not any([str(i).find("import_error_test") != -1 for i in sys.argv]):
+    pytest.skip(allow_module_level=True)
+
+
+def test_no_c_module(monkeypatch):
+    original_import = __import__
+
+    def import_mock(name, *args):
+        if name == "_pillow_heif":
+            name = "_pillow_heif_miss"
+        return original_import(name, *args)
+
+    with mock.patch("builtins.__import__", side_effect=import_mock):
+        import pillow_heif
+
+    with pytest.raises(ModuleNotFoundError):
+        pillow_heif.libheif_version()
+
+    with pytest.raises(ModuleNotFoundError):
+        pillow_heif.misc.CtxEncode(pillow_heif.constants.HeifCompressionFormat.AV1)
+
+    assert pillow_heif.get_file_mimetype(b"\x00\x00\x00\x20\x66\x74\x79\x70\x61\x76\x69\x73") == "image/avif-sequence"
diff --git a/tests/write_test.py b/tests/write_test.py
@@ -94,7 +94,7 @@ def test_pillow_save_one_all():
 
 
 def test_heif_no_encoder():
-    with mock.patch.dict("pillow_heif.heif.lib_info", {"libheif": "1.14.2", "HEIF": "", "AVIF": ""}):
+    with mock.patch.dict("pillow_heif.heif._pillow_heif.lib_info", {"libheif": "1.14.2", "HEIF": "", "AVIF": ""}):
         im_heif = pillow_heif.from_pillow(Image.new("L", (64, 64)))
         out_buffer = BytesIO()
         with pytest.raises(RuntimeError):
