Package Bio :: Module File :: Class _IndexedSeqFileProxy
[hide private]
[frames] | no frames]

Class _IndexedSeqFileProxy

source code

object --+
         |
        _IndexedSeqFileProxy
Known Subclasses:

Base class for file format specific random access (PRIVATE).

This is subclasses in both Bio.SeqIO for indexing as SeqRecord objects, and in Bio.SearchIO for indexing QueryResult objects.

Subclasses for each file format should define '__iter__', 'get' and optionally 'get_raw' methods.

Instance Methods [hide private]
 
__iter__(self)
Returns (identifier, offset, length in bytes) tuples.
source code
 
get(self, offset)
Returns parsed object for this entry.
source code
 
get_raw(self, offset)
Return the raw record from the file as a bytes string (if implemented).
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__iter__(self)

source code 

Returns (identifier, offset, length in bytes) tuples.

The length can be zero where it is not implemented or not possible for a particular file format.

get_raw(self, offset)

source code 

Return the raw record from the file as a bytes string (if implemented).

If the key is not found, a KeyError exception is raised.

This may not have been implemented for all file formats.