add timestamping to expression profile logs

Author: jpn--

activitysim/core/timing.py

@@ -99,7 +99,7 @@ def write_log(self, state: State) -> None:
             filename = self.log_file
         else:
             filename = state.get_log_file_path(
-                str(Path("expr-performance") / self.log_file)
+                str(Path("expr-performance") / self.log_file), timestamped=True
             )
 
         # if the log file already exists and overwrite is false, create a new file
@@ -191,7 +191,9 @@ def _read_log(self, log_file: Path) -> pd.DataFrame:
         return df
 
     def __init__(self, state: State, collect_mp: bool = True) -> None:
-        self.log_dir = state.get_log_file_path(str(Path("expr-performance")))
+        self.log_dir = state.get_log_file_path(
+            str(Path("expr-performance")), timestamped=True
+        )
         self.default_cutoff = state.settings.expression_profile_cutoff
         raw_data = {}
         for f in self.log_dir.glob("*.log"):
@@ -205,7 +207,9 @@ def __init__(self, state: State, collect_mp: bool = True) -> None:
 
         if collect_mp:
             raw_data = {}
-            mp_log_dirs = state.get_log_file_path(".").glob("*-expr-performance")
+            mp_log_dirs = state.get_log_file_path(".", timestamped=True).glob(
+                "*-expr-performance"
+            )
             for mp_log_dir in mp_log_dirs:
                 subproc_name = "-".join(mp_log_dir.stem.split("-")[:-2])
                 for f in mp_log_dir.glob("*.log"):

activitysim/core/workflow/state.py

@@ -1142,7 +1142,9 @@ def get_output_file_path(self, file_name: str, prefix: str | bool = None) -> Pat
             file_name = f"{prefix}-{file_name}"
         return self.filesystem.get_output_dir().joinpath(file_name)
 
-    def get_log_file_path(self, file_name: str, prefix: bool = True) -> Path:
+    def get_log_file_path(
+        self, file_name: str, prefix: bool = True, timestamped: bool = False
+    ) -> Path:
         """
         Get the log file path for this process.
 
@@ -1159,6 +1161,10 @@ def get_log_file_path(self, file_name: str, prefix: bool = True) -> Path:
             value of the prefix id drawn from the "log_file_prefix" key within
             this state.  If that key is not set, no prefix is added regardless
             of the value of this argument.
+        timestamped : bool, default False
+            Whether to add a timestamp to the log file name. If True, a
+            timestamp is added as a directory prefix to the log file name,
+            and the directory is created if it does not already exist.
 
         Returns
         -------
@@ -1167,6 +1173,19 @@ def get_log_file_path(self, file_name: str, prefix: bool = True) -> Path:
         prefix = prefix and self.get_injectable("log_file_prefix", None)
         if prefix:
             file_name = f"{prefix}-{file_name}"
+        if timestamped:
+            from datetime import datetime
+
+            timestamp = self.get("run_timestamp", None)
+            if timestamp is None:
+                # if no run timestamp, use current time, and store it so
+                # it can be used later in the same run
+                timestamp = datetime.now().strftime("%Y%m%d-%H%M%S")
+                self.set("run_timestamp", timestamp)
+                self.filesystem.get_log_file_path(timestamp).mkdir(
+                    parents=True, exist_ok=True
+                )
+            file_name = os.path.join(timestamp, file_name)
         return self.filesystem.get_log_file_path(file_name)
 
     def set_step_args(self, args=None):