Skip to content

gh-143728: Keep TypedDict and NamedTuple in class role in docs#143702

Merged
AlexWaygood merged 3 commits intopython:mainfrom
johnslavik:set-namedtuple-and-typeddict-to-classes-in-docs
Jan 13, 2026
Merged

gh-143728: Keep TypedDict and NamedTuple in class role in docs#143702
AlexWaygood merged 3 commits intopython:mainfrom
johnslavik:set-namedtuple-and-typeddict-to-classes-in-docs

Conversation

@johnslavik
Copy link
Member

@johnslavik johnslavik commented Jan 11, 2026 •
edited by bedevere-app bot
Loading

@johnslavik johnslavik added the docs Documentation in the Doc dir label Jan 11, 2026
@johnslavik johnslavik added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jan 11, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Jan 11, 2026
@bedevere-app bedevere-app bot mentioned this pull request Jan 11, 2026
Closed
@johnslavik johnslavik mentioned this pull request Jan 11, 2026
Merged
AlexWaygood
AlexWaygood reviewed Jan 11, 2026
View reviewed changes
Doc/library/typing.rst
types.

.. function:: NamedTuple
.. class:: NamedTuple
Copy link
Member

@AlexWaygood AlexWaygood Jan 11, 2026

Choose a reason for hiding this comment

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

does this one need to change? I don't think we have any attributes documented for NamedTuple with the .. attribute:: syntax

Copy link
Member Author

@johnslavik johnslavik Jan 11, 2026

Choose a reason for hiding this comment

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

Suggested change
.. class:: NamedTuple
.. function:: NamedTuple

Copy link
Contributor

@Viicos Viicos Jan 11, 2026

Choose a reason for hiding this comment

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

What if this changes in the future, and we would then need to change the type again? My only concern is that changing the type results in warnings/errors for anyone referencing NamedTuple in their docs, so maybe we need to be careful when changing such types.

First example that came to mind was the peps repo, with some hits for TypedDict: https://github.com/search?q=repo%3Apython%2Fpeps+%2F%3Aclass%3A%60%28%28%7E%29%3Ftyping%5C.%29%3FTypedDict%2F&type=code

Copy link
Member Author

@johnslavik johnslavik Jan 11, 2026

Choose a reason for hiding this comment

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

Not sure NamedTuple is likely to change, but I brought back the revert in 4244745.
It seems to me that status quo is a safer approach.

@johnslavik johnslavik changed the title gh-86139: Keep TypedDict and NamedTuple in class role in docs gh-86139: Keep TypedDict in class role in docs Jan 11, 2026
@johnslavik johnslavik changed the title gh-86139: Keep TypedDict in class role in docs gh-86139: Keep TypedDict and NamedTuple in class role in docs Jan 11, 2026
@aisk
Copy link
Member

aisk commented Jan 12, 2026

According to the discussion in #143692, I think we can change it from .. function:: to .. data::?

@johnslavik
Copy link
Member Author

johnslavik commented Jan 12, 2026 •
edited
Loading

OK, I'll try to get .. data :: to work, assuming we don't want to merge this in first as a quick remediation.

I'll do that in the span of next 24 hours though.

@davidhewitt davidhewitt mentioned this pull request Jan 12, 2026
Closed
sobolevn
sobolevn reviewed Jan 12, 2026
View reviewed changes
Doc/library/typing.rst


.. function:: TypedDict
.. class:: TypedDict(dict)
Copy link
Member

@sobolevn sobolevn Jan 12, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

This would fix #143728, see https://docs.python.org/3.15/library/typing.html#typing.__total__

@johnslavik johnslavik changed the title gh-86139: Keep TypedDict and NamedTuple in class role in docs gh-143728: Keep TypedDict and NamedTuple in class role in docs Jan 12, 2026
@Viicos
Copy link
Contributor

Viicos commented Jan 12, 2026

Should we merge this one then?

@Viicos Viicos mentioned this pull request Jan 13, 2026
Merged
5 tasks
@AlexWaygood
Copy link
Member

AlexWaygood commented Jan 13, 2026

Okay, yes, I tried using .. data:: locally and it does not fix the regression for the TypedDict attributes:

image

So it seems we have to stick with .. class:: due to the Sphinx limitation. A bit of a shame, but oh well.

@AlexWaygood AlexWaygood merged commit 865eb12 into python:main Jan 13, 2026
32 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jan 13, 2026
@miss-islington-app
Copy link

miss-islington-app bot commented Jan 13, 2026

Thanks @johnslavik for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 13, 2026
@johnslavik @miss-islington
pythongh-143728: Keep TypedDict and NamedTuple in class role in…
ac0925d 
… docs (pythonGH-143702)

(cherry picked from commit 865eb12)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 13, 2026
@johnslavik @miss-islington
pythongh-143728: Keep TypedDict and NamedTuple in class role in…
4c75e86 
… docs (pythonGH-143702)

(cherry picked from commit 865eb12)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 13, 2026

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

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jan 13, 2026
@bedevere-app
Copy link

bedevere-app bot commented Jan 13, 2026

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 13, 2026
AlexWaygood pushed a commit that referenced this pull request Jan 13, 2026
@miss-islington @johnslavik
[3.14] gh-143728: Keep TypedDict and NamedTuple in class role i…
baba8d2 
…n docs (GH-143702) (#143799)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
AlexWaygood pushed a commit that referenced this pull request Jan 13, 2026
@miss-islington @johnslavik
[3.13] gh-143728: Keep TypedDict and NamedTuple in class role i…
3dd9afc 
…n docs (GH-143702) (#143800)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood left review comments

@sobolevn sobolevn sobolevn approved these changes

@JelleZijlstra JelleZijlstra Awaiting requested review from JelleZijlstra JelleZijlstra is a code owner

+1 more reviewer

@Viicos Viicos Viicos left review comments

Reviewers whose approvals may not affect merge requirements

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.

5 participants

@johnslavik @aisk @Viicos @AlexWaygood @sobolevn