BaseController does not check for python attribute name clashes

Aperta Adatta ai principianti
  • Qualcosa non va?
#437 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
backend

Direzione di ricerca

Inizia individuando BaseController e _check_for_name_clash, poi leggi i test esistenti sui conflitti di nomi. Estendi il controllo per rilevare i nomi di attributi riservati di Python, mantenendo i controlli di namespace esistenti. L’attività è completata quando un conflitto come description genera un ValueError più chiaro; esegui i test pertinenti del controller.

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

Descrizione

We have _check_for_name_clash, which does:

def _check_for_name_clash(self, name: str):
    namespaces = {
        "attribute": self.__attributes,
        "sub controller": self.__sub_controllers,
        "scan method": self.__scan_methods,
        "command method": self.__command_methods,
    }

    for kind, namespace in namespaces.items():
        if name in namespace:
            raise ValueError(
                f"Controller {self} has existing {kind} {name}: {namespace[name]}"
            )

However, this fastcs-eiger issue https://github.com/DiamondLightSource/fastcs-eiger/issues/107 reported an obscure error message when the python attribute "description" was shadowed by an attribute. _check_for_name_clash should be extended to check for these kinds of name clashed doing something like:

if hasattr(self, name) and not any(name in ns for ns in namespaces.values()):
    raise ValueError(
        f"Controller {self} has existing Python attribute {name!r}: "
        f"{getattr(self, name)!r}"
    )

Acceptance Criteria

  • Python attribute reserved names are caught, and their error reporting improved.
Lingua principale
Python
Stelle
6
Fork
8
Nessuna PR unita negli ultimi 30g

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/fastcs

Tutte le issue di DiamondLightSource/fastcs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.