File: opener.py

package info (click to toggle)
python-pbcore 1.7.1%2Bgit20200430.a127b1e%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 5,404 kB
  • sloc: python: 23,243; xml: 2,504; makefile: 232; sh: 66
file content (112 lines) | stat: -rw-r--r-- 3,113 bytes parent folder | download | duplicates (3)
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
__all__ = ["openAlignmentFile",
           "openIndexedAlignmentFile",
           "entryPoint"]

from pbcore.io import (IndexedFastaReader, FastaReader,
                       BamReader, IndexedBamReader,
                       GffReader, FastqReader,
                       PacBioBamIndex, openDataSet)


def raise_no_h5():
    raise NotImplementedError("hdf5 file support has been removed")


def openIndexedAlignmentFile(fname, referenceFastaFname=None, sharedIndex=None):
    """
    Factory function to get a handle to a reader for an alignment file (BAM),
    requires bam.pbi index

    The reference FASTA, if provided, must have a FASTA index
    (fasta.fai).
    """
    if fname.endswith(".h5"):
        raise_no_h5()
    elif fname.endswith("bam"):
        return IndexedBamReader(fname, referenceFastaFname=referenceFastaFname, sharedIndex=sharedIndex)
    else:
        raise ValueError("Invalid alignment file suffix")


def openAlignmentFile(fname, referenceFastaFname=None, sharedIndex=None):
    """
    Factory function to get a handle to a reader for an alignment file (BAM),
    not requiring index capability
    """
    if fname.endswith("cmp.h5"):
        raise_no_h5()
    elif fname.endswith("bam"):
        return BamReader(fname, referenceFastaFname)


def _openersFor(ext):
    if ext == "gff":
        return (GffReader,)
    elif ext in ("fq", "fastq"):
        return (FastqReader,)
    elif ext in ("fa", "fasta"):
        return (IndexedFastaReader, FastaReader)
    elif ext == "cmp.h5":
        raise_no_h5()
    elif ext == "bas.h5":
        raise_no_h5()
    elif ext == "bax.h5":
        raise_no_h5()
    elif ext == "fofn":
        raise_no_h5()
    elif ext == "bam":
        return (IndexedBamReader, BamReader)
    elif ext == "pbi":
        return (PacBioBamIndex,)
    elif ext == "xml":
        return (openDataSet,)
    else:
        raise ValueError("No known opener class for extension %s" % ext)


def _extension(fname):
    parts = fname.split(".")
    if parts[-1] == "h5":
        raise_no_h5()
    else:
        return parts[-1]


def _openAny(fname, *extraArgs):
    ext = _extension(fname)
    openers = _openersFor(ext)
    lastException = None
    for opener in openers:
        try:
            f = opener(fname, *extraArgs)
            return f
        except IOError as e:
            lastException = e
    else:
        assert lastException is not None
        raise lastException  # pylint: disable=raising-bad-type


def entryPoint():
    """
    This entry point (callable from the command line as ".open")
    provides a convenient way to load up a data file for inspection.
    """
    import sys
    import code
    import numpy as np

    if len(sys.argv) < 2:
        print("Requires at least one argument!")
        return 1

    fname = sys.argv[1]
    extraArgs = sys.argv[2:]

    f = _openAny(fname, *extraArgs)
    banner = "Your file has been opened as object 'f'"
    try:
        from IPython import embed
        embed(banner1=banner)
    except ImportError:
        code.InteractiveConsole(locals=locals()).interact(banner=banner)