pypa / pypa/setuptools

Add type hints to setuptools

Open
#2,345 10 comments 16 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

It seems that setuptools doesn't have type hints at the moment:

4: error: Skipping analyzing 'setuptools': found module but no type hints or library stubs
4: note: See https://mypy.readthedocs.io/en/latest/running_mypy.html#missing-imports

I think that adding type hints at least to the most common entrypoints (e.g. setup) would be great to have, considering that setuptools is quite an important part of the official Python ecosystem.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the commonly used setuptools entry point mentioned in the issue, especially setup, and reproduce the mypy missing-type-hints error. Done should mean the targeted public entry points provide type hints and the reported mypy diagnostic is resolved; no files or tests are named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.