Jython 2.7.4 · org.python.modules._io.PyIOBase · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected boolean	__closed True if the object is closed to further client operations.
protected PyStringMap	__dict__ Provide a dictionary in the object, so that methods and attributes may be overridden at instance level.
public static final String	close_doc
public static final String	closed_doc
private Closer<PyIOBase>	closer The ioDelegate's closer object; ensures the stream is closed at shutdown
pack-priv static final String	doc
public static final String	fileno_doc
public static final String	flush_doc
public static final String	isatty_doc
public static final String	readable_doc
public static final String	readline_doc
public static final String	readlines_doc
public static final String	seek_doc
public static final String	seekable_doc
public static final String	tell_doc
public static final String	truncate_doc
public static final PyType	TYPE Hides org.python.core.PyObject.TYPE.
public static final String	writable_doc
public static final String	writelines_doc

Access	Constructor and Description
protected	PyIOBase()
protected	PyIOBase(PyType subtype)

Method Summary

Modifier and Type	Method and Description
public void	__del_builtin__() Implements org.python.core.finalization.FinalizableBuiltin.__del_builtin__. `__del_builtin__()` is the built-in's own finalizer, while `FinalizablePyObjectDerived#__del_derived__()` refers to an instance's in-dict `__del__`.
public PyObject	Returns: this object __enter__() Called at the start of a context-managed suite (supporting the `with` clause).
public boolean	Returns: false __exit__(PyObject type, PyObject value, PyObject traceback) Called at the end of a context-managed suite (supporting the `with` clause), and will normally close the stream.
public PyObject	__iter__() Overrides org.python.core.PyObject.__iter__. Return an iterator on which `next` may be repeatedly called to produce (usually) lines from this stream or file.
public PyObject	__iternext__() Overrides org.python.core.PyObject.__iternext__. Return the next element of the sequence that this is an iterator for.
public void	_checkClosed(String optional custom message msg) Raise an error if the underlying IO stream is closed.
public final void	_checkClosed()
public void	_checkReadable(String optional custom message msg) Raise an error if the underlying IO stream is not readable.
public final void	_checkReadable() Raise an error if the underlying IO stream is not readable.
public void	_checkSeekable(String optional custom message msg) Raise an error if the pointer of underlying IO stream is not capable of being positioned.
public final void	_checkSeekable() Raise an error if the pointer of underlying IO stream is not capable of being positioned.
public void	_checkWritable(String optional custom message msg) Raise an error if the underlying IO stream is not writable.
public final void	_checkWritable() Raise an error if the underlying IO stream is not writable.
pack-priv final PyObject	_IOBase___enter__()
pack-priv final boolean	_IOBase___exit__(PyObject type, PyObject value, PyObject traceback)
pack-priv static PyObject	_IOBase___new__(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords)
pack-priv final void	_IOBase__checkClosed(String msg)
pack-priv final void	_IOBase__checkReadable(String msg)
pack-priv final void	_IOBase__checkSeekable(String msg)
pack-priv final void	_IOBase__checkWritable(String msg)
pack-priv final void	_IOBase__unsupported(String name)
pack-priv final void	_IOBase_close()
pack-priv final PyObject	_IOBase_fileno()
pack-priv final void	_IOBase_flush()
pack-priv final boolean	_IOBase_isatty()
pack-priv final PyObject	_IOBase_next()
pack-priv final boolean	_IOBase_readable()
pack-priv final PyObject	_IOBase_readline(PyObject limit)
pack-priv final PyObject	_IOBase_readlines(PyObject hint)
pack-priv final long	_IOBase_seek(long pos, int whence)
pack-priv final boolean	_IOBase_seekable()
pack-priv final long	_IOBase_tell()
pack-priv final long	_IOBase_truncate(PyObject size)
pack-priv final boolean	_IOBase_writable()
pack-priv final void	_IOBase_writelines(PyObject lines)
private PyObject	_readline(int limit)
public void	close() Close the stream.
public final boolean	Returns: `true` if closed closed() Is the stream closed against further client operations?
public final void	closed_readonly(boolean value)
public PyStringMap	fastGetDict() Overrides org.python.core.PyObject.fastGetDict. xxx implements where meaningful
public PyObject	Returns: a file descriptor (as opaque object) fileno() Return a file descriptor for the stream.
public void	flush() Flush write buffers, or no-op for read-only and non-blocking streams.
public boolean	Returns: `true` if a console: `false` if not or we can't tell isatty() Is the stream known to be an interactive console?
public PyObject	Returns: next line from the stream or file next() May be called repeatedly to produce (usually) lines from this stream or file.
public boolean	Returns: `true` if readable readable() Is the stream readable?
protected static PyBuffer	Returns: a 1D contiguous PyBuffer of bytes readablePyBuffer(PyObject to be wrapped and presented as a buffer obj) Construct a PyBuffer on a given object suitable for writing to the underlying stream.
public PyObject	Returns: the line (or fragment) readline(int maximum number of bytes (<0 means no limit) limit) Return one line of text (bytes terminates by `'\n'`), or the specified number of bytes, or the whole stream, whichever is shortest.
public PyObject	Returns: the line (or fragment) readline() Return one line of text (bytes terminates by `'\n'`), or the whole stream, whichever is shorter.
public PyObject	Returns: list containing the lines read readlines(PyObject stop reading lines after this many bytes (if not EOF first) hint) Read a stream as a sequence of lines.
public boolean	refersDirectlyTo(PyObject ob) Implements org.python.core.Traverseproc.refersDirectlyTo. Optional operation.
public long	Returns: the new current position seek(long relative to the specified point pos, int 0=from start, 1=from here, 2=from end whence) Position the read or write pointer at a given byte offset `pos` relative to a position indicated by `whence`.
public final long	Returns: the new current position seek(long relative to the start pos) Position the read or write pointer at a given byte offset `pos` relative to the start.
public boolean	Returns: `True` if may be positioned seekable() Is the stream capable of positioning the read/write pointer?
private static PyException	tailoredIOError(String msg, String oper) Convenience method providing the exception in the _checkWhatever() methods.
protected static PyException	Returns: TypeError to throw tailoredTypeError(String of thing expected (or could any text) type, PyObject argument provided from which actual type will be reported arg) Convenience method providing the exception when an argument is not the expected type.
public long	Returns: stream position tell() Get the current stream position.
public int	traverse(Visitproc visit, Object arg) Implements org.python.core.Traverseproc.traverse. Traverses all directly contained `PyObject`s.
public long	Returns: the new size truncate(long requested for stream size) Truncate file to `size` bytes.
public long	Returns: the new size truncate() Truncate file to `size` bytes to the current position (as reported by `tell()`).
protected PyException	Returns: the exception for throwing unsupported(String name of operation op) Convenience method returning a PyException(_io.UnsupportedOperation), ripe for throwing, and naming the unsupported operation.
public boolean	Returns: `true` if writable writable() Is the stream writable?
protected static PyBuffer	Returns: a 1D contiguous PyBuffer of bytes writablePyBuffer(PyObject to be wrapped and presented as a buffer obj) Construct a PyBuffer on a given object suitable for reading into from the underlying stream.
public void	writelines(PyObject lines) Write an iterable sequence of strings to the stream.

