Update dict-based agent portrayals to use `AgentPortrayalStyle` in tests by falloficarus22 · Pull Request #2934 · mesa/mesa

falloficarus22 · 2025-12-08T08:31:37Z

Summary

This PR addresses part of issue #2904 (section 1.1) by updating the older visualization test suite to replace deprecated dict-based agent portrayals with AgentPortrayalStyle and add tests to confirm the emitted FutureWarning from older dict-based agent portrayals.

Changes Made

tests/test_examples_viz.py: Updated 9 agent portrayal functions to AgentPortrayalStyle.
tests/test_solara_viz_updated.py: Updated dict-based portrayal to AgentPortrayalStyle.
tests/test_backends.py: Added tests for deprecated dict-based portrayal to confirm they emit FutureWarning.

Impact

Eliminates FutureWarning: Returning a dict from agent_portrayal is deprecated messages from the test suite.
Verifies deprecated dict-based portrayal still works (backward compatibility) while emitting the expected warning.
All visualization tests passing.
Code follows new Mesa API standards using AgentPortrayalStyle.

Testing

Ran the following tests successfully:

pytest tests/test_examples_viz.py tests/test_solara_viz_updated.py tests/test_backends.py -v

Changes by @Sahil-Chhoker:

Updated the description to match the PR’s functionality.

- Remove deprecated dict-based portrayal tests from test_backends.py - Convert dict-based portrayal to AgentPortrayalStyle in test_solara_viz_updated.py - Eliminates 3 FutureWarning messages from tests suite Fixes mesa#2904 (partial - section 1.1)

EwoutH · 2025-12-08T08:40:46Z

Thanks!

Would you like to give a shot at fixing all remaining agent_portrayal warnings?

github-actions · 2025-12-08T08:49:37Z

Performance benchmarks:

Model	Size	Init time [95% CI]	Run time [95% CI]
BoltzmannWealth	small	🔴 +7.9% [+6.8%, +9.0%]	🔵 -0.2% [-0.4%, -0.0%]
BoltzmannWealth	large	🔵 -2.8% [-15.1%, +7.2%]	🔴 +9.1% [+5.5%, +12.8%]
Schelling	small	🔵 -0.3% [-0.5%, -0.1%]	🔵 -0.6% [-0.8%, -0.4%]
Schelling	large	🔵 +7.9% [-0.2%, +21.5%]	🔴 +22.8% [+7.4%, +45.9%]
WolfSheep	small	🔵 +0.1% [-0.2%, +0.4%]	🔵 -1.6% [-1.7%, -1.5%]
WolfSheep	large	🔵 +0.1% [-2.3%, +2.2%]	🔵 +13.1% [-28.2%, +59.2%]
BoidFlockers	small	🔵 -1.5% [-1.9%, -1.0%]	🔵 +0.1% [-0.1%, +0.3%]
BoidFlockers	large	🔵 -2.0% [-2.4%, -1.7%]	🔵 -0.1% [-0.4%, +0.1%]

falloficarus22 · 2025-12-08T08:52:20Z

Thanks!

Would you like to give a shot at fixing all remaining agent_portrayal warnings?

Sure, will try

…tPortrayalStyle - Converted 9 agent_portrayal functions from dict-based to AgentPortrayalStyle - Includes complex portrayals (wolf_sheep, epstein_civil_violence) - Eliminates remaining FutureWarning messages in example tests Part of mesa#2904 (Item 1.1)

…rscape test

for more information, see https://pre-commit.ci

falloficarus22 · 2025-12-08T11:06:58Z

Hey @EwoutH , please check if the fixes I applied are correct and worth merging this PR.

EwoutH

Thanks for this. Already looks cleaner. I have a suggestion on how to handle the deprecated tests.

EwoutH · 2025-12-08T16:50:43Z

tests/test_backends.py

-    # Test with dict-based portrayal
-    def agent_portrayal_dict(agent):
-        return {"size": 5, "color": "red", "marker": "o"}
-
-    data = mb.collect_agent_data(DummySpace(), agent_portrayal_dict)
-    assert "loc" in data and data["loc"].shape[0] == 1
-


I think we can do here:

# Test with dict-based portrayal (deprecated, emits FutureWarning) def agent_portrayal_dict(agent): return {"size": 5, "color": "red", "marker": "o"} with pytest.warns(FutureWarning): data = mb.collect_agent_data(DummySpace(), agent_portrayal_dict) assert "loc" in data and data["loc"].shape[0] == 1

That way we make sure that the old behavior also keeps working until we remove it.

Okay, will work on it.

EwoutH · 2025-12-08T16:51:11Z

tests/test_backends.py

-    # Test with dict-based portrayal
-    def agent_portrayal_dict(agent):
-        return {"size": 5, "color": "red", "marker": "o"}
-
-    data = ab.collect_agent_data(DummySpace(), agent_portrayal_dict)
-    assert "loc" in data and data["loc"].shape[0] == 1
-


Idem dito

# Test with dict-based portrayal (deprecated, emits FutureWarning) def agent_portrayal_dict(agent): return {"size": 5, "color": "red", "marker": "o"} with pytest.warns(FutureWarning): data = ab.collect_agent_data(DummySpace(), agent_portrayal_dict) assert "loc" in data and data["loc"].shape[0] == 1

falloficarus22 · 2025-12-09T03:57:41Z

Hey @EwoutH verified the backward compatibilty too.

EwoutH · 2025-12-11T10:07:16Z

