Mesa 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

tests/test_examples.py

@@ -1,14 +1,17 @@
-import sys
-import os.path
-import unittest
 import contextlib
 import importlib
+import os.path
+import sys
+import unittest
 
 
 def classcase(name):
     return "".join(x.capitalize() for x in name.replace("-", "_").split("_"))
 
 
+@unittest.skip(
+    "Skipping TextExamples, because examples folder was moved. More discussion needed."
+)
 class TestExamples(unittest.TestCase):
     """
     Test examples' models.  This creates a model object and iterates it through
@@ -59,7 +62,7 @@ class TestExamples(unittest.TestCase):
                         f"{example.replace('-', '_')}.server"
                     )
                     server.server.render_model()
-                Model = getattr(mod, classcase(example))
-                model = Model()
+                model_class = getattr(mod, classcase(example))
+                model = model_class()
                 for _ in range(10):
                     model.step()

tests/test_grid.py

@@ -3,7 +3,9 @@ Test the Grid objects.
 """
 import random
 import unittest
-from mesa.space import Grid, SingleGrid, MultiGrid, HexGrid
+from unittest.mock import Mock, patch
+
+from mesa.space import HexGrid, MultiGrid, SingleGrid
 
 # Initial agent positions for testing
 #
@@ -14,7 +16,7 @@ from mesa.space import Grid, SingleGrid, MultiGrid, HexGrid
 #   1 0 1
 #   0 0 1
 # -------------------
-TEST_GRID = [[0, 1, 0, 1, 0], [0, 0, 1, 1, 0], [1, 1, 0, 0, 0]]
+TEST_GRID = [[0, 1, 0, 1, 0, 0], [0, 0, 1, 1, 0, 1], [1, 1, 0, 0, 0, 1]]
 
 
 class MockAgent:
@@ -28,9 +30,9 @@ class MockAgent:
         self.pos = pos
 
 
-class TestBaseGrid(unittest.TestCase):
+class TestSingleGrid(unittest.TestCase):
     """
-    Testing a non-toroidal grid.
+    Testing a non-toroidal singlegrid.
     """
 
     torus = False
@@ -39,9 +41,10 @@ class TestBaseGrid(unittest.TestCase):
         """
         Create a test non-toroidal grid and populate it with Mock Agents
         """
+        # The height needs to be even to test the edge case described in PR #1517
+        height = 6  # height of grid
         width = 3  # width of grid
-        height = 5  # height of grid
-        self.grid = Grid(width, height, self.torus)
+        self.grid = SingleGrid(width, height, self.torus)
         self.agents = []
         counter = 0
         for x in range(width):
@@ -108,10 +111,10 @@ class TestBaseGrid(unittest.TestCase):
         assert len(neighborhood) == 8
 
         neighborhood = self.grid.get_neighborhood((1, 4), moore=False)
-        assert len(neighborhood) == 3
+        assert len(neighborhood) == 4
 
         neighborhood = self.grid.get_neighborhood((1, 4), moore=True)
-        assert len(neighborhood) == 5
+        assert len(neighborhood) == 8
 
         neighborhood = self.grid.get_neighborhood((0, 0), moore=False)
         assert len(neighborhood) == 2
@@ -126,7 +129,7 @@ class TestBaseGrid(unittest.TestCase):
         assert len(neighbors) == 3
 
         neighbors = self.grid.get_neighbors((1, 3), moore=False, radius=2)
-        assert len(neighbors) == 2
+        assert len(neighbors) == 3
 
     def test_coord_iter(self):
         ci = self.grid.coord_iter()
@@ -147,8 +150,8 @@ class TestBaseGrid(unittest.TestCase):
     def test_agent_move(self):
         # get the agent at [0, 1]
         agent = self.agents[0]
-        self.grid.move_agent(agent, (1, 1))
-        assert agent.pos == (1, 1)
+        self.grid.move_agent(agent, (1, 0))
+        assert agent.pos == (1, 0)
         # move it off the torus and check for the exception
         if not self.torus:
             with self.assertRaises(Exception):
@@ -156,22 +159,51 @@ class TestBaseGrid(unittest.TestCase):
             with self.assertRaises(Exception):
                 self.grid.move_agent(agent, [1, self.grid.height + 1])
         else:
