summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorTim Hoffmann <2836374+timhoffm@users.noreply.github.com>2023-05-03 07:00:42 (GMT)
committerGitHub <noreply@github.com>2023-05-03 07:00:42 (GMT)
commitfdb3ef8c0f94c7e55870a585dc6499aca46f9f90 (patch)
tree8a2c2ce856fe00afc77a99049f3bfa331068069d /Doc
parent5b05b013ff13032ffc4db07108a507c08b3a604d (diff)
downloadcpython-fdb3ef8c0f94c7e55870a585dc6499aca46f9f90.zip
cpython-fdb3ef8c0f94c7e55870a585dc6499aca46f9f90.tar.gz
cpython-fdb3ef8c0f94c7e55870a585dc6499aca46f9f90.tar.bz2
gh-82012: Deprecate bitwise inversion (~) of bool (#103487)
The bitwise inversion operator on bool returns the bitwise inversion of the underlying int value; i.e. `~True == -2` such that `bool(~True) == True`. It's a common pitfall that users mistake `~` as negation operator and actually want `not`. Supporting `~` is an artifact of bool inheriting from int. Since there is no real use-case for the current behavior, let's deprecate `~` on bool and later raise an error. This removes a potential source errors for users. Full reasoning: https://github.com/python/cpython/issues/82012#issuecomment-1258705971 Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/functions.rst2
-rw-r--r--Doc/library/stdtypes.rst54
-rw-r--r--Doc/whatsnew/3.12.rst6
3 files changed, 40 insertions, 22 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index a5e86ef..085a11c 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -147,7 +147,7 @@ are always available. They are listed here in alphabetical order.
or omitted, this returns ``False``; otherwise, it returns ``True``. The
:class:`bool` class is a subclass of :class:`int` (see :ref:`typesnumeric`).
It cannot be subclassed further. Its only instances are ``False`` and
- ``True`` (see :ref:`bltin-boolean-values`).
+ ``True`` (see :ref:`typebool`).
.. index:: pair: Boolean; type
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 2360472..f6662b4 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -802,6 +802,39 @@ 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``.
+
+.. index::
+ single: False
+ single: True
+ pair: Boolean; values
+
+The built-in function :func:`bool` converts any value to a boolean, if the
+value can be interpreted as a truth value (see section :ref:`truth` above).
+
+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". However,
+the logical operators ``and``, ``or`` and ``!=`` should be preferred
+over ``&``, ``|`` and ``^``.
+
+.. deprecated:: 3.12
+
+ 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, ``False`` and ``True`` behave like the integers 0 and 1, respectively.
+However, relying on this is discouraged; explicitly convert using :func:`int`
+instead.
+
.. _typeiter:
Iterator Types
@@ -5394,27 +5427,6 @@ information. There is exactly one ``NotImplemented`` object.
It is written as ``NotImplemented``.
-.. _bltin-boolean-values:
-
-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).
-
-.. index::
- single: False
- single: True
- pair: Boolean; values
-
-They are written as ``False`` and ``True``, respectively.
-
-
.. _typesinternal:
Internal Objects
diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
index a3fce7c..5f8a1f0 100644
--- a/Doc/whatsnew/3.12.rst
+++ b/Doc/whatsnew/3.12.rst
@@ -710,6 +710,12 @@ Deprecated
replaced by :data:`calendar.Month.JANUARY` and :data:`calendar.Month.FEBRUARY`.
(Contributed by Prince Roshan in :gh:`103636`.)
+* The bitwise inversion operator (``~``) on bool is deprecated. It will throw an
+ error in Python 3.14. Use ``not`` for logical negation of bools instead.
+ In the rare case that you really need the bitwise inversion of the underlying
+ ``int``, convert to int explicitly with ``~int(x)``. (Contributed by Tim Hoffmann
+ in :gh:`103487`.)
+
Pending Removal in Python 3.13
------------------------------