wip: tox validation for pydantic 1.x version.

Author: eternalcuriouslearner

instrumentation-genai/opentelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/response_extractors.py

@@ -18,20 +18,19 @@
 from collections.abc import Mapping, Sequence
 from typing import TYPE_CHECKING, List, Optional, TypeVar, Union
 
-from pydantic import BaseModel, Field, ValidationError
-
-try:
-    from pydantic import ConfigDict
-
-    _PYDANTIC_V2 = True
-except ImportError:
-    ConfigDict = None
-    _PYDANTIC_V2 = False
+from pydantic import BaseModel, Field, StrictInt, StrictStr, ValidationError
 
 from opentelemetry.semconv._incubating.attributes import (
     openai_attributes as OpenAIAttributes,
 )
 
+_PYDANTIC_V2 = hasattr(BaseModel, "model_validate")
+
+if _PYDANTIC_V2:
+    from pydantic import ConfigDict
+else:
+    ConfigDict = None
+
 if TYPE_CHECKING:
     from opentelemetry.util.genai.types import (
         InputMessage,
@@ -71,51 +70,53 @@ class Config:
 
 
 class _ResponseTextFormatModel(_ExtractorModel):
-    type: Optional[str] = None
+    type: Optional[StrictStr] = None
 
 
 class _ResponseTextConfigModel(_ExtractorModel):
     format: Optional[_ResponseTextFormatModel] = None
 
 
 class _ResponseInputContentModel(_ExtractorModel):
-    text: Optional[str] = None
+    text: Optional[StrictStr] = None
 
 
 class _ResponseInputItemModel(_ExtractorModel):
-    role: Optional[str] = None
-    content: Optional[Union[str, List[_ResponseInputContentModel]]] = None
+    role: Optional[StrictStr] = None
+    content: Optional[Union[StrictStr, List[_ResponseInputContentModel]]] = (
+        None
+    )
 
 
 class _ResponsesRequestModel(_ExtractorModel):
-    instructions: Optional[str] = None
-    input: Optional[Union[str, List[_ResponseInputItemModel]]] = None
+    instructions: Optional[StrictStr] = None
+    input: Optional[Union[StrictStr, List[_ResponseInputItemModel]]] = None
     text: Optional[_ResponseTextConfigModel] = None
 
 
 class _ResponseOutputContentModel(_ExtractorModel):
-    type: Optional[str] = None
-    text: Optional[str] = None
-    refusal: Optional[str] = None
+    type: Optional[StrictStr] = None
+    text: Optional[StrictStr] = None
+    refusal: Optional[StrictStr] = None
 
 
 class _ResponseOutputItemModel(_ExtractorModel):
-    type: Optional[str] = None
-    role: Optional[str] = None
-    status: Optional[str] = None
+    type: Optional[StrictStr] = None
+    role: Optional[StrictStr] = None
+    status: Optional[StrictStr] = None
     content: List[_ResponseOutputContentModel] = Field(default_factory=list)
 
 
 class _UsageDetailsModel(_ExtractorModel):
-    cached_tokens: Optional[int] = None
-    cache_creation_input_tokens: Optional[int] = None
+    cached_tokens: Optional[StrictInt] = None
+    cache_creation_input_tokens: Optional[StrictInt] = None
 
 
 class _UsageModel(_ExtractorModel):
-    input_tokens: Optional[int] = None
-    output_tokens: Optional[int] = None
-    prompt_tokens: Optional[int] = None
-    completion_tokens: Optional[int] = None
+    input_tokens: Optional[StrictInt] = None
+    output_tokens: Optional[StrictInt] = None
+    prompt_tokens: Optional[StrictInt] = None
+    completion_tokens: Optional[StrictInt] = None
     input_tokens_details: Optional[_UsageDetailsModel] = None
     prompt_tokens_details: Optional[_UsageDetailsModel] = None
 
@@ -125,9 +126,9 @@ class _ResponsesResultModel(_ExtractorModel):
     # terminal message items available yet" so downstream extraction helpers
     # naturally return empty lists instead of raising.
     output: List[_ResponseOutputItemModel] = Field(default_factory=list)
-    model: Optional[str] = None
-    id: Optional[str] = None
-    service_tier: Optional[str] = None
+    model: Optional[StrictStr] = None
+    id: Optional[StrictStr] = None
+    service_tier: Optional[StrictStr] = None
     usage: Optional[_UsageModel] = None
 
 
@@ -138,12 +139,19 @@ def _rebuild_model(model_type: type[BaseModel]) -> None:
         model_type.update_forward_refs(**globals())
 
 
-_rebuild_model(_ResponseTextConfigModel)
-_rebuild_model(_ResponseInputItemModel)
-_rebuild_model(_ResponsesRequestModel)
-_rebuild_model(_ResponseOutputItemModel)
-_rebuild_model(_UsageModel)
-_rebuild_model(_ResponsesResultModel)
+for _model_type in (
+    _ResponseTextFormatModel,
+    _ResponseTextConfigModel,
+    _ResponseInputContentModel,
+    _ResponseInputItemModel,
+    _ResponsesRequestModel,
+    _ResponseOutputContentModel,
+    _ResponseOutputItemModel,
+    _UsageDetailsModel,
+    _UsageModel,
+    _ResponsesResultModel,
+):
+    _rebuild_model(_model_type)
 
 
 def _validate_model(

instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/requirements.pydantic1.txt

@@ -0,0 +1,55 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# ********************************
+# WARNING: NOT HERMETIC !!!!!!!!!!
+# ********************************
+#
+# This "requirements.txt" is installed in conjunction
+# with multiple other dependencies in the top-level "tox.ini"
+# file. In particular, please see:
+#
+#   openai-pydantic1: {[testenv]test_deps}
+#   openai-pydantic1: -r {toxinidir}/instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/requirements.pydantic1.txt
+#
+# This provides additional dependencies, namely:
+#
+#   opentelemetry-api
+#   opentelemetry-sdk
+#   opentelemetry-semantic-conventions
+#
+# ... with a "dev" version based on the latest distribution.
+
+
+# This variant of the requirements aims to test the system using
+# the newest supported version of external dependencies with Pydantic 1.x.
+
+openai==1.109.1
+pydantic==1.10.24
+httpx==0.27.2
+# older jiter is required for PyPy < 3.11
+jiter==0.11.1
+Deprecated==1.2.14
+importlib-metadata==6.11.0
+packaging==24.0
+pytest==7.4.4
+pytest-vcr==1.0.2
+pytest-asyncio==0.21.0
+wrapt==1.16.0
+# test with the latest version of opentelemetry-api, sdk, and semantic conventions
+
+-e opentelemetry-instrumentation
+-e instrumentation-genai/opentelemetry-instrumentation-openai-v2
+-e util/opentelemetry-util-genai

instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/test_response_extractors.py

@@ -67,6 +67,10 @@ def _module(block_genai_types_import=False):
     return _load_module(block_genai_types_import)
 
 
+def _validate_compat_model(loaded_module, model_type, value):
+    return loaded_module._validate_model(model_type, value, "test")
+
+
 @pytest.fixture(scope="module", name="loaded_module")
 def _loaded_module_fixture():
     return _module()
@@ -329,7 +333,9 @@ def test_set_invocation_response_attributes_populates_output_messages(
 def test_prevalidated_response_model_skips_revalidation(
     loaded_module, monkeypatch
 ):
-    validated_result = loaded_module._ResponsesResultModel.model_validate(
+    validated_result = _validate_compat_model(
+        loaded_module,
+        loaded_module._ResponsesResultModel,
         SimpleNamespace(
             output=[
                 SimpleNamespace(
@@ -338,8 +344,9 @@ def test_prevalidated_response_model_skips_revalidation(
                     content=[SimpleNamespace(type="output_text", text="Done")],
                 )
             ]
-        )
+        ),
     )
+    assert validated_result is not None
 
     def _unexpected_validation(_result):
         raise AssertionError("unexpected response revalidation")
@@ -358,7 +365,7 @@ def _unexpected_validation(_result):
     [
         ({"instructions": ["not-a-string"]}, "_extract_system_instruction"),
         ({"input": 42}, "_extract_input_messages"),
-        ({"text": {"format": 42}}, "_extract_output_type"),
+        ({"text": {"format": {"type": 42}}}, "_extract_output_type"),
     ],
 )
 def test_request_validation_errors_are_logged_and_ignored(

tox.ini

@@ -10,6 +10,7 @@ envlist =
 
     ; instrumentation-openai
     py3{9,10,11,12,13,14}-test-instrumentation-openai-v2-{oldest,latest}
+    py313-test-instrumentation-openai-v2-pydantic1
     pypy3-test-instrumentation-openai-v2-{oldest,latest}
     lint-instrumentation-openai-v2
 
@@ -482,6 +483,8 @@ deps =
   # and the latest version of OTel API and SDK
   openai-latest: {[testenv]test_deps}
   openai-latest: -r {toxinidir}/instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/requirements.latest.txt
+  openai-pydantic1: {[testenv]test_deps}
+  openai-pydantic1: -r {toxinidir}/instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/requirements.pydantic1.txt
   lint-instrumentation-openai-v2: -r {toxinidir}/instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/requirements.oldest.txt
   openai_agents-oldest: -r {toxinidir}/instrumentation-genai/opentelemetry-instrumentation-openai-agents-v2/tests/requirements.oldest.txt
   openai_agents-latest: {[testenv]test_deps}