esper 3.7__tar.gz → 3.8__tar.gz

{esper-3.7 → esper-3.8}/.github/workflows/unit-tests.yml

@@ -14,9 +14,9 @@ jobs:
         python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13', '3.14', 'pypy-3.10' ]
     steps:
       - name: Python ${{ matrix.python-version }} ${{ matrix.os }}
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install test dependencies

{esper-3.7 → esper-3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esper
-Version: 3.7
+Version: 3.8
 Summary: esper is a lightweight Entity System (ECS) for Python, with a focus on performance
 Author-email: Benjamin Moran <benmoran@protonmail.com>
 Requires-Python: >=3.8

{esper-3.7 → esper-3.8}/RELEASE_NOTES

@@ -1,3 +1,13 @@
+esper 3.8
+=========
+Maintenance release
+
+Changes
+-------
+- Fix incorrect return type hints for try_components. #120
+- Fix bug where cached components could be lost when switching worlds. #121
+
+
 esper 3.7
 =========
 Maintenance release

{esper-3.7 → esper-3.8}/esper/__init__.py

@@ -22,7 +22,7 @@ from math import inf
 
 from itertools import count as _count
 
-__version__ = version = '3.7'
+__version__ = version = '3.8'
 
 
 ###################
@@ -203,9 +203,6 @@ def switch_world(name: str) -> None:
 
     .. note:: At startup, a "default" World context is active.
     """
-    if name not in _context_map:
-        _context_map[name] = (_count(start=1), {}, {}, set(), {}, {}, [], {}, False, {}, {})
-
     global _current_world
     global _entity_count
     global _components
@@ -220,6 +217,17 @@ def switch_world(name: str) -> None:
     global event_registry
     global current_world
 
+    if _current_world is not None:
+        _context_map[_current_world] = (
+            _entity_count, _components, _entities, _dead_entities,
+            _get_component_cache, _get_components_cache,
+            _processors, _processors_dict, _cache_dirty,
+            process_times, event_registry,
+        )
+
+    if name not in _context_map:
+        _context_map[name] = (_count(start=1), {}, {}, set(), {}, {}, [], {}, False, {}, {})
+
     (_entity_count, _components, _entities, _dead_entities, _get_component_cache,
      _get_components_cache, _processors, _processors_dict, _cache_dirty,
      process_times, event_registry) = _context_map[name]
@@ -461,7 +469,7 @@ def try_remove_component(entity: int, component_type: type[_C]) -> _C | None:
             del _components[component_type]
 
         clear_cache()
-        return _entities[entity].pop(component_type)  # type: ignore[no-any-return]
+        return _entities[entity].pop(component_type, None)  # type: ignore[no-any-return]
 
     return None
 
@@ -579,17 +587,17 @@ def try_component(entity: int, component_type: type[_C]) -> _C | None:
 
 
 @_overload
-def try_components(entity: int, __c1: type[_C], __c2: type[_C2]) -> tuple[_C, _C2]:
+def try_components(entity: int, __c1: type[_C], __c2: type[_C2]) -> tuple[_C, _C2] | None:
     ...
 
 
 @_overload
-def try_components(entity: int, __c1: type[_C], __c2: type[_C2], __c3: type[_C3]) -> tuple[_C, _C2, _C3]:
+def try_components(entity: int, __c1: type[_C], __c2: type[_C2], __c3: type[_C3]) -> tuple[_C, _C2, _C3] | None:
     ...
 
 
 @_overload
-def try_components(entity: int, __c1: type[_C], __c2: type[_C2], __c3: type[_C3], __c4: type[_C4]) -> tuple[_C, _C2, _C3, _C4]:
+def try_components(entity: int, __c1: type[_C], __c2: type[_C2], __c3: type[_C3], __c4: type[_C4]) -> tuple[_C, _C2, _C3, _C4] | None:
     ...
 
 

{esper-3.7 → esper-3.8}/examples/benchmark.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 import gc
 import random
@@ -26,8 +25,7 @@ parser.add_option("-e", "--entities", dest="entities", action="store", default=5
 
 MAX_ENTITIES = options.entities
 if MAX_ENTITIES <= 500:
-    print("The number of entities must be greater than 500.")
-    sys.exit(1)
+    sys.exit("The number of entities must be greater than 500.")
 
 if options.walltime:
     print("Benchmarking wall clock time...\n")
@@ -35,6 +33,12 @@ if options.walltime:
 else:
     time_query = time.process_time
 
+if options.plot:
+    try:
+        from matplotlib import pyplot as plt
+    except ImportError:
+        sys.exit("The matplotlib module is required for plotting results.")
+
 
 ##########################
 # Simple timing decorator:
@@ -264,13 +268,7 @@ for amount in range(500, MAX_ENTITIES, MAX_ENTITIES//50):
 if not options.plot:
     print("\nRun 'benchmark.py --help' for details on plotting this benchmark.")
 
-if options.plot:
-    try:
-        from matplotlib import pyplot as plt
-    except ImportError:
-        print("\nThe matplotlib module is required for plotting results.")
-        sys.exit(1)
-
+else:
     plt.figure(1)
     lines = []
     for num, result in results.items():

{esper-3.7 → esper-3.8}/examples/benchmark_cache.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 import sys
 import time
@@ -9,12 +8,6 @@ from dataclasses import dataclass as component
 
 import esper
 
-try:
-    from matplotlib import pyplot
-except ImportError:
-    print("The matplotlib module is required for this benchmark.")
-    raise Exception
-
 ######################
 # Commandline options:
 ######################
@@ -25,9 +18,13 @@ parser.add_option("-e", "--entities", dest="entities", action="store", default=5
 (options, arguments) = parser.parse_args()
 
 MAX_ENTITIES = options.entities
-if MAX_ENTITIES <= 50:
-    print("The number of entities must be greater than 500.")
-    sys.exit(1)
+if MAX_ENTITIES <= 500:
+    sys.exit("The number of entities must be greater than 500.")
+
+try:
+    from matplotlib import pyplot
+except ImportError:
+    sys.exit("The matplotlib module is required for plotting results.")
 
 
 ##########################

{esper-3.7 → esper-3.8}/examples/pygame_example.py

@@ -1,11 +1,15 @@
-import pygame
+#!/usr/bin/env python
+from pathlib import Path
 
+import pygame
 import esper
 
 
 FPS = 60
 RESOLUTION = 720, 480
 
+# Parent dir of this script, to find the PNGs regardless of cwd
+path = Path(__file__).parent
 
 ##################################
 #  Define some Components:
@@ -81,10 +85,10 @@ def run():
     # Initialize Esper world, and create a "player" Entity with a few Components.
     player = esper.create_entity()
     esper.add_component(player, Velocity(x=0, y=0))
-    esper.add_component(player, Renderable(image=pygame.image.load("redsquare.png"), posx=100, posy=100))
+    esper.add_component(player, Renderable(image=pygame.image.load(path / "redsquare.png"), posx=100, posy=100))
     # Another motionless Entity:
     enemy = esper.create_entity()
-    esper.add_component(enemy, Renderable(image=pygame.image.load("bluesquare.png"), posx=400, posy=250))
+    esper.add_component(enemy, Renderable(image=pygame.image.load(path / "bluesquare.png"), posx=400, posy=250))
 
     # Create some Processor instances, and asign them to be processed.
     render_processor = RenderProcessor(window=window)

{esper-3.7 → esper-3.8}/examples/pyglet_example.py

@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 import pyglet
 import esper
 
@@ -29,8 +30,8 @@ class MovementProcessor:
     def __init__(self, minx, maxx, miny, maxy):
         super().__init__()
         self.minx = minx
-        self.miny = miny
         self.maxx = maxx
+        self.miny = miny
         self.maxy = maxy
 
     def process(self, dt):

{esper-3.7 → esper-3.8}/examples/pysdl2_example.py

@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+from pathlib import Path
 from sdl2 import *
 import sdl2.ext as ext
 import esper
@@ -5,6 +7,8 @@ import esper
 
 RESOLUTION = 720, 480
 
+# Parent dir of this script, to find the PNGs regardless of cwd
+path = Path(__file__).parent
 
 ##################################
 #  Define some Components:
@@ -66,7 +70,7 @@ class RenderProcessor:
             destination.y = int(rend.y)
             destination.w = rend.w
             destination.h = rend.h
-            SDL_RenderCopy(self.renderer.renderer, rend.texture, None, destination)
+            SDL_RenderCopy(self.renderer.sdlrenderer, rend.texture, None, destination)
         self.renderer.present()
 
 
@@ -76,7 +80,7 @@ class RenderProcessor:
 def texture_from_image(renderer, image_name):
     """Create an SDL2 Texture from an image file"""
     soft_surface = ext.load_image(image_name)
-    texture = SDL_CreateTextureFromSurface(renderer.renderer, soft_surface)
+    texture = SDL_CreateTextureFromSurface(renderer.sdlrenderer, soft_surface)
     SDL_FreeSurface(soft_surface)
     return texture
 
@@ -94,11 +98,11 @@ def run():
     # Initialize Esper world, and create a "player" Entity with a few Components.
     player = esper.create_entity()
     esper.add_component(player, Velocity(x=0, y=0))
-    esper.add_component(player, Renderable(texture=texture_from_image(renderer, "redsquare.png"),
+    esper.add_component(player, Renderable(texture=texture_from_image(renderer, str(path / "redsquare.png")),
                                            width=64, height=64, posx=100, posy=100))
     # Another motionless Entity:
     enemy = esper.create_entity()
-    esper.add_component(enemy, Renderable(texture=texture_from_image(renderer, "bluesquare.png"),
+    esper.add_component(enemy, Renderable(texture=texture_from_image(renderer, str(path / "bluesquare.png")),
                                           width=64, height=64, posx=400, posy=250))
 
     # Create some Processor instances, and asign them to be processed.

{esper-3.7 → esper-3.8}/tests/test_world.py

@@ -11,6 +11,7 @@ def _reset_to_zero():
     # Wipe out all world contexts
     # and re-create the default.
     esper._context_map.clear()
+    esper._current_world = None  # type: ignore[assignment]
     esper.switch_world("default")
 
 
@@ -709,6 +710,55 @@ def test_delete_world():
     with pytest.raises(KeyError):
          esper.delete_world("non_existent")
 
+
+def test_switch_world_cache_dirty():
+    """Verify that switching worlds preserves the cache dirty flag.
+
+    This test reproduces the bug from issue #121: get_component returns
+    stale data after switching to an already-existing world that was
+    modified by add_component.
+    """
+    esper.switch_world("issue121_test")
+
+    class Component:
+        pass
+
+    e = esper.create_entity()
+
+    c = esper.get_component(Component)
+    assert len(c) == 0
+
+    esper.add_component(e, Component())
+
+    esper.switch_world("issue121_test")
+
+    c = esper.get_component(Component)
+    assert len(c) == 1
+
+    esper.switch_world("default")
+    esper.delete_world("issue121_test")
+
+
+def test_switch_world_same_entities_preserved():
+    """Verify that switching to a world and back preserves entities and components."""
+    esper.switch_world("world_a")
+    e = esper.create_entity()
+    esper.add_component(e, ComponentA())
+
+    esper.switch_world("world_b")
+    c = esper.get_component(ComponentA)
+    assert len(c) == 0
+
+    esper.switch_world("world_a")
+    c = esper.get_component(ComponentA)
+    assert len(c) == 1
+    assert c[0][1] is not None
+
+    esper.switch_world("default")
+    esper.delete_world("world_a")
+    esper.delete_world("world_b")
+
+
 ##################################################
 #   Some helper functions and Component templates:
 ##################################################