drivendataorg/cloudpathlib

mark pydantic integration (as an extra?)

Ouverte

#385 ouverte le 11 déc. 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Python (87 forks)auto 404
good first issuetyping

Métriques du dépôt

Stars
 (624 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

We run mypy with ignore_missing_imports = false and then have an explicit allow list for packages. Since cloudpathlib imports pydantic (albeit behind a guard) but does not depends on it, mypy fails with :

cloudpath.py:1207: error: Cannot find implementation or library stub for module named "pydantic_core"  [import-not-found]

We would normally set ignore_missing_imports for just pydantic_core, but that's somewhat wonky in this case because pydantic_core does have type stubs, it's just not a dependency.

I think the most straightforward approach would be to add a pydantic extra to cloudpathlib, but there might be a fancier way to inform mypy directly of the "optional-ness" of the imports.

Guide contributeur

Direction de recherche
Ajoutez une dépendance optionnelle 'pydantic' aux dépendances optionnelles du paquet dans setup.py ou pyproject.toml, et mettez à jour la protection d'importation pour permettre à mypy de reconnaître la dépendance optionnelle.
Stack technique
python
Domaine
backendcloud
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60