Avoid relying on `typing.TYPE_CHECKING` to the maximum possible extent

Abierto
#468 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
python

Línea de trabajo

Empieza revisando el uso de TYPE_CHECKING implicado por #454 y los issues relacionados de Sphinx, y luego identifica qué guards evitan imports innecesarios o circulares. Comprueba cómo afectan esos imports al renderizado de Sphinx y a la depuración. Se considera terminado cuando se hayan eliminado los guards TYPE_CHECKING innecesarios, mientras se mantienen los guards necesarios para la seguridad de los imports.

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

Descripción

cuda.core documentation enhancement P1

During investigation of #454 and related doc rendering issues, it has come to my attention that the type checking detection logic does not work well with Sphinx (ex: https://github.com/sphinx-doc/sphinx/issues/13137, https://github.com/sphinx-doc/sphinx/issues/11225).

Independently, Ralf has pointed out that it makes code debugging harder (https://github.com/NVIDIA/cuda-python/pull/463#discussion_r1967029167).

The idea of having a if TYPE_CHECKING: check is to avoid unnecessary imports or circular imports. If such issues do not exist, we should avoid using it.

Lenguaje dominante
Cython
Estrellas
3.4k
Forks
329
Merge medio
1 d 21 h
PR fusionados (30 d)
113

Guía de contribución

Abrir la guía de contribución

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 NVIDIA/cuda-python

Todos los issues de NVIDIA/cuda-python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.