esper 2.4__zip → 2.5__zip

esper-2.4/.github/workflows/python-package.yml → esper-2.5/.github/workflows/unit-tests.yml

@@ -1,21 +1,22 @@
-name: Python Package Tests
+name: unit tests
 
 on:
   push:
   pull_request:
 
+
 jobs:
-  test:
-    runs-on: ubuntu-20.04
+  tests:
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.6", "3.7", "3.8", "3.9", "pypy-3.6", "pypy-3.7"]
-      fail-fast: true
+        os: [ 'ubuntu-latest', 'macos-latest', 'windows-latest' ]
+        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12-dev', 'pypy-3.7' ]
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
+      - name: Python ${{ matrix.python-version }} ${{ matrix.os }}
+        uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install test dependencies

{esper-2.4 → esper-2.5}/LICENSE.rst

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

{esper-2.4 → esper-2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esper
-Version: 2.4
+Version: 2.5
 Summary: esper is a lightweight Entity System (ECS) for Python, with a focus on performance.
 Home-page: https://github.com/benmoran56/esper
 Download-URL: https://github.com/benmoran56/esper/releases
@@ -20,8 +20,9 @@ Classifier: Topic :: Games/Entertainment
 Classifier: Topic :: Software Development :: Libraries
 License-File: LICENSE.rst
 
-[![CI Status](https://readthedocs.org/projects/esper/badge/?version=latest)](https://travis-ci.org/benmoran56/esper)
-[![Documentation Status](https://readthedocs.org/projects/esper/badge/?version=latest)](https://esper.readthedocs.io/?badge=latest)
+[![pypi](https://badge.fury.io/py/esper.svg)](https://pypi.python.org/pypi/esper)
+[![rtd](https://readthedocs.org/projects/esper/badge/?version=latest)](https://esper.readthedocs.io)
+[![PyTest](https://github.com/benmoran56/esper/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/benmoran56/esper/actions/workflows/unit-tests.yml)
 
 Esper is a lightweight Entity System module for Python, with a focus on performance
 ===================================================================================
@@ -393,4 +394,6 @@ Contributions to Esper are always welcome, but there are some specific project g
 - Avoid bloat as much as possible. New features will be considered if they are commonly useful. Generally speaking, we don't want to add functionality that is better handled in another module or library. 
 - Performance is preferrable to readability.
 
-If you have any questions before contributing, feel free to `open an issue <https://github.com/benmoran56/esper/issues>`_.
+If you have any questions before contributing, feel free to [open an issue].
+
+[open an issue]: https://github.com/benmoran56/esper/issues

{esper-2.4 → esper-2.5}/README.md

@@ -1,5 +1,6 @@
-[![CI Status](https://readthedocs.org/projects/esper/badge/?version=latest)](https://travis-ci.org/benmoran56/esper)
-[![Documentation Status](https://readthedocs.org/projects/esper/badge/?version=latest)](https://esper.readthedocs.io/?badge=latest)
+[![pypi](https://badge.fury.io/py/esper.svg)](https://pypi.python.org/pypi/esper)
+[![rtd](https://readthedocs.org/projects/esper/badge/?version=latest)](https://esper.readthedocs.io)
+[![PyTest](https://github.com/benmoran56/esper/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/benmoran56/esper/actions/workflows/unit-tests.yml)
 
 Esper is a lightweight Entity System module for Python, with a focus on performance
 ===================================================================================
@@ -371,4 +372,6 @@ Contributions to Esper are always welcome, but there are some specific project g
 - Avoid bloat as much as possible. New features will be considered if they are commonly useful. Generally speaking, we don't want to add functionality that is better handled in another module or library. 
 - Performance is preferrable to readability.
 
-If you have any questions before contributing, feel free to `open an issue <https://github.com/benmoran56/esper/issues>`_.
+If you have any questions before contributing, feel free to [open an issue].
+
+[open an issue]: https://github.com/benmoran56/esper/issues

{esper-2.4 → esper-2.5}/RELEASE_NOTES

@@ -1,3 +1,23 @@
+esper 2.5
+=========
+Maintenance release
+
+Changes
+-------
+- Removing all Components from an Entity will no longer automatically delete the Entity.
+- Typing fixes and additions.
+- Entity DB check and creation is done once when Entity is created, not when adding Components.
+
+
+esper 2.4
+=========
+Maintenance release
+
+Changes
+-------
+- Minor typing changes, and docstring improvement.
+
+
 esper 2.3
 =========
 Maintenance release

{esper-2.4 → esper-2.5}/esper/__init__.py

@@ -1,21 +1,21 @@
-from __future__ import annotations
-
 import time as _time
 
 from types import MethodType as _MethodType
 
-from typing import Iterable as _Iterable
+from typing import Any as _Any
 from typing import List as _List
-from typing import Optional as _Optional
-from typing import Tuple as _Tuple
 from typing import Type as _Type
+from typing import Tuple as _Tuple
 from typing import TypeVar as _TypeVar
+from typing import Iterable as _Iterable
+from typing import Optional as _Optional
+from typing import overload as _overload
 
 from weakref import ref as _ref
 from weakref import WeakMethod as _WeakMethod
 
 
-version = '2.4'
+version = '2.5'
 
 
 ###################
@@ -88,6 +88,9 @@ def remove_handler(name: str, func) -> None:
 
 
 _C = _TypeVar('_C')
+_C2 = _TypeVar('_C2')
+_C3 = _TypeVar('_C3')
+_C4 = _TypeVar('_C4')
 
 
 class Processor:
@@ -116,7 +119,7 @@ class Processor:
     """
 
     priority = 0
-    world: World
+    world: "World"
 
     def process(self, *args, **kwargs):
         raise NotImplementedError
@@ -212,6 +215,9 @@ class World:
 
         entity = self._next_entity_id
 
+        if entity not in self._entities:
+            self._entities[entity] = {}
+
         for component_instance in components:
 
             component_type = type(component_instance)
@@ -221,9 +227,6 @@ class World:
 
             self._components[component_type].add(entity)
 
-            if entity not in self._entities:
-                self._entities[entity] = {}
-
             self._entities[entity][component_type] = component_instance
             self.clear_cache()
 
@@ -311,16 +314,13 @@ class World:
 
         self._components[component_type].add(entity)
 
-        if entity not in self._entities:
-            self._entities[entity] = {}
-
         self._entities[entity][component_type] = component_instance
         self.clear_cache()
 
-    def remove_component(self, entity: int, component_type: _Type[_C]) -> int:
+    def remove_component(self, entity: int, component_type: _Type[_C]) -> _C:
         """Remove a Component instance from an Entity, by type.
 
-        A Component instance can be removed by providing its type.
+        A Component instance can only be removed by providing its type.
         For example: world.delete_component(enemy_a, Velocity) will remove
         the Velocity instance from the Entity enemy_a.
 
@@ -332,13 +332,8 @@ class World:
         if not self._components[component_type]:
             del self._components[component_type]
 
-        del self._entities[entity][component_type]
-
-        if not self._entities[entity]:
-            del self._entities[entity]
-
         self.clear_cache()
-        return entity
+        return self._entities[entity].pop(component_type)
 
     def _get_component(self, component_type: _Type[_C]) -> _Iterable[_Tuple[int, _C]]:
         entity_db = self._entities
@@ -365,7 +360,19 @@ class World:
                 component_type, list(self._get_component(component_type))
             )
 
-    def get_components(self, *component_types: _Type[_C]) -> _List[_Tuple[int, _List[_C]]]:
+    @_overload
+    def get_components(self, __c1: _Type[_C], __c2: _Type[_C2]) -> _List[_Tuple[int, _Tuple[_C, _C2]]]:
+        ...
+
+    @_overload
+    def get_components(self, __c1: _Type[_C], __c2: _Type[_C2], __c3: _Type[_C3]) -> _List[_Tuple[int, _Tuple[_C, _C2, _C3]]]:
+        ...
+
+    @_overload
+    def get_components(self, __c1: _Type[_C], __c2: _Type[_C2], __c3: _Type[_C3], __c4: _Type[_C4]) -> _List[_Tuple[int, _Tuple[_C, _C2, _C3, _C4]]]:
+        ...
+
+    def get_components(self, *component_types: _Type[_Any]) -> _Iterable[_Tuple[int, _Tuple[_Any, ...]]]:
         """Get an iterator for Entity and multiple Component sets."""
         try:
             return self._get_components_cache[component_types]

{esper-2.4 → esper-2.5}/esper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: esper
-Version: 2.4
+Version: 2.5
 Summary: esper is a lightweight Entity System (ECS) for Python, with a focus on performance.
 Home-page: https://github.com/benmoran56/esper
 Download-URL: https://github.com/benmoran56/esper/releases
@@ -20,8 +20,9 @@ Classifier: Topic :: Games/Entertainment
 Classifier: Topic :: Software Development :: Libraries
 License-File: LICENSE.rst
 
-[![CI Status](https://readthedocs.org/projects/esper/badge/?version=latest)](https://travis-ci.org/benmoran56/esper)
-[![Documentation Status](https://readthedocs.org/projects/esper/badge/?version=latest)](https://esper.readthedocs.io/?badge=latest)
+[![pypi](https://badge.fury.io/py/esper.svg)](https://pypi.python.org/pypi/esper)
+[![rtd](https://readthedocs.org/projects/esper/badge/?version=latest)](https://esper.readthedocs.io)
+[![PyTest](https://github.com/benmoran56/esper/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/benmoran56/esper/actions/workflows/unit-tests.yml)
 
 Esper is a lightweight Entity System module for Python, with a focus on performance
 ===================================================================================
@@ -393,4 +394,6 @@ Contributions to Esper are always welcome, but there are some specific project g
 - Avoid bloat as much as possible. New features will be considered if they are commonly useful. Generally speaking, we don't want to add functionality that is better handled in another module or library. 
 - Performance is preferrable to readability.
 
-If you have any questions before contributing, feel free to `open an issue <https://github.com/benmoran56/esper/issues>`_.
+If you have any questions before contributing, feel free to [open an issue].
+
+[open an issue]: https://github.com/benmoran56/esper/issues

{esper-2.4 → esper-2.5}/esper.egg-info/SOURCES.txt

@@ -1,5 +1,4 @@
 .gitignore
-.travis.yml
 LICENSE.rst
 MANIFEST.in
 README.md
@@ -9,7 +8,7 @@ setup.py
 .github/ISSUE_TEMPLATE/bug_report.md
 .github/ISSUE_TEMPLATE/feature_request.md
 .github/ISSUE_TEMPLATE/question-or-comment.md
-.github/workflows/python-package.yml
+.github/workflows/unit-tests.yml
 docs/Makefile
 docs/conf.py
 docs/index.rst

{esper-2.4 → esper-2.5}/tests/test_world.py

@@ -39,6 +39,11 @@ def test_create_entity_with_components(world):
     assert world.has_component(entity2, ComponentB) is True
 
 
+def test_adding_component_to_not_existing_entity_raises_error(world):
+    with pytest.raises(KeyError):
+        world.add_component(123, ComponentA())
+
+
 def test_create_entity_and_add_components(world):
     entity1 = world.create_entity()
     world.add_component(entity1, ComponentA())
@@ -59,18 +64,17 @@ def test_delete_entity(world):
     world.add_component(entity1, ComponentC())
     entity2 = world.create_entity()
     world.add_component(entity2, ComponentD())
-    entity3 = world.create_entity()
-    world.add_component(entity3, ComponentE())
-    entity4 = world.create_entity()
+    entity_with_component = world.create_entity()
+    world.add_component(entity_with_component, ComponentE())
+    empty_entity = world.create_entity()
 
-    assert entity3 == 3
-    world.delete_entity(entity3, immediate=True)
+    assert entity_with_component == 3
+    world.delete_entity(entity_with_component, immediate=True)
     with pytest.raises(KeyError):
-        world.components_for_entity(entity3)
+        world.components_for_entity(entity_with_component)
     with pytest.raises(KeyError):
         world.delete_entity(999, immediate=True)
-    with pytest.raises(KeyError):
-        world.delete_entity(entity4, immediate=True)
+    world.delete_entity(empty_entity, immediate=True)
 
 
 def test_component_for_entity(world):
@@ -256,17 +260,71 @@ def test_cache_results(world):
     assert len(list(query for query in world.get_components(ComponentB, ComponentC))) == 1
 
 
-def test_entity_exists(world):
-    dead_entity = world.create_entity(ComponentB())
-    world.delete_entity(dead_entity)
-    empty_entity = world.create_entity()
-    existent_entity = world.create_entity(ComponentA())
-    future_entity = existent_entity + 1
+class TestEntityExists:
+    def test_dead_entity(self, world):
+        dead_entity = world.create_entity(ComponentB())
+        world.delete_entity(dead_entity)
+        assert not world.entity_exists(dead_entity)
+
+    def test_not_created_entity(self, world):
+        assert not world.entity_exists(123)
+
+    def test_empty_entity(self, world):
+        empty_entity = world.create_entity()
+        assert world.entity_exists(empty_entity)
+
+    def test_entity_with_component(self, world):
+        entity_with_component = world.create_entity(ComponentA())
+        assert world.entity_exists(entity_with_component)
+
+
+class TestRemoveComponent:
+    def test_remove_from_not_existing_entity_raises_key_error(self, world):
+        with pytest.raises(KeyError):
+            world.remove_component(123, ComponentA)
+
+    def test_remove_not_existing_component_raises_key_error(self, world):
+        entity = world.create_entity(ComponentB())
+
+        with pytest.raises(KeyError):
+            world.remove_component(entity, ComponentA)
 
-    assert world.entity_exists(existent_entity)
-    assert not world.entity_exists(dead_entity)
-    assert not world.entity_exists(empty_entity)
-    assert not world.entity_exists(future_entity)
+    def test_remove_component_with_object_raises_key_error(self, populated_world):
+        entity = 2
+        component = ComponentD()
+
+        assert populated_world.has_component(entity, type(component))
+        with pytest.raises(KeyError):
+            populated_world.remove_component(entity, component)
+
+    def test_remove_component_returns_removed_instance(self, world):
+        component = ComponentA()
+        entity = world.create_entity(component)
+
+        result = world.remove_component(entity, type(component))
+
+        assert result is component
+
+    def test_remove_last_component_leaves_empty_entity(self, world):
+        entity = world.create_entity()
+        world.add_component(entity, ComponentA())
+
+        world.remove_component(entity, ComponentA)
+
+        assert not world.has_component(entity, ComponentA)
+        assert world.entity_exists(entity)
+
+    def test_removing_one_component_leaves_other_intact(self, world):
+        component_a = ComponentA()
+        component_b = ComponentB()
+        component_c = ComponentC()
+        entity = world.create_entity(component_a, component_b, component_c)
+
+        world.remove_component(entity, ComponentB)
+
+        assert world.component_for_entity(entity, ComponentA) is component_a
+        assert not world.has_component(entity, ComponentB)
+        assert world.component_for_entity(entity, ComponentC) is component_c
 
 
 def test_event_dispatch_no_handlers():
@@ -301,13 +359,14 @@ def test_set_methoad_as_handler_in_init():
         def __init__(self):
             esper.set_handler("foo", self._my_handler)
 
-        def _my_handler(self):
+        @staticmethod
+        def _my_handler():
             print("OK")
 
         def process(self, dt):
             pass
 
-    myclass = MyClass()
+    _myclass = MyClass()
     esper.dispatch_event("foo")
     esper.event_registry.clear()
 
@@ -315,7 +374,8 @@ def test_set_methoad_as_handler_in_init():
 def test_set_instance_methoad_as_handler():
     class MyClass(esper.Processor):
 
-        def my_handler(self):
+        @staticmethod
+        def my_handler():
             print("OK")
 
         def process(self, dt):
@@ -377,8 +437,7 @@ class ComponentE:
 
 
 class ComponentF:
-    def __init__(self):
-        pass
+    pass
 
 
 class CorrectProcessorA(esper.Processor):

esper-2.4/.travis.yml

@@ -1,12 +0,0 @@
-dist: xenial
-language: python
-python:
-  - "3.7"
-  - "3.8"
-  - "3.9"
-  - "3.10"
-  - "nightly"
-  - "pypy3"
-
-# command to run tests:
-script: py.test -v tests