Help on OutStream in module ipykernel.iostream object:
class OutStream(io.TextIOBase)
| A file like object that publishes the stream to a 0MQ PUB socket.
|
| Output is handed off to an IO Thread
|
| Method resolution order:
| OutStream
| io.TextIOBase
| _io._TextIOBase
| io.IOBase
| _io._IOBase
| builtins.object
|
| Methods defined here:
|
| __init__(self, session, pub_thread, name, pipe=None)
| Initialize self. See help(type(self)) for accurate signature.
|
| close(self)
| Flush and close the IO object.
|
| This method has no effect if the file is already closed.
|
| flush(self)
| trigger actual zmq send
|
| send will happen in the background thread
|
| set_parent(self, parent)
|
| write(self, string)
| Write string to stream.
| Returns the number of characters written (which is always equal to
| the length of the string).
|
| writelines(self, sequence)
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| closed
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| encoding = 'UTF-8'
|
| flush_interval = 0.2
|
| flush_timeout = 10
|
| topic = None
|
| ----------------------------------------------------------------------
| Methods inherited from _io._TextIOBase:
|
| detach(...)
| Separate the underlying buffer from the TextIOBase and return it.
|
| After the underlying buffer has been detached, the TextIO is in an
| unusable state.
|
| read(...)
| Read at most n characters from stream.
|
| Read from underlying buffer until we have n characters or we hit EOF.
| If n is negative or omitted, read until EOF.
|
| readline(...)
| Read until newline or EOF.
|
| Returns an empty string if EOF is hit immediately.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from _io._TextIOBase:
|
| errors
| The error setting of the decoder or encoder.
|
| Subclasses should override.
|
| newlines
| Line endings translated so far.
|
| Only line endings translated during reading are considered.
|
| Subclasses should override.
|
| ----------------------------------------------------------------------
| Methods inherited from _io._IOBase:
|
| __del__(...)
|
| __enter__(...)
|
| __exit__(...)
|
| __iter__(self, /)
| Implement iter(self).
|
| __new__(*args, **kwargs) from builtins.type
| Create and return a new object. See help(type) for accurate signature.
|
| __next__(self, /)
| Implement next(self).
|
| fileno(self, /)
| Returns underlying file descriptor if one exists.
|
| OSError is raised if the IO object does not use a file descriptor.
|
| isatty(self, /)
| Return whether this is an 'interactive' stream.
|
| Return False if it can't be determined.
|
| readable(self, /)
| Return whether object was opened for reading.
|
| If False, read() will raise OSError.
|
| readlines(self, hint=-1, /)
| Return a list of lines from the stream.
|
| hint can be specified to control the number of lines read: no more
| lines will be read if the total size (in bytes/characters) of all
| lines so far exceeds hint.
|
| seek(...)
| Change stream position.
|
| Change the stream position to the given byte offset. The offset is
| interpreted relative to the position indicated by whence. Values
| for whence are:
|
| * 0 -- start of stream (the default); offset should be zero or positive
| * 1 -- current stream position; offset may be negative
| * 2 -- end of stream; offset is usually negative
|
| Return the new absolute position.
|
| seekable(self, /)
| Return whether object supports random access.
|
| If False, seek(), tell() and truncate() will raise OSError.
| This method may need to do a test seek().
|
| tell(self, /)
| Return current stream position.
|
| truncate(...)
| Truncate file to size bytes.
|
| File pointer is left unchanged. Size defaults to the current IO
| position as reported by tell(). Returns the new size.
|
| writable(self, /)
| Return whether object was opened for writing.
|
| If False, write() will raise OSError.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from _io._IOBase:
|
| __dict__