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

Ouverte
#468 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
42/100
Type d'issue
Refactorisation
Clarté
À clarifier
Activité
Calme
Stack technique
python
Domaine
developer-experience, documentation

Piste de recherche

Commencez par examiner l'utilisation de TYPE_CHECKING concernée par #454 et les issues Sphinx associées, puis identifiez quels guards empêchent les imports inutiles ou circulaires. Vérifiez comment ces imports affectent le rendu de Sphinx et le débogage. C'est terminé lorsque les guards TYPE_CHECKING inutiles sont supprimés, tandis que les guards nécessaires à la sécurité des imports sont conservés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Cython
Étoiles
3.4k
Forks
329
Merge moyen
1 j 21 h
PR mergées (30 j)
113

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de NVIDIA/cuda-python

Toutes les issues de NVIDIA/cuda-python

Issues similaires

Plus d'issues DevTools

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.