python / python/cpython

Naming consistency for various types

Open
#126,662 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stdlib type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Feature or enhancement

Proposal:

A number of classes self-report names which are not an importable name for that type.
The inconsistency means that the class itself can’t be pickled, typeshed can’t match their display name, and can cause minor confusion. I’m interested in getting these to be consistent where possible.

An accounting of all the types I know about in the category is available at the linked discuss thread.

Has this already been discussed elsewhere?

I have already discussed this feature proposal on Discourse

Links to previous discussion of this feature:

Recent discuss thread: https://discuss.python.org/t/naming-consistency-for-various-types/70401

Another related discussion for types exposed in the types module is available here: https://github.com/python/cpython/issues/100129

Linked PRs
  • gh-126663
  • gh-126712
  • gh-126721
  • gh-126723
  • gh-126724
  • gh-137122
  • gh-137123

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

Start by reading the linked Discourse discussions and related issue 100129, then review PRs 126663, 126712, 126721, 126723, 126724, 137122, and 137123. Use the accounting of affected types there to determine the agreed scope; the work is done when the selected types consistently report importable names and the stated pickling and typeshed concerns are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.