mesa_frames.AgentSet.get#

AgentSet.get(attr_names: int | float | date | time | datetime | timedelta | str | bool | bytes | list[Any] | Expr | Series | None | Iterable[int | float | date | time | datetime | timedelta | str | bool | bytes | list[Any] | Expr | Series | None], mask: Sequence[int] | int | Literal['all', 'active'] | None | Expr | Series | DataFrame = None) → Series | DataFrame[source]#

Retrieve agent attributes as a Series or DataFrame.

Parameters:

  • attr_names (str | Collection[str] | None, optional) – Column name or collection of names to fetch. When None, return all agent attributes (excluding any internal identifiers).

  • mask (AgentMask | None, optional) – Subset selector limiting which agents are included. None means operate on the full set.

Returns:

A Series when selecting a single attribute, otherwise a DataFrame containing the requested columns.

Return type:

Series | DataFrame