Mesa 3.0.0a4__py3-none-any.whl → 3.0.0a5__py3-none-any.whl

mesa/__init__.py

@@ -1,5 +1,4 @@
-"""
-Mesa Agent-Based Modeling Framework
+"""Mesa Agent-Based Modeling Framework.
 
 Core Objects: Model, and Agent.
 """
@@ -24,7 +23,7 @@ __all__ = [
 ]
 
 __title__ = "mesa"
-__version__ = "3.0.0a4"
+__version__ = "3.0.0a5"
 __license__ = "Apache 2.0"
 _this_year = datetime.datetime.now(tz=datetime.timezone.utc).date().year
 __copyright__ = f"Copyright {_this_year} Project Mesa Team"

mesa/agent.py

@@ -1,7 +1,6 @@
-"""
-The agent class for Mesa framework.
+"""Agent related classes.
 
-Core Objects: Agent
+Core Objects: Agent and AgentSet.
 """
 
 # Mypy; for the `|` operator purpose
@@ -16,11 +15,11 @@ import operator
 import warnings
 import weakref
 from collections import defaultdict
-from collections.abc import Callable, Iterable, Iterator, MutableSet, Sequence
+from collections.abc import Callable, Hashable, Iterable, Iterator, MutableSet, Sequence
 from random import Random
 
 # mypy
-from typing import TYPE_CHECKING, Any, Literal
+from typing import TYPE_CHECKING, Any, Literal, overload
 
 if TYPE_CHECKING:
     # We ensure that these are not imported during runtime to prevent cyclic
@@ -30,8 +29,7 @@ if TYPE_CHECKING:
 
 
 class Agent:
-    """
-    Base class for a model agent in Mesa.
+    """Base class for a model agent in Mesa.
 
     Attributes:
         model (Model): A reference to the model instance.
@@ -49,11 +47,12 @@ class Agent:
     _ids = defaultdict(functools.partial(itertools.count, 1))
 
     def __init__(self, *args, **kwargs) -> None:
-        """
-        Create a new agent.
+        """Create a new agent.
 
         Args:
             model (Model): The model instance in which the agent exists.
+            args: currently ignored, to be fixed in 3.1
+            kwargs: currently ignored, to be fixed in 3.1
         """
         # TODO: Cleanup in future Mesa version (3.1+)
         match args:
@@ -89,28 +88,25 @@ class Agent:
     def step(self) -> None:
         """A single step of the agent."""
 
-    def advance(self) -> None:
+    def advance(self) -> None:  # noqa: D102
         pass
 
     @property
     def random(self) -> Random:
+        """Return a seeded rng."""
         return self.model.random
 
 
 class AgentSet(MutableSet, Sequence):
-    """
-    A collection class that represents an ordered set of agents within an agent-based model (ABM). This class
-    extends both MutableSet and Sequence, providing set-like functionality with order preservation and
+    """A collection class that represents an ordered set of agents within an agent-based model (ABM).
+
+    This class extends both MutableSet and Sequence, providing set-like functionality with order preservation and
     sequence operations.
 
     Attributes:
         model (Model): The ABM model instance to which this AgentSet belongs.
 
-    Methods:
-        __len__, __iter__, __contains__, select, shuffle, sort, _update, do, get, __getitem__,
-        add, discard, remove, __getstate__, __setstate__, random
-
-    Note:
+    Notes:
         The AgentSet maintains weak references to agents, allowing for efficient management of agent lifecycles
         without preventing garbage collection. It is associated with a specific model instance, enabling
         interactions with the model's environment and other agents.The implementation uses a WeakKeyDictionary to store agents,
@@ -118,14 +114,12 @@ class AgentSet(MutableSet, Sequence):
     """
 
     def __init__(self, agents: Iterable[Agent], model: Model):
