diff options
Diffstat (limited to 'pexpect/fdpexpect.py')
| -rw-r--r-- | pexpect/fdpexpect.py | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/pexpect/fdpexpect.py b/pexpect/fdpexpect.py index 40817b9..ac7443e 100644 --- a/pexpect/fdpexpect.py +++ b/pexpect/fdpexpect.py @@ -115,17 +115,20 @@ class fdspawn(SpawnBase): self.write(s) def read_nonblocking(self, size=1, timeout=-1): - """ Read from the file descriptor and return the result as a string. + """ + Read from the file descriptor and return the result as a string. + + The read_nonblocking method of :class:`SpawnBase` assumes that a call + to os.read will not block (timeout parameter is ignored). This is not + the case for POSIX file-like objects such as sockets and serial ports. - The read_nonblocking method of SpawnBase assumes that a call to - os.read will not block. This is not the case for POSIX file like - objects like sockets and serial ports. So we use select to implement - the timeout on POSIX. + Use :func:`select.select`, timeout is implemented conditionally for + POSIX systems. - :param size: Read at most size bytes - :param timeout: Wait timeout seconds for file descriptor to be ready - to read. If -1, use self.timeout. If 0, poll. - :return: String containing the bytes read + :param int size: Read at most *size* bytes. + :param int timeout: Wait timeout seconds for file descriptor to be + ready to read. When -1 (default), use self.timeout. When 0, poll. + :return: String containing the bytes read """ if os.name == 'posix': if timeout == -1: |