remove code for kaleido v0 and orca (including engine argument for image writing functions)

Author: emilykl

plotly/basedatatypes.py

@@ -3717,86 +3717,46 @@ def to_image(self, *args, **kwargs):
 
         Parameters
         ----------
-        format: str or None
-            The desired image format. One of
-              - 'png'
-              - 'jpg' or 'jpeg'
-              - 'webp'
-              - 'svg'
-              - 'pdf'
-              - 'eps' (deprecated) (Requires the poppler library to be installed)
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_format` if engine is "kaleido"
-                - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
-
-        width: int or None
-            The width of the exported image in layout pixels. If the `scale`
-            property is 1.0, this will also be the width of the exported image
-            in physical pixels.
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_width` if engine is "kaleido"
-                - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
-
-        height: int or None
-            The height of the exported image in layout pixels. If the `scale`
-            property is 1.0, this will also be the height of the exported image
-            in physical pixels.
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_height` if engine is "kaleido"
-                - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
-
-        scale: int or float or None
-            The scale factor to use when exporting the figure. A scale factor
-            larger than 1.0 will increase the image resolution with respect
-            to the figure's layout pixel dimensions. Whereas as scale factor of
-            less than 1.0 will decrease the image resolution.
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_scale` if engine is "kaliedo"
-                - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
+        fig:
+            Figure object or dict representing a figure
 
-        validate: bool
-            True if the figure should be validated before being converted to
-            an image, False otherwise.
+        format: str
+            (optional) The desired image format. One of:
+                - 'png'
+                - 'jpg' or 'jpeg'
+                - 'webp'
+                - 'svg'
+                - 'pdf'
+            Defaults to `plotly.io.defaults.default_format`.
+
+        width: int
+            (optional) The width of the exported image in layout pixels. If the
+            `scale` property is 1.0, this will also be the width of the exported image
+            in physical pixels. Defaults to `plotly.io.defaults.default_width`.
+
+        height: int
+            (optional) The height of the exported image in layout pixels. If the
+            `scale` property is 1.0, this will also be the height of the exported image
+            in physical pixels. Defaults to `plotly.io.defaults.default_height`.
+
+        scale: int or float
+            (optional) The scale factor to use when exporting the figure. A scale
+            factor larger than 1.0 will increase the image resolution with respect
+            to the figure's layout pixel dimensions, while a scale factor of
+            less than 1.0 will decrease the image resolution. Defaults to
+            `plotly.io.defaults.default_scale`.
 
