Replace deprecated pandas.Series.iteritems

src/adtk/data/_data.py

@@ -161,7 +161,13 @@ def validate_events(
     merged_event_list = (
         []
     )  # type: List[Union[Tuple[pd.Timestamp, pd.Timestamp], pd.Timestamp]]
-    for t, v in time_window_end_series.iteritems():  # type: pd.Timestamp, int
+    # @modified 20240113 - earthgecko/adtk - Task #5224: Replace deprecated pandas.Series.iteritems
+    #                      earthgecko/skyline - Bug #5222: adtk - pandas error
+    # arundo/adtk - https://github.com/arundo/adtk/issues/147
+    # pandas.Series.iteritems - https://pandas.pydata.org/pandas-docs/version/1.5/reference/api/pandas.Series.iteritems.html
+    # Deprecated since version 1.5.0: iteritems is deprecated and will be removed in a future version. Use .items instead.
+    # for t, v in time_window_end_series.iteritems():  # type: pd.Timestamp, int
+    for t, v in time_window_end_series.items():  # type: pd.Timestamp, int
         if (status == 0) and (v > 0):
             start = t  # type: pd.Timestamp
             status = 1
@@ -588,7 +594,13 @@ def expand_events(  # type:ignore
                     right_expand=right_expand,
                     freq_as_period=freq_as_period,
                 )
-                for _, s in events.iteritems()
+                # @modified 20240113 - earthgecko/adtk - Task #5224: Replace deprecated pandas.Series.iteritems
+                #                      earthgecko/skyline - Bug #5222: adtk - pandas error
+                # arundo/adtk - https://github.com/arundo/adtk/issues/147
+                # pandas.Series.iteritems - https://pandas.pydata.org/pandas-docs/version/1.5/reference/api/pandas.Series.iteritems.html
+                # Deprecated since version 1.5.0: iteritems is deprecated and will be removed in a future version. Use .items instead.
+                # for _, s in events.iteritems()
+                for _, s in events.iter()
             ],
             axis=1,
         )  # type: pd.DataFrame

src/adtk/visualization/_visualization.py

@@ -2,6 +2,7 @@
 We don't typing the visualization module because there are a lot recursion on
 nested tree structure which would be messy if we type rigorously."""
 
+import os
 import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
@@ -31,6 +32,8 @@ def plot(
     axes=None,
     figsize=None,
     legend=True,
+    title="",
+    save_to_file="",
 ):
     """Plot time series and/or anomalies.
 
@@ -191,6 +194,14 @@ def plot(
     legend: bool, optional
         Whether to show legend in the plot. Default: True.
 
+    title: str, optional
+        The title add to the plot.
+        Default: "".
+
+    save_to_file: str, optional
+        The full path and filename where to save the plot as a png image.
+        Default: "".
+
     Returns
     --------
     matplotlib Axes object or array of Axes objects
@@ -329,6 +340,41 @@ def plot(
         for ax in axes:
             ax.legend()
 
+    # title
+    if title != "":
+        try:
+            plt.suptitle(title, fontsize=12)
+        except Exception as e:
+            print("could not add title to plot - {}".format(e))
+
+    # save_to_file
+    save_to_file_path = None
+    if save_to_file != "":
+        try:
+            save_to_file_path = os.path.dirname(save_to_file)
+        except Exception as e:
+            print(
+                "{} not a valid path/filename for "
+                "save_to_file - %s".format(save_to_file, e))
+
+    save_to_file_path_exists = False
+    if save_to_file_path:
+        try:
+            if os.path.exists(save_to_file_path):
+                save_to_file_path_exists = True
+        except Exception as e:
+            print(
+                "{} is not a valid path in "
+                "save_to_file - {}".format(save_to_file, e))
+    if save_to_file_path_exists:
+        try:
+            plt.savefig(save_to_file, dpi=100)
+            os.chmod(save_to_file, mode=0o644)
+        except Exception as e:
+            print(
+                "error: failed to save plot to "
+                "%s - %s".format(save_to_file, e))
+
     return axes