danielgtaylor / danielgtaylor/python-betterproto

Mypy type checking does not work with enums

Ouverte
#616 2 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug low priority
Langage dominant
Python
Étoiles
1.8k
Forks
234
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

### Summary

When using an enum in a code project mypy is broken and has the impression that all the enum fields are of type 'int'

### Reproduction Steps

Run type checking on this file and see the problem in version 2.0.0b7
```py
import betterproto

class Colour(betterproto.Enum):
RED = 1
GREEN = 2
BLUE = 3

def print_color(color: Colour) -> None:
print(color.value)

def test_mypy_types() -> None:
print(Colour.RED == Colour.try_value(Colour.RED))

print_color(Colour.RED)
print_color(Colour.try_value(Colour.RED))

if __name__ == '__main__':
test_mypy_types()

```

### Expected Results

I would have expected the type checking to pass as in version 2.0.0-beta6

This is caused by #293 (and is not solved by #540)

The expected type of `Colour.RED` is a `Colour` not an `int`.

### Actual Results

```bash
$ poetry run mypy test-mypy.py
test-mypy.py:16: error: Argument 1 to "print_color" has incompatible type "int"; expected "Colour" [arg-type]
print_color(Colour.RED)
^~~~~~~~~~
Found 1 error in 1 file (checked 1 source file)
```

### System Information

```bash
Python 3.11.9
Name: betterproto
Version: 2.0.0b7
Summary: A better Protobuf / gRPC generator & library
Home-page: https://github.com/danielgtaylor/python-betterproto
Author: Daniel G. Taylor
Author-email: danielgtaylor@gmail.com
License: MIT
Location: /home/jns/product/.venv/lib/python3.11/site-packages
Requires: grpclib, python-dateutil, typing-extensions
Required-by: inventory_code_project_enumeration, inventory_name_inference, inventory_py_schema_description, inventory_py_schema_endpoints_extraction, inventory_py_schema_services_extraction, inventory_repository_analysis, inventory_repository_clone, inventory_repository_extract_schema, inventory_repository_extract_secret, inventory_repository_extract_service, inventory_repository_owner_search, inventory_schema_analysis, inventory_schema_classification, inventory_schema_conversion, inventory_schema_data_leaks, inventory_service_description, inventory_software_types_fingerprinter, protocol
```

### Checklist

- [X] I have searched the issues for duplicates.
- [X] I have shown the entire traceback, if possible.
- [X] I have verified this issue occurs on the latest prelease of betterproto which can be installed using `pip install -U --pre betterproto`, if possible.

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.

Piste de recherche

Commencez par exécuter mypy sur la reproduction test-mypy.py fournie avec la version concernée de betterproto, puis examinez les modifications du typage des enum associées à #293 et #540. C’est terminé lorsque mypy traite Colour.RED et Colour.try_value(Colour.RED) comme des valeurs Colour et que l’exemple réussit sans l’erreur argument-type signalée.

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

Évaluation

Stack technique
python
Domaine
tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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