-        """
-        Initializes the AgentSet with a collection of agents and a reference to the model.
+        """Initializes the AgentSet with a collection of agents and a reference to the model.
 
         Args:
             agents (Iterable[Agent]): An iterable of Agent objects to be included in the set.
             model (Model): The ABM model instance to which this AgentSet belongs.
         """
-
         self.model = model
         self._agents = weakref.WeakKeyDictionary({agent: None for agent in agents})
 
@@ -149,8 +143,7 @@ class AgentSet(MutableSet, Sequence):
         agent_type: type[Agent] | None = None,
         n: int | None = None,
     ) -> AgentSet:
-        """
-        Select a subset of agents from the AgentSet based on a filter function and/or quantity limit.
+        """Select a subset of agents from the AgentSet based on a filter function and/or quantity limit.
 
         Args:
             filter_func (Callable[[Agent], bool], optional): A function that takes an Agent and returns True if the
@@ -160,6 +153,7 @@ class AgentSet(MutableSet, Sequence):
               - If a float between 0 and 1, at most that fraction of original the agents are selected.
             inplace (bool, optional): If True, modifies the current AgentSet; otherwise, returns a new AgentSet. Defaults to False.
             agent_type (type[Agent], optional): The class type of the agents to select. Defaults to None, meaning no type filtering is applied.
+            n (int): deprecated, use at_most instead
 
         Returns:
             AgentSet: A new AgentSet containing the selected agents, unless inplace is True, in which case the current AgentSet is updated.
@@ -200,8 +194,7 @@ class AgentSet(MutableSet, Sequence):
         return AgentSet(agents, self.model) if not inplace else self._update(agents)
 
     def shuffle(self, inplace: bool = False) -> AgentSet:
-        """
-        Randomly shuffle the order of agents in the AgentSet.
+        """Randomly shuffle the order of agents in the AgentSet.
 
         Args:
             inplace (bool, optional): If True, shuffles the agents in the current AgentSet; otherwise, returns a new shuffled AgentSet. Defaults to False.
@@ -230,8 +223,7 @@ class AgentSet(MutableSet, Sequence):
         ascending: bool = False,
         inplace: bool = False,
     ) -> AgentSet:
-        """
-        Sort the agents in the AgentSet based on a specified attribute or custom function.
+        """Sort the agents in the AgentSet based on a specified attribute or custom function.
 
         Args:
             key (Callable[[Agent], Any] | str): A function or attribute name based on which the agents are sorted.
@@ -254,15 +246,14 @@ class AgentSet(MutableSet, Sequence):
 
     def _update(self, agents: Iterable[Agent]):
         """Update the AgentSet with a new set of agents.
+
         This is a private method primarily used internally by other methods like select, shuffle, and sort.
         """
-
         self._agents = weakref.WeakKeyDictionary({agent: None for agent in agents})
         return self
 
     def do(self, method: str | Callable, *args, **kwargs) -> AgentSet:
-        """
-        Invoke a method or function on each agent in the AgentSet.
+        """Invoke a method or function on each agent in the AgentSet.
 
         Args:
             method (str, callable): the callable to do on each agent
@@ -302,9 +293,25 @@ class AgentSet(MutableSet, Sequence):
 
         return self
 
-    def map(self, method: str | Callable, *args, **kwargs) -> list[Any]:
+    def shuffle_do(self, method: str | Callable, *args, **kwargs) -> AgentSet:
+        """Shuffle the agents in the AgentSet and then invoke a method or function on each agent.
+
+        It's a fast, optimized version of calling shuffle() followed by do().
         """
-        Invoke a method or function on each agent in the AgentSet and return the results.
+        agents = list(self._agents.keys())
+        self.random.shuffle(agents)
+
+        if isinstance(method, str):
+            for agent in agents:
+                getattr(agent, method)(*args, **kwargs)
+        else:
+            for agent in agents:
+                method(agent, *args, **kwargs)
+
+        return self
+
+    def map(self, method: str | Callable, *args, **kwargs) -> list[Any]:
+        """Invoke a method or function on each agent in the AgentSet and return the results.
 
         Args:
             method (str, callable): the callable to apply on each agent
@@ -335,8 +342,7 @@ class AgentSet(MutableSet, Sequence):
         return res
 
     def agg(self, attribute: str, func: Callable) -> Any:
-        """
-        Aggregate an attribute of all agents in the AgentSet using a specified function.
+        """Aggregate an attribute of all agents in the AgentSet using a specified function.
 
         Args:
             attribute (str): The name of the attribute to aggregate.
@@ -348,14 +354,29 @@ class AgentSet(MutableSet, Sequence):
         values = self.get(attribute)
         return func(values)
 
+    @overload
     def get(
         self,
-        attr_names: str | list[str],
+        attr_names: str,
         handle_missing: Literal["error", "default"] = "error",
         default_value: Any = None,
-    ) -> list[Any] | list[list[Any]]:
-        """
-        Retrieve the specified attribute(s) from each agent in the AgentSet.
+    ) -> list[Any]: ...
+
+    @overload
+    def get(
+        self,
+        attr_names: list[str],
+        handle_missing: Literal["error", "default"] = "error",
+        default_value: Any = None,
+    ) -> list[list[Any]]: ...
+
+    def get(
+        self,
+        attr_names,
+        handle_missing="error",
+        default_value=None,
+    ):
+        """Retrieve the specified attribute(s) from each agent in the AgentSet.
 
         Args:
             attr_names (str | list[str]): The name(s) of the attribute(s) to retrieve from each agent.