-        engine (deprecated): str
-            Image export engine to use. This parameter is deprecated and Orca engine support will be
-            dropped in the next major Plotly version. Until then, the following values are supported:
-            - "kaleido": Use Kaleido for image export
-            - "orca": Use Orca for image export
-            - "auto" (default): Use Kaleido if installed, otherwise use Orca
+        validate: bool
+            (optional) True if the figure should be validated before being converted
+            to an image, False otherwise. Defaults to True.
 
         Returns
         -------
         bytes
             The image data
         """
-        import plotly.io as pio
-        from plotly.io.kaleido import (
-            kaleido_available,
-            kaleido_major,
-            ENABLE_KALEIDO_V0_DEPRECATION_WARNINGS,
-            KALEIDO_DEPRECATION_MSG,
-            ORCA_DEPRECATION_MSG,
-            ENGINE_PARAM_DEPRECATION_MSG,
-        )
 
-        if ENABLE_KALEIDO_V0_DEPRECATION_WARNINGS:
-            if (
-                kwargs.get("engine", None) in {None, "auto", "kaleido"}
-                and kaleido_available()
-                and kaleido_major() < 1
-            ):
-                warnings.warn(KALEIDO_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
-            if kwargs.get("engine", None) == "orca":
-                warnings.warn(ORCA_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
-            if kwargs.get("engine", None):
-                warnings.warn(
-                    ENGINE_PARAM_DEPRECATION_MSG, DeprecationWarning, stacklevel=2
-                )
+        import plotly.io as pio
 
         return pio.to_image(self, *args, **kwargs)
 
@@ -3807,91 +3767,50 @@ def write_image(self, *args, **kwargs):
 
         Parameters
         ----------
+        fig:
+            Figure object or dict representing a figure
+
         file: str or writeable
             A string representing a local file path or a writeable object
             (e.g. a pathlib.Path object or an open file descriptor)
 
-        format: str or None
-            The desired image format. One of
-              - 'png'
-              - 'jpg' or 'jpeg'
-              - 'webp'
-              - 'svg'
-              - 'pdf'
-              - 'eps' (deprecated) (Requires the poppler library to be installed)
-
-            If not specified and `file` is a string then this will default to the
-            file extension. If not specified and `file` is not a string then this
-            will default to:
-                - `plotly.io.defaults.default_format` if engine is "kaleido"
-                - `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
-
-        width: int or None
-            The width of the exported image in layout pixels. If the `scale`
-            property is 1.0, this will also be the width of the exported image
-            in physical pixels.
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_width` if engine is "kaleido"
-                - `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
-
-        height: int or None
-            The height of the exported image in layout pixels. If the `scale`
-            property is 1.0, this will also be the height of the exported image
-            in physical pixels.
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_height` if engine is "kaleido"
-                - `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
-
-        scale: int or float or None
-            The scale factor to use when exporting the figure. A scale factor
-            larger than 1.0 will increase the image resolution with respect
-            to the figure's layout pixel dimensions. Whereas as scale factor of
-            less than 1.0 will decrease the image resolution.
-
-            If not specified, will default to:
-                - `plotly.io.defaults.default_scale` if engine is "kaleido"
-                - `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
+        format: str
+            (optional) The desired image format. One of:
+            - 'png'
+            - 'jpg' or 'jpeg'
+            - 'webp'
+            - 'svg'
+            - 'pdf'
+            Defaults to the file extension of `file`, if given; otherwise
+            defaults to `plotly.io.defaults.default_format`.
+
+        width: int
+            (optional) The width of the exported image in layout pixels. If the
+            `scale` property is 1.0, this will also be the width of the exported image
+            in physical pixels. Defaults to `plotly.io.defaults.default_width`.
+
+        height: int
+            (optional) The height of the exported image in layout pixels. If the
+            `scale` property is 1.0, this will also be the height of the exported image
+            in physical pixels. Defaults to `plotly.io.defaults.default_height`.
+
+        scale: int or float
+            (optional) The scale factor to use when exporting the figure. A scale
+            factor larger than 1.0 will increase the image resolution with respect
+            to the figure's layout pixel dimensions, while a scale factor of
+            less than 1.0 will decrease the image resolution. Defaults to
+            `plotly.io.defaults.default_scale`.
 
         validate: bool
-            True if the figure should be validated before being converted to
-            an image, False otherwise.
-
-        engine (deprecated): str
-            Image export engine to use. This parameter is deprecated and Orca engine support will be
-            dropped in the next major Plotly version. Until then, the following values are supported:
-            - "kaleido": Use Kaleido for image export
-            - "orca": Use Orca for image export
-            - "auto" (default): Use Kaleido if installed, otherwise use Orca
+            (optional) True if the figure should be validated before being converted
+            to an image, False otherwise. Defaults to True.
 
         Returns
         -------
         None
         """
         import plotly.io as pio
-        from plotly.io.kaleido import (
-            kaleido_available,
-            kaleido_major,
-            ENABLE_KALEIDO_V0_DEPRECATION_WARNINGS,
-            KALEIDO_DEPRECATION_MSG,
-            ORCA_DEPRECATION_MSG,
-            ENGINE_PARAM_DEPRECATION_MSG,
-        )
 
-        if ENABLE_KALEIDO_V0_DEPRECATION_WARNINGS:
-            if (
-                kwargs.get("engine", None) in {None, "auto", "kaleido"}
-                and kaleido_available()
-                and kaleido_major() < 1
-            ):
-                warnings.warn(KALEIDO_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
-            if kwargs.get("engine", None) == "orca":
-                warnings.warn(ORCA_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
-            if kwargs.get("engine", None):
-                warnings.warn(
-                    ENGINE_PARAM_DEPRECATION_MSG, DeprecationWarning, stacklevel=2
-                )
         return pio.write_image(self, *args, **kwargs)
 
     # Static helpers

plotly/io/__init__.py

@@ -10,7 +10,6 @@
         write_images,
         full_figure_for_development,
     )
-    from . import orca, kaleido
     from . import json
     from ._json import to_json, from_json, read_json, write_json
     from ._templates import templates, to_templated
@@ -23,7 +22,6 @@
         "to_image",
         "write_image",
         "write_images",
-        "orca",
         "json",
         "to_json",
         "from_json",
@@ -43,7 +41,7 @@
 else:
     __all__, __getattr__, __dir__ = relative_import(
         __name__,
-        [".orca", ".kaleido", ".json", ".base_renderers"],
+        [".kaleido", ".json", ".base_renderers"],
         [
             "._kaleido.to_image",
             "._kaleido.write_image",