Inherited from org.python.core.PyObject:: __abs____add____and____call____call____call____call____call____call____call____call____call____call____call____call____call____call____call____call____cmp____coerce____coerce_ex____complex____contains____delattr____delattr____delete____delitem____delitem____delslice____delslice____dir____div____divmod____ensure_finalizer____eq____findattr____findattr____findattr_ex____finditem____finditem____finditem____float____floordiv____format____ge____get____getattr____getattr____getitem____getitem____getnewargs____getslice____getslice____gt____hash____hex____iadd____iand____idiv____idivmod____ifloordiv____ilshift____imod____imul____index____int____invert____ior____ipow____irshift____isub____itruediv____ixor____le____len____long____lshift____lt____mod____mul____ne____neg____nonzero____not____oct____or____pos____pow____pow____radd____rand____rawdir____rdiv____rdivmod____reduce____reduce_ex____reduce_ex____repr____rfloordiv____rlshift____rmod____rmul____ror____rpow____rrshift____rshift____rsub____rtruediv____rxor____set____setattr____setattr____setitem____setitem____setitem____setslice____setslice____str____sub____tojava____truediv____trunc____unicode____xor___add _and _callextra _cmp _div _divmod _doget _doget _doset _eq _floordiv _ge _gt _iadd _iand _idiv _idivmod _ifloordiv _ilshift _imod _imul _in _ior _ipow _irshift _is _isnot _isub _itruediv _ixor _jcall _jcallexc _jthrow _le _lshift _lt _mod _mul _ne _notin _or _pow _rshift _sub _truediv _unsupportedop _xor adaptToCoerceTuple asDouble asIndex asIndex asInt asInt asIterable asLong asLong asName asName asString asString asStringOrNull asStringOrNull bit_length conjugate delDict delType dispatch__init__equals fastGetClass finalize getDict getJavaProxy getType hashCode impAttr implementsDescrDelete implementsDescrGet implementsDescrSet invoke invoke invoke invoke invoke invoke isCallable isDataDescr isIndex isInteger isMappingType isNumberType isSequenceType mergeClassDict mergeDictAttr mergeListAttr noAttributeError object___subclasshook__readonlyAttributeError runsupportedopMessage setDict setType toString unsupportedopMessage

