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 摘要。