MagicStack / MagicStack/asyncpg

Type hints

Abierto
#387 1 comentario 32 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Python
Estrellas
8.1k
Forks
468
Sin PR fusionados en 30 d

Descripción

Hi there!

I would really appreciate if the methods were defined with correct return data type as specified in PEP-484.

This would help with typing hints where the IDE can correctly determine how to help out with the right methods and variables.

Some examples on places I've stumbled into this:

  • create_ppol should type hint Pool
  • Pool.acquire() should type hint Connection
  • Connection.fetch() should type hint list of Record
  • Connection.fetchrow() should type hint Record or None

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

Empieza leyendo las definiciones de create_ppol, Pool.acquire(), Connection.fetch() y Connection.fetchrow(), y después compara sus anotaciones de retorno con PEP 484. La tarea está terminada cuando los métodos indicados exponen tipos de retorno precisos, incluidos Pool, Connection, una lista de Record y Record o None.

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

Evaluación

Stack tecnológico
postgresql, python
Área
api, databases
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.