Terminate create_plots immediately if SMOKE_TEST is set

Author: AVHopp

baybe/utils/plotting.py

@@ -17,7 +17,8 @@ def create_plots(data: pd.DataFrame, path: Path, base_name: str, **kwargs) -> No
     The plots will be saved in the location specified by ``path``.
     The attribute ``base_name`` is used to define the name of the outputs.
 
-    If the ``SMOKE_TEST`` variable is set, no plots are being saved.
+    If the ``SMOKE_TEST`` variable is set, no plots are being created and this method
+    immediately returns.
 
     Using the ``BAYBE_MULTIVERSION_PLOTS`` environment variable, it is possible to
     create plots for the light and dark version of the documentation. If this variable
@@ -30,7 +31,10 @@ def create_plots(data: pd.DataFrame, path: Path, base_name: str, **kwargs) -> No
         **kwargs: Keyword arguments. They are directly passed to ``sns.lineplot`` and
             are used for specifying the plot.
     """
-    # First, we see if we happen to find the plotting themes in the current folder.
+    # If we run a SMOKE_TEST, we immediately return
+    if "SMOKE_TEST" in os.environ:
+        return
+    # We see if we happen to find the plotting themes in the current folder.
     # This is e.g. the case if we convert the file to a jupyter notebook.
     try:
         themes = json.load(open("plotting_themes.json"))
@@ -64,12 +68,11 @@ def create_plots(data: pd.DataFrame, path: Path, base_name: str, **kwargs) -> No
         if kwargs:
             sns.lineplot(data=data, **kwargs)
             output_path = Path(path, f"{base_name}_{theme_name}.svg")
-            if "SMOKE_TEST" not in os.environ:
-                plt.savefig(
-                    output_path,
-                    format="svg",
-                    transparent=True,
-                )
-                plt.clf()
+            plt.savefig(
+                output_path,
+                format="svg",
+                transparent=True,
+            )
+            plt.clf()
         else:
             warnings.warn("No keyword arguments were provided when plotting.")