python / python/typeshed

Good ways to contribute

Ouverte
#4,641 3 commentaires 22 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
5.1k
Forks
2.1k
Merge moyen
1 j 19 h
PR mergées (30 j)
82

Description

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)

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Aucune modification précise d’un fichier ou de la documentation n’est spécifiée. Commencez par lire CONTRIBUTING.md ainsi que tests/mypy_test.py et les listes d’autorisation de stubtest qui y sont référencées, puis décidez d’un workflow de contribution ciblé ou d’un exemple à documenter. Pour considérer le travail comme terminé, il faudra s’accorder sur le périmètre et disposer d’un guide mis à jour et exact.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.