python / python/pyperformance

Add type hints?

Abierto
#282 0 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
1k
Forks
203
Merge medio
1 h 20 min
PR fusionados (30 d)
2

Descripción

How would we feel about adding type hints to the pyperformance codebase?

Running a type checker on pyperformance might catch some bugs. But more importantly, in my opinion, it would make some parts of the code base a lot easier to read and reason about -- it would be self-evident what kind of object is being accepted and returned by various functions.

There are various tools that we could use to add "obvious" type hints quickly to the code base, such as autotyping and MonkeyType.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

No se indican archivos ni pruebas. Empieza revisando la base de código de pyperformance y evaluando autotyping y MonkeyType como posibles puntos de partida. La tarea estaría terminada cuando se haya acordado el alcance para añadir anotaciones de tipos y un enfoque de comprobación de tipos que mejore la legibilidad y pueda detectar errores.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
tooling
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.