@@ -402,8 +423,7 @@ class AgentSet(MutableSet, Sequence):
             )
 
     def set(self, attr_name: str, value: Any) -> AgentSet:
-        """
-        Set a specified attribute to a given value for all agents in the AgentSet.
+        """Set a specified attribute to a given value for all agents in the AgentSet.
 
         Args:
             attr_name (str): The name of the attribute to set.
@@ -417,8 +437,7 @@ class AgentSet(MutableSet, Sequence):
         return self
 
     def __getitem__(self, item: int | slice) -> Agent:
-        """
-        Retrieve an agent or a slice of agents from the AgentSet.
+        """Retrieve an agent or a slice of agents from the AgentSet.
 
         Args:
             item (int | slice): The index or slice for selecting agents.
@@ -429,8 +448,7 @@ class AgentSet(MutableSet, Sequence):
         return list(self._agents.keys())[item]
 
     def add(self, agent: Agent):
-        """
-        Add an agent to the AgentSet.
+        """Add an agent to the AgentSet.
 
         Args:
             agent (Agent): The agent to add to the set.
@@ -441,8 +459,7 @@ class AgentSet(MutableSet, Sequence):
         self._agents[agent] = None
 
     def discard(self, agent: Agent):
-        """
-        Remove an agent from the AgentSet if it exists.
+        """Remove an agent from the AgentSet if it exists.
 
         This method does not raise an error if the agent is not present.
 
@@ -456,8 +473,7 @@ class AgentSet(MutableSet, Sequence):
             del self._agents[agent]
 
     def remove(self, agent: Agent):
-        """
-        Remove an agent from the AgentSet.
+        """Remove an agent from the AgentSet.
 
         This method raises an error if the agent is not present.
 
@@ -470,8 +486,7 @@ class AgentSet(MutableSet, Sequence):
         del self._agents[agent]
 
     def __getstate__(self):
-        """
-        Retrieve the state of the AgentSet for serialization.
+        """Retrieve the state of the AgentSet for serialization.
 
         Returns:
             dict: A dictionary representing the state of the AgentSet.
@@ -479,8 +494,7 @@ class AgentSet(MutableSet, Sequence):
         return {"agents": list(self._agents.keys()), "model": self.model}
 
     def __setstate__(self, state):
-        """
-        Set the state of the AgentSet during deserialization.
+        """Set the state of the AgentSet during deserialization.
 
         Args:
             state (dict): A dictionary representing the state to restore.
@@ -490,8 +504,7 @@ class AgentSet(MutableSet, Sequence):
 
     @property
     def random(self) -> Random:
-        """
-        Provide access to the model's random number generator.
+        """Provide access to the model's random number generator.
 
         Returns:
             Random: The random number generator associated with the model.
@@ -499,8 +512,7 @@ class AgentSet(MutableSet, Sequence):
         return self.model.random
 
     def groupby(self, by: Callable | str, result_type: str = "agentset") -> GroupBy:
-        """
-        Group agents by the specified attribute or return from the callable
+        """Group agents by the specified attribute or return from the callable.
 
         Args:
             by (Callable, str): used to determine what to group agents by
@@ -510,6 +522,7 @@ class AgentSet(MutableSet, Sequence):
                                 * if ``by`` is a str, it should refer to an attribute on the agent and the value
                                   of this attribute will be used for grouping
             result_type (str, optional): The datatype for the resulting groups {"agentset", "list"}
+
         Returns:
             GroupBy
 
@@ -541,8 +554,7 @@ class AgentSet(MutableSet, Sequence):
 
 
 class GroupBy:
-    """Helper class for AgentSet.groupby
-
+    """Helper class for AgentSet.groupby.
 
     Attributes:
         groups (dict): A dictionary with the group_name as key and group as values
