💥 boom: replace DataclassInstance with optype.HasDataclassFields (#78)

* 💥 boom: replace DataclassInstance with opt.dataclasses.HasDataclassFields
* ⬆️ dep-bump: optype v0.17.0

Signed-off-by: nstarman <nstarman@users.noreply.github.com>

Author: nstarman

pyproject.toml

@@ -18,7 +18,7 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "optype>=0.16.0",
+  "optype>=0.17.0",
   "plum-dispatch>=2.5.1",
   "typing_extensions>=4.12.2",
 ]

src/dataclassish/__init__.py

@@ -18,7 +18,6 @@
     "field_values",
     "field_items",
     # Classes
-    "DataclassInstance",
     "F",
 )
 
@@ -33,7 +32,7 @@
     get_field,
     replace,
 )
-from ._src.types import DataclassInstance, F
+from ._src.types import F
 from ._version import version as __version__
 
 # Register dispatches by importing the submodules

src/dataclassish/_src/converters.py

@@ -224,7 +224,7 @@ def field(
 
 
 class DataclassWithConvertersInstance(Protocol):
-    """DataclassInstance Protocol with additional ``__converter_init__``."""
+    """Dataclass instance Protocol with additional ``__converter_init__``."""
 
     __dataclass_fields__: ClassVar[dict[str, dataclasses.Field[Any]]]
     __dataclass_init__: Callable[..., None]

src/dataclassish/_src/register_dataclass.py

@@ -13,17 +13,17 @@
 )
 from typing import Any
 
+import optype as opt
 from plum import dispatch
 
 from .register_base import _recursive_replace_helper
-from .types import DataclassInstance
 
 # ===================================================================
 
 if sys.version_info < (3, 13):
 
     @dispatch
-    def get_field(obj: DataclassInstance, k: str, /) -> Any:
+    def get_field(obj: opt.dataclasses.HasDataclassFields, k: str, /) -> Any:
         """Get a field of a dataclass instance by name.
 
         Examples:
@@ -49,7 +49,9 @@ def get_field(obj: DataclassInstance, k: str, /) -> Any:
 if sys.version_info < (3, 13):
 
     @dispatch
-    def replace(obj: DataclassInstance, /, **kwargs: Any) -> DataclassInstance:
+    def replace(
+        obj: opt.dataclasses.HasDataclassFields, /, **kwargs: Any
+    ) -> opt.dataclasses.HasDataclassFields:
         """Replace the fields of a dataclass instance.
 
         Examples:
@@ -72,7 +74,9 @@ def replace(obj: DataclassInstance, /, **kwargs: Any) -> DataclassInstance:
         return _dataclass_replace(obj, **kwargs)
 
     @dispatch  # type: ignore[no-redef]
-    def replace(obj: DataclassInstance, fs: Mapping[str, Any], /) -> DataclassInstance:
+    def replace(
+        obj: opt.dataclasses.HasDataclassFields, fs: Mapping[str, Any], /
+    ) -> opt.dataclasses.HasDataclassFields:
         """Replace the fields of a dataclass instance.
 
         Examples:
@@ -127,7 +131,7 @@ def replace(obj: DataclassInstance, fs: Mapping[str, Any], /) -> DataclassInstan
 
 
 @dispatch
-def fields(obj: DataclassInstance, /) -> tuple[Field, ...]:  # type: ignore[type-arg]  # TODO: raise issue in beartype
+def fields(obj: opt.dataclasses.HasDataclassFields, /) -> tuple[Field, ...]:  # type: ignore[type-arg]  # TODO: raise issue in beartype
     """Return the fields of a dataclass instance.
 
     Examples:
@@ -154,7 +158,7 @@ def fields(obj: DataclassInstance, /) -> tuple[Field, ...]:  # type: ignore[type
 
 @dispatch
 def asdict(
-    obj: DataclassInstance,
+    obj: opt.dataclasses.HasDataclassFields,
     /,
     *,
     dict_factory: Callable[[list[tuple[str, Any]]], dict[str, Any]] = dict,
@@ -184,7 +188,7 @@ def asdict(
 
 @dispatch
 def astuple(
-    obj: DataclassInstance,
+    obj: opt.dataclasses.HasDataclassFields,
     /,
     *,
     tuple_factory: Callable[[Any], tuple[Any, ...]] = tuple,

src/dataclassish/_src/types.py

@@ -1,46 +1,9 @@
 """Data types for ``dataclassish``."""
 
-__all__ = ("DataclassInstance", "F")
+__all__ = ("F",)
 
 from dataclasses import dataclass
-from typing import Any, ClassVar, Generic, Protocol, TypeVar, runtime_checkable
-
-
-@runtime_checkable
-class DataclassInstance(Protocol):
-    """Protocol for dataclass instances.
-
-    Examples
-    --------
-    >>> from dataclasses import dataclass
-    >>> from dataclassish import DataclassInstance
-
-    >>> @dataclass
-    ... class Point:
-    ...     x: float
-    ...     y: float
-
-    >>> issubclass(Point, DataclassInstance)
-    True
-
-    >>> point = Point(1.0, 2.0)
-
-    >>> isinstance(point, DataclassInstance)
-    True
-
-    """
-
-    __dataclass_fields__: ClassVar[dict[str, Any]]
-
-    # B/c of https://github.com/python/mypy/issues/3939 just having
-    # `__dataclass_fields__` is insufficient for `issubclass` checks.
-    @classmethod
-    def __subclasshook__(cls: type, c: type) -> bool:
-        """Customize the subclass check."""
-        return hasattr(c, "__dataclass_fields__")
-
-
-# ===================================================================
+from typing import Generic, TypeVar
 
 V = TypeVar("V")