MagicStack / MagicStack/asyncpg

Type hints

Offen
#387 1 Kommentar 32 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
8.1k
Forks
468
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Lesen der Definitionen von create_ppol, Pool.acquire(), Connection.fetch() und Connection.fetchrow(), und vergleiche dann ihre Rückgabeannotationen mit PEP 484. Erledigt ist die Aufgabe, wenn die genannten Methoden genaue Rückgabetypen offenlegen, einschließlich Pool, Connection, einer Liste von Record sowie Record oder None.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
postgresql, python
Bereich
api, databases
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.