python / python/typeshed

Good ways to contribute

未关闭
#4,641 3 条评论 22 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Python
星标
5.1k
派生
2.1k
平均合并
1 天 19 小时
30 天内合并 PR
82

描述

Welcome to typeshed! Like most projects, reading our CONTRIBUTING.md and scrolling through our issues is a good way to find things that need improvement. In fact, many of our issues should be fixable by beginners, even if not marked as such.

However, unlike many projects, there are other very easy ways to find improvements to be made, without relying on people running into and filing issues. Here are some things you can do (click on details for the details):

1) Use stubtest to find things missing from or problematic with stubs.

stubtest is a tool that comes bundled with mypy. It compares stubs to what it can deduce from importing and introspecting the library at runtime.

$ pip install mypy
# to find potential issues with the module sys
$ stubtest --custom-typeshed-dir ~/your_copy_of/typeshed sys --concise

We maintain a list of existing stubtest errors on the standard library and third party stubs, that we're looking to either fix or to add a comment explaining why stubtest should be ignored:
Allowlist of errors for the stdlib
Example of allowlist for a third party stub

These lists of existing errors do not include things that are missing entirely from the stubs, so running stubtest yourself (without --ignore-missing-stub) can be a good way to identify places where stubs are missing definitions entirely.

If you have an idea, you could even teach stubtest new tricks to find issues, like #3968

2) Use stricter mypy settings to identify issues with stubs.

mypy has a lot of different flags that could help identify improvements. For instance, I recommend using the following patch and re-running the test to find places where typeshed stubs are missing annotations:

diff --git a/tests/mypy_test.py b/tests/mypy_test.py
index f32da57f..e94e5a29 100755
--- a/tests/mypy_test.py
+++ b/tests/mypy_test.py
@@ -136,6 +136,8 @@ def main():
             flags.append('--no-implicit-optional')
             flags.append('--disallow-any-generics')
             flags.append('--disallow-subclassing-any')
+            flags.append('--disallow-incomplete-defs')
+            flags.append('--warn-incomplete-stub')
             if args.warn_unused_ignores:
                 flags.append('--warn-unused-ignores')
             if args.platform:

Similarly, we run checks against some stubs with looser pyright settings. By running with a more strict pyright setting, we can find issues.

3) Contribute stubs for a new library.

We've had requests for stubs for at least the following libraries:

zxcvbn
pyspark
psutil
pymongo
setuptools
python-future
pyzmq
pynput
z3
pony

Take a look at CONTRIBUTING.md for more guidance, but note that for larger libraries we accept partial / incomplete stubs. Note that you should check whether the library already provides (or is interested in providing) inline types or in-package stubs — types are typically best maintained by library authors.

4) Literally just grep for the words "incomplete" or "TODO"

As mentioned in point 3, we accept partial / incomplete stubs. As recommended by https://github.com/python/typeshed/blob/master/CONTRIBUTING.md#incomplete-stubs, these are marked with a comment that says # incomplete. They're waiting for you to complete them!

Another thing to search for is module level def __getattr__. stubtest is pretty good with helping point out ways to complete stubs.

5) Update third party stubs

We currently specify a specific version of a third party package our stubs are meant to describe in each stub's METADATA.toml file. Changing this version to the latest and seeing what stubtest has to say is a great way to help keep type information up to date.

Also note that several of the previous points apply, in particular, fixing existing errors in the stubtest allowlist for a third party package (allowlist can be found in the @tests directory)

(Other maintainers: feel free to edit the text of this issue as you see fit)

贡献指南

打开贡献指南

从这里开始

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

调研方向

未指定对单个文件或文档的具体更改。首先阅读 CONTRIBUTING.md 以及其中引用的 tests/mypy_test.py 和 stubtest allowlist,然后决定要记录一个重点明确的贡献工作流程或示例。要视为完成,需要就范围达成一致,并更新一份准确的指南。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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