tcod-ecs 5.4.0__tar.gz → 5.4.2__tar.gz

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: tcod-ecs
-Version: 5.4.0
+Version: 5.4.2
 Summary: A type-hinted Entity Component System based on Python dictionaries and sets.
 Author-email: Kyle Benesch <4b796c65+github@gmail.com>
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -16,12 +16,12 @@ License-File: LICENSE
 Requires-Dist: attrs >=23.1.0
 Requires-Dist: cattrs >=23.1.2
 Requires-Dist: sentinel-value >=1.0.0
-Requires-Dist: typing-extensions >=4.9.0
+Requires-Dist: typing-extensions >=4.13.1
 Requires-Dist: attrs >=22.2.0 ; extra == "test"
 Requires-Dist: pytest >=7.2.0 ; extra == "test"
 Requires-Dist: pytest-cov >=4.0.0 ; extra == "test"
 Requires-Dist: pytest-benchmark >=4.0.0 ; extra == "test"
-Requires-Dist: mypy >=1.1.1 ; extra == "test"
+Requires-Dist: mypy >=1.17.0 ; extra == "test"
 Project-URL: Changelog, https://github.com/HexDecimal/python-tcod-ecs/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://python-tcod-ecs.readthedocs.io
 Project-URL: Home, https://github.com/HexDecimal

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/pyproject.toml

@@ -17,12 +17,12 @@ classifiers = [
     "Typing :: Typed",
 ]
 dynamic = ["version", "description"]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dependencies = [
     "attrs >=23.1.0",
     "cattrs >=23.1.2",
     "sentinel-value >=1.0.0",
-    "typing-extensions >=4.9.0",
+    "typing-extensions >=4.13.1",
 ]
 
 [tool.setuptools_scm]
@@ -34,7 +34,7 @@ test = [
     "pytest >=7.2.0",
     "pytest-cov >=4.0.0",
     "pytest-benchmark >=4.0.0",
-    "mypy >=1.1.1",
+    "mypy >=1.17.0",
 ]
 
 [tool.flit.module]
@@ -50,7 +50,8 @@ Source = "https://github.com/HexDecimal/python-tcod-ecs"
 files = "."
 exclude = ['^build/', '^\.']
 explicit_package_bases = true
-python_version = "3.10"            # Type check Python version with EllipsisType
+python_version = "3.10"
+enable_incomplete_feature = ["TypeForm"]
 warn_unused_configs = true
 disallow_any_generics = true
 disallow_subclassing_any = true
@@ -65,6 +66,8 @@ warn_unused_ignores = true
 warn_return_any = true
 no_implicit_reexport = true
 strict_equality = true
+strict_bytes = true
+extra_checks = true
 
 [tool.pyright]
 reportInconsistentOverload = false

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/__init__.py

@@ -4,12 +4,21 @@ from __future__ import annotations
 
 import importlib.metadata
 from collections import defaultdict
-from typing import TypeVar
+from typing import TYPE_CHECKING, TypeVar
 
 from tcod.ecs.constants import IsA
 from tcod.ecs.entity import Entity
 from tcod.ecs.registry import Registry
