Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Provide maturity annotation for classes and fields

Aperta
#466 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@korikuzma ci sta già lavorando.

Dal 17/12/2024.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

enhancement

GKS schemas often include maturity model annotations on objects and properties to indicate some expectation of model stability. It'd be nice to access this somehow within VRS-Python.

  • Most naive solution: put it in the docstring. Not machine-readable, but simple to implement.
  • Maybe the next simplest solution: include it as part of the model_json_schema() output. This is computationally accessible, albeit somewhat indirectly so. It would most directly match the schema itself.
  • Implement as some kind of private or dunder field on each schema class, e.g. Allele.__maturity__ = <MaturityModel.TRIAL_USE>. Not sure of what the equivalent way to get property maturity would be, though.

Possible use cases/helper functions to implement

  • A function that takes a Ga4ghIdentifiableObject and tells you which components or properties are most immature, i.e. are most liable to change in structure in future releases
  • A function that takes a Ga4ghIdentifiableObject and tells you whether it contains any components or properties that are below a particular maturity model threshold and/or are deprecated
Lingua principale
Python
Stelle
63
Fork
43
Merge medio
1h 2m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ga4gh/vrs-python

Tutte le issue di ga4gh/vrs-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.