Add pass through kopts dict for kaleido args (#316)

* Add pass through kopts dict for kaleido args

* Update CHANGELOG

* Remove separate n arg entirely

* Add NoneType check to dict destruct

* Add kopts to calc_fig

Author: ayjayt

src/py/CHANGELOG.txt

@@ -1,3 +1,5 @@
+v1.0.0rc12
+- Add `kopts` args to top-level shortcuts to pass args to `Kaleido(**kopts)`
 v1.0.0rc11
 - Write mocker tool to parameterize opts in tests
 - Crop page to pdf size

src/py/kaleido/__init__.py

@@ -33,17 +33,25 @@ async def calc_fig(
     opts=None,
     *,
     topojson=None,
+    kopts=None,
 ):
     """
     Return binary for plotly figure.
 
     A convenience wrapper for `Kaleido.calc_fig()` which starts a `Kaleido` and
     executes the `calc_fig()`.
+    It takes an additional argument, `kopts`, a dictionary of arguments to pass
+    to the kaleido process. See the `kaleido.Kaleido` docs. However,
+    `calc_fig()` will never use more than one processor, so any `n` value will
+    be overridden.
+
 
     See documentation for `Kaleido.calc_fig()`.
 
     """
-    async with Kaleido(n=1) as k:
+    kopts = kopts or {}
+    kopts["n"] = 1
+    async with Kaleido(**kopts) as k:
         return await k.calc_fig(
             fig,
             path=path,
@@ -60,20 +68,21 @@ async def write_fig(  # noqa: PLR0913 (too many args, complexity)
     topojson=None,
     error_log=None,
     profiler=None,
-    n=1,
+    kopts=None,
 ):
     """
     Write a plotly figure(s) to a file.
 
     A convenience wrapper for `Kaleido.write_fig()` which starts a `Kaleido` and
     executes the `write_fig()`.
-    It takes one additional argument, `n`, which can be used to set the number
-    of processes.
+    It takes an additional argument, `kopts`, a dictionary of arguments to pass
+    to the kaleido process. See the `kaleido.Kaleido` docs.
+
 
-    See documentation for `Kaleido.write_fig()`.
+    See documentation for `Kaleido.write_fig()` for the other arguments.
 
     """
-    async with Kaleido(n=n) as k:
+    async with Kaleido(**(kopts or {})) as k:
         await k.write_fig(
             fig,
             path=path,
@@ -89,20 +98,21 @@ async def write_fig_from_object(
     *,
     error_log=None,
     profiler=None,
-    n=1,
+    kopts=None,
 ):
     """
     Write a plotly figure(s) to a file.
 
     A convenience wrapper for `Kaleido.write_fig_from_object()` which starts a
     `Kaleido` and executes the `write_fig_from_object()`
-    It takes one additional argument, `n`, which can be used to set the number
-    of processes.
+    It takes an additional argument, `kopts`, a dictionary of arguments to pass
+    to the kaleido process. See the `kaleido.Kaleido` docs.
 
-    See documentation for `Kaleido.write_fig_from_object()`.
+    See documentation for `Kaleido.write_fig_from_object()` for the other
+    arguments.
 
     """
-    async with Kaleido(n=n) as k:
+    async with Kaleido(**(kopts or {})) as k:
         await k.write_fig_from_object(
             generator,
             error_log=error_log,