__closed	back to summary
protected boolean __closed True if the object is closed to further client operations. It is the state accessed by `closed` and checked by `_checkClosed()`. It may be set without making it an error (for this object and its subclasses) to access some downstream object, notably in the implementation of `close()`. Annotations @ExposedGet name:closed doc:True if the stream is closed.

__dict__	back to summary
protected PyStringMap __dict__ Provide a dictionary in the object, so that methods and attributes may be overridden at instance level. Annotations @ExposedGet

close_doc	back to summary
public static final String close_doc

closed_doc	back to summary
public static final String closed_doc

closer	back to summary
private Closer<PyIOBase> closer The ioDelegate's closer object; ensures the stream is closed at shutdown

doc	back to summary
pack-priv static final String doc

fileno_doc	back to summary
public static final String fileno_doc

flush_doc	back to summary
public static final String flush_doc

isatty_doc	back to summary
public static final String isatty_doc

readable_doc	back to summary
public static final String readable_doc

readline_doc	back to summary
public static final String readline_doc

readlines_doc	back to summary
public static final String readlines_doc

seek_doc	back to summary
public static final String seek_doc

seekable_doc	back to summary
public static final String seekable_doc

tell_doc	back to summary
public static final String tell_doc

truncate_doc	back to summary
public static final String truncate_doc

TYPE	back to summary
public static final PyType TYPE Hides org.python.core.PyObject.TYPE.

writable_doc	back to summary
public static final String writable_doc

writelines_doc	back to summary
public static final String writelines_doc

PyIOBase	back to summary
protected PyIOBase()

PyIOBase	back to summary
protected PyIOBase(PyType subtype)

Method Detail

__del_builtin__ back to summary

__del_builtin__	back to summary
public void __del_builtin__() Implements org.python.core.finalization.FinalizableBuiltin.__del_builtin__. Doc from org.python.core.finalization.FinalizableBuiltin.__del_builtin__. `__del_builtin__()` is the built-in's own finalizer, while `FinalizablePyObjectDerived#__del_derived__()` refers to an instance's in-dict `__del__`. A FinalizeTrigger calls `FinalizablePyObjectDerived#__del_derived__()` first and - if existent - `__del_builtin__()` after that. A plain `FinalizablePyObject#__del__()` would behave as overridden by `FinalizablePyObjectDerived#__del_derived__()`, i.e. won't be called if the type implements `FinalizablePyObjectDerived`, while `__del_builtin__()` is called in any case. Annotations @Override

public void __del_builtin__()

Implements org.python.core.finalization.FinalizableBuiltin.__del_builtin__.

Doc from org.python.core.finalization.FinalizableBuiltin.__del_builtin__.