@Sahil-Chhoker I think it looks good, could you give a final check?

Sahil-Chhoker · 2025-12-11T10:24:02Z

tests/test_examples_viz.py

-        color = agent.wealth  # we are using a colormap to translate wealth to color
-        return {"color": color}
+        return AgentPortrayalStyle(
+            color="tab:purple" if agent.wealth > 0 else "tab:grey"
+        )


Why aren't you setting color to agent.wealth here, this is a crucial test to check if the backend is properly converting int values to a colormap, but now you are just returning two colors.

Thanks for catching that out, I'm trying to fix it now

for more information, see https://pre-commit.ci

falloficarus22 · 2025-12-11T11:51:41Z

Hey @Sahil-Chhoker , I've updated the test to use color=agent.wealth. I came across a bug in mpl_space_drawing.py: the backend was attempting to copy the scalar color value (an integer in this case) directly to edgecolors, which caused Matplotlib to crash.

I’ve pushed a fix for that backend issue along with the updated test, so AgentPortrayalStyle now correctly handles scalar values for colormapping."

Let me know if I'm wrong or if I need to change anything.

Sahil-Chhoker · 2025-12-16T05:43:33Z

Sorry for the delay @falloficarus22, and thanks for tracking the bug, this is indeed the right fix for it but can you make a separate PR with just the fix since this PR is only for the tests, first we'll merge the fix then this PR.

falloficarus22 · 2025-12-16T05:51:24Z

Sorry for the delay @falloficarus22, and thanks for tracking the bug, this is indeed the right fix for it but can you make a separate PR with just the fix since this PR is only for the tests, first we'll merge the fix then this PR.

Okay, will do.

Sahil-Chhoker

Good Work!

falloficarus22 · 2025-12-16T11:50:27Z

Good Work!

Thanks!

falloficarus22 and others added 3 commits December 8, 2025 09:32

Fix visualization tests: resolve invalid color arg and stabilize suga…

543b58f

…rscape test

[pre-commit.ci] auto fixes from pre-commit.com hooks

4941736

for more information, see https://pre-commit.ci

EwoutH reviewed Dec 8, 2025

View reviewed changes

Add pytest.warns(FutureWarning) to deprecated dict-based portrayal tests

ca616ae

falloficarus22 requested a review from EwoutH December 9, 2025 12:59

Merge branch 'mesa:main' into fix-agent-portrayal-deprecation-warnings

6ab0643

EwoutH requested a review from Sahil-Chhoker December 11, 2025 10:06

Sahil-Chhoker requested changes Dec 11, 2025

View reviewed changes

falloficarus22 and others added 3 commits December 11, 2025 11:36

Merge branch 'mesa:main' into fix-agent-portrayal-deprecation-warnings

3dd43f7

Fix scalar color handling in backend and update Boltzmann viz test

5265bf9

[pre-commit.ci] auto fixes from pre-commit.com hooks

ab41b11

for more information, see https://pre-commit.ci

falloficarus22 requested a review from Sahil-Chhoker December 11, 2025 11:49

Merge branch 'mesa:main' into fix-agent-portrayal-deprecation-warnings

0cca173

falloficarus22 mentioned this pull request Dec 16, 2025

Tracking issue: Resolve test suite warnings #2904

Closed

12 tasks

This was referenced Dec 16, 2025

Matplotlib Backend Crashes when Scalar/Numeric Values are used for Color #2958

Closed

Fix scalar color handling in legacy matplotlib backend. #2959

Merged

Merge branch 'mesa:main' into fix-agent-portrayal-deprecation-warnings

61ddbe4

Sahil-Chhoker changed the title ~~Fix agent portrayal dict deprecation warnings in tests~~ Update dict-based agent portrayals to use AgentPortrayalStyle in tests Dec 16, 2025

Sahil-Chhoker added the testing Release notes label label Dec 16, 2025

Sahil-Chhoker approved these changes Dec 16, 2025

View reviewed changes

Sahil-Chhoker merged commit 4ecebb1 into mesa:main Dec 16, 2025
13 of 14 checks passed

falloficarus22 deleted the fix-agent-portrayal-deprecation-warnings branch December 16, 2025 11:50

rico-haas mentioned this pull request Dec 17, 2025

[haasro] Reviewing exercise submission Simulation-Software-Engineering/reviewing-exercise#32

Open

Uh oh!

Conversation

falloficarus22 commented Dec 8, 2025 • edited by Sahil-Chhoker Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes Made

Impact

Testing

Uh oh!

EwoutH commented Dec 8, 2025

Uh oh!

github-actions bot commented Dec 8, 2025

Uh oh!

falloficarus22 commented Dec 8, 2025

Uh oh!

falloficarus22 commented Dec 8, 2025

Uh oh!

EwoutH left a comment

Choose a reason for hiding this comment

Uh oh!

EwoutH Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

falloficarus22 Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

EwoutH Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

falloficarus22 Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

falloficarus22 commented Dec 9, 2025

Uh oh!

EwoutH commented Dec 11, 2025

Uh oh!

Sahil-Chhoker Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

falloficarus22 Dec 11, 2025

Choose a reason for hiding this comment

Uh oh!

falloficarus22 commented Dec 11, 2025

Uh oh!

Sahil-Chhoker commented Dec 16, 2025

Uh oh!

falloficarus22 commented Dec 16, 2025

Uh oh!

Sahil-Chhoker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

falloficarus22 commented Dec 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

falloficarus22 commented Dec 8, 2025 •

edited by Sahil-Chhoker

Loading