[Python-checkins] cpython (3.4): Issue #19428: Document that PyMarshal_ReadLongFromFile() and

Wed Mar 18 13:59:10 CET 2015

https://hg.python.org/cpython/rev/acb4d43955f6
changeset: 95035:acb4d43955f6
branch: 3.4
parent: 95032:6f7ed6e95ea8
user: Victor Stinner <victor.stinner at gmail.com>
date: Wed Mar 18 13:58:49 2015 +0100
summary:
 Issue #19428: Document that PyMarshal_ReadLongFromFile() and
PyMarshal_ReadShortFromFile() can fail.
files:
 Doc/c-api/marshal.rst | 21 +++++++++++++++------
 1 files changed, 15 insertions(+), 6 deletions(-)

diff --git a/Doc/c-api/marshal.rst b/Doc/c-api/marshal.rst
--- a/Doc/c-api/marshal.rst
+++ b/Doc/c-api/marshal.rst
@@ -53,6 +53,8 @@
 for reading. Only a 32-bit value can be read in using this function,
 regardless of the native size of :c:type:`long`.
 
+ On error, raise an exception and return ``-1``.
+
 
 .. c:function:: int PyMarshal_ReadShortFromFile(FILE *file)
 
@@ -60,11 +62,15 @@
 for reading. Only a 16-bit value can be read in using this function,
 regardless of the native size of :c:type:`short`.
 
+ On error, raise an exception and return ``-1``.
+
 
 .. c:function:: PyObject* PyMarshal_ReadObjectFromFile(FILE *file)
 
 Return a Python object from the data stream in a :c:type:`FILE\*` opened for
- reading. On error, sets the appropriate exception (:exc:`EOFError` or
+ reading.
+
+ On error, sets the appropriate exception (:exc:`EOFError` or
 :exc:`TypeError`) and returns *NULL*.
 
 
@@ -76,14 +82,17 @@
 aggressively load file data into memory so that the de-serialization can
 operate from data in memory rather than reading a byte at a time from the
 file. Only use these variant if you are certain that you won't be reading
- anything else from the file. On error, sets the appropriate exception
- (:exc:`EOFError` or :exc:`TypeError`) and returns *NULL*.
+ anything else from the file.
+
+ On error, sets the appropriate exception (:exc:`EOFError` or
+ :exc:`TypeError`) and returns *NULL*.
 
 
 .. c:function:: PyObject* PyMarshal_ReadObjectFromString(char *string, Py_ssize_t len)
 
 Return a Python object from the data stream in a character buffer
- containing *len* bytes pointed to by *string*. On error, sets the
- appropriate exception (:exc:`EOFError` or :exc:`TypeError`) and returns
- *NULL*.
+ containing *len* bytes pointed to by *string*.
 
+ On error, sets the appropriate exception (:exc:`EOFError` or
+ :exc:`TypeError`) and returns *NULL*.
+
-- 
Repository URL: https://hg.python.org/cpython