__del_builtin__() is the built-in's own finalizer, while FinalizablePyObjectDerived#__del_derived__() refers to an instance's in-dict __del__. A FinalizeTrigger calls FinalizablePyObjectDerived#__del_derived__() first and - if existent - __del_builtin__() after that. A plain FinalizablePyObject#__del__() would behave as overridden by FinalizablePyObjectDerived#__del_derived__(), i.e. won't be called if the type implements FinalizablePyObjectDerived, while __del_builtin__() is called in any case.

Annotations

@Override

__enter__ back to summary

__enter__	back to summary
public PyObject __enter__() Called at the start of a context-managed suite (supporting the `with` clause). Returns:PyObject this object

public PyObject __enter__()

Called at the start of a context-managed suite (supporting the with clause).

Returns:PyObject: this object

__exit__ back to summary

__exit__	back to summary
public boolean __exit__(PyObject type, PyObject value, PyObject traceback) Called at the end of a context-managed suite (supporting the `with` clause), and will normally close the stream. Returns:boolean false

public boolean __exit__(PyObject type, PyObject value, PyObject traceback)

Called at the end of a context-managed suite (supporting the with clause), and will normally close the stream.

Returns:boolean: false

__iter__ back to summary

__iter__	back to summary
public PyObject __iter__() Overrides org.python.core.PyObject.__iter__. Return an iterator on which `next` may be repeatedly called to produce (usually) lines from this stream or file. Annotations @Override

public PyObject __iter__()

Overrides org.python.core.PyObject.__iter__.

Return an iterator on which next may be repeatedly called to produce (usually) lines from this stream or file.

Annotations

@Override

__iternext__	back to summary
public PyObject __iternext__() Overrides org.python.core.PyObject.__iternext__. Doc from org.python.core.PyObject.__iternext__. Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached. Annotations @Override

__iternext__

back to summary

public PyObject __iternext__()

Overrides org.python.core.PyObject.__iternext__.

Doc from org.python.core.PyObject.__iternext__.

Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached.

Annotations

@Override

_checkClosed back to summary

