Package org.python.modules._io
Class PyFileIODerived
- java.lang.Object
-
- org.python.core.PyObject
-
- org.python.modules._io.PyIOBase
-
- org.python.modules._io.PyRawIOBase
-
- org.python.modules._io.PyFileIO
-
- org.python.modules._io.PyFileIODerived
-
- All Implemented Interfaces:
java.io.Serializable
,FinalizableBuiltin
,FinalizablePyObjectDerived
,Slotted
,Traverseproc
,TraverseprocDerived
public class PyFileIODerived extends PyFileIO implements Slotted, FinalizablePyObjectDerived, TraverseprocDerived
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.python.core.PyObject
PyObject.ConversionException
-
-
Field Summary
-
Fields inherited from class org.python.modules._io.PyRawIOBase
read_doc, readall_doc, readinto_doc, write_doc
-
Fields inherited from class org.python.modules._io.PyIOBase
close_doc, closed_doc, fileno_doc, flush_doc, isatty_doc, readable_doc, readline_doc, readlines_doc, seek_doc, seekable_doc, tell_doc, truncate_doc, writable_doc, writelines_doc
-
Fields inherited from class org.python.core.PyObject
gcMonitorGlobal
-
-
Constructor Summary
Constructors Constructor Description PyFileIODerived(PyType subtype, PyObject file, OpenMode mode, boolean closefd)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PyObject
__abs__()
Equivalent to the standard Python __abs__ method.PyObject
__add__(PyObject other)
Equivalent to the standard Python __add__ method.PyObject
__and__(PyObject other)
Equivalent to the standard Python __and__ methodPyObject
__call__(PyObject[] args, java.lang.String[] keywords)
The basic method to override when implementing a callable object.int
__cmp__(PyObject other)
Equivalent to the standard Python __cmp__ method.java.lang.Object
__coerce_ex__(PyObject o)
Implements numeric coercionPyComplex
__complex__()
Equivalent to the standard Python __complex__ method.boolean
__contains__(PyObject o)
Equivalent to the standard Python __contains__ method.void
__del_derived__()
__del_builtin__
is the built-in's own finalizer, while__del_derived__
refers to an instance's in-dict__del__
.void
__delattr__(java.lang.String name)
A variant of the __delattr__ method which accepts a String as the key.void
__delete__(PyObject obj)
void
__delitem__(PyObject key)
Equivalent to the standard Python __delitem__ method.void
__delslice__(PyObject start, PyObject stop, PyObject step)
PyObject
__dir__()
Equivalent to the standard Python __dir__ method.PyObject
__div__(PyObject other)
Equivalent to the standard Python __div__ methodPyObject
__divmod__(PyObject other)
Equivalent to the standard Python __divmod__ methodvoid
__ensure_finalizer__()
PyObjects that implementorg.python.core.finalization.HasFinalizeTrigger
shall implement this method via:
FinalizeTrigger.ensureFinalizer(this);
PyObject
__enter__()
Called at the start of a context-managed suite (supporting thewith
clause).PyObject
__eq__(PyObject other)
Equivalent to the standard Python __eq__ method.boolean
__exit__(PyObject type, PyObject value, PyObject traceback)
Called at the end of a context-managed suite (supporting thewith
clause), and will normally close the stream.PyObject
__findattr_ex__(java.lang.String name)
Attribute lookup hook.PyObject
__finditem__(int key)
A variant of the __finditem__ method which accepts a primitiveint
as the key.PyObject
__finditem__(PyObject key)
Very similar to the standard Python __getitem__ method.PyFloat
__float__()
Equivalent to the standard Python __float__ method.PyObject
__floordiv__(PyObject other)
Equivalent to the standard Python __floordiv__ methodPyObject
__format__(PyObject other)
PyObject
__ge__(PyObject other)
Equivalent to the standard Python __ge__ method.PyObject
__get__(PyObject obj, PyObject type)
Get descriptor for this PyObject.PyObject
__getitem__(PyObject key)
Equivalent to the standard Python __getitem__ method.PyObject
__getslice__(PyObject start, PyObject stop, PyObject step)
PyObject
__gt__(PyObject other)
Equivalent to the standard Python __gt__ method.PyString
__hex__()
Equivalent to the standard Python __hex__ method Should only be overridden by numeric objects that can be reasonably represented as a hexadecimal string.PyObject
__iadd__(PyObject other)
Equivalent to the standard Python __iadd__ method.PyObject
__iand__(PyObject other)
Equivalent to the standard Python __iand__ methodPyObject
__idiv__(PyObject other)
Equivalent to the standard Python __idiv__ methodPyObject
__ifloordiv__(PyObject other)
Equivalent to the standard Python __ifloordiv__ methodPyObject
__ilshift__(PyObject other)
Equivalent to the standard Python __ilshift__ methodPyObject
__imod__(PyObject other)
Equivalent to the standard Python __imod__ methodPyObject
__imul__(PyObject other)
Equivalent to the standard Python __imul__ method.PyObject
__index__()
Equivalent to the standard Python __index__ method.PyObject
__int__()
Equivalent to the standard Python __int__ method.PyObject
__invert__()
Equivalent to the standard Python __invert__ method.PyObject
__ior__(PyObject other)
Equivalent to the standard Python __ior__ methodPyObject
__ipow__(PyObject other)
Equivalent to the standard Python __ipow__ methodPyObject
__irshift__(PyObject other)
Equivalent to the standard Python __irshift__ methodPyObject
__isub__(PyObject other)
Equivalent to the standard Python __isub__ methodPyObject
__iter__()
Return an iterator on whichnext
may be repeatedly called to produce (usually) lines from this stream or file.PyObject
__iternext__()
Return the next element of the sequence that this is an iterator for.PyObject
__itruediv__(PyObject other)
Equivalent to the standard Python __itruediv__ methodPyObject
__ixor__(PyObject other)
Equivalent to the standard Python __ixor__ methodPyObject
__le__(PyObject other)
Equivalent to the standard Python __le__ method.int
__len__()
Equivalent to the standard Python __len__ method.PyObject
__long__()
Equivalent to the standard Python __long__ method.PyObject
__lshift__(PyObject other)
Equivalent to the standard Python __lshift__ methodPyObject
__lt__(PyObject other)
Equivalent to the standard Python __lt__ method.PyObject
__mod__(PyObject other)
Equivalent to the standard Python __mod__ methodPyObject
__mul__(PyObject other)
Equivalent to the standard Python __mul__ method.PyObject
__ne__(PyObject other)
Equivalent to the standard Python __ne__ method.PyObject
__neg__()
Equivalent to the standard Python __neg__ method.boolean
__nonzero__()
Equivalent to the standard Python __nonzero__ method.PyString
__oct__()
Equivalent to the standard Python __oct__ method.PyObject
__or__(PyObject other)
Equivalent to the standard Python __or__ methodPyObject
__pos__()
Equivalent to the standard Python __pos__ method.PyObject
__pow__(PyObject other, PyObject modulo)
Implements the three argument power function.PyObject
__radd__(PyObject other)
Equivalent to the standard Python __radd__ method.PyObject
__rand__(PyObject other)
Equivalent to the standard Python __rand__ methodPyObject
__rdiv__(PyObject other)
Equivalent to the standard Python __rdiv__ methodPyObject
__rdivmod__(PyObject other)
Equivalent to the standard Python __rdivmod__ methodPyObject
__reduce__()
Used for pickling.PyString
__repr__()
Equivalent to the standard Python __repr__ method.PyObject
__rfloordiv__(PyObject other)
Equivalent to the standard Python __rfloordiv__ methodPyObject
__rlshift__(PyObject other)
Equivalent to the standard Python __rlshift__ methodPyObject
__rmod__(PyObject other)
Equivalent to the standard Python __rmod__ methodPyObject
__rmul__(PyObject other)
Equivalent to the standard Python __rmul__ method.PyObject
__ror__(PyObject other)
Equivalent to the standard Python __ror__ methodPyObject
__rpow__(PyObject other)
Equivalent to the standard Python __rpow__ methodPyObject
__rrshift__(PyObject other)
Equivalent to the standard Python __rrshift__ methodPyObject
__rshift__(PyObject other)
Equivalent to the standard Python __rshift__ methodPyObject
__rsub__(PyObject other)
Equivalent to the standard Python __rsub__ methodPyObject
__rtruediv__(PyObject other)
Equivalent to the standard Python __rtruediv__ methodPyObject
__rxor__(PyObject other)
Equivalent to the standard Python __rxor__ methodvoid
__set__(PyObject obj, PyObject value)
void
__setattr__(java.lang.String name, PyObject value)
A variant of the __setattr__ method which accepts a String as the key.void
__setitem__(PyObject key, PyObject value)
Equivalent to the standard Python __setitem__ method.void
__setslice__(PyObject start, PyObject stop, PyObject step, PyObject value)
PyString
__str__()
Equivalent to the standard Python __str__ method.PyObject
__sub__(PyObject other)
Equivalent to the standard Python __sub__ methodjava.lang.Object
__tojava__(java.lang.Class c)
Equivalent to the Jython __tojava__ method.PyObject
__truediv__(PyObject other)
Equivalent to the standard Python __truediv__ methodPyUnicode
__unicode__()
PyObject
__xor__(PyObject other)
Equivalent to the standard Python __xor__ methodvoid
_checkClosed(java.lang.String msg)
Raise an error if the underlying IO stream is closed.void
_checkReadable(java.lang.String msg)
Raise an error if the underlying IO stream is not readable.void
_checkSeekable(java.lang.String msg)
Raise an error if the pointer of underlying IO stream is not capable of being positioned.void
_checkWritable(java.lang.String msg)
Raise an error if the underlying IO stream is not writable.void
close()
Close the underlying ioDelegate only ifclosefd
was specified as (or defaulted to)True
.void
dispatch__init__(PyObject[] args, java.lang.String[] keywords)
Dispatch __init__ behaviorPyObject
fileno()
Return a file descriptor for the stream.void
flush()
Flush write buffers, or no-op for read-only and non-blocking streams.PyObject
getSlot(int index)
int
hashCode()
boolean
isatty()
Is the stream known to be an interactive console?PyObject
read(int n)
The read() method is implemented by calling readinto(); derived classes that want to support read() only need to implement readinto() as a primitive operation.boolean
readable()
Is the stream readable?PyObject
readall()
Read until end of file, using multipleread()
operations on the underlying stream.PyObject
readinto(PyObject b)
Read up tolen(b)
bytes intobytearray b
and return the number of bytes read.PyObject
readline()
Return one line of text (bytes terminates by'\n'
), or the whole stream, whichever is shorter.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.PyObject
readlines(PyObject hint)
Read a stream as a sequence of lines.long
seek(long pos, int whence)
Position the read or write pointer at a given byte offsetpos
relative to a position indicated bywhence
.boolean
seekable()
Is the stream capable of positioning the read/write pointer?void
setSlot(int index, PyObject value)
long
tell()
Get the current stream position.int
traverseDerived(Visitproc visit, java.lang.Object arg)
Traverses all reachablePyObject
s.int
traverseDictIfAny(Visitproc visit, java.lang.Object arg)
long
truncate()
Truncate file tosize
bytes to the current position (as reported bytell()
).long
truncate(long size)
Truncate file tosize
bytes.boolean
writable()
Is the stream writable?PyObject
write(PyObject b)
Write the given bytes or bytearray object to the underlying raw stream and return the number of bytes written.void
writelines(PyObject lines)
Write an iterable sequence of strings to the stream.-
Methods inherited from class org.python.modules._io.PyFileIO
mode_readonly, toString
-
Methods inherited from class org.python.modules._io.PyIOBase
__del_builtin__, _checkClosed, _checkReadable, _checkSeekable, _checkWritable, closed, closed_readonly, fastGetDict, next, refersDirectlyTo, seek, traverse
-
Methods inherited from class org.python.core.PyObject
__call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __call__, __coerce__, __delattr__, __delitem__, __delslice__, __findattr__, __findattr__, __finditem__, __getattr__, __getattr__, __getitem__, __getnewargs__, __getslice__, __hash__, __idivmod__, __not__, __pow__, __reduce_ex__, __reduce_ex__, __setattr__, __setitem__, __setitem__, __setslice__, __trunc__, _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, _xor, asDouble, asIndex, asIndex, asInt, asInt, asIterable, asLong, asLong, asName, asName, asString, asString, asStringOrNull, asStringOrNull, bit_length, conjugate, delDict, delType, equals, fastGetClass, getDict, getType, implementsDescrDelete, implementsDescrGet, implementsDescrSet, invoke, invoke, invoke, invoke, invoke, invoke, isCallable, isDataDescr, isIndex, isInteger, isMappingType, isNumberType, isSequenceType, noAttributeError, object___subclasshook__, readonlyAttributeError, setDict, setType
-
-
-
-
Method Detail
-
__del_derived__
public void __del_derived__()
Description copied from interface:FinalizablePyObjectDerived
__del_builtin__
is the built-in's own finalizer, while__del_derived__
refers to an instance's in-dict__del__
. A FinalizeTrigger calls__del_derived__
first and - if existent -__del_builtin__
after that. A plain__del__
would behave as overridden by__del_derived__
, i.e. won't be called if the type implementsFinalizablePyObjectDerived
while__del_builtin__
is called in any case.- Specified by:
__del_derived__
in interfaceFinalizablePyObjectDerived
-
__ensure_finalizer__
public void __ensure_finalizer__()
Description copied from class:PyObject
PyObjects that implementorg.python.core.finalization.HasFinalizeTrigger
shall implement this method via:
FinalizeTrigger.ensureFinalizer(this);
- Overrides:
__ensure_finalizer__
in classPyObject
-
traverseDerived
public int traverseDerived(Visitproc visit, java.lang.Object arg)
Description copied from interface:TraverseprocDerived
Traverses all reachablePyObject
s. Like in CPython,arg
must be passed unmodified tovisit
as its second parameter.- Specified by:
traverseDerived
in interfaceTraverseprocDerived
-
traverseDictIfAny
public int traverseDictIfAny(Visitproc visit, java.lang.Object arg)
-
__str__
public PyString __str__()
Description copied from class:PyObject
Equivalent to the standard Python __str__ method. This method should not typically need to be overridden. The easiest way to configure the string representation of aPyObject
is to override the standard JavatoString
method.
-
__repr__
public PyString __repr__()
Description copied from class:PyObject
Equivalent to the standard Python __repr__ method. This method should not typically need to be overrriden. The easiest way to configure the string representation of aPyObject
is to override the standard JavatoString
method.
-
__hex__
public PyString __hex__()
Description copied from class:PyObject
Equivalent to the standard Python __hex__ method Should only be overridden by numeric objects that can be reasonably represented as a hexadecimal string.
-
__oct__
public PyString __oct__()
Description copied from class:PyObject
Equivalent to the standard Python __oct__ method. Should only be overridden by numeric objects that can be reasonably represented as an octal string.
-
__float__
public PyFloat __float__()
Description copied from class:PyObject
Equivalent to the standard Python __float__ method. Should only be overridden by numeric objects that can be reasonably coerced into a python float.
-
__complex__
public PyComplex __complex__()
Description copied from class:PyObject
Equivalent to the standard Python __complex__ method. Should only be overridden by numeric objects that can be reasonably coerced into a python complex number.- Overrides:
__complex__
in classPyObject
- Returns:
- a complex number corresponding to the value of this object.
-
__pos__
public PyObject __pos__()
Description copied from class:PyObject
Equivalent to the standard Python __pos__ method.
-
__neg__
public PyObject __neg__()
Description copied from class:PyObject
Equivalent to the standard Python __neg__ method.
-
__abs__
public PyObject __abs__()
Description copied from class:PyObject
Equivalent to the standard Python __abs__ method.
-
__invert__
public PyObject __invert__()
Description copied from class:PyObject
Equivalent to the standard Python __invert__ method.- Overrides:
__invert__
in classPyObject
- Returns:
- ~this.
-
__reduce__
public PyObject __reduce__()
Description copied from class:PyObject
Used for pickling. Default implementation calls object___reduce__.- Overrides:
__reduce__
in classPyObject
- Returns:
- a tuple of (class, tuple)
-
__dir__
public PyObject __dir__()
Description copied from class:PyObject
Equivalent to the standard Python __dir__ method.
-
__add__
public PyObject __add__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __add__ method.
-
__radd__
public PyObject __radd__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __radd__ method.
-
__sub__
public PyObject __sub__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __sub__ method
-
__rsub__
public PyObject __rsub__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rsub__ method
-
__mul__
public PyObject __mul__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __mul__ method.
-
__rmul__
public PyObject __rmul__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rmul__ method.
-
__div__
public PyObject __div__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __div__ method
-
__rdiv__
public PyObject __rdiv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rdiv__ method
-
__floordiv__
public PyObject __floordiv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __floordiv__ method- Overrides:
__floordiv__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the floordiv, or null if this operation is not defined
-
__rfloordiv__
public PyObject __rfloordiv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rfloordiv__ method- Overrides:
__rfloordiv__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the left-hand operand).- Returns:
- the result of the floordiv, or null if this operation is not defined.
-
__truediv__
public PyObject __truediv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __truediv__ method- Overrides:
__truediv__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the truediv, or null if this operation is not defined
-
__rtruediv__
public PyObject __rtruediv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rtruediv__ method- Overrides:
__rtruediv__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the left-hand operand).- Returns:
- the result of the truediv, or null if this operation is not defined.
-
__mod__
public PyObject __mod__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __mod__ method
-
__rmod__
public PyObject __rmod__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rmod__ method
-
__divmod__
public PyObject __divmod__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __divmod__ method- Overrides:
__divmod__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the divmod, or null if this operation is not defined
-
__rdivmod__
public PyObject __rdivmod__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rdivmod__ method- Overrides:
__rdivmod__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the left-hand operand).- Returns:
- the result of the divmod, or null if this operation is not defined.
-
__rpow__
public PyObject __rpow__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rpow__ method
-
__lshift__
public PyObject __lshift__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __lshift__ method- Overrides:
__lshift__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the lshift, or null if this operation is not defined
-
__rlshift__
public PyObject __rlshift__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rlshift__ method- Overrides:
__rlshift__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the left-hand operand).- Returns:
- the result of the lshift, or null if this operation is not defined.
-
__rshift__
public PyObject __rshift__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rshift__ method- Overrides:
__rshift__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the rshift, or null if this operation is not defined
-
__rrshift__
public PyObject __rrshift__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rrshift__ method- Overrides:
__rrshift__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the left-hand operand).- Returns:
- the result of the rshift, or null if this operation is not defined.
-
__and__
public PyObject __and__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __and__ method
-
__rand__
public PyObject __rand__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rand__ method
-
__or__
public PyObject __or__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __or__ method
-
__ror__
public PyObject __ror__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ror__ method
-
__xor__
public PyObject __xor__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __xor__ method
-
__rxor__
public PyObject __rxor__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __rxor__ method
-
__lt__
public PyObject __lt__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __lt__ method.
-
__le__
public PyObject __le__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __le__ method.
-
__gt__
public PyObject __gt__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __gt__ method.
-
__ge__
public PyObject __ge__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ge__ method.
-
__eq__
public PyObject __eq__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __eq__ method.
-
__ne__
public PyObject __ne__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ne__ method.
-
__format__
public PyObject __format__(PyObject other)
- Overrides:
__format__
in classPyObject
-
__iadd__
public PyObject __iadd__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __iadd__ method.
-
__isub__
public PyObject __isub__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __isub__ method
-
__imul__
public PyObject __imul__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __imul__ method.
-
__idiv__
public PyObject __idiv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __idiv__ method
-
__ifloordiv__
public PyObject __ifloordiv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ifloordiv__ method- Overrides:
__ifloordiv__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the ifloordiv, or null if this operation is not defined
-
__itruediv__
public PyObject __itruediv__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __itruediv__ method- Overrides:
__itruediv__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the itruediv, or null if this operation is not defined
-
__imod__
public PyObject __imod__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __imod__ method
-
__ipow__
public PyObject __ipow__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ipow__ method
-
__ilshift__
public PyObject __ilshift__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ilshift__ method- Overrides:
__ilshift__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the ilshift, or null if this operation is not defined
-
__irshift__
public PyObject __irshift__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __irshift__ method- Overrides:
__irshift__
in classPyObject
- Parameters:
other
- the object to perform this binary operation with (the right-hand operand).- Returns:
- the result of the irshift, or null if this operation is not defined
-
__iand__
public PyObject __iand__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __iand__ method
-
__ior__
public PyObject __ior__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ior__ method
-
__ixor__
public PyObject __ixor__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __ixor__ method
-
__int__
public PyObject __int__()
Description copied from class:PyObject
Equivalent to the standard Python __int__ method. Should only be overridden by numeric objects that can be reasonably coerced into an integer.
-
__long__
public PyObject __long__()
Description copied from class:PyObject
Equivalent to the standard Python __long__ method. Should only be overridden by numeric objects that can be reasonably coerced into a python long.
-
__unicode__
public PyUnicode __unicode__()
- Overrides:
__unicode__
in classPyObject
-
__cmp__
public int __cmp__(PyObject other)
Description copied from class:PyObject
Equivalent to the standard Python __cmp__ method.
-
__nonzero__
public boolean __nonzero__()
Description copied from class:PyObject
Equivalent to the standard Python __nonzero__ method. Returns whether of not a givenPyObject
is considered true.- Overrides:
__nonzero__
in classPyObject
-
__contains__
public boolean __contains__(PyObject o)
Description copied from class:PyObject
Equivalent to the standard Python __contains__ method.- Overrides:
__contains__
in classPyObject
- Parameters:
o
- the element to search for in this container.- Returns:
- the result of the search.
-
__len__
public int __len__()
Description copied from class:PyObject
Equivalent to the standard Python __len__ method. Part of the mapping discipline.
-
__iter__
public PyObject __iter__()
Description copied from class:PyIOBase
Return an iterator on whichnext
may be repeatedly called to produce (usually) lines from this stream or file.
-
__iternext__
public PyObject __iternext__()
Description copied from class:PyObject
Return the next element of the sequence that this is an iterator for. Returns null when the end of the sequence is reached.- Overrides:
__iternext__
in classPyIOBase
-
__finditem__
public PyObject __finditem__(PyObject key)
Description copied from class:PyObject
Very similar to the standard Python __getitem__ method. Instead of throwing a KeyError if the item isn't found, this just returns null. Classes that wish to implement __getitem__ should override this method instead (with the appropriate semantics.- Overrides:
__finditem__
in classPyObject
- Parameters:
key
- the key to lookup in this container- Returns:
- the value corresponding to key or null if key is not found
-
__finditem__
public PyObject __finditem__(int key)
Description copied from class:PyObject
A variant of the __finditem__ method which accepts a primitiveint
as the key. By default, this method will call__finditem__(PyObject key)
with the appropriate args. The only reason to override this method is for performance.- Overrides:
__finditem__
in classPyObject
- Parameters:
key
- the key to lookup in this sequence.- Returns:
- the value corresponding to key or null if key is not found.
- See Also:
PyObject.__finditem__(PyObject)
-
__getitem__
public PyObject __getitem__(PyObject key)
Description copied from class:PyObject
Equivalent to the standard Python __getitem__ method. This method should not be overridden. Override the__finditem__
method instead.- Overrides:
__getitem__
in classPyObject
- Parameters:
key
- the key to lookup in this container.- Returns:
- the value corresponding to that key.
- See Also:
PyObject.__finditem__(PyObject)
-
__setitem__
public void __setitem__(PyObject key, PyObject value)
Description copied from class:PyObject
Equivalent to the standard Python __setitem__ method.- Overrides:
__setitem__
in classPyObject
- Parameters:
key
- the key whose value will be setvalue
- the value to set this key to
-
__getslice__
public PyObject __getslice__(PyObject start, PyObject stop, PyObject step)
- Overrides:
__getslice__
in classPyObject
-
__setslice__
public void __setslice__(PyObject start, PyObject stop, PyObject step, PyObject value)
- Overrides:
__setslice__
in classPyObject
-
__delslice__
public void __delslice__(PyObject start, PyObject stop, PyObject step)
- Overrides:
__delslice__
in classPyObject
-
__delitem__
public void __delitem__(PyObject key)
Description copied from class:PyObject
Equivalent to the standard Python __delitem__ method.- Overrides:
__delitem__
in classPyObject
- Parameters:
key
- the key to be removed from the container
-
__call__
public PyObject __call__(PyObject[] args, java.lang.String[] keywords)
Description copied from class:PyObject
The basic method to override when implementing a callable object. The first len(args)-len(keywords) members of args[] are plain arguments. The last len(keywords) arguments are the values of the keyword arguments.
-
__findattr_ex__
public PyObject __findattr_ex__(java.lang.String name)
Description copied from class:PyObject
Attribute lookup hook. If the attribute is not found, null may be returned or a Py.AttributeError can be thrown, whatever is more correct, efficient and/or convenient for the implementing class. Client code should usePyObject.__getattr__(String)
orPyObject.__findattr__(String)
. Both methods have a clear policy for failed lookups.- Overrides:
__findattr_ex__
in classPyObject
- Returns:
- The looked up value. May return null if the attribute is not found
-
__setattr__
public void __setattr__(java.lang.String name, PyObject value)
Description copied from class:PyObject
A variant of the __setattr__ method which accepts a String as the key. This String must be interned.- Overrides:
__setattr__
in classPyObject
- Parameters:
name
- the name whose value will be set - must be an interned string .value
- the value to set this name to- See Also:
PyObject.__setattr__(PyString, PyObject)
-
__delattr__
public void __delattr__(java.lang.String name)
Description copied from class:PyObject
A variant of the __delattr__ method which accepts a String as the key. This String must be interned. By default, this will call__delattr__(PyString name)
with the appropriate args. The only reason to override this method is for performance.- Overrides:
__delattr__
in classPyObject
- Parameters:
name
- the name which will be removed - must be an interned string .- See Also:
PyObject.__delattr__(PyString)
-
__get__
public PyObject __get__(PyObject obj, PyObject type)
Description copied from class:PyObject
Get descriptor for this PyObject.- Overrides:
__get__
in classPyObject
- Parameters:
obj
- - the instance accessing this descriptor. Can be null if this is being accessed by a type.type
- - the type accessing this descriptor. Will be null if obj exists as obj is of the type accessing the descriptor.- Returns:
- - the object defined for this descriptor for the given obj and type.
-
__delete__
public void __delete__(PyObject obj)
- Overrides:
__delete__
in classPyObject
-
__pow__
public PyObject __pow__(PyObject other, PyObject modulo)
Description copied from class:PyObject
Implements the three argument power function.
-
dispatch__init__
public void dispatch__init__(PyObject[] args, java.lang.String[] keywords)
Description copied from class:PyObject
Dispatch __init__ behavior- Overrides:
dispatch__init__
in classPyObject
-
__index__
public PyObject __index__()
Description copied from class:PyObject
Equivalent to the standard Python __index__ method.
-
__tojava__
public java.lang.Object __tojava__(java.lang.Class c)
Description copied from class:PyObject
Equivalent to the Jython __tojava__ method. Tries to coerce this object to an instance of the requested Java class. Returns the special objectPy.NoConversion
if thisPyObject
can not be converted to the desired Java class.- Overrides:
__tojava__
in classPyObject
- Parameters:
c
- the Class to convert thisPyObject
to.
-
__coerce_ex__
public java.lang.Object __coerce_ex__(PyObject o)
Description copied from class:PyObject
Implements numeric coercion- Overrides:
__coerce_ex__
in classPyObject
- Parameters:
o
- the other object involved in the coercion- Returns:
- null if coercion is not implemented Py.None if coercion was not possible a single PyObject to use to replace o if this is unchanged; or a PyObject[2] consisting of replacements for this and o.
-
__enter__
public PyObject __enter__()
Description copied from class:PyIOBase
Called at the start of a context-managed suite (supporting thewith
clause).
-
fileno
public PyObject fileno()
Description copied from class:PyIOBase
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 thatRawIOBase.fileno()
returns.
-
seek
public long seek(long pos, int whence)
Description copied from class:PyIOBase
Position the read or write pointer at a given byte offsetpos
relative to a position indicated bywhence
.- If
whence
=0, the position will be set topos
bytes. - If
whence
=1 the position will be set to the current position pluspos
. - If
whence
=2 the position will be set to the stream size pluspos
(and usuallypos
<=0).
- If
-
tell
public long tell()
Description copied from class:PyIOBase
Get the current stream position.
-
truncate
public long truncate(long size)
Description copied from class:PyIOBase
Truncate file tosize
bytes.
-
truncate
public long truncate()
Description copied from class:PyIOBase
Truncate file tosize
bytes to the current position (as reported bytell()
).
-
flush
public void flush()
Description copied from class:PyIOBase
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.
-
close
public void close()
Description copied from class:PyFileIO
Close the underlying ioDelegate only ifclosefd
was specified as (or defaulted to)True
.
-
seekable
public boolean seekable()
Description copied from class:PyIOBase
Is the stream capable of positioning the read/write pointer?
-
_checkSeekable
public void _checkSeekable(java.lang.String msg)
Description copied from class:PyIOBase
Raise an error if the pointer of underlying IO stream is not capable of being positioned.- Overrides:
_checkSeekable
in classPyIOBase
- Parameters:
msg
- optional custom message
-
readable
public boolean readable()
Description copied from class:PyIOBase
Is the stream readable?
-
_checkReadable
public void _checkReadable(java.lang.String msg)
Description copied from class:PyIOBase
Raise an error if the underlying IO stream is not readable.- Overrides:
_checkReadable
in classPyIOBase
- Parameters:
msg
- optional custom message
-
writable
public boolean writable()
Description copied from class:PyIOBase
Is the stream writable?
-
_checkWritable
public void _checkWritable(java.lang.String msg)
Description copied from class:PyIOBase
Raise an error if the underlying IO stream is not writable.- Overrides:
_checkWritable
in classPyIOBase
- Parameters:
msg
- optional custom message
-
_checkClosed
public void _checkClosed(java.lang.String msg)
Description copied from class:PyIOBase
Raise an error if the underlying IO stream is closed. (Note opposite sense fromPyIOBase._checkSeekable(java.lang.String)
, etc..- Overrides:
_checkClosed
in classPyIOBase
- Parameters:
msg
- optional custom message
-
__exit__
public boolean __exit__(PyObject type, PyObject value, PyObject traceback)
Description copied from class:PyIOBase
Called at the end of a context-managed suite (supporting thewith
clause), and will normally close the stream.
-
isatty
public boolean isatty()
Description copied from class:PyIOBase
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.
-
readline
public PyObject readline()
Description copied from class:PyIOBase
Return one line of text (bytes terminates by'\n'
), or the whole stream, whichever is shorter.
-
readline
public PyObject readline(int limit)
Description copied from class:PyIOBase
Return one line of text (bytes terminates by'\n'
), or the specified number of bytes, or the whole stream, whichever is shortest.
-
readlines
public PyObject readlines(PyObject hint)
Description copied from class:PyIOBase
Read a stream as a sequence of lines.
-
writelines
public void writelines(PyObject lines)
Description copied from class:PyIOBase
Write an iterable sequence of strings to the stream.- Overrides:
writelines
in classPyIOBase
-
readall
public PyObject readall()
Description copied from class:PyRawIOBase
Read until end of file, using multipleread()
operations on the underlying stream. If the firstread()
returnsNone
(only possible in the case of a non-blocking stream), this method returnsNone
.- Overrides:
readall
in classPyRawIOBase
- Returns:
- a PyString holding the bytes read or
Py.None
(when a non-blocking source is not ready with further data)
-
read
public PyObject read(int n)
Description copied from class:PyRawIOBase
The read() method is implemented by calling readinto(); derived classes that want to support read() only need to implement readinto() as a primitive operation. In general, readinto() can be more efficient than read().- Overrides:
read
in classPyRawIOBase
- Parameters:
n
- number of bytes to read (if possible)- Returns:
- a PyString holding the bytes read or
Py.None
(when a non-blocking source is not ready with further data)
-
readinto
public PyObject readinto(PyObject b)
Description copied from class:PyRawIOBase
Read up tolen(b)
bytes intobytearray b
and return the number of bytes read. If the object is in non-blocking mode and no bytes are available,None
is returned.";
-
write
public PyObject write(PyObject b)
Description copied from class:PyRawIOBase
Write the given bytes or bytearray object to the underlying raw stream and return the number of bytes written.
-
-