+delete buffer

Author: ikvk

README.rst

@@ -7,14 +7,15 @@ Implementation of the ECS template for creating games.
 
 Make a game instead of architecture for a game.
 
-`Документация на русском <https://github.com/ikvk/ecs_pattern/blob/master/_docs/README_RUS.rst>`_.
+`Документация на Русском <https://github.com/ikvk/ecs_pattern/blob/master/_docs/README_RUS.rst>`_.
 
 .. image:: https://img.shields.io/pypi/dm/ecs_pattern.svg?style=social
 
 ===============  ==========================================
-Python version   3.5+
+Python version   3.3+
 License          Apache-2.0
 PyPI             https://pypi.python.org/pypi/ecs_pattern/
+Dependencies     dataclasses before 3.7, typing before 3.5
 ===============  ==========================================
 
 Intro
@@ -120,6 +121,10 @@ Guide
 
     | *entities.delete* - delete entities.
 
+    | *entities.delete_buffer_add* - save entities to the delete buffer to delete later.
+
+    | *entities.delete_buffer_purge* - delete all entities from the delete buffer.
+
     | *entities.init* - initialize entities (let manager know about entities).
 
     | *entities.get_by_class* - get all entities of the specified classes.
@@ -130,10 +135,12 @@ Guide
 
         entities = EntityManager()
         entities.add(Player('Ivan', 20, 1, 2), Player('Vladimir', 30, 3, 4), Ball(0, 7))
-        for player_entity in entities.get_by_class(Player):
-            print(player_entity.name)
         for entity_with_pos in self.entities.get_with_component(ComPosition):
             print(entity_with_pos.x, entity_with_pos.y)
+        for player_entity in entities.get_by_class(Player):
+            print(player_entity.name)
+            entities.delete_buffer_add(player_entity)
+        entities.delete_buffer_purge()
         entities.delete(*tuple(next(entities.get_by_class(Ball), [])))
 
 **SystemManager**
@@ -162,7 +169,7 @@ Guide
 
 Examples
 --------
-* `Pong game: pygame + ecs-pattern <https://github.com/ikvk/ecs_pattern/tree/master/examples/pong>`_.
+* `Pong game: pygame + ecs_pattern <https://github.com/ikvk/ecs_pattern/tree/master/examples/pong>`_.
 
 Advantages
 ----------
@@ -190,13 +197,15 @@ Newbie mistakes
 * Raising ECS to the absolute, no one cancels the OOP
 * Adaptation of the existing project code under ECS "as is"
 * Use of recursive or reactive logic in systems
+* Using EntityManager.delete in get_by_class, get_with_component loops
 
 Good Practices
 --------------
 * Use components - flags
 * Minimize component change locations
 * Use event entities and event systems
 * In large projects, placing ECS objects by type is not convenient (components.py, systems.py ...). Group by responsibilities (movement.py ...)
+* Do not use methods in components and entities
 
 Releases
 --------
@@ -205,7 +214,7 @@ History of important changes: `release_notes.rst <https://github.com/ikvk/ecs_pa
 
 Help the project
 ----------------
-
-Welcome :D
-
-⭐
+* Found a bug or have a suggestion - issue / merge request 🎯
+* There is nothing to help this project with - help another open project that you are using ✋
+* Nowhere to put the money - spend it on family, friends, loved ones or people around you 💰
+* Star the project ⭐

_docs/README_RUS.rst

@@ -7,12 +7,15 @@ ecs_pattern 🚀
 
 Делайте игру вместо архитектуры для игры.
 
+`Documentation in English <https://github.com/ikvk/ecs_pattern/blob/master/README.rst>`_.
+
 .. image:: https://img.shields.io/pypi/dm/ecs_pattern.svg?style=social
 
 ===============  ==========================================
-Python version   3.5+
+Python version   3.3+
 License          Apache-2.0
 PyPI             https://pypi.python.org/pypi/ecs_pattern/
+Dependencies     dataclasses before 3.7, typing before 3.5
 ===============  ==========================================
 
 Введение
@@ -118,6 +121,10 @@ PyPI             https://pypi.python.org/pypi/ecs_pattern/
 
     | *entities.delete* - удалить сущности.
 
+    | *entities.delete_buffer_add* - сохранить сущности в буфер удаления, чтобы удалить позже.
+
+    | *entities.delete_buffer_purge* - удалить все сущности из буфера удаления.
+
     | *entities.init* - инициализировать сущности (дать менеджеру знать о сущностях).
 
     | *entities.get_by_class* - получить все сущности указанных классов.
@@ -128,10 +135,12 @@ PyPI             https://pypi.python.org/pypi/ecs_pattern/
 
         entities = EntityManager()
         entities.add(Player('Ivan', 20, 1, 2), Player('Vladimir', 30, 3, 4), Ball(0, 7))
-        for player_entity in entities.get_by_class(Player):
-            print(player_entity.name)
         for entity_with_pos in self.entities.get_with_component(ComPosition):
             print(entity_with_pos.x, entity_with_pos.y)
+        for player_entity in entities.get_by_class(Player):
+            print(player_entity.name)
+            entities.delete_buffer_add(player_entity)
+        entities.delete_buffer_purge()
         entities.delete(*tuple(next(entities.get_by_class(Ball), [])))
 
 **SystemManager**
@@ -160,7 +169,7 @@ PyPI             https://pypi.python.org/pypi/ecs_pattern/
 
 Примеры
 -------
