Skip to content
Open
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions python/semantic_kernel/functions/kernel_function.py
Original file line number Diff line number Diff line change
Expand Up @@ -388,9 +388,12 @@ def function_copy(self, plugin_name: str | None = None) -> "KernelFunction":
KernelFunction: The copied function.
"""
cop: KernelFunction = copy(self)
cop.metadata = deepcopy(self.metadata)
if plugin_name:
cop.metadata.plugin_name = plugin_name
# Always deep-copy metadata to avoid shared mutable state between function copies.
new_plugin_name = plugin_name if plugin_name is not None else self.metadata.plugin_name
cop.metadata = self.metadata.model_copy(
update={"plugin_name": new_plugin_name},
deep=True,
)
return cop

def _handle_exception(self, current_span: trace.Span, exception: Exception, attributes: dict[str, str]) -> None:
Expand Down
97 changes: 97 additions & 0 deletions python/tests/unit/functions/test_function_copy_optimization.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Copyright (c) Microsoft. All rights reserved.

"""Tests for function_copy optimization (Issue #1: Lazy deepcopy)."""

import pytest
from unittest.mock import patch

from semantic_kernel.functions import kernel_function


@pytest.fixture
def sample_function():
@kernel_function
def test_func(input: str) -> str:
return f"Result: {input}"

from semantic_kernel.functions.kernel_function_from_method import KernelFunctionFromMethod
return KernelFunctionFromMethod(method=test_func, plugin_name="test_plugin")


class TestFunctionCopyOptimization:
"""Test suite for function_copy lazy deepcopy optimization."""

def test_function_copy_same_plugin_no_deepcopy(self, sample_function):
"""Test that function_copy doesn't deepcopy when plugin_name is same or None.

This tests the optimization where metadata is reused when no plugin_name change.
"""
original_plugin = sample_function.plugin_name

# Case 1: No plugin_name provided (should reuse reference)
copy1 = sample_function.function_copy()
assert copy1.metadata is sample_function.metadata # Should be same reference
assert copy1.plugin_name == original_plugin

# Case 2: Same plugin_name provided (should reuse reference)
copy2 = sample_function.function_copy(original_plugin)
assert copy2.metadata is sample_function.metadata # Should be same reference

def test_function_copy_different_plugin_creates_copy(self, sample_function):
"""Test that function_copy does create a shallow copy when plugin_name changes.

This tests that when we actually need to change the plugin_name,
a shallow copy is created.
"""
new_plugin_name = "new_plugin"
copy = sample_function.function_copy(new_plugin_name)

# Metadata should be different object (copied)
assert copy.metadata is not sample_function.metadata
# But should have the new plugin_name
assert copy.metadata.plugin_name == new_plugin_name
# Original should be unchanged
assert sample_function.metadata.plugin_name != new_plugin_name

def test_function_copy_preserves_function_behavior(self, sample_function):
"""Test that copied function still works correctly."""
copy = sample_function.function_copy()

# Verify function metadata is preserved
assert copy.name == sample_function.name
assert copy.description == sample_function.description
# Verify function is callable (indirectly through having same underlying function)
assert hasattr(copy, 'invoke')

@patch('semantic_kernel.functions.kernel_function.deepcopy', side_effect=AssertionError("deepcopy should not be called"))
def test_function_copy_no_unnecessary_deepcopy(self, mock_deepcopy, sample_function):
"""Test that deepcopy is NOT called when plugin_name doesn't change.

This is the key optimization test - it verifies that the old problematic
deepcopy is not being called anymore.
"""
# When plugin_name is None or same, deepcopy should not be called
original_metadata = sample_function.metadata
try:
copy = sample_function.function_copy()
# If we get here, deepcopy was not called and metadata reference was reused
assert copy.metadata is original_metadata
except AssertionError as e:
if "deepcopy should not be called" in str(e):
pytest.fail("function_copy still calls deepcopy unnecessarily")
raise

def test_function_copy_multiple_calls_same_plugin(self, sample_function):
"""Test that multiple copies with same plugin reuse metadata.

This tests the performance benefit of reusing metadata references
when no change is needed.
"""
copy1 = sample_function.function_copy()
copy2 = sample_function.function_copy()
copy3 = sample_function.function_copy(sample_function.plugin_name)

# All should reference the same original metadata
assert copy1.metadata is sample_function.metadata
assert copy2.metadata is sample_function.metadata
assert copy3.metadata is sample_function.metadata
Loading