upstream-dependencies/galaxy-sequence-utils/galaxy_utils/sequence/vcf.py
1# Dan Blankenberg
2# See http://www.1000genomes.org/wiki/Analysis/variant-call-format
3
4NOT_A_NUMBER = float('NaN')
5
6
7class VariantCall:
8 version = None
9 header_startswith = None
10 required_header_fields = None
11 required_header_length = None
12
13 @classmethod
14 def get_class_by_format(cls, format):
15 assert format in VCF_FORMATS, f'Unknown format type specified: {format}'
16 return VCF_FORMATS[format]
17
18 def __init__(self, vcf_line, metadata, sample_names):
19 raise Exception('Abstract Method')
20
21
22class VariantCall33(VariantCall):
23 version = 'VCFv3.3'
24 header_startswith = '#CHROM\tPOS\tID\tREF\tALT\tQUAL\tFILTER\tINFO'
25 required_header_fields = header_startswith.split('\t')
26 required_header_length = len(required_header_fields)
27
28 def __init__(self, vcf_line, metadata, sample_names):
29 # Raw line is needed for indexing file.
30 self.raw_line = vcf_line
31 self.line = vcf_line.rstrip('\n\r')
32 self.metadata = metadata
33 self.sample_names = sample_names
34 self.format = None
35 self.sample_values = []
36
37 # parse line
38 self.fields = self.line.split('\t')
39 if sample_names:
40 assert len(self.fields) == self.required_header_length + len(sample_names) + 1, f'Provided VCF line ({self.line}) has wrong length (expected: {self.required_header_length + len(sample_names) + 1:d})'
41 else:
42 assert len(self.fields) == self.required_header_length, f'Provided VCF line ({self.line}) has wrong length (expected: {self.required_header_length:d})'
43 self.chrom, self.pos, self.id, self.ref, self.alt, self.qual, self.filter, self.info = self.fields[:self.required_header_length]
44 self.pos = int(self.pos)
45 self.alt = self.alt.split(',')
46 try:
47 self.qual = float(self.qual)
48 except ValueError:
49 self.qual = NOT_A_NUMBER # Missing data can be denoted as a '.'
50 if len(self.fields) > self.required_header_length:
51 self.format = self.fields[self.required_header_length].split(':')
52 for sample_value in self.fields[self.required_header_length + 1:]:
53 self.sample_values.append(sample_value.split(':'))
54
55
56class VariantCall40(VariantCall33):
57 version = 'VCFv4.0'
58
59 def __init__(self, vcf_line, metadata, sample_names):
60 VariantCall33.__init__(self, vcf_line, metadata, sample_names)
61
62
63class VariantCall41(VariantCall40):
64 version = 'VCFv4.1'
65
66
67# VCF Format version lookup dict
68VCF_FORMATS = {}
69for format in [VariantCall33, VariantCall40, VariantCall41]:
70 VCF_FORMATS[format.version] = format
71
72
73class Reader:
74 def __init__(self, fh):
75 self.vcf_file = fh
76 self.metadata = {}
77 self.header_fields = None
78 self.metadata_len = 0
79 self.sample_names = []
80 self.vcf_class = None
81
82 # Read file metadata.
83 while True:
84 line = self.vcf_file.readline()
85 self.metadata_len += len(line)
86 assert line, 'Invalid VCF file provided.'
87 line = line.rstrip('\r\n')
88 if self.vcf_class and line.startswith(self.vcf_class.header_startswith):
89 # read the header fields, ignoring any blank tabs, which GATK
90 # VCF produces after the sample
91 self.header_fields = [field for field in line.split('\t') if field]
92 if len(self.header_fields) > self.vcf_class.required_header_length:
93 for sample_name in self.header_fields[self.vcf_class.required_header_length + 1:]:
94 self.sample_names.append(sample_name)
95 break
96 assert line.startswith('##'), 'Non-metadata line found before header'
97 line = line[2:] # strip ##
98 metadata = line.split('=', 1)
99 metadata_name = metadata[0]
100 if len(metadata) == 2:
101 metadata_value = metadata[1]
102 else:
103 metadata_value = None
104 if metadata_name in self.metadata:
105 if not isinstance(self.metadata[metadata_name], list):
106 self.metadata[metadata_name] = [self.metadata[metadata_name]]
107 self.metadata[metadata_name].append(metadata_value)
108 else:
109 self.metadata[metadata_name] = metadata_value
110 if metadata_name == 'fileformat':
111 self.vcf_class = VariantCall.get_class_by_format(metadata_value)
112
113 def close(self):
114 return self.vcf_file.close()
115
116 def next(self):
117 line = self.vcf_file.readline()
118 if not line:
119 raise StopIteration
120 return self.vcf_class(line, self.metadata, self.sample_names)
121
122 def __iter__(self):
123 while True:
124 try:
125 yield self.next()
126 except StopIteration:
127 self.close()
128 # Catch exception and return normally
129 return