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

mesa/time.py

@@ -25,14 +25,14 @@ Key concepts:
 # Remove this __future__ import once the oldest supported Python is 3.10
 from __future__ import annotations
 
-from collections import OrderedDict, defaultdict
+from collections import defaultdict
 
 # mypy
 from typing import Iterator, Union
+
 from mesa.agent import Agent
 from mesa.model import Model
 
-
 # BaseScheduler has a self.time of int, while
 # StagedActivation has a self.time of float
 TimeT = Union[float, int]
@@ -45,7 +45,6 @@ class BaseScheduler:
     Assumes that each agent added has a *step* method which takes no arguments.
 
     (This is explicitly meant to replicate the scheduler in MASON).
-
     """
 
     def __init__(self, model: Model) -> None:
@@ -53,7 +52,7 @@ class BaseScheduler:
         self.model = model
         self.steps = 0
         self.time: TimeT = 0
-        self._agents: dict[int, Agent] = OrderedDict()
+        self._agents: dict[int, Agent] = {}
 
     def add(self, agent: Agent) -> None:
         """Add an Agent object to the schedule.
@@ -61,9 +60,7 @@ class BaseScheduler:
         Args:
             agent: An Agent to be added to the schedule. NOTE: The agent must
             have a step() method.
-
         """
-
         if agent.unique_id in self._agents:
             raise Exception(
                 f"Agent with unique id {repr(agent.unique_id)} already added to scheduler"
@@ -76,7 +73,6 @@ class BaseScheduler:
 
         Args:
             agent: An agent object.
-
         """
         del self._agents[agent.unique_id]
 
@@ -89,7 +85,7 @@ class BaseScheduler:
 
     def get_agent_count(self) -> int:
         """Returns the current number of agents in the queue."""
-        return len(self._agents.keys())
+        return len(self._agents)
 
     @property
     def agents(self) -> list[Agent]:
@@ -98,15 +94,16 @@ class BaseScheduler:
     def agent_buffer(self, shuffled: bool = False) -> Iterator[Agent]:
         """Simple generator that yields the agents while letting the user
         remove and/or add agents during stepping.
-
         """
+        # To be able to remove and/or add agents during stepping
+        # it's necessary to cast the keys view to a list.
         agent_keys = list(self._agents.keys())
         if shuffled:
             self.model.random.shuffle(agent_keys)
 
-        for key in agent_keys:
-            if key in self._agents:
-                yield self._agents[key]
+        for agent_key in agent_keys:
+            if agent_key in self._agents:
+                yield self._agents[agent_key]
 
 
 class RandomActivation(BaseScheduler):
@@ -117,7 +114,6 @@ class RandomActivation(BaseScheduler):
     default behavior for an ABM.
 
     Assumes that all agents have a step(model) method.
-
     """
 
     def step(self) -> None:
@@ -137,11 +133,12 @@ class SimultaneousActivation(BaseScheduler):
     This scheduler requires that each agent have two methods: step and advance.
     step() activates the agent and stages any necessary changes, but does not
     apply them yet. advance() then applies the changes.
-
     """
 
     def step(self) -> None:
         """Step all agents, then advance them."""
+        # To be able to remove and/or add agents during stepping
+        # it's necessary to cast the keys view to a list.
         agent_keys = list(self._agents.keys())
         for agent_key in agent_keys:
             self._agents[agent_key].step()
