You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2018/09/18 18:27:40 UTC

[arrow] branch master updated: ARROW-3056: [Python] Add notes to NativeFile docstrings for BufferedIOBase methods that are not implemented

This is an automated email from the ASF dual-hosted git repository.

wesm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/master by this push:
     new 8dd3fc7  ARROW-3056: [Python] Add notes to NativeFile docstrings for BufferedIOBase methods that are not implemented
8dd3fc7 is described below

commit 8dd3fc78c8a9d97699dee9e34756f3cd59f2d2ef
Author: Wes McKinney <we...@apache.org>
AuthorDate: Tue Sep 18 14:27:28 2018 -0400

    ARROW-3056: [Python] Add notes to NativeFile docstrings for BufferedIOBase methods that are not implemented
    
    This will make it more clear to user that failure is expected since this code is compiled
    
    Author: Wes McKinney <we...@apache.org>
    
    Closes #2577 from wesm/ARROW-3056 and squashes the following commits:
    
    6fdc0bc9a <Wes McKinney> Add notes to NativeFile docstrings that methods are not implemented
---
 python/pyarrow/io.pxi | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/python/pyarrow/io.pxi b/python/pyarrow/io.pxi
index 0b740f2..2e934da 100644
--- a/python/pyarrow/io.pxi
+++ b/python/pyarrow/io.pxi
@@ -96,6 +96,9 @@ cdef class NativeFile:
         return False
 
     def fileno(self):
+        """
+        NOT IMPLEMENTED
+        """
         raise UnsupportedOperation()
 
     def close(self):
@@ -301,7 +304,7 @@ cdef class NativeFile:
         return bytes_read
 
     def readline(self, size=None):
-        """Read and return a line of bytes from the file.
+        """NOT IMPLEMENTED. Read and return a line of bytes from the file.
 
         If size is specified, read at most size bytes.
 
@@ -311,8 +314,7 @@ cdef class NativeFile:
         raise UnsupportedOperation()
 
     def readlines(self, hint=None):
-        """
-        Read lines of the file
+        """NOT IMPLEMENTED. Read lines of the file
 
         Parameters
         -----------
@@ -350,6 +352,9 @@ cdef class NativeFile:
         return pyarrow_wrap_buffer(output)
 
     def truncate(self):
+        """
+        NOT IMPLEMENTED
+        """
         raise UnsupportedOperation()
 
     def writelines(self, lines):