rename callpattern

Author: patricktnast

src/vivarium_profiling/tools/extraction.py

@@ -1,8 +1,9 @@
 """Data extraction utilities for benchmark profiling results.
 
 This module provides configurable extraction of profiling metrics from cProfile
-stats files and memory profiler output. The extraction is driven by CallPattern
-objects that map logical names to regex patterns for matching function calls.
+stats files and memory profiler output. The extraction is driven by
+FunctionCallConfiguration objects that map logical names to regex patterns for
+matching function calls.
 """
 
 from __future__ import annotations
@@ -17,7 +18,7 @@
 
 
 @dataclass
-class CallPattern:
+class FunctionCallConfiguration:
     """Configuration for extracting metrics for a specific function from cProfile stats.
 
     Attributes
@@ -88,8 +89,10 @@ def columns(self) -> list[str]:
         return cols
 
 
-def bottleneck_config(name: str, filename: str, function_name: str) -> CallPattern:
-    """Create a CallPattern for a bottleneck function (extracts all 3 metrics).
+def bottleneck_config(
+    name: str, filename: str, function_name: str
+) -> FunctionCallConfiguration:
+    """Create a FunctionCallConfiguration for a bottleneck function (extracts all 3 metrics).
 
     Parameters
     ----------
@@ -102,10 +105,10 @@ def bottleneck_config(name: str, filename: str, function_name: str) -> CallPatte
 
     Returns
     -------
-        CallPattern configured for bottleneck extraction.
+        FunctionCallConfiguration configured for bottleneck extraction.
 
     """
-    return CallPattern(
+    return FunctionCallConfiguration(
         name=name,
         filename=filename,
         function_name=function_name,
@@ -115,8 +118,10 @@ def bottleneck_config(name: str, filename: str, function_name: str) -> CallPatte
     )
 
 
-def phase_config(name: str, filename: str = "/vivarium/framework/engine.py") -> CallPattern:
-    """Create a CallPattern for a simulation phase (extracts cumtime only).
+def phase_config(
+    name: str, filename: str = "/vivarium/framework/engine.py"
+) -> FunctionCallConfiguration:
+    """Create a FunctionCallConfiguration for a simulation phase (extracts cumtime only).
 
     Parameters
     ----------
@@ -127,10 +132,10 @@ def phase_config(name: str, filename: str = "/vivarium/framework/engine.py") ->
 
     Returns
     -------
-        CallPattern configured for phase extraction.
+        FunctionCallConfiguration configured for phase extraction.
 
     """
-    return CallPattern(
+    return FunctionCallConfiguration(
         name=name,
         filename=filename,
         function_name=name,
@@ -177,11 +182,11 @@ class ExtractionConfig:
     Attributes
     ----------
     patterns
-        List of CallPattern objects defining what metrics to extract.
+        List of FunctionCallConfiguration objects defining what metrics to extract.
 
     """
 
-    def __init__(self, patterns: list[CallPattern] | None = None):
+    def __init__(self, patterns: list[FunctionCallConfiguration] | None = None):
         if patterns is None:
             patterns = DEFAULT_BOTTLENECKS + DEFAULT_PHASES
         self.patterns = patterns

tests/test_extraction.py

@@ -1,21 +1,23 @@
 """Unit tests for extraction utilities."""
 
 from vivarium_profiling.tools.extraction import (
-    CallPattern,
     ExtractionConfig,
+    FunctionCallConfiguration,
     bottleneck_config,
     extract_runtime,
     parse_function_metrics,
     phase_config,
 )
 
 
-class TestCallPattern:
-    """Tests for CallPattern dataclass."""
+class TestFunctionCallConfiguration:
+    """Tests for FunctionCallConfiguration dataclass."""
 
-    def test_call_pattern_defaults(self):
-        """Test CallPattern with default extraction flags."""
-        pattern = CallPattern(name="test_func", filename="test.py", function_name="test_func")
+    def test_function_call_configuration_defaults(self):
+        """Test FunctionCallConfiguration with default extraction flags."""
+        pattern = FunctionCallConfiguration(
+            name="test_func", filename="test.py", function_name="test_func"
+        )
 
         assert pattern.name == "test_func"
         assert pattern.filename == "test.py"
@@ -29,9 +31,9 @@ def test_call_pattern_defaults(self):
         assert pattern.ncalls_col == "test_func_ncalls"
         assert pattern.columns == ["test_func_cumtime"]
 
-    def test_call_pattern_all_extracts(self):
-        """Test CallPattern with all extraction flags enabled."""
-        pattern = CallPattern(
+    def test_function_call_configuration_all_extracts(self):
+        """Test FunctionCallConfiguration with all extraction flags enabled."""
+        pattern = FunctionCallConfiguration(
             name="bottleneck",
             filename="test.py",
             function_name="bottleneck",
@@ -47,9 +49,9 @@ def test_call_pattern_all_extracts(self):
             "bottleneck_ncalls",
         ]
 
-    def test_call_pattern_custom_templates(self):
-        """Test CallPattern with custom column templates."""
-        pattern = CallPattern(
+    def test_function_call_configuration_custom_templates(self):
+        """Test FunctionCallConfiguration with custom column templates."""
+        pattern = FunctionCallConfiguration(
             name="phase",
             filename="engine.py",
             function_name="phase",
@@ -76,7 +78,7 @@ def test_extraction_config_defaults(self):
     def test_extraction_config_custom_patterns(self):
         """Test ExtractionConfig with custom patterns."""
         patterns = [
-            CallPattern("func1", "test.py", "func1"),
+            FunctionCallConfiguration("func1", "test.py", "func1"),
             bottleneck_config("func2", "test.py", "func2"),
         ]
         config = ExtractionConfig(patterns=patterns)
@@ -87,16 +89,18 @@ def test_extraction_config_custom_patterns(self):
     def test_metric_columns(self):
         """Test metric_columns property."""
         patterns = [
-            CallPattern("a", "test.py", "a", extract_cumtime=True, extract_percall=True),
-            CallPattern("b", "test.py", "b", extract_cumtime=True),
+            FunctionCallConfiguration(
+                "a", "test.py", "a", extract_cumtime=True, extract_percall=True
+            ),
+            FunctionCallConfiguration("b", "test.py", "b", extract_cumtime=True),
         ]
         config = ExtractionConfig(patterns=patterns)
 
         assert config.metric_columns == ["a_cumtime", "a_percall", "b_cumtime"]
 
     def test_results_columns(self):
         """Test results_columns includes base columns."""
-        patterns = [CallPattern("test", "test.py", "test")]
+        patterns = [FunctionCallConfiguration("test", "test.py", "test")]
         config = ExtractionConfig(patterns=patterns)
 
         cols = config.results_columns
@@ -181,7 +185,7 @@ def test_extract_metrics_default_patterns(self, sample_stats_file):
     def test_extract_metrics_custom_patterns(self, sample_stats_file):
         """Test extracting metrics with custom patterns."""
         patterns = [
-            CallPattern(
+            FunctionCallConfiguration(
                 "custom_func",
                 "some/custom/module.py",
                 "custom_function",
@@ -202,7 +206,7 @@ def test_extract_metrics_custom_patterns(self, sample_stats_file):
 
     def test_extract_metrics_missing_patterns(self, sample_stats_file):
         """Test extracting metrics when patterns don't match."""
-        patterns = [CallPattern("missing", "nonexistent.py", "missing")]
+        patterns = [FunctionCallConfiguration("missing", "nonexistent.py", "missing")]
         config = ExtractionConfig(patterns=patterns)
         metrics = config.extract_metrics(sample_stats_file)