Skip to content

[doc] bpo-45680: Disambiguate __getitem__ and __class_getitem__ in the data model. #29389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ambv merged 11 commits into from
Nov 18, 2021
Merged

[doc] bpo-45680: Disambiguate __getitem__ and __class_getitem__ in the data model. #29389

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
020d168
[doc] bpo-45680: Disambiguate ``__getitem__`` and ``__class_getitem__…
AlexWaygood Nov 3, 2021
fe66943
Update 2021-11-03-14-30-55.bpo-45680.UBpWzY.rst
AlexWaygood Nov 3, 2021
32d7751
Delete news entry
AlexWaygood Nov 3, 2021
efa0731
Address review
AlexWaygood Nov 4, 2021
7ae4fac
Improve links to ``typing`` docs
AlexWaygood Nov 4, 2021
8bc6b7c
Add link to glossary definition
AlexWaygood Nov 4, 2021
b01b0c9
Address second review
AlexWaygood Nov 7, 2021
ca568d5
Revise changes to ``__getitem__``
AlexWaygood Nov 7, 2021
c1955d7
Improve code snippet
AlexWaygood Nov 8, 2021
ace22fd
Remove trailing whitespace
AlexWaygood Nov 8, 2021
f8ea20a
Fix CI failures
AlexWaygood Nov 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revise changes to __getitem__
  • Loading branch information
@AlexWaygood
AlexWaygood committed Nov 7, 2021
commit ca568d5eec128f79647ac3b7f74c238a3ee3b1d4
20 changes: 10 additions & 10 deletions Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2443,27 +2443,27 @@ through the object's keys; for sequences, it should iterate through the values.

.. method:: object.__getitem__(self, key)

Called to implement evaluation of ``self[key]``, which is translated by the
interpreter to ``type(self).__getitem__(self, key)``. For :term:`sequence`
types, the accepted keys should be integers and slice objects. Note that
the special interpretation of negative indexes (if the class wishes to
emulate a :term:`sequence` type) is up to the :meth:`__getitem__` method. If
*key* is of an inappropriate type, :exc:`TypeError` may be raised; if of a
value outside the set of indexes for the sequence (after any special
Called to implement evaluation of ``self[key]``. For :term:`sequence` types,
the accepted keys should be integers and slice objects. Note that the
special interpretation of negative indexes (if the class wishes to emulate a
:term:`sequence` type) is up to the :meth:`__getitem__` method. If *key* is
of an inappropriate type, :exc:`TypeError` may be raised; if of a value
outside the set of indexes for the sequence (after any special
interpretation of negative values), :exc:`IndexError` should be raised. For
:term:`mapping` types, if *key* is missing (not in the container),
:exc:`KeyError` should be raised.

.. note::

:keyword:`for` loops expect that an :exc:`IndexError` will be raised for illegal
indexes to allow proper detection of the end of the sequence.
:keyword:`for` loops expect that an :exc:`IndexError` will be raised for
illegal indexes to allow proper detection of the end of the sequence.

.. note::

When :ref:`subscripting<subscriptions>` a *class*, the special
class method :meth:`~object.__class_getitem__` may be called instead of
``__getitem__()``. See :ref:`classgetitem-versus-getitem`.
``__getitem__()``. See :ref:`classgetitem-versus-getitem` for more
details.


.. method:: object.__setitem__(self, key, value)
Expand Down