-            self.grid.move_agent(agent, [-1, 1])
-            assert agent.pos == (self.grid.width - 1, 1)
-            self.grid.move_agent(agent, [1, self.grid.height + 1])
-            assert agent.pos == (1, 1)
+            self.grid.move_agent(agent, [0, -1])
+            assert agent.pos == (0, self.grid.height - 1)
+            self.grid.move_agent(agent, [1, self.grid.height])
+            assert agent.pos == (1, 0)
 
     def test_agent_remove(self):
         agent = self.agents[0]
         x, y = agent.pos
         self.grid.remove_agent(agent)
         assert agent.pos is None
-        assert self.grid.grid[x][y] is None
+        assert self.grid[x][y] is None
+
+    def test_swap_pos(self):
+        # Swap agents positions
+        agent_a, agent_b = list(filter(None, self.grid))[:2]
+        pos_a = agent_a.pos
+        pos_b = agent_b.pos
+
+        self.grid.swap_pos(agent_a, agent_b)
+
+        assert agent_a.pos == pos_b
+        assert agent_b.pos == pos_a
+        assert self.grid[pos_a] == agent_b
+        assert self.grid[pos_b] == agent_a
+
+        # Swap the same agents
+        self.grid.swap_pos(agent_a, agent_a)
+
+        assert agent_a.pos == pos_b
+        assert self.grid[pos_b] == agent_a
+
+        # Raise for agents not on the grid
+        self.grid.remove_agent(agent_a)
+        self.grid.remove_agent(agent_b)
 
+        id_a = agent_a.unique_id
+        id_b = agent_b.unique_id
+        e_message = f"<Agent id: {id_a}>, <Agent id: {id_b}> - not on the grid"
+        with self.assertRaisesRegex(Exception, e_message):
+            self.grid.swap_pos(agent_a, agent_b)
 
-class TestBaseGridTorus(TestBaseGrid):
+
+class TestSingleGridTorus(TestSingleGrid):
     """
-    Testing the toroidal base grid.
+    Testing the toroidal singlegrid.
     """
 
     torus = True
@@ -190,25 +222,30 @@ class TestBaseGridTorus(TestBaseGrid):
         neighborhood = self.grid.get_neighborhood((0, 0), moore=False)
         assert len(neighborhood) == 4
 
+        # here we test the edge case described in PR #1517 using a radius
+        # measuring half of the grid height
+        neighborhood = self.grid.get_neighborhood((0, 0), moore=True, radius=3)
+        assert len(neighborhood) == 17
+
+        neighborhood = self.grid.get_neighborhood((1, 1), moore=False, radius=3)
+        assert len(neighborhood) == 15
+
         neighbors = self.grid.get_neighbors((1, 4), moore=False)
-        assert len(neighbors) == 1
+        assert len(neighbors) == 2
 
         neighbors = self.grid.get_neighbors((1, 4), moore=True)
-        assert len(neighbors) == 3
+        assert len(neighbors) == 4
 
         neighbors = self.grid.get_neighbors((1, 1), moore=False, include_center=True)
         assert len(neighbors) == 3
 
         neighbors = self.grid.get_neighbors((1, 3), moore=False, radius=2)
-        assert len(neighbors) == 2
+        assert len(neighbors) == 3
 
 
-class TestSingleGrid(unittest.TestCase):
+class TestSingleGridEnforcement(unittest.TestCase):
     """
-    Test the SingleGrid object.
-
-    Since it inherits from Grid, all the functionality tested above should
-    work here too. Instead, this tests the enforcement.
+    Test the enforcement in SingleGrid.
     """
 
     def setUp(self):
@@ -231,7 +268,27 @@ class TestSingleGrid(unittest.TestCase):
                 self.grid.place_agent(a, (x, y))
         self.num_agents = len(self.agents)
 
-    def test_enforcement(self):
+    @patch.object(MockAgent, "model", create=True)
+    def test_position_agent(self, mock_model):
+        a = MockAgent(100, None)
+        with self.assertRaises(Exception) as exc_info:
+            self.grid.position_agent(a, (1, 1))
+        expected = (
+            "x must be an integer or a string 'random'."
+            " Actual type: <class 'tuple'>. Actual value: (1, 1)."
+        )
+        assert str(exc_info.exception) == expected
+        with self.assertRaises(Exception) as exc_info:
+            self.grid.position_agent(a, "(1, 1)")
+        expected = (
+            "x must be an integer or a string 'random'."
+            " Actual type: <class 'str'>. Actual value: (1, 1)."
+        )
+        assert str(exc_info.exception) == expected
+        self.grid.position_agent(a, "random")
+
+    @patch.object(MockAgent, "model", create=True)
+    def test_enforcement(self, mock_model):
         """
         Test the SingleGrid empty count and enforcement.
         """
