Decide on a pydantic v3 BaseModel tagged union method and document it here
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- developer-experience, documentation
Piste de recherche
Commencez par comparer les approches des tagged unions utilisées par scanspec, FastCS, pvi, ibek et blueapi, en tenant compte des changements proposés dans pydantic v3. Le travail sera considéré comme terminé lorsque les projets se seront mis d’accord sur une approche commune de BaseModel et que cette méthode sera documentée ici, avec les compromis pertinents.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
At the moment we have multiple ways of using pydantic and tagged unions:
scanspecusing pydantic dataclasses and a decorator to make a tagged union of subclasses, it requires positional argsFastCSusing plain dataclasses and a pydantic BaseModel creation function to do serialization and deserializationpviuses an explicitly created union of BaseModelsibekuses automatically created Entity BaseModels from EntityModel instancesblueapidoes something with BaseModels too, but I can't remember what
With the advent of pydantic v3, now would be a good time to look at investigating a common approach for all these usecases. Standardising on BaseModel instances would probably give us the most tool support for things like documenting models in sphinx, FastAPI and GraphQL support, and downstream serialization
@GDYendell @gilesknap @DiamondJoseph @tpoliaw @abbiemery FYI
@hyperrealist I'm hoping you'll take this on at some point in the new year
- Langage dominant
- Jinja
- Étoiles
- 25
- Forks
- 9
- Merge moyen
- 4 h 36 min
- PR mergées (30 j)
- 4
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de DiamondLightSource/python-copier-template
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
-
documentation good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 70/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Toutes les issues de DiamondLightSource/python-copier-template
Issues similaires
-
[dsh-plugin.org | dsh-plugin-hub] plugin distribution incomplete: yjh051108/dsh-routing-suiteOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 71/100
yjh051108/dsh-routing-suite#227 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
dusk-network/exu#15 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
radio-t/radio-t-site#537 ·
-
eval-drift
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
-
bug:new
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
callstackincubator/simlock#450 ·
Les mainteneurs répondent en général sous 1 jour