diff options
| author |   Campbell Barton <ideasman42@gmail.com> | 2020-10-03 02:18:01 +1000 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2020-10-02 19:18:01 +0300 |
| commit | 20ce62f00957d11f24f6449cd5c0ef5dd67174d4 (patch) | |
| tree | 5b94ee7e1ff145cc5bcc2acbbecbbeb8a8f2ec83 | |
| parent | bpo-41692: Deprecate PyUnicode_InternImmortal() (GH-22486) (diff) | |
| download | cpython-20ce62f00957d11f24f6449cd5c0ef5dd67174d4.tar.gz cpython-20ce62f00957d11f24f6449cd5c0ef5dd67174d4.tar.bz2 cpython-20ce62f00957d11f24f6449cd5c0ef5dd67174d4.zip | |
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)
| -rw-r--r-- | Doc/c-api/dict.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst index 769484134ed..8e0d6845463 100644 --- a/Doc/c-api/dict.rst +++ b/Doc/c-api/dict.rst @@ -81,14 +81,16 @@ Dictionary Objects .. c:function:: int PyDict_DelItem(PyObject *p, PyObject *key) Remove the entry in dictionary *p* with key *key*. *key* must be hashable; - if it isn't, :exc:`TypeError` is raised. Return ``0`` on success or ``-1`` - on failure. + if it isn't, :exc:`TypeError` is raised. + If *key* is not in the dictionary, :exc:`KeyError` is raised. + Return ``0`` on success or ``-1`` on failure. .. c:function:: int PyDict_DelItemString(PyObject *p, const char *key) - Remove the entry in dictionary *p* which has a key specified by the string - *key*. Return ``0`` on success or ``-1`` on failure. + Remove the entry in dictionary *p* which has a key specified by the string *key*. + If *key* is not in the dictionary, :exc:`KeyError` is raised. + Return ``0`` on success or ``-1`` on failure. .. c:function:: PyObject* PyDict_GetItem(PyObject *p, PyObject *key) |