_checkClosed	back to summary
public void _checkClosed(String msg) throws PyException Raise an error if the underlying IO stream is closed. (Note opposite sense from `_checkSeekable`, etc.. Parameters msg:String optional custom message Exceptions PyException: `ValueError` if the object is closed to client operations

public void _checkClosed(String msg) throws PyException

Raise an error if the underlying IO stream is closed. (Note opposite sense from _checkSeekable, etc..

Parameters

msg:String: optional custom message

Exceptions

PyException:: ValueError if the object is closed to client operations

_checkClosed	back to summary
public final void _checkClosed() throws PyException

_checkReadable back to summary

_checkReadable	back to summary
public void _checkReadable(String msg) Raise an error if the underlying IO stream is not readable. Parameters msg:String optional custom message Exceptions PyException: `ValueError` if the object is closed to client operations `IOError` if the stream is not readable.

public void _checkReadable(String msg)

Raise an error if the underlying IO stream is not readable.

Parameters

msg:String: optional custom message

Exceptions

PyException:

ValueError if the object is closed to client operations
IOError if the stream is not readable.

_checkReadable back to summary

_checkReadable	back to summary
public final void _checkReadable() Raise an error if the underlying IO stream is not readable. Exceptions PyException: `ValueError` if the object is closed to client operations `IOError` if the stream is not readable.

public final void _checkReadable()

Raise an error if the underlying IO stream is not readable.

Exceptions

PyException:

ValueError if the object is closed to client operations
IOError if the stream is not readable.

_checkSeekable back to summary

_checkSeekable	back to summary
public void _checkSeekable(String msg) Raise an error if the pointer of underlying IO stream is not capable of being positioned. Parameters msg:String optional custom message Exceptions PyException: `ValueError` if the object is closed to client operations `IOError` if the stream is not capable of being positioned.

public void _checkSeekable(String msg)

Raise an error if the pointer of underlying IO stream is not capable of being positioned.

Parameters

msg:String: optional custom message

Exceptions

PyException:

ValueError if the object is closed to client operations
IOError if the stream is not capable of being positioned.

_checkSeekable back to summary

_checkSeekable	back to summary
public final void _checkSeekable() Raise an error if the pointer of underlying IO stream is not capable of being positioned. Exceptions PyException: `ValueError` if the object is closed to client operations `IOError` if the stream is not capable of being positioned.

public final void _checkSeekable()

Raise an error if the pointer of underlying IO stream is not capable of being positioned.

Exceptions

PyException:

ValueError if the object is closed to client operations
IOError if the stream is not capable of being positioned.

_checkWritable back to summary

_checkWritable	back to summary
public void _checkWritable(String msg) throws PyException Raise an error if the underlying IO stream is not writable. Parameters msg:String optional custom message Exceptions PyException: `ValueError` if the object is closed to client operations `IOError` if the stream is not writable.

public void _checkWritable(String msg) throws PyException

Raise an error if the underlying IO stream is not writable.

Parameters

msg:String: optional custom message

Exceptions

PyException:

ValueError if the object is closed to client operations
IOError if the stream is not writable.

_checkWritable back to summary

_checkWritable	back to summary
public final void _checkWritable() throws PyException Raise an error if the underlying IO stream is not writable. Exceptions PyException: `ValueError` if the object is closed to client operations `IOError` if the stream is not writable.

public final void _checkWritable() throws PyException

Raise an error if the underlying IO stream is not writable.

Exceptions

PyException:

ValueError if the object is closed to client operations
IOError if the stream is not writable.

_IOBase___enter__	back to summary
pack-priv final PyObject _IOBase___enter__() Annotations @ExposedMethod names:__enter__, __iter__

_IOBase___exit__	back to summary
pack-priv final boolean _IOBase___exit__(PyObject type, PyObject value, PyObject traceback) Annotations @ExposedMethod

_IOBase___new__	back to summary
pack-priv static PyObject _IOBase___new__(PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords) Annotations @ExposedNew

_IOBase__checkClosed	back to summary
pack-priv final void _IOBase__checkClosed(String msg) throws PyException Annotations @ExposedMethod defaults:null

_IOBase__checkReadable	back to summary
pack-priv final void _IOBase__checkReadable(String msg) Annotations @ExposedMethod defaults:null

_IOBase__checkSeekable	back to summary
pack-priv final void _IOBase__checkSeekable(String msg) Annotations @ExposedMethod defaults:null

_IOBase__checkWritable	back to summary
pack-priv final void _IOBase__checkWritable(String msg) throws PyException Annotations @ExposedMethod defaults:null

_IOBase__unsupported	back to summary
pack-priv final void _IOBase__unsupported(String name) Annotations @ExposedMethod doc:Internal: raise an exception for unsupported operations.

_IOBase_close	back to summary
pack-priv final void _IOBase_close() Annotations @ExposedMethod doc:Flush and close the IO object. This method has no effect if the file is already closed.

_IOBase_fileno	back to summary
pack-priv final PyObject _IOBase_fileno() Annotations @ExposedMethod doc:Returns underlying file descriptor if one exists. An IOError is raised if the IO object does not use a file descriptor.

_IOBase_flush	back to summary
pack-priv final void _IOBase_flush() Annotations @ExposedMethod doc:Flush write buffers, if applicable. This is not implemented for read-only and non-blocking streams.

_IOBase_isatty	back to summary
pack-priv final boolean _IOBase_isatty() Annotations @ExposedMethod doc:Return whether this is an \'interactive\' stream. Return False if it can\'t be determined.

_IOBase_next	back to summary
pack-priv final PyObject _IOBase_next() throws PyException Annotations @ExposedMethod doc:x.__next__() <==> next(x)

_IOBase_readable	back to summary
pack-priv final boolean _IOBase_readable() throws PyException Annotations @ExposedMethod doc:Return whether object was opened for reading. If False, read() will raise IOError.

_IOBase_readline	back to summary
pack-priv final PyObject _IOBase_readline(PyObject limit) Annotations @ExposedMethod defaults:null doc:Read and return a line from the stream. If limit is specified, at most limit bytes will be read. The line terminator is always b\' \' for binary files; for text files, the newlines argument to open can be used to select the line terminator(s) recognized.

_IOBase_readlines	back to summary
pack-priv final PyObject _IOBase_readlines(PyObject hint) Annotations @ExposedMethod defaults:null doc: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.

_IOBase_seek

back to summary

pack-priv final long _IOBase_seek(long pos, int whence)

Annotations

@ExposedMethod
defaults:0
doc:Change stream position. Change the stream position to byte offset offset. 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.

_IOBase_seekable	back to summary
pack-priv final boolean _IOBase_seekable() throws PyException Annotations @ExposedMethod doc:Return whether object supports random access. If False, seek(), tell() and truncate() will raise IOError. This method may need to do a test seek().

_IOBase_tell	back to summary
pack-priv final long _IOBase_tell() Annotations @ExposedMethod doc:Return current stream position.

_IOBase_truncate	back to summary
pack-priv final long _IOBase_truncate(PyObject size) Annotations @ExposedMethod defaults:null doc: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.

_IOBase_writable	back to summary
pack-priv final boolean _IOBase_writable() throws PyException Annotations @ExposedMethod doc:Return whether object was opened for writing. If False, read() will raise IOError.

_IOBase_writelines	back to summary
pack-priv final void _IOBase_writelines(PyObject lines) Annotations @ExposedMethod doc:Write a list of lines to the stream. Line separators are not added, so it is usual for each of the lines provided to have a line separator at the end.

_readline	back to summary
private PyObject _readline(int limit)

close	back to summary
public void close() Close the stream. If closed already, this is a no-op.

closed back to summary

public final boolean closed()

Is the stream closed against further client operations?

Returns:boolean: true if closed

closed_readonly	back to summary
public final void closed_readonly(boolean value) Annotations @ExposedSet name:closed

fastGetDict

back to summary

public PyStringMap fastGetDict()

Overrides org.python.core.PyObject.fastGetDict.

Doc from org.python.core.PyObject.fastGetDict.

xxx implements where meaningful

Returns:PyStringMap

internal object per instance dict or null

Annotations

@Override

fileno back to summary

public PyObject fileno()

Return a file descriptor for the stream. A CPython file descriptor is an int, but this is not the natural choice in Jython, since Java has no such convention of using integers. File descriptors should be passed around opaquely, so their actual type is irrelevant, as long as (say) _jyio#open(PyObject[], String[]) accepts the type that FileIO#fileno() returns.

Returns:PyObject: a file descriptor (as opaque object)

flush	back to summary
public void flush() Flush write buffers, or no-op for read-only and non-blocking streams. Irrespective of the concrete type of the i/o object, locally-buffered write data is written downstream. Whether the downstream in object is also flushed depends upon the specific type of this object.

isatty back to summary

public boolean isatty()

Is the stream known to be an interactive console? This relies on the ability of the underlying stream to know, which is not always possible.

Returns:boolean: true if a console: false if not or we can't tell

next back to summary

public PyObject next() throws PyException

May be called repeatedly to produce (usually) lines from this stream or file.

Returns:PyObject

next line from the stream or file

Exceptions

PyException:

StopIteration when iteration has reached a natural conclusion
ValueError if the file or stream is closed
IOError reflecting an I/O error in during the read

readable back to summary

public boolean readable() throws PyException

Is the stream readable?

Returns:boolean

true if readable

Exceptions

PyException:: ValueError if the object is closed to client operations

readablePyBuffer back to summary

protected static PyBuffer readablePyBuffer(PyObject obj) throws PyException

Construct a PyBuffer on a given object suitable for writing to the underlying stream. The buffer returned will be navigable as a 1D contiguous sequence of bytes.

Parameters

obj:PyObject: to be wrapped and presented as a buffer

Returns:PyBuffer

a 1D contiguous PyBuffer of bytes

Exceptions

PyException:

BufferError if object has buffer API, but is not 1D contiguous bytes
TypeError if object not convertible to a byte array

readline back to summary

public PyObject readline(int limit)

Return one line of text (bytes terminates by '\n'), or the specified number of bytes, or the whole stream, whichever is shortest.

Parameters

limit:int: maximum number of bytes (<0 means no limit)

Returns:PyObject

the line (or fragment)

readline back to summary

public PyObject readline()

Return one line of text (bytes terminates by '\n'), or the whole stream, whichever is shorter.

Returns:PyObject: the line (or fragment)

readlines

back to summary

public PyObject readlines(PyObject hint)

Read a stream as a sequence of lines.

Parameters

hint:PyObject: stop reading lines after this many bytes (if not EOF first)

Returns:PyObject

list containing the lines read

refersDirectlyTo back to summary

public boolean refersDirectlyTo(PyObject ob)

Implements org.python.core.Traverseproc.refersDirectlyTo.

Doc from org.python.core.Traverseproc.refersDirectlyTo.

Optional operation. Should only be implemented if it is more efficient than calling traverse(Visitproc, Object) with a visitproc that just watches out for ob. Must return false if ob is null.

Annotations

@Override

seek back to summary

public long seek(long pos, int whence)

Position the read or write pointer at a given byte offset pos relative to a position indicated by whence.

If whence=0, the position will be set to pos bytes.
If whence=1 the position will be set to the current position plus pos.
If whence=2 the position will be set to the stream size plus pos (and usually pos<=0).

Parameters

pos:long: relative to the specified point
whence:int: 0=from start, 1=from here, 2=from end

Returns:long

the new current position

seek back to summary

public final long seek(long pos)

Position the read or write pointer at a given byte offset pos relative to the start.

Parameters

pos:long: relative to the start

Returns:long

the new current position

seekable back to summary

public boolean seekable() throws PyException

Is the stream capable of positioning the read/write pointer?

Returns:boolean

True if may be positioned

Exceptions

PyException:: ValueError if the object is closed to client operations

tailoredIOError	back to summary
private static PyException tailoredIOError(String msg, String oper) Convenience method providing the exception in the _checkWhatever() methods.

tailoredTypeError back to summary

protected static PyException tailoredTypeError(String type, PyObject arg)

Convenience method providing the exception when an argument is not the expected type. The format is "type argument expected, got type(arg)."

Parameters

type:String: of thing expected (or could any text)
arg:PyObject: argument provided from which actual type will be reported

Returns:PyException

TypeError to throw

tell

back to summary

public long tell()

Get the current stream position.

Returns:long: stream position

traverse back to summary

public int traverse(Visitproc visit, Object arg)

Implements org.python.core.Traverseproc.traverse.

Doc from org.python.core.Traverseproc.traverse.

Traverses all directly contained PyObjects. Like in CPython, arg must be passed unmodified to visit as its second parameter. If Visitproc#visit(PyObject, Object) returns nonzero, this return value must be returned immediately by traverse. Visitproc#visit(PyObject, Object) must not be called with a null PyObject-argument.

Annotations

@Override

truncate back to summary

public long truncate(long size)

Truncate file to size bytes.

Parameters

size:long: requested for stream

Returns:long

the new size

truncate back to summary

public long truncate()

Truncate file to size bytes to the current position (as reported by tell()).

Returns:long: the new size

unsupported

back to summary

protected PyException unsupported(String op)

Convenience method returning a PyException(_io.UnsupportedOperation), ripe for throwing, and naming the unsupported operation. Like many similar methods, this does not actually throw (raise) the exception: it should be thrown from the place where the problem is.

Parameters

op:String: name of operation

Returns:PyException

the exception for throwing

writable back to summary

public boolean writable() throws PyException

Is the stream writable?

Returns:boolean

true if writable

Exceptions

PyException:: ValueError if the object is closed to client operations

writablePyBuffer back to summary

protected static PyBuffer writablePyBuffer(PyObject obj) throws PyException

Construct a PyBuffer on a given object suitable for reading into from the underlying stream. The buffer returned will be navigable as a 1D contiguous writable sequence of bytes.

Parameters

obj:PyObject: to be wrapped and presented as a buffer

Returns:PyBuffer

a 1D contiguous PyBuffer of bytes

Exceptions

PyException:

BufferError if object has buffer API, but is not 1D contiguous bytes
TypeError if object not convertible to a byte array

writelines	back to summary
public void writelines(PyObject lines) Write an iterable sequence of strings to the stream.

public Class PyIOBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail