Add short_version and use it in links (#7115)

pydantic/_internal/_generate_schema.py

@@ -41,7 +41,7 @@
 from ..errors import PydanticSchemaGenerationError, PydanticUndefinedAnnotation, PydanticUserError
 from ..fields import AliasChoices, AliasPath, FieldInfo
 from ..json_schema import JsonSchemaValue
-from ..version import VERSION
+from ..version import version_short
 from ..warnings import PydanticDeprecatedSince20
 from . import _decorators, _discriminated_union, _known_annotated_metadata, _typing_extra
 from ._annotated_handlers import GetCoreSchemaHandler, GetJsonSchemaHandler
@@ -249,7 +249,7 @@ def _add_custom_serialization_from_json_encoders(
             continue
 
         warnings.warn(
-            f'`json_encoders` is deprecated. See https://docs.pydantic.dev/{VERSION}/usage/serialization/#custom-serializers for alternatives',
+            f'`json_encoders` is deprecated. See https://docs.pydantic.dev/{version_short()}/usage/serialization/#custom-serializers for alternatives',
             PydanticDeprecatedSince20,
         )
 

pydantic/_migration.py

@@ -3,7 +3,7 @@
 from typing import Any, Callable, Dict
 
 from ._internal._validators import import_string
-from .version import VERSION
+from .version import version_short
 
 MOVED_IN_V2 = {
     'pydantic.utils:version_info': 'pydantic.version:version_info',
@@ -288,7 +288,7 @@ def wrapper(name: str) -> object:
         if import_path == 'pydantic:BaseSettings':
             raise PydanticImportError(
                 '`BaseSettings` has been moved to the `pydantic-settings` package. '
-                f'See https://docs.pydantic.dev/{".".join(VERSION.split(".")[:2])}/migration/#basesettings-has-moved-to-pydantic-settings '
+                f'See https://docs.pydantic.dev/{version_short()}/migration/#basesettings-has-moved-to-pydantic-settings '
                 'for more details.'
             )
         if import_path in REMOVED_IN_V2:

pydantic/errors.py

@@ -6,7 +6,7 @@
 from typing_extensions import Literal, Self
 
 from ._migration import getattr_migration
-from .version import VERSION
+from .version import version_short
 
 __all__ = (
     'PydanticUserError',
@@ -20,7 +20,7 @@
 # We use this URL to allow for future flexibility about how we host the docs, while allowing for Pydantic
 # code in the while with "old" URLs to still work.
 # 'u' refers to "user errors" - e.g. errors caused by developers using pydantic, as opposed to validation errors.
-DEV_ERROR_DOCS_URL = f'https://errors.pydantic.dev/{VERSION}/u/'
+DEV_ERROR_DOCS_URL = f'https://errors.pydantic.dev/{version_short()}/u/'
 PydanticErrorCodes = Literal[
     'class-not-fully-defined',
     'custom-json-schema',

pydantic/version.py

@@ -7,6 +7,14 @@
 """The version of Pydantic."""
 
 
+def version_short() -> str:
+    """Return the major.minor part of Pydantic version.
+
+    It return '2.1' if Pydantic version is '2.1.1'.
+    """
+    return '.'.join(VERSION.split('.')[:2])
+
+
 def version_info() -> str:
     """Return complete version information for Pydantic and its dependencies."""
     import platform

pydantic/warnings.py

@@ -1,7 +1,7 @@
 """Pydantic-specific warnings."""
 from __future__ import annotations as _annotations
 
-from .version import VERSION
+from .version import version_short
 
 __all__ = 'PydanticDeprecatedSince20', 'PydanticDeprecationWarning'
 
@@ -36,7 +36,7 @@ def __str__(self) -> str:
             f' to be removed in V{self.expected_removal[0]}.{self.expected_removal[1]}.'
         )
         if self.since == (2, 0):
-            message += f' See Pydantic V2 Migration Guide at https://errors.pydantic.dev/{VERSION}/migration/'
+            message += f' See Pydantic V2 Migration Guide at https://errors.pydantic.dev/{version_short()}/migration/'
         return message
 
 

tests/test_errors.py

@@ -3,7 +3,7 @@
 import pytest
 
 from pydantic import BaseModel, PydanticUserError, ValidationError
-from pydantic.version import VERSION
+from pydantic.version import version_short
 
 
 def test_user_error_url():
@@ -13,7 +13,7 @@ def test_user_error_url():
     # insert_assert(str(exc_info.value))
     assert str(exc_info.value) == (
         'Pydantic models should inherit from BaseModel, BaseModel cannot be instantiated directly\n\n'
-        f'For further information visit https://errors.pydantic.dev/{VERSION}/u/base-model-instantiated'
+        f'For further information visit https://errors.pydantic.dev/{version_short()}/u/base-model-instantiated'
     )
 
 

tests/test_version.py

@@ -1,9 +1,11 @@
 import re
+from unittest.mock import patch
 
+import pytest
 from packaging.version import parse as parse_version
 
 import pydantic
-from pydantic.version import version_info
+from pydantic.version import version_info, version_short
 
 
 def test_version_info():
@@ -23,3 +25,9 @@ def test_version_attribute_is_present():
 
 def test_version_attribute_is_a_string():
     assert isinstance(pydantic.__version__, str)
+
+
+@pytest.mark.parametrize('version,expected', (('2.1', '2.1'), ('2.1.0', '2.1')))
+def test_version_short(version, expected):
+    with patch('pydantic.version.VERSION', version):
+        assert version_short() == expected

tests/test_warnings.py

@@ -1,5 +1,5 @@
 from pydantic import PydanticDeprecatedSince20, PydanticDeprecationWarning
-from pydantic.version import VERSION
+from pydantic.version import version_short
 
 
 def test_pydantic_deprecation_warning():
@@ -28,7 +28,7 @@ def test_pydantic_deprecation_warning_2_0_migration_guide_link():
 
     assert (
         str(warning)
-        == f'Warning message. Deprecated in Pydantic V2.0 to be removed in V3.0. See Pydantic V2 Migration Guide at https://errors.pydantic.dev/{VERSION}/migration/'
+        == f'Warning message. Deprecated in Pydantic V2.0 to be removed in V3.0. See Pydantic V2 Migration Guide at https://errors.pydantic.dev/{version_short()}/migration/'
     )