questdb/py-questdb-client

.pyi type hints

Offen

#84 geöffnet am 14.04.2024

Auf GitHub ansehen
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (14 Forks)auto 404
good first issue

Repository-Metriken

Stars
 (71 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We have a Cython package that doesn't do a great job of exposing typing information to PyCharm. It looks like this needs additional .pyi files to get it working:

https://stackoverflow.com/questions/41734836/what-does-i-represent-in-python-pyi-extension

Shame, since pretty much all the typing is already on the signatures in Cython and usually works just fine in VS Code. Oh well :-)

Contributor Guide

Research-Richtung
Erstellen Sie .pyi Stub Dateien für das Cython Modul, um Typ Hinweise verfügbar zu machen. Identifizieren Sie die öffentlichen API Funktionen und Klassen in den .pyx/.pxd Dateien und schreiben Sie dann manuell .pyi Dateien mit korrekten Typannotationen, die den Cython Signaturen entsprechen.
Tech Stack
python
Domain
developer experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80