@@ -164,7 +161,6 @@ class StagedActivation(BaseScheduler):
 
     This schedule tracks steps and time separately. Time advances in fractional
     increments of 1 / (# of stages), meaning that 1 step = 1 unit of time.
-
     """
 
     def __init__(
@@ -184,22 +180,24 @@ class StagedActivation(BaseScheduler):
             shuffle_between_stages: If True, shuffle the agents after each
                                     stage; otherwise, only shuffle at the start
                                     of each step.
-
         """
         super().__init__(model)
-        self.stage_list = ["step"] if not stage_list else stage_list
+        self.stage_list = stage_list if stage_list else ["step"]
         self.shuffle = shuffle
         self.shuffle_between_stages = shuffle_between_stages
         self.stage_time = 1 / len(self.stage_list)
 
     def step(self) -> None:
         """Executes all the stages for all agents."""
+        # To be able to remove and/or add agents during stepping
+        # it's necessary to cast the keys view to a list.
         agent_keys = list(self._agents.keys())
         if self.shuffle:
             self.model.random.shuffle(agent_keys)
         for stage in self.stage_list:
             for agent_key in agent_keys:
-                getattr(self._agents[agent_key], stage)()  # Run stage
+                if agent_key in self._agents:
+                    getattr(self._agents[agent_key], stage)()  # Run stage
             # We recompute the keys because some agents might have been removed
             # in the previous loop.
             agent_keys = list(self._agents.keys())
@@ -241,7 +239,6 @@ class RandomActivationByType(BaseScheduler):
         Args:
             agent: An Agent to be added to the schedule.
         """
-
         super().add(agent)
         agent_class: type[Agent] = type(agent)
         self.agents_by_type[agent_class][agent.unique_id] = agent
@@ -250,7 +247,6 @@ class RandomActivationByType(BaseScheduler):
         """
         Remove all instances of a given agent from the schedule.
         """
-
         del self._agents[agent.unique_id]
 
         agent_class: type[Agent] = type(agent)
@@ -266,6 +262,8 @@ class RandomActivationByType(BaseScheduler):
             shuffle_agents: If True, the order of execution of each agents in a
                             type group is shuffled.
         """
+        # To be able to remove and/or add agents during stepping
+        # it's necessary to cast the keys view to a list.
         type_keys: list[type[Agent]] = list(self.agents_by_type.keys())
         if shuffle_types:
             self.model.random.shuffle(type_keys)
@@ -286,10 +284,11 @@ class RandomActivationByType(BaseScheduler):
         if shuffle_agents:
             self.model.random.shuffle(agent_keys)
         for agent_key in agent_keys:
-            self.agents_by_type[type_class][agent_key].step()
+            if agent_key in self.agents_by_type[type_class]:
+                self.agents_by_type[type_class][agent_key].step()
 
     def get_type_count(self, type_class: type[Agent]) -> int:
         """
         Returns the current number of agents of certain type in the queue.
         """
-        return len(self.agents_by_type[type_class].values())
+        return len(self.agents_by_type[type_class])

mesa/visualization/ModularVisualization.py

@@ -93,20 +93,20 @@ Client -> Server:
     {
     "type": "get_params"
     }
-
 """
 import asyncio
 import os
 import platform
+import webbrowser
+
 import tornado.autoreload
+import tornado.escape
+import tornado.gen
 import tornado.ioloop
 import tornado.web
 import tornado.websocket
-import tornado.escape
-import tornado.gen
-import webbrowser
 
-from mesa.visualization.UserParam import UserSettableParameter, UserParam
+from mesa.visualization.UserParam import UserParam, UserSettableParameter
 
 # Suppress several pylint warnings for this file.
 # Attributes being defined outside of init is a Tornado feature.
@@ -145,7 +145,6 @@ class VisualizationElement:
     Methods:
         render: Takes a model object, and produces JSON data which can be sent
                 to the client.
-
     """
 
     package_includes = []
@@ -165,7 +164,6 @@ class VisualizationElement:
 
         Returns:
             A JSON-ready object.
-
         """
         return "<b>VisualizationElement goes here</b>."
 
@@ -297,7 +295,12 @@ class ModularServer(tornado.web.Application):
             tornado.web.StaticFileHandler,
             {"path": os.path.dirname(__file__) + "/templates"},
         )
-        self.handlers = [page_handler, socket_handler, static_handler]
+        custom_handler = (
+            r"/local/custom/(.*)",
+            tornado.web.StaticFileHandler,
+            {"path": ""},
+        )
+        self.handlers = [page_handler, socket_handler, static_handler, custom_handler]
 
         self.settings = {
             "debug": True,
@@ -384,7 +387,6 @@ class ModularServer(tornado.web.Application):
     def render_model(self):
         """Turn the current state of the model into a dictionary of
         visualizations
-
         """
         visualization_state = []
         for element in self.visualization_elements:

mesa/visualization/TextVisualization.py

@@ -24,7 +24,6 @@ one ASCII character via a converter method. This (as opposed to a dictionary)
 is used so as to allow the method to access Agent internals, as well as to
 potentially render a cell based on several values (e.g. an Agent grid and a
 Patch value grid).
-
 """
 # Pylint instructions: allow single-character variable names.
 # pylint: disable=invalid-name
@@ -38,7 +37,6 @@ class TextVisualization:
         model: The underlying model object to be visualized.
         elements: List of visualization elements, which will be rendered
                     in the order they are added.
-
     """
 
     def __init__(self, model):
@@ -97,7 +95,6 @@ class TextGrid(ASCIIElement):
 
     Properties:
         grid: The underlying grid object.
-
     """
 
     grid = None

mesa/visualization/UserParam.py

@@ -1,6 +1,5 @@
-from warnings import warn
 import numbers
-
+from warnings import warn
 
 NUMBER = "number"
 CHECKBOX = "checkbox"
@@ -67,7 +66,6 @@ class UserSettableParameter:
         choices=None,
         description=None,
     ):
