[FR] Add return type annotations for public functions (firestore.client(), storage.bucket(), etc)

Offen

#626 erstellt am 15.7.2022 5 Kommentare 5 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@mohitCodepy arbeitet bereits daran.

Seit 13.3.2023.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

api: core help wanted type: feature request

Is your feature request related to a problem? Please describe.
VSCode can use Python type annotations to provide a much better experience, and allow completion.

Describe the solution you'd like
function signatures should return a return type, to allow completions. For example, in firestore.py
def client() -> google.cloud.firestore.Client would allow completion on client().collection("something"), etc.

Describe alternatives you've considered
As a workaround, I'm using the following today:

from firebase_admin import firestore
from google.cloud.firestore import Client as FirestoreClient # importing the return type of firestore.client()
db: FirestoreClient = firestore.client() # Adding an annotation to my db variable, to enable completion and syntax checking

Additional context
Using the latest VSCode, with the Pylance extension.

Vorherrschende Sprache: Python
Sterne: 1.2k
Forks: 359
Ø Merge: 3 T. 9 Std.
Gemergte PRs (30 T.): 3

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus firebase/firebase-admin-python

Fix typos and wrong types in remote_config.py Offen

api: remoteconfig

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100

firebase/firebase-admin-python#957 · 1 Kommentar · Erstellt am 27.6.2026
FR: Make the Number of Retires Configurable in transaction() Offen

api: database type: feature request

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100

firebase/firebase-admin-python#58 · Erstellt am 14.8.2017
"Invalid database id (default)" con Firestore Python (Admin SDK) Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

firebase/firebase-admin-python#978 · 1 Kommentar · Erstellt am 25.8.2026
[FR] Support VERIFY_AND_CHANGE_EMAIL in generate_email_action_link (parity with firebase-admin-node) Offen

api: auth

firebase/firebase-admin-python#949 · 2 Kommentare · 1 Reaktion · 1 zugewiesene Person · Erstellt am 23.4.2026
ECONNRESET connecting to Firebase auth emulator from functions emulator with grpc imported Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 43/100

firebase/firebase-admin-python#945 · 1 Kommentar · 1 Reaktion · Erstellt am 14.4.2026

Alle Issues in firebase/firebase-admin-python