ML Community Day is November 9! Join us for updates from TensorFlow, JAX, and more Learn more


File I/O wrappers without thread locking.

Note, that this is somewhat like builtin Python file I/O, but there are semantic differences to make it more efficient for some backing filesystems. For example, a write mode file will not be opened until the first write call (to minimize RPC invocations in network filesystems).

mode Returns the mode in which the file was opened.
name Returns the file name.



View source

Closes the file.

Should be called for the WritableFile to be flushed.

In general, if you use the context manager pattern, you don't need to call this directly.

with"/tmp/x", "w") as f:
# implicit f.close() at the end of the block

For cloud filesystems, forgetting to call close() might result in data loss as last write might not have been replicated.


View source

Flushes the Writable file.

This only ensures that the data has made its way out of the process without any guarantees on whether it's written to disk. This means that the data would survive an application crash but not necessarily an OS crash.


View source


View source

Returns the contents of a file as a string.

Starts reading from current position in file.

n Read n bytes if n != -1. If n = -1, reads to end of file.

n bytes of the file (or whole file) in bytes mode or n bytes of the string if in string (regular) mode.


View source

Reads the next line, keeping \n. At EOF, returns ''.


View source

Returns all lines from the file in a list.


View source

Seeks to the offset in the file. (deprecated arguments)

offset The byte count relative to the whence argument.
whence Valid values for whence are: 0: start of the file (default) 1: relative to the current position of the file 2: relative to the end of file. offset is usually negative.


View source

Returns True as FileIO supports random access ops of seek()/tell()


View source