MagicStack / MagicStack/asyncpg

Type hints

未关闭
#387 1 条评论 32 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Python
星标
8.1k
派生
468
PR 合并指标
30 天内没有已合并 PR

描述

Hi there!

I would really appreciate if the methods were defined with correct return data type as specified in PEP-484.

This would help with typing hints where the IDE can correctly determine how to help out with the right methods and variables.

Some examples on places I've stumbled into this:

  • create_ppol should type hint Pool
  • Pool.acquire() should type hint Connection
  • Connection.fetch() should type hint list of Record
  • Connection.fetchrow() should type hint Record or None

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先阅读 create_ppol、Pool.acquire()、Connection.fetch() 和 Connection.fetchrow() 的定义,然后将它们的返回注解与 PEP 484 进行比较。完成标准是,所列方法公开准确的返回类型,包括 Pool、Connection、Record 列表以及 Record 或 None。

由索引模型根据 Issue 内容生成。

评估

技术栈
postgresql, python
领域
api, databases
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。