Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-82012: Deprecate bitwise inversion (~) of bool #103487

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
merged 5 commits into from
May 3, 2023
Merged

gh-82012: Deprecate bitwise inversion (~) of bool #103487

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f0351a
gh-82012: Deprecate bitwise inversion (~) of bool
timhoffm Apr 12, 2023
3632ba5
Document bool behavior for bitwise operations
timhoffm Apr 30, 2023
2cbfe2d
Move section "Boolean Values" into "Boolean Type"
timhoffm May 1, 2023
e5ec711
Update Doc/library/stdtypes.rst
timhoffm May 1, 2023
2db5864
Update Doc/library/stdtypes.rst
timhoffm May 1, 2023
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
Document bool behavior for bitwise operations 
This also pulls the bool type to top-level of the type
description page. Before it was only documented in the
section "Other Built-in Types / Boolean Values".
  • Loading branch information
@timhoffm
timhoffm committed Apr 30, 2023
commit 3632ba5d40540462c1e5e287d7e36796f85f65f9
36 changes: 27 additions & 9 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,31 @@ number, :class:`float`, or :class:`complex`::
hash_value = -2
return hash_value

.. _typebool:

Boolean Type - :class:`bool`
============================

Booleans represent truth values. The :class:`bool` type has exactly two
constant instances ``True`` and ``False``.

Other types can be cast to bool explicitly using the function :func:`bool`.
Additionally, they are implicitly interpreted as bool in some contexts - see
:ref:`truth`.

For logical operations, use the :ref:`boolean operators <boolean>` ``and``,
``or`` and ``not``.
When applying the bitwise operators ``&``, ``|``, ``^`` to two booleans, they
return a bool equivalent to the logical operations "and", "or", "xor". Still,
for ``&`` and ``|``, the logical operators ``and`` and ``or`` are preferred.
The use of the bitwise inversion operator ``~`` is deprecated and will raise
an error in Python 3.14.

:class:`bool` is a subclass of :class:`int` (see :ref:`typesnumeric`). In
many numeric contexts, bools behave like the integers 0 and 1, respectively.
However, relying on this is discouraged; explicitly convert using :func:`int`
instead.

.. _typeiter:

Iterator Types
Expand Down Expand Up @@ -5399,21 +5424,14 @@ It is written as ``NotImplemented``.
Boolean Values
--------------

Boolean values are the two constant objects ``False`` and ``True``. They are
used to represent truth values (although other values can also be considered
false or true). In numeric contexts (for example when used as the argument to
an arithmetic operator), they behave like the integers 0 and 1, respectively.
The built-in function :func:`bool` can be used to convert any value to a
Boolean, if the value can be interpreted as a truth value (see section
:ref:`truth` above).
Boolean values are the two constant objects ``False`` and ``True``. See
:ref:`typebool` for more info.

.. index::
single: False
single: True
pair: Boolean; values

They are written as ``False`` and ``True``, respectively.


.. _typesinternal:

Expand Down