firebase / firebase/firebase-admin-python

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

未關閉
#626 5 則留言 5 個 reaction 已指派 1 人 已被 @mohitCodepy 認領 在 GitHub 檢視
api: core help wanted type: feature request
主要語言
Python
星號
1.2k
分支
359
平均合併
5 天 6 分鐘
30 天內合併 PR
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 摘要。