firebase / firebase/firebase-admin-python

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

オープン
#626 コメント 5 件 リアクション 5 件 担当者 1 名 @mohitCodepy が担当を希望しています GitHub で見る
api: core help wanted type: feature request
主要言語
Python
スター
1.2k
フォーク
359
平均マージ
5日 6分
マージ済み PR(30日)
2

説明

**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.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。