@@ -550,6 +562,12 @@ class GroupBy:
     """
 
     def __init__(self, groups: dict[Any, list | AgentSet]):
+        """Initialize a GroupBy instance.
+
+        Args:
+            groups (dict): A dictionary with the group_name as key and group as values
+
+        """
         self.groups: dict[Any, list | AgentSet] = groups
 
     def map(self, method: Callable | str, *args, **kwargs) -> dict[Any, Any]:
@@ -562,6 +580,8 @@ class GroupBy:
                                     * if ``method`` is a str, it should refer to a method on the group
 
                                     Additional arguments and keyword arguments will be passed on to the callable.
+            args: arguments to pass to the callable
+            kwargs: keyword arguments to pass to the callable
 
         Returns:
             dict with group_name as key and the return of the method as value
@@ -579,7 +599,7 @@ class GroupBy:
             return {k: method(v, *args, **kwargs) for k, v in self.groups.items()}
 
     def do(self, method: Callable | str, *args, **kwargs) -> GroupBy:
-        """Apply the specified callable to each group
+        """Apply the specified callable to each group.
 
         Args:
             method (Callable, str): The callable to apply to each group,
@@ -588,6 +608,8 @@ class GroupBy:
                                     * if ``method`` is a str, it should refer to a method on the group
 
                                     Additional arguments and keyword arguments will be passed on to the callable.
+            args: arguments to pass to the callable
+            kwargs: keyword arguments to pass to the callable
 
         Returns:
             the original GroupBy instance
@@ -606,8 +628,31 @@ class GroupBy:
 
         return self
 
-    def __iter__(self):
+    def count(self) -> dict[Any, int]:
+        """Return the count of agents in each group.
+
+        Returns:
+            dict: A dictionary mapping group names to the number of agents in each group.
+        """
+        return {k: len(v) for k, v in self.groups.items()}
+
+    def agg(self, attr_name: str, func: Callable) -> dict[Hashable, Any]:
+        """Aggregate the values of a specific attribute across each group using the provided function.
+
+        Args:
+            attr_name (str): The name of the attribute to aggregate.
+            func (Callable): The function to apply (e.g., sum, min, max, mean).
+
+        Returns:
+            dict[Hashable, Any]: A dictionary mapping group names to the result of applying the aggregation function.
+        """
+        return {
+            group_name: func([getattr(agent, attr_name) for agent in group])
+            for group_name, group in self.groups.items()
+        }
+
+    def __iter__(self):  # noqa: D105
         return iter(self.groups.items())
 
-    def __len__(self):
+    def __len__(self):  # noqa: D105
         return len(self.groups)

mesa/batchrunner.py

@@ -1,3 +1,5 @@
+"""batchrunner for running a factorial experiment design over a model."""
+
 import itertools
 import multiprocessing
 from collections.abc import Iterable, Mapping
@@ -24,29 +26,19 @@ def batch_run(
 ) -> list[dict[str, Any]]:
     """Batch run a mesa model with a set of parameter values.
 
-    Parameters
-    ----------
-    model_cls : Type[Model]
-        The model class to batch-run
-    parameters : Mapping[str, Union[Any, Iterable[Any]]],
-        Dictionary with model parameters over which to run the model. You can either pass single values or iterables.
-    number_processes : int, optional
-        Number of processes used, by default 1. Set this to None if you want to use all CPUs.
-    iterations : int, optional
-        Number of iterations for each parameter combination, by default 1
-    data_collection_period : int, optional
-        Number of steps after which data gets collected, by default -1 (end of episode)
-    max_steps : int, optional
-        Maximum number of model steps after which the model halts, by default 1000
-    display_progress : bool, optional
-        Display batch run process, by default True
+    Args:
+        model_cls (Type[Model]): The model class to batch-run
+        parameters (Mapping[str, Union[Any, Iterable[Any]]]): Dictionary with model parameters over which to run the model. You can either pass single values or iterables.
+        number_processes (int, optional): Number of processes used, by default 1. Set this to None if you want to use all CPUs.
+        iterations (int, optional): Number of iterations for each parameter combination, by default 1
+        data_collection_period (int, optional): Number of steps after which data gets collected, by default -1 (end of episode)
+        max_steps (int, optional): Maximum number of model steps after which the model halts, by default 1000
+        display_progress (bool, optional): Display batch run process, by default True
 
-    Returns
-    -------
-    List[Dict[str, Any]]
-        [description]
-    """
+    Returns:
+        List[Dict[str, Any]]
 
+    """
     runs_list = []
     run_id = 0
     for iteration in range(iterations):
@@ -88,7 +80,7 @@ def _make_model_kwargs(
     parameters : Mapping[str, Union[Any, Iterable[Any]]]
         Single or multiple values for each model parameter name
 
-    Returns
+    Returns:
     -------
     List[Dict[str, Any]]
         A list of all kwargs combinations.
@@ -128,7 +120,7 @@ def _model_run_func(
     data_collection_period : int
         Number of steps after which data gets collected
 
-    Returns
+    Returns:
     -------
     List[Dict[str, Any]]
         Return model_data, agent_data from the reporters

mesa/cookiecutter-mesa/hooks/post_gen_project.py

@@ -1,3 +1,5 @@
+"""helper module."""
+
 import glob
 import os
 

mesa/cookiecutter-mesa/{{cookiecutter.snake}}/{{cookiecutter.snake}}/__init__.py

@@ -0,0 +1 @@
+"""helper modules."""