-from tcod.ecs.registry import Registry as World
+
+if TYPE_CHECKING:
+    from typing_extensions import deprecated
+
+    @deprecated("Renamed to Registry.")
+    class World(Registry):  # noqa: D101
+        pass
+
+else:
+    from tcod.ecs.registry import Registry as World
 
 __all__ = (
     "Entity",

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/_converter.py

@@ -2,10 +2,13 @@ from __future__ import annotations
 
 import functools
 from collections import defaultdict
-from typing import Any, Callable, get_args, get_origin
+from typing import TYPE_CHECKING, Any, get_args, get_origin
 
 import cattrs
 
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
 
 def _is_defaultdict_type(type_hint: object) -> bool:
     """Return True if `type_hint` is a defaultdict type-hint."""
@@ -14,7 +17,7 @@ def _is_defaultdict_type(type_hint: object) -> bool:
 
 def _setup_defaultdict_factory(type_hint: type[defaultdict[Any, Any] | object]) -> Callable[[], Any]:
     """Return the factory value for a defaultdict given its value type-hint."""
-    assert type_hint is not Any  # type: ignore[comparison-overlap]
+    assert type_hint is not Any
     if get_origin(type_hint) is not defaultdict:
         return get_origin(type_hint) or type_hint
     return functools.partial(defaultdict, _setup_defaultdict_factory(get_args(type_hint)[1]))

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '5.4.0'
-__version_tuple__ = version_tuple = (5, 4, 0)
+__version__ = version = '5.4.2'
+__version_tuple__ = version_tuple = (5, 4, 2)
+
+__commit_id__ = commit_id = 'g99e849adf'

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/callbacks.py

@@ -2,9 +2,8 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Callable, TypeVar, Union
-
-from typing_extensions import TypeAlias
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Any, TypeAlias, TypeVar
 
 if TYPE_CHECKING:
     from tcod.ecs.entity import Entity
@@ -12,7 +11,7 @@ if TYPE_CHECKING:
 
 _T = TypeVar("_T")
 
-_OnComponentChangedFunc: TypeAlias = Callable[["Entity", Union[_T, None], Union[_T, None]], None]
+_OnComponentChangedFunc: TypeAlias = Callable[["Entity", _T | None, _T | None], None]
 _OnComponentChangedFuncT = TypeVar("_OnComponentChangedFuncT", bound=_OnComponentChangedFunc[Any])
 
 _on_component_changed_callbacks: dict[ComponentKey[Any], list[_OnComponentChangedFunc[Any]]] = {}

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/entity.py

@@ -2,27 +2,20 @@
 
 from __future__ import annotations
 
+from collections.abc import Iterable, Iterator, Mapping, MutableMapping, MutableSet
 from typing import (
     TYPE_CHECKING,
     Any,
     Final,
     Generic,
-    Iterable,
-    Iterator,
-    Mapping,
-    MutableMapping,
-    MutableSet,
-    Tuple,
-    Type,
     TypeVar,
-    Union,
     overload,
 )
 from weakref import WeakKeyDictionary, WeakValueDictionary
 
 import attrs
 from sentinel_value import sentinel
-from typing_extensions import Self, deprecated
+from typing_extensions import Self, TypeForm, deprecated
 
 import tcod.ecs.callbacks
 import tcod.ecs.query
@@ -389,7 +382,7 @@ def _traverse_entities(start: Entity, traverse_parents: tuple[object, ...]) -> I
 
 
 @attrs.define(eq=False, frozen=True, weakref_slot=False)
-class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]], object]):
+class EntityComponents(MutableMapping[TypeForm[Any] | tuple[object, TypeForm[Any]], object]):
     """A proxy attribute to access an entities components like a dictionary.
 
     See :any:`Entity.components`.
@@ -447,7 +440,7 @@ class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]]
 
         tcod.ecs.callbacks._on_component_changed(key, self.entity, old_value, value)
 
-    def __delitem__(self, key: type[object] | tuple[object, type[object]]) -> None:
+    def __delitem__(self, key: TypeForm[object] | tuple[object, TypeForm[object]]) -> None:
         """Delete a directly held component from an entity."""
         assert self.__assert_key(key)
 
@@ -474,8 +467,8 @@ class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]]
             *(_components_by_entity.get(entity, ()) for entity in _traverse_entities(self.entity, self.traverse))
         )
 
-    def __contains__(self, key: ComponentKey[object]) -> bool:  # type: ignore[override]
-        """Return True if this entity has the provided component."""
+    def __contains__(self, key: object) -> bool:
+        """Return True if this entity has the provided component key."""
         _components_by_entity = self.entity.registry._components_by_entity
         return any(
             key in _components_by_entity.get(entity, ()) for entity in _traverse_entities(self.entity, self.traverse)
@@ -500,7 +493,7 @@ class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]]
             self.set(value)
 
     @deprecated("This method has been deprecated. Iterate over items instead.", category=FutureWarning)
-    def by_name_type(self, name_type: type[_T1], component_type: type[_T2]) -> Iterator[tuple[_T1, type[_T2]]]:
+    def by_name_type(self, name_type: type[_T1], component_type: TypeForm[_T2]) -> Iterator[tuple[_T1, TypeForm[_T2]]]:
         """Iterate over all of an entities component keys with a specific (name_type, component_type) combination.
 
         .. versionadded:: 3.0
@@ -508,13 +501,12 @@ class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]]
         .. deprecated:: 3.1
             This method has been deprecated. Iterate over items instead.
         """
-        # Naive implementation until I feel like optimizing it
         for key in self:
             if not isinstance(key, tuple):
                 continue
             key_name, key_component = key
             if key_component is component_type and isinstance(key_name, name_type):
-                yield key_name, key_component
+                yield key_name, key_component  # type: ignore[unused-ignore]  # Too complex for PyLance, deprecated anyways
 
     @overload
     def __ior__(self, value: SupportsKeysAndGetItem[ComponentKey[Any], Any]) -> Self: ...
@@ -544,7 +536,7 @@ class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]]
         except KeyError:
             return default  # type: ignore[return-value] # https://github.com/python/mypy/issues/3737
 
-    def setdefault(self, __key: ComponentKey[T], __default: T, /) -> T:
+    def setdefault(self, __key: ComponentKey[T], __default: T, /) -> T:  # type: ignore[override] # Disallows default None
         """Assign a default value if a component is missing, then returns the current value."""
         try:
             return self[__key]
@@ -932,7 +924,7 @@ class EntityRelationsExclusive(MutableMapping[object, Entity]):
 
 
 @attrs.define(eq=False, frozen=True, weakref_slot=False)
-class EntityComponentRelationMapping(Generic[T], MutableMapping[Entity, T]):
+class EntityComponentRelationMapping(MutableMapping[Entity, T], Generic[T]):
     """An entity-component mapping to access the relation target component objects.
 
     See :any:`Entity.relation_components`.
