openzim / openzim/python-scraperlib
Calls to third party code not respecting type hints
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 31
- Forks
- 27
- Merge moyen
- 3 j 7 h
- PR mergées (30 j)
- 2
Description
Following #227, scraperlib users are not allowed to send values of unexpected types to our API.
We should apply the same strict treatment to our usage of other's APIs.
beartype allows setting this in our code and raising or warning on incorrect calls. Once we fix the codebase, we would keep it and it would serve as automated test for this.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner la base de code de scraperlib à la recherche d’appels à des API tierces et de l’application des indications de type décrite dans #227. Utilisez beartype pour identifier les appels incorrects ; le travail est considéré comme terminé lorsque la base de code passe cette vérification sans types d’arguments inattendus, tout en conservant ces vérifications sous forme de tests automatisés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api
- Type d'issue
- Refactorisation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100