Version 1.0.11: automatically cleanup if needed

Author: brean

pathfinding/core/graph.py

@@ -10,6 +10,8 @@ def __init__(
         self.edges = edges if edges else []
         self.nodes = nodes if nodes else {}
         self.bi_directional = bi_directional
+        # we will call cleanup automatically if dirty is True
+        self.dirty = False
         self.edge_node_items()
         if not nodes:
             self.generate_nodes()

pathfinding/core/grid.py

@@ -46,6 +46,8 @@ def __init__(
         """
         self.width = width
         self.height = height
+        # we will call cleanup automatically if dirty is True
+        self.dirty = False
         self.passable_left_right_border = False
         self.passable_up_down_border = False
         if isinstance(matrix, (tuple, list)) or (

pathfinding/core/world.py

@@ -9,11 +9,20 @@
 class World:
     def __init__(self, grids: Dict[int, Grid]):
         self.grids = grids
+        self.dirty = False
 
-    def neighbors(self, node: Node, diagonal_movement: DiagonalMovement) -> List[Node]:
-        return self.grids[node.grid_id].neighbors(node, diagonal_movement=diagonal_movement)
+    def cleanup(self):
+        for grid in self.grids:
+            grid.cleanup()
+
+    def neighbors(
+            self, node: Node,
+            diagonal_movement: DiagonalMovement) -> List[Node]:
+        return self.grids[node.grid_id].neighbors(
+            node, diagonal_movement=diagonal_movement)
 
     def calc_cost(self, node_a, node_b, weighted=False):
         # TODO: if node_a.grid_id != node_b.grid_id calculate distance between
         # grids as well, for now we ignore switching grids
-        return self.grids[node_a.grid_id].calc_cost(node_a, node_b, weighted=weighted)
+        return self.grids[node_a.grid_id].calc_cost(
+            node_a, node_b, weighted=weighted)

pathfinding/finder/bi_a_star.py

@@ -43,6 +43,8 @@ def find_path(self, start, end, grid):
         :param grid: grid that stores all possible steps/tiles as 2D-list
         :return:
         """
+        self.clean_grid(grid)
+
         self.start_time = time.time()  # execution time limitation
         self.runs = 0  # count number of iterations
 

pathfinding/finder/finder.py

@@ -138,6 +138,12 @@ def check_neighbors(self, start, end, graph, open_list,
         raise NotImplementedError(
             'Please implement check_neighbors in your finder')
 
+    def clean_grid(self, grid):
+        """clean the map if needed."""
+        if grid.dirty:
+            grid.cleanup()
+        grid.dirty = True
+
     def find_path(self, start, end, grid):
         """
         find a path from start to end node on grid by iterating over
@@ -148,6 +154,8 @@ def find_path(self, start, end, grid):
         (can be a list of grids)
         :return:
         """
+        self.clean_grid(grid)
+
         self.start_time = time.time()  # execution time limitation
         self.runs = 0  # count number of iterations
         start.opened = True

pathfinding/finder/ida_star.py

@@ -97,6 +97,8 @@ def search(self, node, g, cutoff, path, depth, end, grid):
         return min_t
 
     def find_path(self, start, end, grid):
+        self.clean_grid(grid)
+
         self.start_time = time.time()  # execution time limitation
         self.runs = 0  # count number of iterations
 

pathfinding/finder/msp.py

@@ -1,4 +1,3 @@
-import heapq
 import time
 from collections import deque, namedtuple
 from ..core import heuristic
@@ -49,6 +48,8 @@ def itertree(self, grid, start):
                         grid, neighbor, node, end, open_list, open_value=True)
 
     def find_path(self, start, end, grid):
+        self.clean_grid(grid)
+
         self.start_time = time.time()  # execution time limitation
         self.runs = 0  # count number of iterations
 
@@ -61,5 +62,4 @@ def find_path(self, start, end, grid):
                     step = step.parent
                 path.appendleft(step)
                 return path, self.runs
-        else:
-            return [], self.runs
+        return [], self.runs

setup.py

@@ -11,7 +11,7 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/brean/python-pathfinding",
-    version="1.0.10",
+    version="1.0.11",
     license="MIT",
     author="Andreas Bresser",
     packages=find_packages(),