Deprecate the agent and propertylayer portrayal dicts#3144
Merged
Conversation
Update deprecation warnings in visualization backends and renderers to specify removal in Mesa 4.0. Updated warning types from PendingDeprecationWarning to FutureWarning where appropriate, and clarified migration guidance for agent_portrayal and propertylayer_portrayal usage.
This comment was marked as off-topic.
This comment was marked as off-topic.
The test now calls sr.setup_propertylayer(style).draw_propertylayer() instead of sr.draw_propertylayer(style).
quaquel
approved these changes
Jan 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates deprecation warnings for visualization portrayal components to specify "will be removed in Mesa 4.0" and upgrades warnings from
PendingDeprecationWarningtoFutureWarning(following our deprecation policy).What's Deprecated
agent_portrayalfunctionspropertylayer_portrayaldraw_agents()anddraw_propertylayer()methodsMigration
Use
AgentPortrayalStyleandPropertyLayerStyleinstead of dictionaries:For
draw_agents()anddraw_propertylayer(), usesetup_agents()andsetup_propertylayer()before calling the draw methods.See the migration guide for details.