numpy / numpy/numtype

Move the common protocols and type-aliases out of `__init__.pyi`

Open
#121 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

numtype stubs: Refactor
Dominant language
Python
Stars
79
Forks
8
PR merge metrics
No merged PRs in 30d

Description

These are often used by other stubs, e.g. as np._SupportsBuffer, even though it doesn't exist at runtime.

They should probably live in numtype (not necessarily as part of the public API, though).

Contributor guide

Open the contributing guide

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

Inspect init.pyi to identify the common protocols and type aliases referenced by other stubs, then review the numtype package layout for a suitable home. Relocate those definitions while preserving the references such as np._SupportsBuffer and keeping them outside the runtime public API unless required.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.