Merge pull request #1999 from NIK-TIGER-BILL/fix/remove-deprecation-package

fix(deps): remove unmaintained deprecation package, use stdlib instead

Author: dirkkul

requirements-devel.txt

@@ -5,7 +5,6 @@ grpcio==1.75.1
 grpcio-tools==1.75.1
 grpcio-health-checking==1.75.1
 pydantic==2.12.0
-deprecation==2.1.0
 
 build
 twine

setup.cfg

@@ -40,7 +40,6 @@ install_requires =
     pydantic>=2.12.0,<3.0.0
     grpcio>=1.59.5,<1.80.0
     protobuf>=4.21.6,<7.0.0
-    deprecation>=2.1.0,<3.0.0
 python_requires = >=3.10
 
 [options.extras_require]

weaviate/collections/batch/client.py

@@ -1,9 +1,10 @@
 from concurrent.futures import ThreadPoolExecutor
 from typing import TYPE_CHECKING, Optional, Type, Union
 
-from deprecation import deprecated as docstring_deprecated
 from typing_extensions import deprecated as typing_deprecated
 
+from weaviate.util import docstring_deprecated
+
 from weaviate.collections.batch.async_ import _BatchBaseAsync
 from weaviate.collections.batch.base import (
     _BatchBase,

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 = "") -> 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:
+        @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)
+
+        docstring = func.__doc__ or ""
+        note = f".. deprecated:: {deprecated_in}\n   {details}\n\n" if deprecated_in else ""
+        wrapper.__doc__ = note + docstring
+
+        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.