tcod-ecs 5.5.0__tar.gz → 5.5.2__tar.gz

{tcod_ecs-5.5.0 → tcod_ecs-5.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tcod-ecs
-Version: 5.5.0
+Version: 5.5.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.10

{tcod_ecs-5.5.0 → tcod_ecs-5.5.2}/pyproject.toml

@@ -92,6 +92,7 @@ line-length = 120
 select = ["ALL"]
 ignore = [
     "A005",   # stdlib-module-shadowing, workaround VSCode treating all modules as local
+    "CPY001", # missing-copyright-notice
     "COM",    # flake8-commas, handled by formatter
     "E501",   # line-too-long
     "S101",   # assert

tcod_ecs-5.5.2/tcod/ecs/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '5.5.2'
+__version_tuple__ = version_tuple = (5, 5, 2)
+
+__commit_id__ = commit_id = 'g60f279cbb'

{tcod_ecs-5.5.0 → tcod_ecs-5.5.2}/tcod/ecs/constants.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing_extensions import Never
+
 
 class _IgnoreSetState(type):
     def __setstate__(cls, _state: object) -> None:
@@ -11,9 +13,9 @@ class _IgnoreSetState(type):
 class IsA(metaclass=_IgnoreSetState):
     """The default is-a relationship tag used for entity inheritance."""
 
-    def __new__(cls: type[IsA], *_args: object) -> type[IsA]:  # type: ignore[misc]
-        """Return own type instead of instance, for outdated sentinel-value pickle data."""
-        return cls
+    def __new__(cls: type[IsA], *_: object) -> Never:  # noqa: D102
+        # Return own type instead of instance, for outdated sentinel-value pickle data.
+        return cls  # type: ignore[misc]
 
 
 _sentinel_IsA = IsA  # Compatibility with sentinel-value, deprecated since 5.4  # noqa: N816

{tcod_ecs-5.5.0 → tcod_ecs-5.5.2}/tcod/ecs/entity.py

@@ -9,6 +9,7 @@ from typing import (
     Final,
     Generic,
     TypeVar,
+    cast,
     overload,
 )
 from weakref import WeakKeyDictionary, WeakValueDictionary
@@ -419,9 +420,12 @@ class EntityComponents(MutableMapping[TypeForm[Any] | tuple[object, TypeForm[Any
         assert self.__assert_key(key)
         _components_by_entity = self.entity.registry._components_by_entity
         for entity in _traverse_entities(self.entity, self.traverse):
+            components = _components_by_entity.get(entity)
+            if components is None:
+                continue
             try:
-                return _components_by_entity[entity][key]  # type: ignore[no-any-return]
-            except KeyError:  # noqa: PERF203
+                return components[key]  # type: ignore[no-any-return]
+            except KeyError:
                 pass
         raise KeyError(key)
 
@@ -443,10 +447,13 @@ class EntityComponents(MutableMapping[TypeForm[Any] | tuple[object, TypeForm[Any
         """Delete a directly held component from an entity."""
         assert self.__assert_key(key)
 
-        old_value = self.entity.registry._components_by_entity[self.entity].get(key)
+        components = self.entity.registry._components_by_entity.get(self.entity)
+        if components is None:
+            raise KeyError(key)
+        old_value = components.get(key)
 
-        del self.entity.registry._components_by_entity[self.entity][key]
-        if not self.entity.registry._components_by_entity[self.entity]:
+        del components[key]
+        if not components:
             del self.entity.registry._components_by_entity[self.entity]
 
         del self.entity.registry._components_by_type[key][self.entity]
@@ -588,8 +595,12 @@ class EntityComponents(MutableMapping[TypeForm[Any] | tuple[object, TypeForm[Any
     def clear(self) -> None:
         """Remove any components stored directly in this entity."""
         if self.traverse:
-            return self(traverse=()).clear()
-        return super().clear()
+            self(traverse=()).clear()
+            return
+        super().clear()
+        # MutableMapping.clear() only calls __delitem__ for existing components,
+        # so it leaves an already empty registry row behind.
+        self.entity.registry._components_by_entity.pop(self.entity, None)
 
 
 @attrs.define(eq=False, frozen=True, weakref_slot=False)
@@ -602,6 +613,11 @@ class EntityTags(MutableSet[Any]):
     entity: Entity
     traverse: tuple[object, ...]
 
+    @classmethod
+    def _from_iterable(cls, it: Iterable[_T1]) -> set[_T1]:
+        """Return an independent set for the inherited set operations."""
+        return set(it)
+
     def __call__(self, *, traverse: Iterable[object]) -> Self:
         """Update this view with alternative parameters, such as a specific traversal relation.
 
@@ -620,7 +636,7 @@ class EntityTags(MutableSet[Any]):
 
     def discard(self, tag: object) -> None:
         """Discard a tag directly held by an entity."""
-        if tag not in self.entity.registry._tags_by_entity[self.entity]:
+        if tag not in self.entity.registry._tags_by_entity.get(self.entity, ()):
             return  # Already doesn't have tag
         tcod.ecs.query._touch_tag(self.entity.registry, tag)  # Tag removed
 
@@ -642,8 +658,9 @@ class EntityTags(MutableSet[Any]):
     def clear(self) -> None:
         """Remove all tags directly in this entity."""
         _tags_by_entity = self.entity.registry._tags_by_entity
-        while _tags_by_entity[self.entity]:
-            self.discard(next(iter(_tags_by_entity[self.entity])))
+        while tags := _tags_by_entity.get(self.entity):
+            self.discard(next(iter(tags)))
+        _tags_by_entity.pop(self.entity, None)
 
     def __contains__(self, x: object) -> bool:
         """Return True if this entity has the given tag."""
@@ -695,6 +712,12 @@ def _relations_lookup_add(registry: Registry, origin: Entity, tag: object, targe
 
 def _relations_lookup_discard(registry: Registry, origin: Entity, tag: object, target: Entity) -> None:
     """Discard a relation tag/component from the lookup table and handle side effects."""
+    tags = registry._relation_tags_by_entity.get(origin)
+    if tags is not None and target in tags.get(tag, ()):
+        return  # A tag relation still owns this index entry.
+    components = registry._relation_components_by_entity.get(origin)
+    if components is not None and target in components.get(cast("ComponentKey[object]", tag), ()):
+        return  # A component relation still owns this index entry.
     registry._relations_lookup[(tag, target)].discard(origin)
     if not registry._relations_lookup[(tag, target)]:
         del registry._relations_lookup[(tag, target)]
@@ -725,6 +748,11 @@ class EntityRelationsMapping(MutableSet[Entity]):
     key: object
     traverse: tuple[object, ...]
 
+    @classmethod
+    def _from_iterable(cls, it: Iterable[_T1]) -> set[_T1]:
+        """Return an independent set for the inherited set operations."""
+        return set(it)
+
     if __debug__:
 
         def __attrs_post_init__(self) -> None:
@@ -826,6 +854,7 @@ class EntityRelations(MutableMapping[object, EntityRelationsMapping]):
     def __setitem__(self, key: object, values: Iterable[Entity]) -> None:
         """Overwrite the targets of a relation tag with the new values."""
         assert not isinstance(values, Entity), "Did you mean `entity.relations[key] = (target,)`?"
+        values = tuple(values)  # Values may be a live view of the mapping being replaced.
         mapping = EntityRelationsMapping(self.entity, key, self.traverse)
         mapping.clear()
         for v in values:
@@ -978,10 +1007,16 @@ class EntityComponentRelationMapping(MutableMapping[Entity, T], Generic[T]):
     def __delitem__(self, target: Entity) -> None:
         """Delete a component assigned to the target entity."""
         registry = self.entity.registry
-        del registry._relation_components_by_entity[self.entity][self.key][target]
-        if not registry._relation_components_by_entity[self.entity][self.key]:
-            del registry._relation_components_by_entity[self.entity][self.key]
-        if not registry._relation_components_by_entity[self.entity]:
+        by_entity = registry._relation_components_by_entity.get(self.entity)
+        if by_entity is None:
+            raise KeyError(target)
+        by_key = by_entity.get(self.key)
+        if by_key is None:
+            raise KeyError(target)
+        del by_key[target]
+        if not by_key:
+            del by_entity[self.key]
+        if not by_entity:
             del registry._relation_components_by_entity[self.entity]
 
         _relations_lookup_discard(registry, self.entity, self.key, target)
@@ -1047,11 +1082,16 @@ class EntityComponentRelations(MutableMapping[ComponentKey[Any], EntityComponent
 
         ..versionadded:: 4.2.0
         """
-        if isinstance(__values, EntityComponentRelationMapping) and __values.entity is self.entity:
+        if (
+            isinstance(__values, EntityComponentRelationMapping)
+            and __values.entity is self.entity
+            and __values.key == __key
+        ):
             return
+        items = tuple(__values.items())  # The input may inherit values from the mapping being replaced.
         mapping: EntityComponentRelationMapping[T] = self[__key]
         mapping.clear()
-        for target, component in __values.items():
+        for target, component in items:
             mapping[target] = component
 
     def __delitem__(self, key: ComponentKey[object]) -> None:

{tcod_ecs-5.5.0 → tcod_ecs-5.5.2}/tcod/ecs/query.py

@@ -6,7 +6,7 @@ import itertools
 import warnings
 from collections import defaultdict
 from typing import TYPE_CHECKING, Any, Protocol, TypeVar, overload
-from weakref import WeakKeyDictionary, WeakSet
+from weakref import WeakSet
 
 import attrs
 from typing_extensions import Self, deprecated
@@ -29,10 +29,6 @@ _T4 = TypeVar("_T4")
 _T5 = TypeVar("_T5")
 
 
-_query_caches: WeakKeyDictionary[Registry, _QueryCache] = WeakKeyDictionary()
-"""The master table of cached queries."""
-
-
 @attrs.define
 class _QueryCache:
     """Main data structure for the query cache."""
@@ -59,7 +55,7 @@ def _drop_cached_query(cache: _QueryCache, query: _Query) -> None:
     """Drop a cached query and all of its dependant queries."""
     cache.queries.pop(query, None)
     for sub_registry, sub_query in cache.dependencies.pop(query, ()):
-        _drop_cached_query(_query_caches[sub_registry], sub_query)
+        _drop_cached_query(_get_query_cache(sub_registry), sub_query)
 
 
 def _touch_component(registry: Registry, component: ComponentKey[object]) -> None:
@@ -126,11 +122,8 @@ def _fetch_relation_table(registry: Registry, relation: _RelationQuery) -> Abstr
 
 
 def _get_query_cache(registry: Registry) -> _QueryCache:
-    """Return the global cache for the given registry, creating it if it does not exist."""
-    cache = _query_caches.get(registry)
-    if cache is None:
-        cache = _query_caches[registry] = _QueryCache()
-    return cache
+    """Return the cache owned by the given registry."""
+    return registry._query_cache
 
 
 def _get_query(registry: Registry, query: _Query) -> AbstractSet[Entity]:
@@ -237,10 +230,6 @@ class _QueryLogicalAnd:
     _all_of: frozenset[_Query] = frozenset()
     _none_of: frozenset[_Query] = frozenset()
 
-    def __attrs_post_init__(self) -> None:
-        """Verify the current state."""
-        assert self._all_of.isdisjoint(self._none_of)
-
     def _add_to_cache(self, registry: Registry, cache: _QueryCache) -> None:
         for dependency in itertools.chain(self._all_of, self._none_of):
             cache.dependencies[dependency].add((registry, self))
@@ -465,13 +454,16 @@ class BoundQuery:
         Entity = tcod.ecs.entity.Entity  # noqa: N806
 
         entities = list(self.all_of(components=set(key) - {Entity}).get_entities())
-        entity_components = []
+        entity_components: list[list[Any]] = []
         for component_key in key:
             if component_key is Entity:
                 entity_components.append(entities)
                 continue
             registry_components = self.registry._components_by_type[component_key]
-            entity_components.append([registry_components[entity] for entity in entities])
+            try:
+                entity_components.append([registry_components[entity] for entity in entities])
+            except KeyError:  # Some matching entities inherit this component.
+                entity_components.append([entity.components[component_key] for entity in entities])
         return zip(*entity_components, strict=True)
 
 

{tcod_ecs-5.5.0 → tcod_ecs-5.5.2}/tcod/ecs/registry.py

@@ -13,6 +13,7 @@ from typing_extensions import deprecated
 import tcod.ecs._converter
 import tcod.ecs.query
 from tcod.ecs.entity import Entity
+from tcod.ecs.query import _QueryCache
 
 if TYPE_CHECKING:
     from tcod.ecs.typing import ComponentKey, _RelationTargetLookup
@@ -71,7 +72,7 @@ def _relations_lookup_from(
         for component_key, target_components in components.items():
             for target in target_components:
                 relations_lookup[(component_key, ...)].add(origin)
-                relations_lookup[(component_key, origin)].add(origin)
+                relations_lookup[(component_key, target)].add(origin)
                 relations_lookup[(origin, component_key, None)].add(target)
                 relations_lookup[(..., component_key, None)].add(target)
 
@@ -152,6 +153,9 @@ class Registry:
     dict[Entity] = entities_name
     """
 
+    _query_cache: _QueryCache = attrs.field(init=False, factory=_QueryCache, repr=False)
+    """Transient query cache, owned here so cached entities do not keep registries alive globally."""
+
     @property
     @deprecated(
         "The 'registry.global_' attribute has been deprecated. Use 'registry[None]' to access this entity.",
@@ -178,6 +182,7 @@ class Registry:
 
     def __setstate__(self, state: dict[str, Any]) -> None:
         """Unpickle this object and handle state migration."""
+        self._query_cache = _QueryCache()
         global_: Entity | None = state.pop("global_", None)  # Migrate from version <=1.2.0
 
         # These attributes contain redundant data and will be removed

tcod_ecs-5.5.0/tcod/ecs/_version.py

@@ -1,34 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = [
-    "__version__",
-    "__version_tuple__",
-    "version",
-    "version_tuple",
-    "__commit_id__",
-    "commit_id",
-]
-
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    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.5.0'
-__version_tuple__ = version_tuple = (5, 5, 0)
-
-__commit_id__ = commit_id = 'gf2ee28b92'