FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal by iritkatriel · Pull Request #105195 · python/cpython · GitHub

/ cpython Public

gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal #105195

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
iritkatriel merged 8 commits into from
Jun 21, 2023
+25 −19
Conversation 22 Commits 8 Checks 0 Files changed 3
Merged

gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal #105195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
34f3010
gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becomin…
iritkatriel Jun 1, 2023
b0997c0
use :c:data: instead of :const:
iritkatriel Jun 1, 2023
52a846b
add link to the PEP
iritkatriel Jun 5, 2023
103aabb
use :c:data:
iritkatriel Jun 5, 2023
864ed5d
Maybe fix the links.
iritkatriel Jun 5, 2023
3c57a95
Merge branch 'main' into immortals-doc
iritkatriel Jun 21, 2023
7330a7f
Apply suggestions from code review
iritkatriel Jun 21, 2023
4281b5b
fix :const:->:c:data:
iritkatriel Jun 21, 2023
File filter

Filter by extension

Filter by extension .rst  (3) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
25 changes: 14 additions & 11 deletions Doc/c-api/bool.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Boolean Objects
---------------

Booleans in Python are implemented as a subclass of integers. There are only
two booleans, :const:`Py_False` and :const:`Py_True`. As such, the normal
two booleans, :c:data:`Py_False` and :c:data:`Py_True`. As such, the normal
creation and deletion functions don't apply to booleans. The following macros
are available, however.

Expand All @@ -19,29 +19,32 @@ are available, however.

.. c:var:: PyObject* Py_False

The Python ``False`` object. This object has no methods. It needs to be
treated just like any other object with respect to reference counts.
The Python ``False`` object. This object has no methods and is
`immortal <https://peps.python.org/pep-0683/>`_.

.. versionchanged:: 3.12
:c:data:`Py_False` is immortal.


.. c:var:: PyObject* Py_True

The Python ``True`` object. This object has no methods. It needs to be treated
just like any other object with respect to reference counts.
The Python ``True`` object. This object has no methods and is
`immortal <https://peps.python.org/pep-0683/>`_.

.. versionchanged:: 3.12
:c:data:`Py_True` is immortal.


.. c:macro:: Py_RETURN_FALSE

Return :const:`Py_False` from a function, properly incrementing its reference
count.
Return :c:data:`Py_False` from a function.


.. c:macro:: Py_RETURN_TRUE

Return :const:`Py_True` from a function, properly incrementing its reference
count.
Return :c:data:`Py_True` from a function.


.. c:function:: PyObject* PyBool_FromLong(long v)

Return a new reference to :const:`Py_True` or :const:`Py_False` depending on the
truth value of *v*.
Return :c:data:`Py_True` or :c:data:`Py_False`, depending on the truth value of *v*.
10 changes: 5 additions & 5 deletions Doc/c-api/none.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ same reason.

.. c:var:: PyObject* Py_None

The Python ``None`` object, denoting lack of value. This object has no methods.
It needs to be treated just like any other object with respect to reference
counts.
The Python ``None`` object, denoting lack of value. This object has no methods
and is `immortal <https://peps.python.org/pep-0683/>`_.

.. versionchanged:: 3.12
:c:data:`Py_None` is immortal.

.. c:macro:: Py_RETURN_NONE

Properly handle returning :c:data:`Py_None` from within a C function (that is,
increment the reference count of ``None`` and return it.)
Return :c:data:`Py_None` from a function.
9 changes: 6 additions & 3 deletions Doc/c-api/slice.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ Ellipsis Object

.. c:var:: PyObject *Py_Ellipsis

The Python ``Ellipsis`` object. This object has no methods. It needs to be
treated just like any other object with respect to reference counts. Like
:c:data:`Py_None` it is a singleton object.
The Python ``Ellipsis`` object. This object has no methods. Like
:c:data:`Py_None`, it is an `immortal <https://peps.python.org/pep-0683/>`_.
singleton object.

.. versionchanged:: 3.12
:c:data:`Py_Ellipsis` is immortal.
Back | FazBrowse Home | New Git URL