@@ -239,17 +296,16 @@ class TestSingleGrid(unittest.TestCase):
         assert len(self.grid.empties) == 9
         a = MockAgent(100, None)
         with self.assertRaises(Exception):
-            self.grid._place_agent(a, (0, 1))
+            self.grid.place_agent(a, (0, 1))
 
         # Place the agent in an empty cell
+        mock_model.schedule.get_agent_count = Mock(side_effect=lambda: len(self.agents))
         self.grid.position_agent(a)
         self.num_agents += 1
         # Test whether after placing, the empty cells are reduced by 1
         assert a.pos not in self.grid.empties
         assert len(self.grid.empties) == 8
-        for i in range(10):
-            # Since the agents and the grid are not associated with a model, we
-            # must explicitly tell move_to_empty the number of agents.
+        for _i in range(10):
             self.grid.move_to_empty(a, num_agents=self.num_agents)
         assert len(self.grid.empties) == 8
 
@@ -299,7 +355,7 @@ class TestMultiGrid(unittest.TestCase):
         counter = 0
         for x in range(width):
             for y in range(height):
-                for i in range(TEST_MULTIGRID[x][y]):
+                for _i in range(TEST_MULTIGRID[x][y]):
                     counter += 1
                     # Create and place the mock agent
                     a = MockAgent(counter, None)
@@ -343,7 +399,7 @@ class TestMultiGrid(unittest.TestCase):
 
 class TestHexGrid(unittest.TestCase):
     """
-    Testing a hexagonal grid.
+    Testing a hexagonal singlegrid.
     """
 
     def setUp(self):
@@ -391,10 +447,14 @@ class TestHexGrid(unittest.TestCase):
         neighborhood = self.grid.get_neighborhood((1, 1), include_center=True)
         assert len(neighborhood) == 7
 
+        neighborhood = self.grid.get_neighborhood((0, 0), radius=4)
+        assert len(neighborhood) == 13
+        assert sum(x + y for x, y in neighborhood) == 39
 
-class TestHexGridTorus(TestBaseGrid):
+
+class TestHexGridTorus(TestSingleGrid):
     """
-    Testing a hexagonal toroidal grid.
+    Testing a hexagonal toroidal singlegrid.
     """
 
     torus = True
@@ -435,12 +495,19 @@ class TestHexGridTorus(TestBaseGrid):
         neighborhood = self.grid.get_neighborhood((2, 4))
         assert len(neighborhood) == 6
 
+        neighborhood = self.grid.get_neighborhood((1, 1), include_center=True, radius=2)
+        assert len(neighborhood) == 13
+
+        neighborhood = self.grid.get_neighborhood((0, 0), radius=4)
+        assert len(neighborhood) == 14
+        assert sum(x + y for x, y in neighborhood) == 45
+
 
 class TestIndexing:
     # Create a grid where the content of each coordinate is a tuple of its coordinates
-    grid = Grid(3, 5, True)
+    grid = SingleGrid(3, 5, True)
     for _, x, y in grid.coord_iter():
-        grid.grid[x][y] = (x, y)
+        grid._grid[x][y] = (x, y)
 
     def test_int(self):
         assert self.grid[0][0] == (0, 0)

tests/test_import_namespace.py

@@ -3,7 +3,6 @@ def test_import():
     # https://github.com/projectmesa/mesa/pull/1294.
     import mesa
     import mesa.flat as mf
-
     from mesa.time import RandomActivation
 
     mesa.time.RandomActivation

tests/test_lifespan.py

@@ -1,10 +1,11 @@
 import unittest
 
-from mesa.time import RandomActivation
-from mesa.datacollection import DataCollector
-from mesa import Model, Agent
 import numpy as np
 
