JuliaDynamics/Agents.jl

[FR] make the `@agent` macro define pretty printing as well

Open

#965 建立於 2024年2月3日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Julia (904 star) (146 fork)batch import
good first issuequality of life

描述

Currently we have:

@agent struct SchellingAgent(GridAgent{2})
    mood::Bool # whether the agent is happy in its position
    group::Int # The group of the agent, determines mood as it interacts with neighbors
end

a = SchellingAgent(1, (1,1), true, 1)

which prints

SchellingAgent(1, (1, 1), true, 1)

wouldn't it be nice to have pretty printing by default, so that each field is printed in 1 line, along with its name, its type, and then = value ? I am sure this shouldn't be too difficult to do...?

貢獻者指南

技術棧
無
領域
developer experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Julia macrosAgents.jl frameworkBase.show
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Investigate the `@agent` macro in Agents.jl (likely in src/agents.jl or similar) to understand how it currently defines structs. Look at how `Base.show` is implemented for other types in the repository. Modify the macro to automatically generate a custom `show` method that prints each field with its name, type, and value on a separate line. Ensure compatibility with existing code. The maintainer has not provided additional guidance, so the implementation should follow common Julia style.