tcod-ecs 5.2.3__tar.gz → 5.3.0__tar.gz

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023-2024 Kyle Benesch
+Copyright (c) 2023-2025 Kyle Benesch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: tcod-ecs
-Version: 5.2.3
+Version: 5.3.0
 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
@@ -12,6 +12,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
+License-File: LICENSE
 Requires-Dist: attrs >=23.1.0
 Requires-Dist: cattrs >=23.1.2
 Requires-Dist: sentinel-value >=1.0.0
@@ -76,7 +77,7 @@ The ECS Registry is used to create and store entities and their components.
 ## Entity
 
 Each Entity is identified by its unique id (`uid`) which can be any hashable object combined with the `registry` it belongs.
-New unique entities can be created with `Registry.new_entity` which uses a new `object()` as the `uid`, this guarantees uniqueness which is not always desireable.
+New unique entities can be created with `Registry.new_entity` which uses a new `object()` as the `uid`, this guarantees uniqueness which is not always desirable.
 An entity always knows about its assigned registry, which can be accessed with the `Entity.registry` property from any Entity instance.
 Registries only know about their entities once the entity is assigned a name, component, tag, or relation.
 

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/README.md

@@ -47,7 +47,7 @@ The ECS Registry is used to create and store entities and their components.
 ## Entity
 
 Each Entity is identified by its unique id (`uid`) which can be any hashable object combined with the `registry` it belongs.
-New unique entities can be created with `Registry.new_entity` which uses a new `object()` as the `uid`, this guarantees uniqueness which is not always desireable.
+New unique entities can be created with `Registry.new_entity` which uses a new `object()` as the `uid`, this guarantees uniqueness which is not always desirable.
 An entity always knows about its assigned registry, which can be accessed with the `Entity.registry` property from any Entity instance.
 Registries only know about their entities once the entity is assigned a name, component, tag, or relation.
 

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/pyproject.toml

@@ -66,6 +66,14 @@ warn_return_any = true
 no_implicit_reexport = true
 strict_equality = true
 
+[tool.pyright]
+reportInconsistentOverload = false
+reportIncompatibleMethodOverride = false
+reportAssignmentType = false
+reportCallIssue = false
+reportInvalidTypeVarUse = false
+reportArgumentType = false
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 required_plugins = ["pytest-cov>=4.0.0", "pytest-benchmark>=4.0.0"]
@@ -81,8 +89,6 @@ line-length = 120
 [tool.ruff.lint] # https://docs.astral.sh/ruff/rules/
 select = ["ALL"]
 ignore = [
-    "ANN101", # missing-type-self
-    "ANN102", # missing-type-cls
     "COM",    # flake8-commas, handled by formatter
     "E501",   # line-too-long
     "S101",   # assert

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/tcod/ecs/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '5.2.3'
-__version_tuple__ = version_tuple = (5, 2, 3)
+__version__ = version = '5.3.0'
+__version_tuple__ = version_tuple = (5, 3, 0)

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/tcod/ecs/entity.py

@@ -66,7 +66,7 @@ class Entity:
         >>> other_entity = registry["other"]
     """  # Changes here should be reflected in conftest.py
 
-    __slots__ = ("registry", "uid", "__weakref__")
+    __slots__ = ("__weakref__", "registry", "uid")
 
     registry: Final[Registry]  # type:ignore[misc]  # https://github.com/python/mypy/issues/5774
     """The :any:`Registry` this entity belongs to."""
@@ -77,7 +77,7 @@ class Entity:
     def world(self) -> Registry:
         """Deprecated alias for registry.
 
-        .. deprecated:: Unreleased
+        .. deprecated:: 5.1
             Use :any:`registry` instead.
         """
         if __debug__:
@@ -126,10 +126,10 @@ class Entity:
 
         .. versionadded:: 4.2.0
         """
-        self.components.clear()
-        self.tags.clear()
-        self.relation_tags_many.clear()
-        self.relation_components.clear()
+        self.components(traverse=()).clear()
+        self.tags(traverse=()).clear()
+        self.relation_tags_many(traverse=()).clear()
+        self.relation_components(traverse=()).clear()
 
     def instantiate(self) -> Self:
         """Return a new entity which inherits the components, tags, and relations of this entity.
@@ -394,7 +394,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]]], Any]):
+class EntityComponents(MutableMapping[Union[Type[Any], Tuple[object, Type[Any]]], object]):
     """A proxy attribute to access an entities components like a dictionary.
 
     See :any:`Entity.components`.
@@ -552,7 +552,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:  # type: ignore[override]
+    def setdefault(self, __key: ComponentKey[T], __default: T, /) -> T:
         """Assign a default value if a component is missing, then returns the current value."""
         try:
             return self[__key]
@@ -1040,7 +1040,7 @@ 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, object], /) -> None:
         """Redefine the component relations for this entity.
 
         ..versionadded:: 4.2.0

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/tcod/ecs/query.py

@@ -336,7 +336,7 @@ class BoundQuery:
     def world(self) -> Registry:
         """Deprecated alias for registry.
 
-        .. deprecated:: Unreleased
+        .. deprecated:: 5.1
             Use :any:`registry` instead.
         """
         if __debug__:
@@ -404,6 +404,30 @@ class BoundQuery:
             & self._query,
         )
 
+    def any_of(
+        self,
+        components: Iterable[ComponentKey[object]] = (),
+        *,
+        tags: Iterable[object] = (),
+        relations: Iterable[_RelationQuery] = (),
+        traverse: Iterable[object] = (IsA,),
+        depth: int | None = None,
+    ) -> Self:
+        """Filter entities based on having at least one of the provided elements.
+
+        .. versionadded:: 5.3
+        """
+        _check_suspicious_tags(tags, stacklevel=2)
+        return self.__class__(
+            self.registry,
+            _QueryLogicalAnd(
+                all_of=frozenset(
+                    [_QueryLogicalOr(any_of=frozenset(self.__as_queries(components, tags, relations, traverse, depth)))]
+                )
+            )
+            & self._query,
+        )
+
     def __iter__(self) -> Iterator[Entity]:
         """Iterate over the matching entities."""
         return iter(self.get_entities())

{tcod_ecs-5.2.3 → tcod_ecs-5.3.0}/tcod/ecs/typing.py

@@ -1,4 +1,4 @@
-"""Common type-hints for tcod.ecs."""
+"""Common type-hints for tcod.ecs."""  # noqa: A005
 
 from __future__ import annotations