DSPy: The framework for programming—not prompting—language models
Python
Fix predict usage tracking (#8146)
Chen Qiand47db83002ac
diff --git a/dspy/predict/predict.py b/dspy/predict/predict.pyindex 7f5612a03..b4a94a367 100644--- a/dspy/predict/predict.py+++ b/dspy/predict/predict.py@@ -11,7 +11,6 @@ from dspy.predict.parameter import Parameterfrom dspy.primitives.prediction import Predictionfrom dspy.primitives.program import Modulefrom dspy.signatures.signature import ensure_signature-from dspy.utils.callback import with_callbackslogger = logging.getLogger(__name__)@@ -71,13 +70,24 @@ class Predict(Module, Parameter):return self- @with_callbacks- def __call__(self, **kwargs):- return self.forward(**kwargs)+ def __call__(self, *args, **kwargs):+ if args:+ raise ValueError(+ "Positional arguments are not allowed when calling `dspy.Predict`, must use keyword arguments "+ "that match your signature input fields. For example: "+ "dspy.Predict('question -> answer')(question='What is the capital of France?')"+ )++ return super().__call__(**kwargs)- @with_callbacks- async def acall(self, **kwargs):- return await self.aforward(**kwargs)+ async def acall(self, *args, **kwargs):+ if args:+ raise ValueError(+ "Positional arguments are not allowed when calling `dspy.Predict`, must use keyword arguments "+ "that match your signature input fields. For example: "+ "dspy.Predict('question -> answer').acall(question='What is the capital of France?')"+ )+ return await super().acall(**kwargs)def _forward_preprocess(self, **kwargs):# Extract the three privileged keyword arguments.diff --git a/tests/predict/test_predict.py b/tests/predict/test_predict.pyindex 3461de479..c60526068 100644--- a/tests/predict/test_predict.py+++ b/tests/predict/test_predict.py@@ -11,6 +11,7 @@ import dspyfrom dspy import Predict, Signaturefrom dspy.utils.dummies import DummyLMfrom unittest.mock import patch, MagicMock, Mock+from litellm import ModelResponsedef test_initialization_with_string_signature():@@ -491,6 +492,30 @@ def test_call_predict_with_chat_history(adapter_type):assert "are you sure that's correct" in messages[3]["content"]+def test_lm_usage():+ program = Predict("question -> answer")+ dspy.settings.configure(lm=dspy.LM("openai/gpt-4o-mini", cache=False), track_usage=True)+ with patch(+ "dspy.clients.lm.litellm_completion",+ return_value=ModelResponse(+ choices=[{"message": {"content": "[[ ## answer ## ]]\nParis"}}],+ usage={"total_tokens": 10},+ ),+ ):+ result = program(question="What is the capital of France?")+ assert result.answer == "Paris"+ assert result.get_lm_usage()["openai/gpt-4o-mini"]["total_tokens"] == 10+++def test_positional_arguments():+ program = Predict("question -> answer")+ with pytest.raises(ValueError) as e:+ program("What is the capital of France?")+ assert "Positional arguments are not allowed when calling `dspy.Predict`, must use keyword arguments" in str(+ e.value+ )++@pytest.mark.parametrize("adapter_type", ["chat", "json"])def test_field_constraints(adapter_type):class SpyLM(dspy.LM):