performance_log can be bool

Author: jpn--

activitysim/core/configuration/base.py

@@ -234,14 +234,27 @@ def pandas_option_context(self):
         else:
             yield
 
-    performance_log: Path | None = None
+    performance_log: Path | bool | None = None
     """Log runtime performance to this file.
 
     The runtime performance log shows the time taken to evaluate each
     expression in the specification files.  It is useful for debugging
     performance issues with complex expressions.
 
-    If set to None (the default), no performance logging will be done."""
+    Giving a filename here will override the global performance logging
+    setting, and will log performance to the specified file, unless the
+    global performance logging setting is set to `False`, in which case
+    no performance logging will be done for any component.
+
+    If set to `True`, performance logging will be activated, and the filename
+    will be chosen based on the trace label for this component.
+
+    If this path is set to None (the default), performance logging will be
+    activated based on the global performance logging setting, and the filename
+    will be chosen based on the trace label for this component.  This is strongly
+    recommended for most use cases, unless the trace label causes the filename
+    to be too long or otherwise unsuitable for the filesystem.
+    """
 
     def subcomponent_settings(self, subcomponent: str) -> ComputeSettings:
         """Get the sharrow settings for a particular subcomponent."""

activitysim/core/interaction_simulate.py

@@ -270,8 +270,13 @@ def to_series(x):
                 and compute_settings.performance_log is None
             ):
                 perf_log_file = Path(trace_label + ".log")
-            elif state.settings.expression_profile is False:
+            elif (
+                state.settings.expression_profile is False
+                or compute_settings.performance_log is False
+            ):
                 perf_log_file = None
+            elif compute_settings.performance_log is True:
+                perf_log_file = Path(trace_label + ".log")
             else:
                 perf_log_file = compute_settings.performance_log
             performance_timer = timing.EvalTiming(perf_log_file)

activitysim/core/simulate.py

@@ -634,8 +634,13 @@ def eval_utilities(
             and compute_settings.performance_log is None
         ):
             perf_log_file = Path(trace_label + ".log")
-        elif state.settings.expression_profile is False:
+        elif (
+            state.settings.expression_profile is False
+            or compute_settings.performance_log is False
+        ):
             perf_log_file = None
+        elif compute_settings.performance_log is True:
+            perf_log_file = Path(trace_label + ".log")
         else:
             perf_log_file = compute_settings.performance_log
         performance_timer = timing.EvalTiming(perf_log_file)