ngs_tools.gtf.Gtf

Module Contents

Classes

Gtf

Class that represents a GTF file.
exception ngs_tools.gtf.Gtf.GtfError

Bases: Exception

Common base class for all non-exit exceptions.

class ngs_tools.gtf.Gtf.Gtf(path: str, mode: typing_extensions.Literal[r, w] = 'r')

Bases: ngs_tools.utils.FileWrapper

Class that represents a GTF file.

read() → ngs_tools.gtf.GtfEntry.GtfEntry

Read a single GTF entry as a GtfEntry instance.

Returns:

The next GTF entry

Raises:

  • GtfError – If the file was not opened for reading, or the file was closed.

  • StopIteration – When there are no more entries to read.

write(entry: ngs_tools.gtf.GtfEntry.GtfEntry)

Write a single GTF entry.

Parameters:

entry – The GTF entry to write

Raises:

FastaError – If the file was not opened for writing, or the file was closed.