Make inspect/ClassProps NG-only

Author: hynek

src/attr/__init__.py

@@ -10,11 +10,10 @@
 from . import converters, exceptions, filters, setters, validators
 from ._cmp import cmp_using
 from ._config import get_run_validators, set_run_validators
-from ._funcs import asdict, assoc, astuple, has, inspect, resolve_types
+from ._funcs import asdict, assoc, astuple, has, resolve_types
 from ._make import (
     NOTHING,
     Attribute,
-    ClassProps,
     Converter,
     Factory,
     _Nothing,
@@ -45,7 +44,6 @@ class AttrsInstance(Protocol):
     "NOTHING",
     "Attribute",
     "AttrsInstance",
-    "ClassProps",
     "Converter",
     "Factory",
     "NothingType",
@@ -69,7 +67,6 @@ class AttrsInstance(Protocol):
     "get_run_validators",
     "has",
     "ib",
-    "inspect",
     "make_class",
     "mutable",
     "resolve_types",

src/attr/__init__.pyi

@@ -141,58 +141,6 @@ class Attribute(Generic[_T]):
 
     def evolve(self, **changes: Any) -> "Attribute[Any]": ...
 
-class ClassProps:
-    """
-    XXX: somehow defining/using enums Mypy starts looking at our own code
-    and causes tons of errors.
-    """
-
-    # class Hashability(enum.Enum): ...
-    # class KeywordOnly(enum.Enum): ...
-
-    is_exception: bool
-    is_slotted: bool
-    has_weakref_slot: bool
-    is_frozen: bool
-    # kw_only: ClassProps.KeywordOnly
-    kw_only: Any
-    collected_fields_by_mro: bool
-    added_init: bool
-    added_repr: bool
-    added_eq: bool
-    added_ordering: bool
-    # hashability: ClassProps.Hashability
-    hashability: Any
-    added_match_args: bool
-    added_str: bool
-    added_pickling: bool
-    on_setattr_hook: _OnSetAttrType | None
-    field_transformer: Callable[[Attribute[Any]], Attribute[Any]] | None
-
-    def __init__(
-        self,
-        is_exception: bool,
-        is_slotted: bool,
-        has_weakref_slot: bool,
-        is_frozen: bool,
-        # kw_only: ClassProps.KeywordOnly
-        kw_only: Any,
-        collected_fields_by_mro: bool,
-        added_init: bool,
-        added_repr: bool,
-        added_eq: bool,
-        added_ordering: bool,
-        # hashability: ClassProps.Hashability
-        hashability: Any,
-        added_match_args: bool,
-        added_str: bool,
-        added_pickling: bool,
-        on_setattr_hook: _OnSetAttrType,
-        field_transformer: Callable[[Attribute[Any]], Attribute[Any]],
-    ) -> None: ...
-    @property
-    def is_hashable(self) -> bool: ...
-
 # NOTE: We had several choices for the annotation to use for type arg:
 # 1) Type[_T]
 #   - Pros: Handles simple cases correctly
@@ -427,7 +375,6 @@ def astuple(
     retain_collection_types: bool = ...,
 ) -> tuple[Any, ...]: ...
 def has(cls: type) -> TypeGuard[type[AttrsInstance]]: ...
-def inspect(cls: type) -> ClassProps: ...
 def assoc(inst: _T, **changes: Any) -> _T: ...
 def evolve(inst: _T, **changes: Any) -> _T: ...
 

src/attrs/__init__.py

@@ -4,7 +4,6 @@
     NOTHING,
     Attribute,
     AttrsInstance,
-    ClassProps,
     Converter,
     Factory,
     NothingType,
@@ -18,12 +17,13 @@
     fields_dict,
     frozen,
     has,
-    inspect,
     make_class,
     mutable,
     resolve_types,
     validate,
 )
+from attr._funcs import inspect
+from attr._make import ClassProps
 from attr._next_gen import asdict, astuple
 
 from . import converters, exceptions, filters, setters, validators

src/attrs/__init__.pyi

@@ -41,8 +41,6 @@ from attr import validate as validate
 from attr import validators as validators
 from attr import attrib, asdict as asdict, astuple as astuple
 from attr import NothingType as NothingType
-from attr import ClassProps as ClassProps
-from attr import inspect as inspect
 
 if sys.version_info >= (3, 11):
     from typing import dataclass_transform
@@ -263,3 +261,57 @@ def frozen(
     field_transformer: _FieldTransformer | None = ...,
     match_args: bool = ...,
 ) -> Callable[[_C], _C]: ...
+
+class ClassProps:
+    """
+    XXX: somehow defining/using enums Mypy starts looking at our own code
+    and causes tons of errors.
+    """
+
+    # class Hashability(enum.Enum): ...
+    # class KeywordOnly(enum.Enum): ...
+
+    is_exception: bool
+    is_slotted: bool
+    has_weakref_slot: bool
+    is_frozen: bool
+    # kw_only: ClassProps.KeywordOnly
+    kw_only: Any
+    collected_fields_by_mro: bool
+    added_init: bool
+    added_repr: bool
+    added_eq: bool
+    added_ordering: bool
+    # hashability: ClassProps.Hashability
+    hashability: Any
+    added_match_args: bool
+    added_str: bool
+    added_pickling: bool
+    on_setattr_hook: _OnSetAttrType | None
+    field_transformer: Callable[[Attribute[Any]], Attribute[Any]] | None
+
+    def __init__(
+        self,
+        is_exception: bool,
+        is_slotted: bool,
+        has_weakref_slot: bool,
+        is_frozen: bool,
+        # kw_only: ClassProps.KeywordOnly
+        kw_only: Any,
+        collected_fields_by_mro: bool,
+        added_init: bool,
+        added_repr: bool,
+        added_eq: bool,
+        added_ordering: bool,
+        # hashability: ClassProps.Hashability
+        hashability: Any,
+        added_match_args: bool,
+        added_str: bool,
+        added_pickling: bool,
+        on_setattr_hook: _OnSetAttrType,
+        field_transformer: Callable[[Attribute[Any]], Attribute[Any]],
+    ) -> None: ...
+    @property
+    def is_hashable(self) -> bool: ...
+
+def inspect(cls: type) -> ClassProps: ...

tests/test_funcs.py

@@ -18,7 +18,7 @@
 
 from attr import asdict, assoc, astuple, evolve, fields, has
 from attr._compat import Mapping, Sequence
-from attr.exceptions import AttrsAttributeNotFoundError, NotAnAttrsClassError
+from attr.exceptions import AttrsAttributeNotFoundError
 from attr.validators import instance_of
 
 from .strategies import nested_classes, simple_classes
@@ -844,11 +844,3 @@ class C:
             inst: int
 
         assert C(42) == evolve(C(23), inst=42)
-
-
-def test_inspect_not_attrs_class():
-    """
-    inspect() raises an error if the class is not an attrs class.
-    """
-    with pytest.raises(NotAnAttrsClassError):
-        attr.inspect(object)

tests/test_next_gen.py

@@ -573,3 +573,11 @@ def test_validators(self):
         from attrs.validators import and_
 
         assert and_ is _attr.validators.and_
+
+
+def test_inspect_not_attrs_class():
+    """
+    inspect() raises an error if the class is not an attrs class.
+    """
+    with pytest.raises(attrs.exceptions.NotAnAttrsClassError):
+        attrs.inspect(object)