hpcflow.sdk.persistence.array_output_sources.ArrayOutputBuffer#

class hpcflow.sdk.persistence.array_output_sources.ArrayOutputBuffer(max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)#

Bases: SpooledTemporaryFile[bytes]

Expose the seekable interface ZipFile needs on Python 3.10.

Methods

close

Flush and close the IO object.

detach

fileno

Return underlying file descriptor if one exists.

flush

Flush write buffers, if applicable.

isatty

Return whether this is an 'interactive' stream.

read

read1

readable

Return whether object was opened for reading.

readinto

readinto1

readline

Read and return a line from the stream.

readlines

Return a list of lines from the stream.

rollover

seek

Change the stream position to the given byte offset.

seekable

Return whether object supports random access.

tell

Return current stream position.

truncate

Truncate file to size bytes.

writable

Return whether object was opened for writing.

write

writelines

Write a list of lines to stream.

Attributes

close()#

Flush and close the IO object.

This method has no effect if the file is already closed.

property closed#
detach()#
property encoding#
property errors#
fileno()#

Return underlying file descriptor if one exists.

Raise OSError if the IO object does not use a file descriptor.

flush()#

Flush write buffers, if applicable.

This is not implemented for read-only and non-blocking streams.

isatty()#

Return whether this is an ‘interactive’ stream.

Return False if it can’t be determined.

property mode#
property name#
property newlines#
read(*args)#
read1(*args)#
readable()#

Return whether object was opened for reading.

If False, read() will raise OSError.

readinto(b)#
readinto1(b)#
readline(*args)#

Read and return a line from the stream.

If size is specified, at most size bytes will be read.

The line terminator is always b’n’ for binary files; for text files, the newlines argument to open can be used to select the line terminator(s) recognized.

readlines(*args)#

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.

rollover()#
seek(*args)#

Change the stream position to the given byte offset.

offset

The stream position, relative to ‘whence’.

whence

The relative position to seek from.

The offset is interpreted relative to the position indicated by whence. Values for whence are:

  • os.SEEK_SET or 0 – start of stream (the default); offset should be zero or positive

  • os.SEEK_CUR or 1 – current stream position; offset may be negative

  • os.SEEK_END or 2 – end of stream; offset is usually negative

Return the new absolute position.

seekable()#

Return whether object supports random access.

If False, seek(), tell() and truncate() will raise OSError. This method may need to do a test seek().

Return type:

bool

tell()#

Return current stream position.

truncate(size=None)#

Truncate file to size bytes.

File pointer is left unchanged. Size defaults to the current IO position as reported by tell(). Return the new size.

writable()#

Return whether object was opened for writing.

If False, write() will raise OSError.

write(s)#
writelines(iterable)#

Write a list of lines to stream.

Line separators are not added, so it is usual for each of the lines provided to have a line separator at the end.