Make an import from 'moduledrawers' directly raise a deprecation warning

Author: bartTC

qrcode/image/styledpil.py

@@ -8,7 +8,7 @@
 
 import qrcode.image.base
 from qrcode.image.styles.colormasks import QRColorMask, SolidFillColorMask
-from qrcode.image.styles.moduledrawers import SquareModuleDrawer
+from qrcode.image.styles.moduledrawers.pil import SquareModuleDrawer
 
 
 class StyledPilImage(qrcode.image.base.BaseImageWithDrawer):

qrcode/image/styles/moduledrawers/__init__.py

@@ -1,13 +1,47 @@
-# For backwards compatibility, importing the PIL drawers here.
-import contextlib
-
-with contextlib.suppress(ImportError):
-    from .pil import (
-        CircleModuleDrawer,  # noqa: F401
-        GappedCircleModuleDrawer,  # noqa: F401
-        GappedSquareModuleDrawer,  # noqa: F401
-        HorizontalBarsDrawer,  # noqa: F401
-        RoundedModuleDrawer,  # noqa: F401
-        SquareModuleDrawer,  # noqa: F401
-        VerticalBarsDrawer,  # noqa: F401
-    )
+"""
+Module for lazy importing of PIL drawers with a deprecation warning.
+
+Currently, importing a PIL drawer from this module is allowed for backwards
+compatibility but will raise a DeprecationWarning.
+
+This will be removed in v9.0.
+"""
+
+import warnings
+
+from qrcode.constants import PIL_AVAILABLE
+
+
+def __getattr__(name):
+    """Lazy import with deprecation warning for PIL drawers."""
+    # List of PIL drawer names that should trigger deprecation warnings
+    pil_drawers = {
+        "CircleModuleDrawer",
+        "GappedCircleModuleDrawer",
+        "GappedSquareModuleDrawer",
+        "HorizontalBarsDrawer",
+        "RoundedModuleDrawer",
+        "SquareModuleDrawer",
+        "VerticalBarsDrawer",
+    }
+
+    if name in pil_drawers:
+        # Only render a warning if PIL is actually installed. Otherwise it would
+        # raise an ImportError directly, which is fine.
+        if PIL_AVAILABLE:
+            warnings.warn(
+                f"Importing '{name}' directly from this module is deprecated."
+                f"Please use 'from qrcode.image.styles.moduledrawers.pil import {name}' "
+                f"instead. This backwards compatibility import will be removed in v9.0.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
+        # Import and return the drawer from the pil module
+        from . import pil  # noqa: PLC0415
+
+        return getattr(pil, name)
+
+    # For any other attribute, raise AttributeError
+    msg = f"module {__name__!r} has no attribute {name!r}"
+    raise AttributeError(msg)

qrcode/tests/test_qrcode_pil.py

@@ -71,13 +71,13 @@ def test_render_styled_with_embedded_image_path(tmp_path):
 @pytest.mark.parametrize(
     "drawer",
     [
-        moduledrawers.CircleModuleDrawer,
-        moduledrawers.GappedCircleModuleDrawer,
-        moduledrawers.GappedSquareModuleDrawer,
-        moduledrawers.HorizontalBarsDrawer,
-        moduledrawers.RoundedModuleDrawer,
-        moduledrawers.SquareModuleDrawer,
-        moduledrawers.VerticalBarsDrawer,
+        moduledrawers.pil.CircleModuleDrawer,
+        moduledrawers.pil.GappedCircleModuleDrawer,
+        moduledrawers.pil.GappedSquareModuleDrawer,
+        moduledrawers.pil.HorizontalBarsDrawer,
+        moduledrawers.pil.RoundedModuleDrawer,
+        moduledrawers.pil.SquareModuleDrawer,
+        moduledrawers.pil.VerticalBarsDrawer,
     ],
 )
 def test_render_styled_with_drawer(drawer):