[typing] TypedDict's 'total' argument is undocumented

[brettcannon]

BPO	39572
Nosy	@gvanrossum, @brettcannon, @ilevkivskyi, @miss-islington, @ananthan-123
PRs	bpo-39572:documented _total_ attribute of TypedDict #18554 [3.8] bpo-39572: Document ’total’ flag of TypedDict (GH-18554) #18556 bpo-39572: Address typo in CHANGELOG. #24999 [3.9] bpo-39572: Address typo in CHANGELOG. (GH-24999) #25545

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-02-19.05:28:20.370>
created_at = <Date 2020-02-06.20:08:00.422>
labels = ['easy', '3.8', '3.9', 'docs']
title = "[typing] TypedDict's 'total' argument is undocumented"
updated_at = <Date 2021-04-23.00:58:50.021>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2021-04-23.00:58:50.021>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-02-19.05:28:20.370>
closer = 'gvanrossum'
components = ['Documentation']
creation = <Date 2020-02-06.20:08:00.422>
creator = 'brett.cannon'
dependencies = []
files = []
hgrepos = []
issue_num = 39572
keywords = ['patch', 'easy']
message_count = 12.0
messages = ['361503', '362228', '362229', '362231', '362232', '362247', '362251', '362252', '362262', '362276', '391643', '391645']
nosy_count = 7.0
nosy_names = ['gvanrossum', 'brett.cannon', 'docs@python', 'python-dev', 'levkivskyi', 'miss-islington', 'Ananthakrishnan']
pr_nums = ['18554', '18556', '24999', '25545']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue39572'
versions = ['Python 3.8', 'Python 3.9']

[brettcannon]

The docs mention __total__, but there's no mention of how to actually set that attribute, nor what it actually represents.

P.S. https://github.com/python/cpython/blob/master/Lib/typing.py#L16 says TypedDict "may be added soon"; I think that's outdated. ;)

[ananthan-123]

https://stackoverflow.com/questions/58427394/what-is-the-meaning-of-total-dunder-attribute-in-python-3

questions about this.

[ananthan-123]

It will be usefull if we document _total_ argument also.

[gvanrossum]

There's no __total__ argument, but there is a __total__ attribute. There are also (new in 3.9) __required_keys__ and __total_keys__ attributes.

Are you interested in submitting a PR with the needed doc changes?

[ananthan-123]

yes,I'm interested.

[gvanrossum]

New changeset ab6423f by ananthan-123 in branch 'master':
bpo-39572: Document ’total’ flag of TypedDict (GH-18554)
ab6423f

[miss-islington]

New changeset 44c6901 by Miss Islington (bot) in branch '3.8':
bpo-39572: Document ’total’ flag of TypedDict (GH-18554)
44c6901

[gvanrossum]

Separately, would you also be interested in writing docs for the __total__ class attribute of TypedDict subclasses (3.8 and 3.9) and for the __required_keys__ and __total_keys__ attributes (only in 3.9)? (Sorry, there's no document you can crib these from. :-)

[ananthan-123]

yes,I'm interested in writing docs for the __required_keys__ and __total_keys__ attributes.

[gvanrossum]

Go for it. Use the same bug number.

On Wed, Feb 19, 2020 at 02:30 Ananthakrishnan <report@bugs.python.org>
wrote:

Ananthakrishnan ananthakrishnan15.2001@gmail.com added the comment:

yes,I'm interested in writing docs for the __required_keys__ and
__total_keys__ attributes.

----------

---

Python tracker <report@bugs.python.org>
<https://bugs.python.org/issue39572\>

---

--
--Guido (mobile)

[miss-islington]

New changeset 6afb0a8 by Simon Charette in branch 'master':
bpo-39572: Address typo in CHANGELOG. (GH-24999)
6afb0a8

[miss-islington]

New changeset bc5a1a7 by Miss Islington (bot) in branch '3.9':
bpo-39572: Address typo in CHANGELOG. (GH-24999)
bc5a1a7