+from mesa import Agent, Model
+from mesa.datacollection import DataCollector
+from mesa.time import RandomActivation
+
 
 class LifeTimeModel(Model):
     """Simple model for running models with a finite life"""

tests/test_main.py

@@ -2,6 +2,7 @@ import os
 import sys
 import unittest
 from unittest.mock import patch
+
 from click.testing import CliRunner
 
 from mesa.main import cli
@@ -19,8 +20,11 @@ class TestCli(unittest.TestCase):
     def tearDown(self):
         sys.path[:] = self.old_sys_path
 
+    @unittest.skip(
+        "Skipping test_run, because examples folder was moved. More discussion needed."
+    )
     def test_run(self):
-        with patch("mesa.visualization.ModularServer") as ModularServer:
+        with patch("mesa.visualization.ModularServer") as ModularServer:  # noqa: N806
             example_dir = os.path.abspath(
                 os.path.join(os.path.dirname(__file__), "../examples/wolf_sheep")
             )

tests/test_scaffold.py

@@ -1,5 +1,6 @@
-import unittest
 import os
+import unittest
+
 from click.testing import CliRunner
 
 from mesa.main import cli

tests/test_space.py

@@ -4,12 +4,9 @@ import networkx as nx
 import numpy as np
 import pytest
 
-from mesa.space import ContinuousSpace
-from mesa.space import SingleGrid
-from mesa.space import NetworkGrid
+from mesa.space import ContinuousSpace, NetworkGrid, SingleGrid
 from tests.test_grid import MockAgent
 
-
 TEST_AGENTS = [(-20, -20), (-20, -20.05), (65, 18)]
 TEST_AGENTS_GRID = [(1, 1), (10, 0), (10, 10)]
 TEST_AGENTS_NETWORK_SINGLE = [0, 1, 5]
@@ -302,10 +299,10 @@ class TestSingleGrid(unittest.TestCase):
         for i, pos in enumerate(TEST_AGENTS_GRID):
             a = self.agents[i]
             assert a.pos == pos
-            assert self.space.grid[pos[0]][pos[1]] == a
+            assert self.space[pos[0]][pos[1]] == a
             self.space.remove_agent(a)
             assert a.pos is None
-            assert self.space.grid[pos[0]][pos[1]] is None
+            assert self.space[pos[0]][pos[1]] is None
 
     def test_empty_cells(self):
         if self.space.exists_empty_cells():
@@ -325,12 +322,12 @@ class TestSingleGrid(unittest.TestCase):
         _agent = self.agents[agent_number]
 
         assert _agent.pos == initial_pos
-        assert self.space.grid[initial_pos[0]][initial_pos[1]] == _agent
-        assert self.space.grid[final_pos[0]][final_pos[1]] is None
+        assert self.space[initial_pos[0]][initial_pos[1]] == _agent
+        assert self.space[final_pos[0]][final_pos[1]] is None
         self.space.move_agent(_agent, final_pos)
         assert _agent.pos == final_pos
-        assert self.space.grid[initial_pos[0]][initial_pos[1]] is None
-        assert self.space.grid[final_pos[0]][final_pos[1]] == _agent
+        assert self.space[initial_pos[0]][initial_pos[1]] is None
+        assert self.space[final_pos[0]][final_pos[1]] == _agent
 
 
 class TestSingleNetworkGrid(unittest.TestCase):
@@ -340,7 +337,7 @@ class TestSingleNetworkGrid(unittest.TestCase):
         """
         Create a test network grid and populate with Mock Agents.
         """
-        G = nx.complete_graph(TestSingleNetworkGrid.GRAPH_SIZE)
+        G = nx.cycle_graph(TestSingleNetworkGrid.GRAPH_SIZE)  # noqa: N806
         self.space = NetworkGrid(G)
         self.agents = []
         for i, pos in enumerate(TEST_AGENTS_NETWORK_SINGLE):
@@ -357,14 +354,10 @@ class TestSingleNetworkGrid(unittest.TestCase):
             assert a.pos == pos
 
     def test_get_neighbors(self):
