Add deprecation warnings for 'embeded_*' parameters and update dependencies

bartTC · bartTC · commit ca68b09739b8 · 2025-07-23T12:28:07.000+02:00
- Introduced warnings for deprecated 'embeded_*' parameters, which will be removed in v9.0.
- Added `deprecation` to dependencies in `pyproject.toml`.
- Added `@deprecation.deprecated` decorator to mark `draw_embeded_image` as deprecated.
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,6 +31,7 @@ classifiers = [
 requires-python = "~=3.9"
 dependencies = [
     "colorama; sys_platform == 'win32'",
+    "deprecation",
 ]
 
 
diff --git a/qrcode/image/styledpil.py b/qrcode/image/styledpil.py
@@ -1,9 +1,12 @@
 from __future__ import annotations
 
+import warnings
 from typing import overload
 
-import qrcode.image.base
+import deprecation
 from PIL import Image
+
+import qrcode.image.base
 from qrcode.image.styles.colormasks import QRColorMask, SolidFillColorMask
 from qrcode.image.styles.moduledrawers import SquareModuleDrawer
 
@@ -45,6 +48,16 @@ class StyledPilImage(qrcode.image.base.BaseImageWithDrawer):
 
     def __init__(self, *args, **kwargs):
         self.color_mask = kwargs.get("color_mask", SolidFillColorMask())
+
+        if kwargs.get("embeded_image_path") or kwargs.get("embeded_image"):
+            warnings.warn(
+                "The 'embeded_*' parameters are deprecated. Use 'embedded_image_path' "
+                "or 'embedded_image' instead. The 'embeded_*' parameters will be "
+                "removed in v9.0.",
+                category=DeprecationWarning,
+                stacklevel=2,
+            )
+
         # allow embeded_ parameters with typos for backwards compatibility
         embedded_image_path = kwargs.get(
             "embedded_image_path", kwargs.get("embeded_image_path", None)
@@ -100,6 +113,15 @@ def process(self):
         if self.embedded_image:
             self.draw_embedded_image()
 
+    @deprecation.deprecated(
+        deprecated_in="9.0",
+        removed_in="8.3",
+        current_version="8.2",
+        details="Use draw_embedded_image() instead",
+    )
+    def draw_embeded_image(self):
+        return self.draw_embedded_image()
+
     def draw_embedded_image(self):
         if not self.embedded_image:
             return
diff --git a/qrcode/main.py b/qrcode/main.py
@@ -1,4 +1,5 @@
 import sys
+import warnings
 from bisect import bisect_left
 from typing import (
     Generic,
@@ -342,6 +343,16 @@ def make_image(self, image_factory=None, **kwargs):
 
         If the data has not been compiled yet, make it first.
         """
+        # Raise a warning that 'embeded' is still used
+        if kwargs.get("embeded_image_path") or kwargs.get("embeded_image"):
+            warnings.warn(
+                "The 'embeded_*' parameters are deprecated. Use 'embedded_image_path' "
+                "or 'embedded_image' instead. The 'embeded_*' parameters will be "
+                "removed in v9.0.",
+                category=DeprecationWarning,
+                stacklevel=2,
+            )
+
         # allow embeded_ parameters with typos for backwards compatibility
         if (
             kwargs.get("embedded_image_path")
@@ -352,6 +363,7 @@ def make_image(self, image_factory=None, **kwargs):
             raise ValueError(
                 "Error correction level must be ERROR_CORRECT_H if an embedded image is provided"
             )
+
         _check_box_size(self.box_size)
         if self.data_cache is None:
             self.make()

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ classifiers = [`
`31`	`31`	`requires-python = "~=3.9"`
`32`	`32`	`dependencies = [`
`33`	`33`	`"colorama; sys_platform == 'win32'",`
	`34`	`+ "deprecation",`
`34`	`35`	`]`
`35`	`36`
`36`	`37`