JuliaDynamics/DrWatson.jl

Allow `dict_list` to return other types than dictionaries

Open

#367 ouverte le 2 nov. 2022

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Julia (94 forks)batch import
enhancementgood first issuerunning-listing

Métriques du dépôt

Stars
 (915 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

In many cases users may want to have the configuration parameters of their programs to be a dedicated Julia composite type. This has many advantages, including customizing savename. It would be nice if dict_list could create objects of a given composite type instead of dictionaries. Would also make the whole integration with produce_or_load simpler.

A very simple, but probably not the most performant way to do this, is to leave dict_list as is, and add a final conversion step by using our functions dict2struct and/or ntuple2struct.

Guide contributeur

Direction de recherche
L'issue propose d'ajouter un paramètre optionnel à `dict list` qui spécifie un type composite cible, en utilisant les fonctions existantes `dict2struct` ou `ntuple2struct` pour la conversion. Le contributeur doit examiner le code source de `dict list` dans le dépôt DrWatson.jl, ainsi que les implémentations de `dict2struct` et `ntuple2struct`. Il doit également réfléchir à la manière de gérer la conversion efficacement et s'il faut ajouter une nouvelle fonction ou modifier celle existante. Le mainteneur pourrait avoir des opinions sur la conception de l'API, il est donc préférable d'ouvrir une PR brouillon pour discussion.
Stack technique
Aucun
Domaine
data
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia basicsDrWatson usage
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65