File: _index.py

package info (click to toggle)
python-biopython 1.85%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 126,372 kB
  • sloc: xml: 1,047,995; python: 332,722; ansic: 16,944; sql: 1,208; makefile: 140; sh: 81
file content (35 lines) | stat: -rw-r--r-- 1,233 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Copyright 2012 by Wibowo Arindrarto.  All rights reserved.
# Revisions copyright 2012-2016 by Peter Cock.  All rights reserved.
#
# This file is part of the Biopython distribution and governed by your
# choice of the "Biopython License Agreement" or the "BSD 3-Clause License".
# Please see the LICENSE file that should have been included as part of this
# package.

"""Custom indexing for Bio.SearchIO objects."""

from io import StringIO

from Bio.File import _IndexedSeqFileProxy
from Bio.File import _open_for_random_access


class SearchIndexer(_IndexedSeqFileProxy):
    """Base class for file format specific random access.

    Subclasses for each file format should define '_parser' and optionally
    'get_raw' methods.
    """

    def __init__(self, filename, **kwargs):
        """Initialize the class."""
        self._handle = _open_for_random_access(filename)
        self._kwargs = kwargs

    def _parse(self, handle):
        """Pass handle and arguments to the next iterable (PRIVATE)."""
        return next(iter(self._parser(handle, **self._kwargs)))

    def get(self, offset):
        """Get offset and convert it from bytes to string."""
        return self._parse(StringIO(self.get_raw(offset).decode()))