-        assert (
-            len(self.space.get_neighbors(0, include_center=True))
-            == TestSingleNetworkGrid.GRAPH_SIZE
-        )
-        assert (
-            len(self.space.get_neighbors(0, include_center=False))
-            == TestSingleNetworkGrid.GRAPH_SIZE - 1
-        )
+        assert len(self.space.get_neighbors(0, include_center=True)) == 3
+        assert len(self.space.get_neighbors(0, include_center=False)) == 2
+        assert len(self.space.get_neighbors(2, include_center=True, radius=3)) == 7
+        assert len(self.space.get_neighbors(2, include_center=False, radius=3)) == 6
 
     def test_move_agent(self):
         initial_pos = 1
@@ -415,7 +408,7 @@ class TestMultipleNetworkGrid(unittest.TestCase):
         """
         Create a test network grid and populate with Mock Agents.
         """
-        G = nx.complete_graph(TestMultipleNetworkGrid.GRAPH_SIZE)
+        G = nx.complete_graph(TestMultipleNetworkGrid.GRAPH_SIZE)  # noqa: N806
         self.space = NetworkGrid(G)
         self.agents = []
         for i, pos in enumerate(TEST_AGENTS_NETWORK_MULTIPLE):

tests/test_time.py

@@ -4,13 +4,14 @@ Test the advanced schedulers.
 
 import unittest
 from unittest import TestCase, mock
-from mesa import Model, Agent
+
+from mesa import Agent, Model
 from mesa.time import (
     BaseScheduler,
-    StagedActivation,
     RandomActivation,
-    SimultaneousActivation,
     RandomActivationByType,
+    SimultaneousActivation,
+    StagedActivation,
 )
 
 RANDOM = "random"
@@ -29,7 +30,15 @@ class MockAgent(Agent):
         self.steps = 0
         self.advances = 0
 
+    def kill_other_agent(self):
+        for agent in self.model.schedule.agents:
+            if agent is not self:
+                self.model.schedule.remove(agent)
+                break
+
     def stage_one(self):
+        if self.model.enable_kill_other_agent:
+            self.kill_other_agent()
         self.model.log.append(self.unique_id + "_1")
 
     def stage_two(self):
@@ -39,11 +48,14 @@ class MockAgent(Agent):
         self.advances += 1
 
     def step(self):
+        if self.model.enable_kill_other_agent:
+            self.kill_other_agent()
         self.steps += 1
+        self.model.log.append(self.unique_id)
 
 
 class MockModel(Model):
-    def __init__(self, shuffle=False, activation=STAGED):
+    def __init__(self, shuffle=False, activation=STAGED, enable_kill_other_agent=False):
         """
         Creates a Model instance with a schedule
 
@@ -59,6 +71,7 @@ class MockModel(Model):
                               The default scheduler is a BaseScheduler.
         """
         self.log = []
+        self.enable_kill_other_agent = enable_kill_other_agent
 
         # Make scheduler
         if activation == STAGED:
@@ -91,7 +104,7 @@ class TestStagedActivation(TestCase):
 
     def test_no_shuffle(self):
         """
-        Testing staged activation without shuffling.
+        Testing the staged activation without shuffling.
         """
         model = MockModel(shuffle=False)
         model.step()
@@ -100,7 +113,7 @@ class TestStagedActivation(TestCase):
 
     def test_shuffle(self):
         """
-        Test staged activation with shuffling
+        Test the staged activation with shuffling
         """
         model = MockModel(shuffle=True)
         model.step()
@@ -118,7 +131,7 @@ class TestStagedActivation(TestCase):
 
     def test_remove(self):
         """
-        Test staged activation can remove an agent
+        Test the staged activation can remove an agent
         """
         model = MockModel(shuffle=True)
         agent_keys = list(model.schedule._agents.keys())
@@ -126,6 +139,15 @@ class TestStagedActivation(TestCase):
         model.schedule.remove(agent)
         assert agent not in model.schedule.agents
 
+    def test_intrastep_remove(self):
+        """
+        Test the staged activation can remove an agent in a
+        step of another agent so that the one removed doesn't step.
+        """
+        model = MockModel(shuffle=True, enable_kill_other_agent=True)
+        model.step()
+        assert len(model.log) == 2
+
     def test_add_existing_agent(self):
         model = MockModel()
         agent = model.schedule.agents[0]
@@ -162,12 +184,20 @@ class TestRandomActivation(TestCase):
         """
         Test the random activation step causes each agent to step
         """
-
         model = MockModel(activation=RANDOM)
         model.step()
         agent_steps = [i.steps for i in model.schedule.agents]
         # one step for each of 2 agents
