traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

bpo-12743: Delete comment from marshal.rst (GH-8457) 

Also, update the list of exceptions that may raised by PyMarshal_*
functions. We usually don't document exceptions raised by a
function, but in this case most of them were already documented
in C API and standard library documentation.
(cherry picked from commit defcffdf86)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-07-26 21:40:37 -07:00 committed by GitHub
parent 3cc505e950
commit 21ed29ac29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Doc/c-api/marshal.rst
View File

@ -40,12 +40,6 @@ unmarshalling. Version 2 uses a binary format for floating point numbers.
The following functions allow marshalled values to be read back in. The following functions allow marshalled values to be read back in.
XXX What about error detection? It appears that reading past the end of the
file will always result in a negative numeric value (where that's relevant),
but it's not clear that negative values won't be handled properly when there's
no error. What's the right way to tell? Should only non-negative values be
written using these routines?
.. c:function:: long PyMarshal_ReadLongFromFile(FILE *file) .. c:function:: long PyMarshal_ReadLongFromFile(FILE *file)
@ -53,7 +47,8 @@ written using these routines?
for reading. Only a 32-bit value can be read in using this function, for reading. Only a 32-bit value can be read in using this function,
regardless of the native size of :c:type:`long`. regardless of the native size of :c:type:`long`.
On error, raise an exception and return ``-1``. On error, sets the appropriate exception (:exc:`EOFError`) and returns
``-1``.
.. c:function:: int PyMarshal_ReadShortFromFile(FILE *file) .. c:function:: int PyMarshal_ReadShortFromFile(FILE *file)
@ -62,7 +57,8 @@ written using these routines?
for reading. Only a 16-bit value can be read in using this function, for reading. Only a 16-bit value can be read in using this function,
regardless of the native size of :c:type:`short`. regardless of the native size of :c:type:`short`.
On error, raise an exception and return ``-1``. On error, sets the appropriate exception (:exc:`EOFError`) and returns
``-1``.
.. c:function:: PyObject* PyMarshal_ReadObjectFromFile(FILE *file) .. c:function:: PyObject* PyMarshal_ReadObjectFromFile(FILE *file)
@ -70,8 +66,8 @@ written using these routines?
Return a Python object from the data stream in a :c:type:`FILE\*` opened for Return a Python object from the data stream in a :c:type:`FILE\*` opened for
reading. reading.
On error, sets the appropriate exception (:exc:`EOFError` or On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError`
:exc:`TypeError`) and returns *NULL*. or :exc:`TypeError`) and returns *NULL*.
.. c:function:: PyObject* PyMarshal_ReadLastObjectFromFile(FILE *file) .. c:function:: PyObject* PyMarshal_ReadLastObjectFromFile(FILE *file)
@ -84,8 +80,8 @@ written using these routines?
file. Only use these variant if you are certain that you won't be reading file. Only use these variant if you are certain that you won't be reading
anything else from the file. anything else from the file.
On error, sets the appropriate exception (:exc:`EOFError` or On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError`
:exc:`TypeError`) and returns *NULL*. or :exc:`TypeError`) and returns *NULL*.
.. c:function:: PyObject* PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len) .. c:function:: PyObject* PyMarshal_ReadObjectFromString(const char *data, Py_ssize_t len)
@ -93,6 +89,6 @@ written using these routines?
Return a Python object from the data stream in a byte buffer Return a Python object from the data stream in a byte buffer
containing *len* bytes pointed to by *data*. containing *len* bytes pointed to by *data*.
On error, sets the appropriate exception (:exc:`EOFError` or On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError`
:exc:`TypeError`) and returns *NULL*. or :exc:`TypeError`) and returns *NULL*.