-* `Игра Pong: pygame + ecs-pattern <https://github.com/ikvk/ecs_pattern/tree/master/examples/pong>`_.
+* `Игра Pong: pygame + ecs_pattern <https://github.com/ikvk/ecs_pattern/tree/master/examples/pong>`_.
 
 Преимущества
 ------------
@@ -188,13 +197,15 @@ PyPI             https://pypi.python.org/pypi/ecs_pattern/
 * Возведение ECS в абсолют, ООП никто не отменяет
 * Адаптация существующего кода проекта под ECS "как есть"
 * Использование рекурсивной или реактивной логики в системах
+* Использование EntityManager.delete в циклах get_by_class, get_with_component
 
 Хорошие практики
 ----------------
 * Используйте компоненты - флаги
 * Минимизируйте места изменения компонента
 * Используйте сущности-события и системы событий
 * В больших проектах размещение объектов ECS по типам не удобно (components.py, systems.py ...). Группируйте по обязанностям (movement.py ...)
+* Не используйте методы в компонентах и сущностях
 
 Релизы
 ------
@@ -203,7 +214,7 @@ PyPI             https://pypi.python.org/pypi/ecs_pattern/
 
 Помощь проекту
 --------------
-
-Приветствуется :D
-
-⭐
+* Нашли ошибку или есть предложение -  issue / merge request 🎯
+* Нечем помочь этому проекту - помогите другому открытому проекту, который используете ✋
+* Некуда деть деньги - потратьте на семью, друзей, близких или окружающих вас людей 💰
+* Поставьте проекту ⭐

_docs/release_notes.rst

@@ -1,3 +1,7 @@
+1.1.0
+=====
+* Added delete buffer: EntityManager.delete_buffer_add, EntityManager.delete_buffer_purge
+
 1.0.0
 =====
 * first version: 24 Aug 2022

ecs_pattern/__init__.py

@@ -4,4 +4,4 @@
 
 from .ecs import component, entity, EntityManager, System, SystemManager
 
-__version__ = '1.0.0'
+__version__ = '1.1.0'

ecs_pattern/ecs.py

@@ -5,6 +5,7 @@
 from typing import Iterable, Iterator, Any
 from dataclasses import dataclass
 from functools import partial
+from collections import deque
 
 # all component classes must be decorated with this function
 component = dataclass
@@ -20,6 +21,7 @@ def __init__(self):
         self._entity_map = {}  # Person: [ent1, ent2]
         self._entity_components_map = {}  # Person: (MoveCom, DamageCom, NameCom)
         self._set_cache_map = {}  # (MoveCom, DamageCom, NameCom): {MoveCom, DamageCom, NameCom}
+        self._delete_entity_buffer = deque()  # deque([Person1, Person2])
 
     def add(self, *entity_value_list: Any):
         """Add entities to world"""
@@ -39,6 +41,17 @@ def delete(self, *entity_value_list: Any):
             entity_value_class = entity_value.__class__
             self._entity_map[entity_value_class].remove(entity_value)
 
+    def delete_buffer_add(self, *entity_value_list: Any):
+        """Save entities into delete buffer for delete them from world later"""
+        for entity_value in entity_value_list:
+            self._delete_entity_buffer.append(entity_value)
+
+    def delete_buffer_purge(self):
+        """Delete all entities from delete buffer"""
+        for delete_entity in self._delete_entity_buffer:
+            self.delete(delete_entity)
+        self._delete_entity_buffer.clear()
+
     def init(self, *entity_list: Any):
         """
         Let entity manager to "know" about entities before work

examples/pong/README.rst

@@ -0,0 +1,8 @@
+.. http://docutils.sourceforge.net/docs/user/rst/quickref.html
+
+Pong game
+=========
+
+Classic game, implemented on pygame + ecs_pattern
+
+.. image:: https://github.com/ikvk/ecs_pattern/blob/master/examples/pong/_docs/pong_screen.png

examples/pong/_docs/pong_screen.png

@@ -147,13 +147,11 @@ def update(self):
             ball.speed_y = 0
         # kill sparks
         table_rect = Rect(table.x, table.y, table.sprite.rect.width, table.sprite.rect.height)
-        spark_for_del_list = []
         for spark in self.entities.get_by_class(Spark):
             if not table_rect.colliderect(
                     Rect(spark.x, spark.y, spark.sprite.rect.width, spark.sprite.rect.height)):
-                spark_for_del_list.append(spark)
-        for spark_for_del in spark_for_del_list:
-            self.entities.delete(spark_for_del)
+                self.entities.delete_buffer_add(spark)
+        self.entities.delete_buffer_purge()
 
 
 class SysGoal(System):

examples/pong/systems.py

@@ -119,6 +119,14 @@ def test_entitymanager(self):
         self.assertEqual(len(list(entities.get_with_component(ComPosition))), 0)
         self.assertEqual(len(list(entities.get_with_component(ComPerson))), 0)
 
+        entities.add(player1, player2)
+        self.assertEqual(len(list(entities.get_by_class(Player))), 2)
+        entities.delete_buffer_purge()
+        self.assertEqual(len(list(entities.get_by_class(Player))), 2)
+        entities.delete_buffer_add(player1, player2)
+        entities.delete_buffer_purge()
+        self.assertEqual(len(list(entities.get_by_class(Player))), 0)
+
     def test_system(self):
         player1 = Player('Ivan', 20, 1, 2)
         player2 = Player('Vladimir', 30, 3, 4)