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

Discussion: blueapi plan renaming

Aperta
#1,701 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
18/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
backend

Direzione di ricerca

The issue is a design discussion, not a settled change. Start with the plan-registration code in blueapi that reads the __name__ of an imported plan, and with the __init__.py re-export pattern shown in the issue. Done would mean a maintainer-agreed approach, such as an explicit registration name or a wrapper, before any implementation begins.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

On i15-1, we've tried to do

from .data_collection import (
    data_collection as single_temperature_collection,
)

__all__ = ["single_temperature_collection"]

in the hope that we could rename our plan as seen inside blueapi. However, the registered plan name is still data_collection inside blueapi, I'm guessing because blueapi uses the __name__ attribute of the imported object to decide this.

There are use cases when you may want to register a plan under a different name inside blueapi, for example if you want the plan called one thing for internal use as a subplan, but something else when exposed to users.

Having said this, maybe the simplest solution is just to wrap plans when we want to do this. Interested on other people's thoughts

Lingua principale
Python
Stelle
13
Fork
14
Merge medio
7g 1h
PR unite (30g)
12

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 DiamondLightSource/blueapi

Tutte le issue di DiamondLightSource/blueapi

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.