JuliaDynamics/Agents.jl

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

Open

#965 aberto em 3 de fev. de 2024

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Julia (146 forks)batch import
good first issuequality of life

Métricas do repositório

Stars
 (904 stars)
Métricas de merge de PR
 (Mesclagem média 12h 3m) (1 fundiu PR em 30d)

Description

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...?

Guia do colaborador

Direção de pesquisa
Investigue a macro `@agent` em Agents.jl (provavelmente em src/agents.jl ou similar) para entender como ela atualmente define structs. Veja como `Base.show` é implementado para outros tipos no repositório. Modifique a macro para gerar automaticamente um método `show` personalizado que imprima cada campo com seu nome, tipo e valor em uma linha separada. Garanta compatibilidade com o código existente. O mantenedor não forneceu orientações adicionais, portanto a implementação deve seguir o estilo comum de Julia.
Pilha de tecnologia
None
Domain
developer experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Julia macrosAgents.jl frameworkBase.show
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80