Use pydantic v1 shim for messages models to eliminate update_forward_refs warnings (#2108)

* Replace deprecated update_forward_refs() with version-conditional model_rebuild()

Use model_rebuild() when running under pydantic v2, fall back to
update_forward_refs() for pydantic v1 compatibility. This eliminates
PydanticDeprecatedSince20 warnings in downstream projects using pydantic v2.

Co-Authored-By: Itamar Hartstein <haritamar@gmail.com>

* Use pydantic_shim for BaseModel in messages package

Switch all messages modules from 'from pydantic import BaseModel' to
'from elementary.utils.pydantic_shim import BaseModel'. This uses the
existing v1 shim so update_forward_refs() is the native v1 API call
and no PydanticDeprecatedSince20 warnings are emitted under pydantic v2.

Co-Authored-By: Itamar Hartstein <haritamar@gmail.com>

* Fix import sorting for isort --profile black

Co-Authored-By: Itamar Hartstein <haritamar@gmail.com>

* Convert remaining from pydantic import BaseModel to use pydantic_shim

Co-Authored-By: Itamar Hartstein <haritamar@gmail.com>

* Fix isort ordering for pydantic_shim imports

Co-Authored-By: Itamar Hartstein <haritamar@gmail.com>

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Itamar Hartstein <haritamar@gmail.com>

Author: devin-ai-integration[bot]

elementary/clients/slack/slack_message_builder.py

@@ -1,11 +1,11 @@
 from enum import Enum
 from typing import List, Optional, Union
 
-from pydantic import BaseModel
 from slack_sdk.models.blocks import HeaderBlock, SectionBlock
 
 from elementary.clients.slack.schema import SlackBlocksType, SlackMessageSchema
 from elementary.utils.json_utils import unpack_and_flatten_str_to_list
+from elementary.utils.pydantic_shim import BaseModel
 
 
 class OptionSchema(BaseModel):

elementary/messages/blocks.py

@@ -1,9 +1,10 @@
 from enum import Enum
 from typing import Any, Dict, List, Optional, Sequence, Union
 
-from pydantic import BaseModel
 from typing_extensions import Literal
 
+from elementary.utils.pydantic_shim import BaseModel
+
 
 class Icon(Enum):
     RED_TRIANGLE = "red_triangle"
@@ -184,5 +185,4 @@ class ExpandableBlock(BaseBlock):
     "ExpandableBlock",
 ]
 
-# Update forward references for recursive types
 ExpandableBlock.update_forward_refs()

elementary/messages/formats/block_kit.py

@@ -1,7 +1,6 @@
 import json
 from typing import Any, Callable, List, Optional, Tuple
 
-from pydantic import BaseModel
 from slack_sdk.models import blocks as slack_blocks
 from tabulate import tabulate
 
@@ -31,6 +30,7 @@
 )
 from elementary.messages.formats.unicode import ICON_TO_UNICODE
 from elementary.messages.message_body import Color, MessageBlock, MessageBody
+from elementary.utils.pydantic_shim import BaseModel
 
 COLOR_MAP = {
     Color.RED: "#ff0000",

elementary/messages/message_body.py

@@ -1,8 +1,6 @@
 from enum import Enum
 from typing import List, Optional, Union
 
-from pydantic import BaseModel
-
 from elementary.messages.blocks import (
     ActionsBlock,
     CodeBlock,
@@ -13,6 +11,7 @@
     LinesBlock,
     TableBlock,
 )
+from elementary.utils.pydantic_shim import BaseModel
 
 
 class Color(Enum):

elementary/messages/messaging_integrations/base_messaging_integration.py

@@ -2,13 +2,12 @@
 from datetime import datetime
 from typing import Any, Generic, Optional, TypeVar
 
-from pydantic import BaseModel
-
 from elementary.messages.message_body import MessageBody
 from elementary.messages.messaging_integrations.exceptions import (
     MessageIntegrationReplyNotSupportedError,
 )
 from elementary.utils.log import get_logger
+from elementary.utils.pydantic_shim import BaseModel
 
 logger = get_logger(__name__)
 

elementary/messages/messaging_integrations/empty_message_context.py

@@ -1,4 +1,4 @@
-from pydantic import BaseModel
+from elementary.utils.pydantic_shim import BaseModel
 
 
 class EmptyMessageContext(BaseModel):

elementary/messages/messaging_integrations/slack_web.py

@@ -2,7 +2,6 @@
 import time
 from typing import Any, Dict, Iterator, Optional
 
-from pydantic import BaseModel
 from ratelimit import limits, sleep_and_retry
 from slack_sdk import WebClient
 from slack_sdk.errors import SlackApiError
@@ -23,6 +22,7 @@
 )
 from elementary.tracking.tracking_interface import Tracking
 from elementary.utils.log import get_logger
+from elementary.utils.pydantic_shim import BaseModel
 
 logger = get_logger(__name__)
 

elementary/monitor/alerts/alert_messages/builder.py

@@ -1,8 +1,6 @@
 from datetime import timedelta
 from typing import Any, Dict, List, Literal, Optional, Sequence, Tuple, Union
 
-from pydantic import BaseModel
-
 from elementary.messages.block_builders import (
     BoldTextBlock,
     BoldTextLineBlock,
@@ -51,6 +49,7 @@
 from elementary.monitor.data_monitoring.alerts.integrations.utils.report_link import (
     ReportLinkData,
 )
+from elementary.utils.pydantic_shim import BaseModel
 
 AlertType = Union[
     TestAlertModel,

elementary/monitor/data_monitoring/alerts/integrations/slack/message_builder.py

@@ -1,9 +1,8 @@
 from typing import Optional
 
-from pydantic import BaseModel
-
 from elementary.clients.slack.schema import SlackBlocksType, SlackMessageSchema
 from elementary.clients.slack.slack_message_builder import SlackMessageBuilder
+from elementary.utils.pydantic_shim import BaseModel
 
 
 class PreviewIsTooLongError(Exception):

tests/unit/messages/messaging_integrations/test_mapped.py

@@ -3,7 +3,6 @@
 from unittest.mock import MagicMock
 
 import pytest
-from pydantic import BaseModel
 
 from elementary.messages.blocks import HeaderBlock
 from elementary.messages.message_body import MessageBody
@@ -15,6 +14,7 @@
     MessagingIntegrationError,
 )
 from elementary.messages.messaging_integrations.mapped import MappedMessagingIntegration
+from elementary.utils.pydantic_shim import BaseModel
 
 
 class MockMessageContext(BaseModel):