-
         warn(
             "UserSettableParameter is deprecated in favor of UserParam objects "
             "such as Slider, Checkbox, Choice, StaticText, NumberInput. "
@@ -75,7 +73,7 @@ class UserSettableParameter:
             "UserSettableParameter will be removed in the next major release."
         )
         if choices is None:
-            choices = list()
+            choices = []
         if param_type not in self.TYPES:
             raise ValueError(f"{param_type} is not a valid Option type")
         self.param_type = param_type
@@ -92,7 +90,7 @@ class UserSettableParameter:
         valid = True
 
         if self.param_type == self.NUMBER:
-            valid = not (self.value is None)
+            valid = self.value is not None
 
         elif self.param_type == self.SLIDER:
             valid = not (
@@ -123,12 +121,11 @@ class UserSettableParameter:
                 self._value = self.min_value
             elif self._value > self.max_value:
                 self._value = self.max_value
-        elif self.param_type == self.CHOICE:
-            if self._value not in self.choices:
-                print(
-                    "Selected choice value not in available choices, selected first choice from 'choices' list"
-                )
-                self._value = self.choices[0]
+        elif (self.param_type == self.CHOICE) and self._value not in self.choices:
+            print(
+                "Selected choice value not in available choices, selected first choice from 'choices' list"
+            )
+            self._value = self.choices[0]
 
     @property
     def json(self):

mesa/visualization/__init__.py

@@ -6,5 +6,4 @@ TextVisualization: Base class for writing ASCII visualizations of model state.
 
 TextServer: Class which takes a TextVisualization child class as an input, and
 renders it in-browser, along with an interface.
-
 """

mesa/visualization/modules/BarChartVisualization.py

@@ -3,10 +3,10 @@ Pie Chart Module
 ============
 
 Module for drawing live-updating bar charts using d3.js
-
 """
 import json
-from mesa.visualization.ModularVisualization import VisualizationElement, D3_JS_FILE
+
+from mesa.visualization.ModularVisualization import D3_JS_FILE, VisualizationElement
 
 
 class BarChartModule(VisualizationElement):
@@ -24,7 +24,6 @@ class BarChartModule(VisualizationElement):
         canvas_height, canvas_width: The width and height to draw the chart on the page, in pixels.
                                     Default to 800 x 400
         data_collector_name: Name of the DataCollector object in the model to retrieve data from.
-
     """
 
     package_includes = [D3_JS_FILE, "BarChartModule.js"]
@@ -76,20 +75,20 @@ class BarChartModule(VisualizationElement):
         if self.scope == "agent":
             df = data_collector.get_agent_vars_dataframe().astype("float")
             latest_step = df.index.levels[0][-1]
-            labelStrings = [f["Label"] for f in self.fields]
-            dict = df.loc[latest_step].T.loc[labelStrings].to_dict()
+            label_strings = [f["Label"] for f in self.fields]
+            dict = df.loc[latest_step].T.loc[label_strings].to_dict()
             current_values = list(dict.values())
 
         elif self.scope == "model":
-            outDict = {}
+            out_dict = {}
             for s in self.fields:
                 name = s["Label"]
                 try:
                     val = data_collector.model_vars[name][-1]
                 except (IndexError, KeyError):
                     val = 0
-                outDict[name] = val
-            current_values.append(outDict)
+                out_dict[name] = val
+            current_values.append(out_dict)
         else:
             raise ValueError("scope must be 'agent' or 'model'")
         return current_values

mesa/visualization/modules/CanvasGridVisualization.py

@@ -3,9 +3,9 @@ Modular Canvas Rendering
 ========================
 
 Module for visualizing model objects in grid cells.
-
 """
 from collections import defaultdict
+
 from mesa.visualization.ModularVisualization import VisualizationElement
 
 
@@ -59,7 +59,6 @@ class CanvasGrid(VisualizationElement):
         canvas_height, canvas_width: Size, in pixels, of the grid visualization
                                      to draw on the client.
         template: "canvas_module.html" stores the module's HTML template.
-
     """
 
     package_includes = ["GridDraw.js", "CanvasModule.js", "InteractionHandler.js"]
@@ -80,7 +79,6 @@ class CanvasGrid(VisualizationElement):
             grid_width, grid_height: Size of the grid, in cells.
             canvas_height, canvas_width: Size of the canvas to draw in the
                                          client, in pixels. (default: 500x500)
-
         """
         self.portrayal_method = portrayal_method
         self.grid_width = grid_width

mesa/visualization/modules/ChartVisualization.py

@@ -3,10 +3,10 @@ Chart Module
 ============
 
 Module for drawing live-updating line charts using Charts.js
-
 """
 import json
-from mesa.visualization.ModularVisualization import VisualizationElement, CHART_JS_FILE
+
+from mesa.visualization.ModularVisualization import CHART_JS_FILE, VisualizationElement
 
 
 class ChartModule(VisualizationElement):
@@ -39,7 +39,6 @@ class ChartModule(VisualizationElement):
         More Pythonic customization; in particular, have both series-level and
         chart-level options settable in Python, and passed to the front-end
         the same way that "Color" is currently.
-
     """
 
     package_includes = [CHART_JS_FILE, "ChartModule.js"]

mesa/visualization/modules/HexGridVisualization.py

@@ -3,9 +3,9 @@ Modular Canvas Rendering
 ========================
 
 Module for visualizing model objects in hexagonal grid cells.
-
 """
 from collections import defaultdict
+
 from mesa.visualization.ModularVisualization import VisualizationElement
 
 
@@ -36,7 +36,6 @@ class CanvasHexGrid(VisualizationElement):
         canvas_height, canvas_width: Size, in pixels, of the grid visualization
                                      to draw on the client.
         template: "canvas_module.html" stores the module's HTML template.
-
     """
 
     package_includes = ["HexDraw.js", "CanvasHexModule.js", "InteractionHandler.js"]
@@ -60,7 +59,6 @@ class CanvasHexGrid(VisualizationElement):
             grid_width, grid_height: Size of the grid, in cells.
             canvas_height, canvas_width: Size of the canvas to draw in the
                                          client, in pixels. (default: 500x500)
-
         """
         self.portrayal_method = portrayal_method
         self.grid_width = grid_width

mesa/visualization/modules/NetworkVisualization.py

@@ -3,9 +3,8 @@ Network Visualization Module
 ============
 
 Module for rendering the network, using [d3.js](https://d3js.org/) framework.
-
 """
-from mesa.visualization.ModularVisualization import VisualizationElement, D3_JS_FILE
+from mesa.visualization.ModularVisualization import D3_JS_FILE, VisualizationElement
 
 
 class NetworkModule(VisualizationElement):

mesa/visualization/modules/PieChartVisualization.py

@@ -3,17 +3,16 @@ Pie Chart Module
 ============
 
 Module for drawing live-updating pie charts using d3.js
-
 """
 import json
-from mesa.visualization.ModularVisualization import VisualizationElement, D3_JS_FILE
+
+from mesa.visualization.ModularVisualization import D3_JS_FILE, VisualizationElement
 
 
 class PieChartModule(VisualizationElement):
     """Each chart can visualize one set of fields from a datacollector as a
     pie chart.
 
-
     Attributes:
         fields: A list of dictionaries containing information on fields to
                 plot. Each dictionary must contain (at least) the "Label" and
@@ -24,9 +23,6 @@ class PieChartModule(VisualizationElement):
                                      the page, in pixels. Default to 500 x 500
         data_collector_name: Name of the DataCollector object in the model to
                              retrieve data from.
-
-
-
     """
 
     package_includes = [D3_JS_FILE, "PieChartModule.js"]

mesa/visualization/templates/js/GridDraw.js

@@ -57,7 +57,7 @@ const GridVisualization = function (
   // Calls the appropriate shape(agent)
   this.drawLayer = function (portrayalLayer) {
     // Re-initialize the lookup table
-    interactionHandler ? interactionHandler.mouseoverLookupTable.init() : null;
+    if (interactionHandler) interactionHandler.mouseoverLookupTable.init();
 
     for (const i in portrayalLayer) {
       const p = portrayalLayer[i];
@@ -72,9 +72,7 @@ const GridVisualization = function (
       p.y = gridHeight - p.y - 1;
 
       // if a handler exists, add coordinates for the portrayalLayer index
-      interactionHandler
-        ? interactionHandler.mouseoverLookupTable.set(p.x, p.y, i)
-        : null;
+      if (interactionHandler) interactionHandler.mouseoverLookupTable.set(p.x, p.y, i);
 
       // If the stroke color is not defined, then the first color in the colors array is the stroke color.
       if (!p.stroke_color) p.stroke_color = p.Color[0];
@@ -127,9 +125,7 @@ const GridVisualization = function (
         this.drawCustomImage(p.Shape, p.x, p.y, p.scale, p.text, p.text_color);
     }
     // if a handler exists, update its mouse listeners with the new data
-    interactionHandler
-      ? interactionHandler.updateMouseListeners(portrayalLayer)
-      : null;
+    if (interactionHandler) interactionHandler.updateMouseListeners(portrayalLayer);
   };
 
   // DRAWING METHODS
@@ -359,7 +355,7 @@ const GridVisualization = function (
 
   this.drawCustomImage = function (shape, x, y, scale, text, text_color_) {
     const img = new Image();
-    img.src = "local/".concat(shape);
+    img.src = "local/custom/".concat(shape);
     if (scale === undefined) {
       scale = 1;
     }
@@ -393,8 +389,8 @@ const GridVisualization = function (
   this.drawGridLines = function () {
     context.beginPath();
     context.strokeStyle = "#eee";
-    maxX = cellWidth * gridWidth;
-    maxY = cellHeight * gridHeight;
+    const maxX = cellWidth * gridWidth;
+    const maxY = cellHeight * gridHeight;
 
     // Draw horizontal grid lines:
     for (let y = 0; y <= maxY; y += cellHeight) {

mesa/visualization/templates/js/HexDraw.js

@@ -55,12 +55,12 @@ const HexVisualization = function (
   const maxR = Math.min(cellHeight, cellWidth) / 2 - 1;
 
   // Configure the interaction handler to use a hex coordinate mapper
-  interactionHandler ? interactionHandler.setCoordinateMapper("hex") : null;
+  if (interactionHandler) interactionHandler.setCoordinateMapper("hex");
 
   // Calls the appropriate shape(agent)
   this.drawLayer = function (portrayalLayer) {
     // Re-initialize the lookup table
-    interactionHandler ? interactionHandler.mouseoverLookupTable.init() : null;
+    if (interactionHandler) interactionHandler.mouseoverLookupTable.init();
     for (const i in portrayalLayer) {
       const p = portrayalLayer[i];
       // Does the inversion of y positioning because of html5
@@ -69,9 +69,7 @@ const HexVisualization = function (
       p.y = gridHeight - p.y - 1;
 
       // if a handler exists, add coordinates for the portrayalLayer index
-      interactionHandler
-        ? interactionHandler.mouseoverLookupTable.set(p.x, p.y, i)
-        : null;
+      if (interactionHandler) interactionHandler.mouseoverLookupTable.set(p.x, p.y, i);
 
       if (p.Shape == "hex")
         this.drawHex(p.x, p.y, p.r, p.Color, p.Filled, p.text, p.text_color);
@@ -93,9 +91,7 @@ const HexVisualization = function (
         this.drawCustomImage(p.Shape, p.x, p.y, p.scale, p.text, p.text_color);
     }
     // if a handler exists, update its mouse listeners with the new data
-    interactionHandler
-      ? interactionHandler.updateMouseListeners(portrayalLayer)
-      : null;
+    if (interactionHandler) interactionHandler.updateMouseListeners(portrayalLayer);
   };
 
   // DRAWING METHODS
@@ -158,7 +154,7 @@ const HexVisualization = function (
     } else {
       cy = (y + 0.5) * cellHeight + cellHeight / 2;
     }
-    maxHexRadius = cellHeight / Math.sqrt(3);
+    const maxHexRadius = cellHeight / Math.sqrt(3);
     const r = radius * maxHexRadius;
 
     function hex_corner(x, y, size, i) {

mesa/visualization/templates/js/InteractionHandler.js

@@ -125,8 +125,6 @@ const InteractionHandler = function (width, height, gridWidth, gridHeight, ctx)
 
       // map the event to x,y coordinates
       const position = coordinateMapper(event);
-      const yPosition = Math.floor(event.offsetY / cellHeight);
-      const xPosition = Math.floor(event.offsetX / cellWidth);
 
       // look up the portrayal items the coordinates refer to and draw a tooltip
       mouseoverLookupTable

tests/test_batchrunner.py

@@ -1,20 +1,19 @@
 """
 Test the BatchRunner
 """
+import unittest
 from functools import reduce
 from operator import mul
-import unittest
 
 from mesa import Agent, Model
-from mesa.time import BaseScheduler
-from mesa.datacollection import DataCollector
 from mesa.batchrunner import (
     BatchRunner,
     FixedBatchRunner,
     ParameterProduct,
     ParameterSampler,
 )
-
+from mesa.datacollection import DataCollector
+from mesa.time import BaseScheduler
 
 NUM_AGENTS = 7
 

tests/test_batchrunnerMP.py

@@ -1,15 +1,15 @@
 """
 Test the BatchRunner
 """
+import unittest
 from functools import reduce
+from multiprocessing import cpu_count, freeze_support
 from operator import mul
-import unittest
 
 from mesa import Agent, Model
-from mesa.time import BaseScheduler
-from mesa.datacollection import DataCollector
 from mesa.batchrunner import BatchRunnerMP, ParameterProduct, ParameterSampler
-from multiprocessing import freeze_support, cpu_count
+from mesa.datacollection import DataCollector
+from mesa.time import BaseScheduler
 
 NUM_AGENTS = 7
 

tests/test_datacollector.py

@@ -3,7 +3,7 @@ Test the DataCollector
 """
 import unittest
 
-from mesa import Model, Agent
+from mesa import Agent, Model
 from mesa.time import BaseScheduler
 
 
@@ -148,7 +148,7 @@ class TestDataCollector(unittest.TestCase):
         assert len(data_collector.tables["Final_Values"]) == 2
         assert "agent_id" in data_collector.tables["Final_Values"]
         assert "final_value" in data_collector.tables["Final_Values"]
-        for key, data in data_collector.tables["Final_Values"].items():
+        for _key, data in data_collector.tables["Final_Values"].items():
             assert len(data) == 9
 
         with self.assertRaises(Exception):