Skip to content

bpo-5945: mapping.rst: PyMapping_Check(list) returns 1 #144

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

Closed
jbarlow83 wants to merge 3 commits into from
Closed

bpo-5945: mapping.rst: PyMapping_Check(list) returns 1 #144

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c7abc1
mapping.rst: PyMapping_Check(list) returns 1
jbarlow83 Feb 16, 2017
be98854
Update mapping.rst
jbarlow83 Feb 23, 2018
463418b
Remove alternative to PyMapping_Check
jbarlow83 May 21, 2018
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
7 changes: 5 additions & 2 deletions Doc/c-api/mapping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ Mapping Protocol

.. c:function:: int PyMapping_Check(PyObject *o)

Return ``1`` if the object provides mapping protocol, and ``0`` otherwise. This
function always succeeds.
**Not recommended.** Return ``1`` if the object provides the C-API mapping
protocol, and ``0`` otherwise. This function always succeeds. The C-API
Copy link
Contributor

@willingc willingc May 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend using @serhiy-storchaka's suggested wording to move this PR forward.

The C-API mapping protocol is not equivalent to :class:collections.abc.Mapping, and also returns 1 for sequences that support slicing. Use :c:func::PyObject_IsInstance instead.

PyMapping_Check() also returns 1 for sequences that support slicing.

mapping protocol is not equivalent to :class:`collections.abc.Mapping`, and
also returns ``1`` for sequences that support slicing. Use
:c:func::`PyObject_IsInstance` instead.


.. c:function:: Py_ssize_t PyMapping_Size(PyObject *o)
Expand Down