refactor: move docstring_deprecated to weaviate/util.py, apply to all 6 files

Per maintainer feedback (@dirkkul), consolidate the stdlib deprecation helper
into weaviate/util.py so all modules share a single implementation.

Changes:
- weaviate/util.py: add docstring_deprecated() function
- weaviate/collections/batch/client.py: remove inline definition, import from util
- weaviate/collections/batch/collection.py: replace 'from deprecation import...'
- weaviate/connect/helpers.py: replace 'from deprecation import...'
- weaviate/collections/classes/config.py: replace 'from deprecation import...'
- weaviate/collections/classes/config_vectorizers.py: replace 'from deprecation import...'
- weaviate/collections/classes/config_named_vectors.py: replace 'from deprecation import...'

The 'deprecation' package is now fully removed from the codebase.

Signed-off-by: NIK-TIGER-BILL <nik.tiger.bill@github.com>

Author: NIK-TIGER-BILL

weaviate/collections/batch/client.py

@@ -1,42 +1,9 @@
 from concurrent.futures import ThreadPoolExecutor
 from typing import TYPE_CHECKING, Optional, Type, Union
 
-import functools
-import warnings as _warnings
-from typing import Callable
-
 from typing_extensions import deprecated as typing_deprecated
 
-
-def docstring_deprecated(details: str = "", deprecated_in: str = "", **_kwargs: object) -> Callable:
-    """Replacement for ``deprecation.deprecated`` that uses only stdlib.
-
-    The ``deprecation`` package has not been maintained since 2019 and is
-    flagged as a security risk by several dependency scanners.  This
-    in-module helper replicates the behaviour we need:
-
-    1. Prepend a ``.. deprecated::`` note to the docstring.
-    2. Emit a :class:`DeprecationWarning` at call time.
-    """
-
-    def decorator(func: Callable) -> Callable:
-        docstring = func.__doc__ or ""
-        note = f".. deprecated:: {deprecated_in}\n   {details}\n\n" if deprecated_in else ""
-        func.__doc__ = note + docstring
-
-        @functools.wraps(func)
-        def wrapper(*args: object, **kwargs: object) -> object:
-            _warnings.warn(
-                f"{func.__qualname__} is deprecated since {deprecated_in}. {details}",
-                DeprecationWarning,
-                stacklevel=2,
-            )
-            return func(*args, **kwargs)
-
-        wrapper.__doc__ = func.__doc__
-        return wrapper
-
-    return decorator
+from weaviate.util import docstring_deprecated
 
 from weaviate.collections.batch.async_ import _BatchBaseAsync
 from weaviate.collections.batch.base import (

weaviate/collections/batch/collection.py

@@ -1,7 +1,7 @@
 from concurrent.futures import ThreadPoolExecutor
 from typing import TYPE_CHECKING, Generic, List, Optional, Type, Union
 
-from deprecation import deprecated as docstring_deprecated
+from weaviate.util import docstring_deprecated
 from typing_extensions import deprecated as typing_deprecated
 
 from weaviate.collections.batch.async_ import _BatchBaseAsync

weaviate/collections/classes/config.py

@@ -14,7 +14,7 @@
     cast,
 )
 
-from deprecation import deprecated as docstring_deprecated
+from weaviate.util import docstring_deprecated
 from pydantic import AnyHttpUrl, Field, TypeAdapter, ValidationInfo, field_validator
 from typing_extensions import TypeAlias
 from typing_extensions import deprecated as typing_deprecated

weaviate/collections/classes/config_named_vectors.py

@@ -1,6 +1,6 @@
 from typing import Any, Dict, List, Literal, Optional, Union
 
-from deprecation import deprecated as docstring_deprecated
+from weaviate.util import docstring_deprecated
 from pydantic import AnyHttpUrl, Field
 from typing_extensions import deprecated as typing_deprecated
 

weaviate/collections/classes/config_vectorizers.py

@@ -2,7 +2,7 @@
 from enum import Enum
 from typing import Any, Dict, List, Literal, Optional, Union, cast
 
-from deprecation import deprecated as docstring_deprecated
+from weaviate.util import docstring_deprecated
 from pydantic import AnyHttpUrl, BaseModel, Field, field_validator
 from typing_extensions import TypeAlias
 from typing_extensions import deprecated as typing_deprecated

weaviate/connect/helpers.py

@@ -3,7 +3,7 @@
 from typing import Dict, Optional, Tuple, Union
 from urllib.parse import urlparse
 
-from deprecation import deprecated as docstring_deprecated
+from weaviate.util import docstring_deprecated
 from typing_extensions import deprecated as typing_deprecated
 
 from weaviate.auth import (

weaviate/util.py

@@ -2,13 +2,15 @@
 
 import base64
 import datetime
+import functools
 import io
 import json
 import os
 import re
 import uuid as uuid_lib
+import warnings as _warnings
 from pathlib import Path
-from typing import Any, Dict, Generator, List, Optional, Sequence, Tuple, Union, cast
+from typing import Any, Callable, Dict, Generator, List, Optional, Sequence, Tuple, Union, cast
 from urllib.parse import quote
 
 import httpx
@@ -32,6 +34,36 @@
 BYTES_PER_CHUNK = 65535  # The number of bytes to read per chunk when encoding files ~ 64kb
 
 
+def docstring_deprecated(details: str = "", deprecated_in: str = "", **_kwargs: object) -> Callable:
+    """Stdlib replacement for ``deprecation.deprecated``.
+
+    The ``deprecation`` package has not been maintained since 2019 and is
+    flagged as a security risk by several dependency scanners.  This helper
+    replicates the behaviour we need:
+
+    1. Prepend a ``.. deprecated::`` note to the function docstring.
+    2. Emit a :class:`DeprecationWarning` at call time.
+    """
+
+    def decorator(func: Callable) -> Callable:
+        docstring = func.__doc__ or ""
+        note = f".. deprecated:: {deprecated_in}\n   {details}\n\n" if deprecated_in else ""
+        func.__doc__ = note + docstring
+
+        @functools.wraps(func)
+        def wrapper(*args: object, **kwargs: object) -> object:
+            _warnings.warn(
+                f"{func.__qualname__} is deprecated since {deprecated_in}. {details}",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return func(*args, **kwargs)
+
+        return wrapper  # type: ignore[return-value]
+
+    return decorator
+
+
 def image_encoder_b64(image_or_image_path: Union[str, io.BufferedReader]) -> str:
     """Encode a image in a Weaviate understandable format from a binary read file or by providing the image path.