Skip to content

Commit 0ae7c8b

Browse files
aktechbitdancer
authored andcommitted
bpo-16011 clarify that 'in' always returns a boolean value
1 parent 9f74deb commit 0ae7c8b

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

Doc/reference/expressions.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1431,28 +1431,29 @@ Membership test operations
14311431
--------------------------
14321432

14331433
The operators :keyword:`in` and :keyword:`not in` test for membership. ``x in
1434-
s`` evaluates to true if *x* is a member of *s*, and false otherwise. ``x not
1435-
in s`` returns the negation of ``x in s``. All built-in sequences and set types
1436-
support this as well as dictionary, for which :keyword:`in` tests whether the
1437-
dictionary has a given key. For container types such as list, tuple, set,
1438-
frozenset, dict, or collections.deque, the expression ``x in y`` is equivalent
1434+
s`` evaluates to ``True`` if *x* is a member of *s*, and ``False`` otherwise.
1435+
``x not in s`` returns the negation of ``x in s``. All built-in sequences and
1436+
set types support this as well as dictionary, for which :keyword:`in` tests
1437+
whether the dictionary has a given key. For container types such as list, tuple,
1438+
set, frozenset, dict, or collections.deque, the expression ``x in y`` is equivalent
14391439
to ``any(x is e or x == e for e in y)``.
14401440

1441-
For the string and bytes types, ``x in y`` is true if and only if *x* is a
1441+
For the string and bytes types, ``x in y`` is ``True`` if and only if *x* is a
14421442
substring of *y*. An equivalent test is ``y.find(x) != -1``. Empty strings are
14431443
always considered to be a substring of any other string, so ``"" in "abc"`` will
14441444
return ``True``.
14451445

14461446
For user-defined classes which define the :meth:`__contains__` method, ``x in
1447-
y`` is true if and only if ``y.__contains__(x)`` is true.
1447+
y`` returns ``True`` if ``y.__contains__(x)`` returns a true value, and
1448+
``False`` otherwise.
14481449

14491450
For user-defined classes which do not define :meth:`__contains__` but do define
1450-
:meth:`__iter__`, ``x in y`` is true if some value ``z`` with ``x == z`` is
1451+
:meth:`__iter__`, ``x in y`` is ``True`` if some value ``z`` with ``x == z`` is
14511452
produced while iterating over ``y``. If an exception is raised during the
14521453
iteration, it is as if :keyword:`in` raised that exception.
14531454

14541455
Lastly, the old-style iteration protocol is tried: if a class defines
1455-
:meth:`__getitem__`, ``x in y`` is true if and only if there is a non-negative
1456+
:meth:`__getitem__`, ``x in y`` is ``True`` if and only if there is a non-negative
14561457
integer index *i* such that ``x == y[i]``, and all lower integer indices do not
14571458
raise :exc:`IndexError` exception. (If any other exception is raised, it is as
14581459
if :keyword:`in` raised that exception).

0 commit comments

Comments
 (0)