@@ -1051,14 +1043,14 @@ class EntityComponentRelations(MutableMapping[ComponentKey[Any], EntityComponent
         """Access relations for this component key as a `{target: component}` dict-like object."""
         return EntityComponentRelationMapping(self.entity, key, self.traverse)
 
-    def __setitem__(self, __key: ComponentKey[T], __values: Mapping[Entity, object], /) -> None:
+    def __setitem__(self, __key: ComponentKey[T], __values: Mapping[Entity, T], /) -> None:
         """Redefine the component relations for this entity.
 
         ..versionadded:: 4.2.0
         """
         if isinstance(__values, EntityComponentRelationMapping) and __values.entity is self.entity:
             return
-        mapping: EntityComponentRelationMapping[object] = self[__key]
+        mapping: EntityComponentRelationMapping[T] = self[__key]
         mapping.clear()
         for target, component in __values.items():
             mapping[target] = component

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/query.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import itertools
 import warnings
 from collections import defaultdict
-from typing import TYPE_CHECKING, Any, Iterable, Iterator, Protocol, TypeVar, overload
+from typing import TYPE_CHECKING, Any, Protocol, TypeVar, overload
 from weakref import WeakKeyDictionary, WeakSet
 
 import attrs
@@ -15,6 +15,7 @@ import tcod.ecs.entity
 from tcod.ecs.constants import IsA
 
 if TYPE_CHECKING:
+    from collections.abc import Iterable, Iterator
     from collections.abc import Set as AbstractSet
 
     from tcod.ecs.entity import Entity
@@ -471,7 +472,7 @@ class BoundQuery:
                 continue
             registry_components = self.registry._components_by_type[component_key]
             entity_components.append([registry_components[entity] for entity in entities])
-        return zip(*entity_components)
+        return zip(*entity_components, strict=True)
 
 
 WorldQuery = BoundQuery

{tcod_ecs-5.4.0 → tcod_ecs-5.4.2}/tcod/ecs/registry.py

@@ -4,7 +4,8 @@ from __future__ import annotations
 
 import warnings
 from collections import defaultdict
-from typing import TYPE_CHECKING, Any, DefaultDict, Dict, Final, Iterable, Mapping, NoReturn, Set, TypeVar
+from collections.abc import Iterable, Mapping
+from typing import TYPE_CHECKING, Any, Final, NoReturn, TypeVar
 
 import attrs
 from typing_extensions import deprecated
@@ -32,10 +33,10 @@ def _defaultdict_of_dict() -> defaultdict[_T1, dict[_T2, _T3]]:
 
 
 def _components_by_entity_from(
-    by_type: defaultdict[ComponentKey[object], dict[Entity, Any]],
-) -> defaultdict[Entity, dict[ComponentKey[object], Any]]:
+    by_type: defaultdict[ComponentKey[_T1], dict[Entity, _T1]],
+) -> defaultdict[Entity, dict[ComponentKey[_T1], _T1]]:
     """Return the component lookup table from the components sparse-set."""
-    by_entity: defaultdict[Entity, dict[ComponentKey[object], Any]] = defaultdict(dict)
+    by_entity: defaultdict[Entity, dict[ComponentKey[_T1], _T1]] = defaultdict(dict)
     for component_key, components in by_type.items():
         for entity, component in components.items():
             by_entity[entity][component_key] = component
@@ -195,23 +196,23 @@ class Registry:
         # Apply defaultdict types to unpickled dictionaries
         self._components_by_type = converter.structure(
             state.pop("_components_by_type"),
-            DefaultDict[Any, Dict[Any, Any]],
+            defaultdict[Any, dict[Any, Any]],
         )
         self._components_by_entity = _components_by_entity_from(self._components_by_type)
 
         self._tags_by_entity = converter.structure(
             state.pop("_tags_by_entity"),
-            DefaultDict[Any, Set[Any]],
+            defaultdict[Any, set[Any]],
         )
         self._tags_by_key = _tags_by_key_from_tags_by_entity(self._tags_by_entity)
 
         self._relation_tags_by_entity = converter.structure(
             state.pop("_relation_tags_by_entity"),
-            DefaultDict[Any, DefaultDict[Any, Set[Any]]],
+            defaultdict[Any, defaultdict[Any, set[Any]]],
         )
         self._relation_components_by_entity = converter.structure(
             state.pop("_relation_components_by_entity"),
-            DefaultDict[Any, DefaultDict[Any, Dict[Any, Any]]],
+            defaultdict[Any, defaultdict[Any, dict[Any, Any]]],
         )
         self._relations_lookup = _relations_lookup_from(
             self._relation_tags_by_entity, self._relation_components_by_entity
@@ -231,11 +232,11 @@ class Registry:
         converter = tcod.ecs._converter._get_converter()
         # Replace defaultdict types with plain dict when saving
         return {
-            "_components_by_type": converter.structure(self._components_by_type, Dict[Any, Dict[Any, Any]]),
-            "_tags_by_entity": converter.structure(self._tags_by_entity, Dict[Any, Any]),
-            "_relation_tags_by_entity": converter.structure(self._relation_tags_by_entity, Dict[Any, Dict[Any, Any]]),
+            "_components_by_type": converter.structure(self._components_by_type, dict[Any, dict[Any, Any]]),
+            "_tags_by_entity": converter.structure(self._tags_by_entity, dict[Any, Any]),
+            "_relation_tags_by_entity": converter.structure(self._relation_tags_by_entity, dict[Any, dict[Any, Any]]),
             "_relation_components_by_entity": converter.structure(
-                self._relation_components_by_entity, Dict[Any, Dict[Any, Any]]
+                self._relation_components_by_entity, dict[Any, dict[Any, Any]]
             ),
             "_names_by_name": self._names_by_name,
         }

tcod_ecs-5.4.2/tcod/ecs/typing.py

@@ -0,0 +1,38 @@
+"""Common type-hints for tcod.ecs."""
+
+from __future__ import annotations
+
+from types import EllipsisType
+from typing import TYPE_CHECKING, Any, TypeAlias, TypeVar
+
+from typing_extensions import TypeForm
+
+if TYPE_CHECKING:
+    from tcod.ecs.entity import Entity
+    from tcod.ecs.query import BoundQuery
+else:
+    Entity = Any
+    BoundQuery = Any
+
+
+_T = TypeVar("_T")
+
+ComponentKey: TypeAlias = TypeForm[_T] | tuple[object, TypeForm[_T]]
+"""ComponentKey is plain `type` or tuple `(tag, type)`."""
+
+_RelationTargetLookup: TypeAlias = Entity | EllipsisType
+"""Possible target for stored relations."""
+
+_RelationQueryTarget: TypeAlias = _RelationTargetLookup | BoundQuery
+"""Possible target for relation queries."""
+
+_RelationQuery: TypeAlias = tuple[object, _RelationQueryTarget] | tuple[_RelationQueryTarget, object, None]  # noqa: PYI047
+"""Query format for relations.
+
+One of 4 formats:
+
+* (tag, target)
+* (tag, ...)
+* (origin, tag, None)
+* (..., tag, None)
+"""

tcod_ecs-5.4.0/tcod/ecs/typing.py

@@ -1,43 +0,0 @@
-"""Common type-hints for tcod.ecs."""
-
-from __future__ import annotations
-
-import sys
-import types
-from typing import TYPE_CHECKING, Any, Tuple, Type, TypeVar, Union
-
-from typing_extensions import TypeAlias
-
-if TYPE_CHECKING:
-    from tcod.ecs.entity import Entity
-    from tcod.ecs.query import BoundQuery
-else:
-    Entity = Any
-    BoundQuery = Any
-
-if sys.version_info >= (3, 10):  # pragma: no cover
-    EllipsisType: TypeAlias = types.EllipsisType
-else:  # pragma: no cover
-    EllipsisType = Any
-
-_T = TypeVar("_T")
-
-ComponentKey: TypeAlias = Union[Type[_T], Tuple[object, Type[_T]]]
-"""ComponentKey is plain `type` or tuple `(tag, type)`."""
-
-_RelationTargetLookup: TypeAlias = Union[Entity, EllipsisType]
-"""Possible target for stored relations."""
-
-_RelationQueryTarget: TypeAlias = Union[_RelationTargetLookup, BoundQuery]
-"""Possible target for relation queries."""
-
-_RelationQuery: TypeAlias = Union[Tuple[object, _RelationQueryTarget], Tuple[_RelationQueryTarget, object, None]]  # noqa: PYI047
-"""Query format for relations.
-
-One of 4 formats:
-
-* (tag, target)
-* (tag, ...)
-* (origin, tag, None)
-* (..., tag, None)
-"""