tf.io.gfile.GFile

Class GFile

Aliases:

  • Class tf.gfile.GFile
  • Class tf.gfile.Open
  • Class tf.io.gfile.GFile

Defined in tensorflow/python/platform/gfile.py.

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).

__init__

__init__(
    name,
    mode='r'
)

Initialize self. See help(type(self)) for accurate signature.

Properties

mode

Returns the mode in which the file was opened.

name

Returns the file name.

Methods

tf.io.gfile.GFile.__enter__

__enter__()

Make usable with "with" statement.

tf.io.gfile.GFile.__exit__

__exit__(
    unused_type,
    unused_value,
    unused_traceback
)

Make usable with "with" statement.

tf.io.gfile.GFile.__iter__

__iter__()

tf.io.gfile.GFile.__next__

__next__()

tf.io.gfile.GFile.close

close()

Closes FileIO. Should be called for the WritableFile to be flushed.

tf.io.gfile.GFile.flush

flush()

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.

tf.io.gfile.GFile.next

next()

tf.io.gfile.GFile.read

read(n=-1)

Returns the contents of a file as a string.

Starts reading from current position in file.

Args:

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

Returns:

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

tf.io.gfile.GFile.readline

readline()

Reads the next line from the file. Leaves the '\n' at the end.

tf.io.gfile.GFile.readlines

readlines()

Returns all lines from the file in a list.

tf.io.gfile.GFile.seek

seek(
    offset=None,
    whence=0,
    position=None
)

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

Args:

  • 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.

tf.io.gfile.GFile.size

size()

Returns the size of the file.

tf.io.gfile.GFile.tell

tell()

Returns the current position in the file.

tf.io.gfile.GFile.write

write(file_content)

Writes file_content to the file. Appends to the end of the file.