-        assert all(map(lambda x: x == 1, agent_steps))
+        assert all(x == 1 for x in agent_steps)
+
+    def test_intrastep_remove(self):
+        """
+        Test the random activation can remove an agent in a
+        step of another agent so that the one removed doesn't step.
+        """
+        model = MockModel(activation=RANDOM, enable_kill_other_agent=True)
+        model.step()
+        assert len(model.log) == 1
 
 
 class TestSimultaneousActivation(TestCase):
@@ -184,8 +214,8 @@ class TestSimultaneousActivation(TestCase):
         # one step for each of 2 agents
         agent_steps = [i.steps for i in model.schedule.agents]
         agent_advances = [i.advances for i in model.schedule.agents]
-        assert all(map(lambda x: x == 1, agent_steps))
-        assert all(map(lambda x: x == 1, agent_advances))
+        assert all(x == 1 for x in agent_steps)
+        assert all(x == 1 for x in agent_advances)
 
 
 class TestRandomActivationByType(TestCase):
@@ -224,7 +254,7 @@ class TestRandomActivationByType(TestCase):
         model.step()
         agent_steps = [i.steps for i in model.schedule.agents]
         # one step for each of 2 agents
-        assert all(map(lambda x: x == 1, agent_steps))
+        assert all(x == 1 for x in agent_steps)
 
     def test_add_non_unique_ids(self):
         """
@@ -233,8 +263,8 @@ class TestRandomActivationByType(TestCase):
         RandomActivationByType.
         """
         model = MockModel(activation=RANDOM_BY_TYPE)
-        a = MockAgent(0, None)
-        b = MockAgent(0, None)
+        a = MockAgent(0, model)
+        b = MockAgent(0, model)
         model.schedule.add(a)
         with self.assertRaises(Exception):
             model.schedule.add(b)

tests/test_tornado.py

@@ -1,8 +1,10 @@
-from tornado.testing import AsyncHTTPTestCase
+import json
+
 import tornado
+from tornado.testing import AsyncHTTPTestCase
+
 from mesa import Model
 from mesa.visualization.ModularVisualization import ModularServer
-import json
 
 
 class TestServer(AsyncHTTPTestCase):

tests/test_usersettableparam.py

@@ -1,11 +1,12 @@
 from unittest import TestCase
+
 from mesa.visualization.UserParam import (
-    UserSettableParameter,
-    Slider,
     Checkbox,
     Choice,
-    StaticText,
     NumberInput,
+    Slider,
+    StaticText,
+    UserSettableParameter,
 )
 
 

tests/test_visualization.py

@@ -1,13 +1,12 @@
-from unittest import TestCase
 from collections import defaultdict
+from unittest import TestCase
 
 from mesa.model import Model
-from mesa.space import Grid
+from mesa.space import MultiGrid
 from mesa.time import SimultaneousActivation
 from mesa.visualization.ModularVisualization import ModularServer
 from mesa.visualization.modules import CanvasGrid, TextElement
 from mesa.visualization.UserParam import UserSettableParameter
-
 from tests.test_batchrunner import MockAgent
 
 
@@ -15,15 +14,14 @@ class MockModel(Model):
     """Test model for testing"""
 
     def __init__(self, width, height, key1=103, key2=104):
-
         self.width = width
         self.height = height
         self.key1 = (key1,)
         self.key2 = key2
         self.schedule = SimultaneousActivation(self)
-        self.grid = Grid(width, height, torus=True)
+        self.grid = MultiGrid(width, height, torus=True)
 
-        for (c, x, y) in self.grid.coord_iter():
+        for _c, x, y in self.grid.coord_iter():
             a = MockAgent(x + y * 100, self, x * y * 3)
             self.grid.place_agent(a, (x, y))
             self.schedule.add(a)
@@ -48,7 +46,6 @@ class TestModularServer(TestCase):
         }
 
     def setUp(self):
-
         self.user_params = {
             "width": 1,
             "height": 1,
@@ -68,7 +65,6 @@ class TestModularServer(TestCase):
         )
 
     def test_canvas_render_model_state(self):
-
         test_portrayal = self.portrayal(None)
         test_grid_state = defaultdict(list)
         test_grid_state[test_portrayal["Layer"]].append(test_portrayal)