GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — gh-89554: Document NoneType, NotImplementedType and EllipsisType as classes by gaborbernat · Pull Request #150682 · python/cpython

Conversation

gaborbernat commented May 31, 2026

Copy link

Copy Markdown

Contributor

types.NoneType, types.NotImplementedType, and types.EllipsisType are classes, but the documentation marks them with the .. data:: directive. This part of gh-89554 is worth a separate look: unlike the descriptor and function type objects, these three are sometimes referenced as :data:, as the type of a singleton value such as None.

This proposes switching them to .. class::, matching the other type objects in types.rst and the What's New in 3.10 entry that introduced them, which already describes them as "classes". It also updates the :data: references in Doc/library/constants.rst and Doc/whatsnew/3.10.rst to :class:.

I am happy to drop this if you would rather keep .. data:: for the singleton-value types. It is split out from the uncontroversial cases in #150676 so the decision can be made on its own.

Refs: gh-89554. Documentation-only change, so no Misc/NEWS entry (skip news).

cc @AA-Turner as the Lib/types.py maintainer.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          pythongh-89554: Document NoneType, NotImplementedType and EllipsisTyp…

265d76d

…e as classes

NoneType, NotImplementedType and EllipsisType are classes, but were
documented with the ".. data::" directive. Unlike the other type objects
in the types module they are sometimes referenced as the type of a
singleton value, so this is proposed separately from the uncontroversial
cases.

Switch the three entries to ".. class::", matching the other type objects
and the What's New in 3.10 note that introduced them as classes, and
update the ":data:" references in constants and the 3.10 What's New page.

gaborbernat requested a review from AA-Turner as a code owner

May 31, 2026 17:18

bedevere-app Bot added docs

Documentation in the Doc dir

skip news labels

May 31, 2026

github-project-automation Bot added this to Docs PRs

May 31, 2026

bedevere-app Bot mentioned this pull request

May 31, 2026

Intersphinx inventory classifies some type-like objects as data #89554

Open

bedevere-app Bot added the awaiting review label

May 31, 2026

github-project-automation Bot moved this to Todo in Docs PRs

May 31, 2026

read-the-docs-community Bot commented May 31, 2026

Copy link

Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #32924507 | 📁 Comparing 265d76d against main (2f8f569)

🔍 Preview build

3 files changed

± library/constants.html
± library/types.html
± whatsnew/3.10.html

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

picnixz commented May 31, 2026

Copy link

Copy Markdown

Member

Please,a void opening automated PRs in a bulk. I'm still not convinced by changing every occurrences mechanically.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

gaborbernat commented Jun 1, 2026

Copy link

Copy Markdown

Contributor Author

Backward-compatibility check. This is the contested subset. The ecosystem still skews class (NoneType 231:27, NotImplementedType 43:2, EllipsisType 113:8 for py:class:py:data), but these carry the most :data: usage in the family, since they are commonly referenced as the type of the None / Ellipsis / NotImplemented singletons. They break more references than the other type-object changes, which is why they are split out for a separate decision.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

picnixz commented Jun 1, 2026

Copy link

Copy Markdown

Member

For those IDK. In some sense with class, I believe autodoc will struggle less.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

serhiy-storchaka approved these changes

Jun 2, 2026

View reviewed changes

serhiy-storchaka left a comment

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. 👍

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

bedevere-app Bot added awaiting merge and removed awaiting review labels

Jun 2, 2026

serhiy-storchaka added needs backport to 3.13

only security fixes

needs backport to 3.14

bugs and security fixes

needs backport to 3.15 bugs and security fixes labels

Jun 2, 2026

serhiy-storchaka merged commit e40190e into python:main

Jun 2, 2026

46 checks passed

Uh oh!

There was an error while loading. Please reload this page.

github-project-automation Bot moved this from Todo to Done in Docs PRs

Jun 2, 2026

miss-islington-app Bot commented Jun 2, 2026

Copy link

Copy Markdown

Thanks @gaborbernat for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the awaiting merge label

Jun 2, 2026

bedevere-app Bot commented Jun 2, 2026

Copy link

Copy Markdown

GH-150755 is a backport of this pull request to the 3.15 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label

Jun 2, 2026

bedevere-app Bot commented Jun 2, 2026

Copy link

Copy Markdown

GH-150756 is a backport of this pull request to the 3.14 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label

Jun 2, 2026

bedevere-app Bot commented Jun 2, 2026

Copy link

Copy Markdown

GH-150757 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label

Jun 2, 2026

serhiy-storchaka pushed a commit that referenced this pull request

Jun 2, 2026


          [3.13] gh-89554: Document NoneType, NotImplementedType and EllipsisTy…

c301ea0

…pe as classes (GH-150682) (GH-150757)

Always use the directive and the role "class" instead of "data" for
NoneType, NotImplementedType and EllipsisType.
(cherry picked from commit e40190e)

Co-authored-by: Bernát Gábor <[email protected]>

serhiy-storchaka pushed a commit that referenced this pull request

Jun 2, 2026


          [3.14] gh-89554: Document NoneType, NotImplementedType and EllipsisTy…

7d66158

…pe as classes (GH-150682) (GH-150756)

Always use the directive and the role "class" instead of "data" for
NoneType, NotImplementedType and EllipsisType.
(cherry picked from commit e40190e)

Co-authored-by: Bernát Gábor <[email protected]>

serhiy-storchaka pushed a commit that referenced this pull request

Jun 2, 2026


          [3.15] gh-89554: Document NoneType, NotImplementedType and EllipsisTy…

ef45089

…pe as classes (GH-150682) (GH-150755)

Always use the directive and the role "class" instead of "data" for
NoneType, NotImplementedType and EllipsisType.
(cherry picked from commit e40190e)

Co-authored-by: Bernát Gábor <[email protected]>

gaborbernat mentioned this pull request

Jun 3, 2026

🐛 fix(annotations): use class role for Ellipsis/NotImplementedType on 3.13+ tox-dev/sphinx-autodoc-typehints#707

Merged

gaborbernat deleted the gh-89554-types-singleton-class-roles branch

October 3, 2026 15:12

Reviewers

serhiy-storchaka

serhiy-storchaka approved these changes

AA-Turner

Awaiting requested review from AA-Turner

AA-Turner is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs

Documentation in the Doc dir

skip news

Projects

Docs PRs

Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.