tarantool / tarantool/tarantool-python
Type hints and type check
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 108
- Forks
- 51
- Merge moyen
- 1 j 8 h
- PR mergées (30 j)
- 1
Description
Type hints is a modern Python way to provide type information (see typing mypy). PR https://github.com/tarantool/tarantool-python/pull/264 is the first one to potentially use type hints, but it would be nice to have it anywhere.
Type asserts is a more tricky question. For now there are some minor type checks and asserts in connector. Some may also be implemented in PR #264. But it is a big question if they should be use. It seems that there are both adepts of using (since it is a convenient concept) and forbidding to use (since it contradicts Python duck typing principle) it. For example, see this StackOverflow thread. One way or another, it would be good to at least have a consistency on this question.
Since now package is fully documented, it should be easy to implement type hints and asserts after one decide what approach we should stick to. But choosing the approach is the question.
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 lire PR #264 ainsi que les vérifications de types et les asserts existants de connector, puis consultez la documentation du package et les références liées à typing et mypy. La première étape consiste à décider s’il faut ajouter des annotations de types et avec quelle cohérence utiliser les vérifications de types à l’exécution ou les asserts ; le travail sera considéré comme terminé lorsque l’approche convenue sera appliquée à l’ensemble du package.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api, backend
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100