BaseController does not check for python attribute name clashes

Abierto Apto para principiantes
  • ¿Algo no está bien?
#437 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
backend

Línea de trabajo

Empieza por localizar BaseController y _check_for_name_clash; después, lee las pruebas existentes sobre conflictos de nombres. Amplía la comprobación para detectar nombres de atributos reservados de Python, conservando las comprobaciones de namespace existentes. La tarea estará terminada cuando un conflicto como description provoque un ValueError más claro; ejecuta las pruebas pertinentes del controlador.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Python
Estrellas
6
Forks
8
Sin PR fusionados en 30 d

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de DiamondLightSource/fastcs

Todos los issues de DiamondLightSource/fastcs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.