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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
# Copyright 2009-2016 by Peter Cock. All rights reserved.
# This code is part of the Biopython distribution and governed by its
# license. Please see the LICENSE file that should have been included
# as part of this package.
"""SeqFeature related tests for SeqRecord objects from Bio.SeqIO.
Initially this takes matched tests of GenBank and FASTA files from the NCBI
and confirms they are consistent using our different parsers.
"""
import sys
# Remove unittest2 import after dropping support for Python2.6
if sys.version_info < (2, 7):
try:
import unittest2 as unittest
except ImportError:
from Bio import MissingPythonDependencyError
raise MissingPythonDependencyError("Under Python 2.6 this test needs the unittest2 library")
else:
import unittest
from Bio import SeqIO
from Bio.Alphabet import generic_dna, generic_protein
from Bio.Seq import Seq, MutableSeq
from Bio.SeqRecord import SeqRecord
from Bio.SeqFeature import SeqFeature, FeatureLocation, ExactPosition
from Bio.SeqFeature import WithinPosition, BeforePosition, AfterPosition, OneOfPosition
class SeqRecordCreation(unittest.TestCase):
"""Test basic creation of SeqRecords."""
def test_annotations(self):
"""Pass in annotations to SeqRecords"""
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test")
self.assertEqual(rec.annotations, {})
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test",
annotations={"test": ["a test"]})
self.assertEqual(rec.annotations["test"], ["a test"])
def test_letter_annotations(self):
"""Pass in letter annotations to SeqRecords"""
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test")
self.assertEqual(rec.annotations, {})
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test",
letter_annotations={"test": [1, 2, 3, 4]})
self.assertEqual(rec.letter_annotations["test"], [1, 2, 3, 4])
# Now try modifying it to a bad value...
try:
rec.letter_annotations["bad"] = "abc"
self.fail("Adding a bad letter_annotation should fail!")
except (TypeError, ValueError) as e:
pass
# Now try setting it afterwards to a bad value...
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test")
try:
rec.letter_annotations = {"test": [1, 2, 3]}
self.fail("Changing to bad letter_annotations should fail!")
except (TypeError, ValueError) as e:
pass
# Now try setting it at creation time to a bad value...
try:
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test",
letter_annotations={"test": [1, 2, 3]})
self.fail("Wrong length letter_annotations should fail!")
except (TypeError, ValueError) as e:
pass
def test_replacing_seq(self):
"""Replacing .seq if .letter_annotation present."""
rec = SeqRecord(Seq("ACGT", generic_dna),
id="Test", name="Test", description="Test",
letter_annotations={"example": [1, 2, 3, 4]})
try:
rec.seq = Seq("ACGTACGT", generic_dna)
self.fail("Changing .seq length with letter_annotations present should fail!")
except ValueError as e:
self.assertEqual(str(e), "You must empty the letter annotations first!")
# Check we can replace IF the length is the same
self.assertEqual(str(rec.seq), "ACGT")
self.assertEqual(rec.letter_annotations, {"example": [1, 2, 3, 4]})
rec.seq = Seq("NNNN", generic_dna)
self.assertEqual(str(rec.seq), "NNNN")
self.assertEqual(rec.letter_annotations, {"example": [1, 2, 3, 4]})
def test_valid_id(self):
with self.assertRaises(TypeError):
SeqRecord(Seq("ACGT", generic_dna), id=dict())
def test_valid_name(self):
with self.assertRaises(TypeError):
SeqRecord(Seq("ACGT", generic_dna), name=dict())
def test_valid_description(self):
with self.assertRaises(TypeError):
SeqRecord(Seq("ACGT", generic_dna), description=dict())
def test_valid_dbxrefs(self):
with self.assertRaises(TypeError):
SeqRecord(Seq("ACGT", generic_dna), dbxrefs=dict())
def test_valid_annotations(self):
with self.assertRaises(TypeError):
SeqRecord(Seq("ACGT", generic_dna), annotations=list())
def test_valid_features(self):
with self.assertRaises(TypeError):
SeqRecord(Seq("ACGT", generic_dna), features=dict())
class SeqRecordMethods(unittest.TestCase):
"""Test SeqRecord methods."""
def setUp(self):
f0 = SeqFeature(FeatureLocation(0, 26), type="source",
qualifiers={"mol_type": ["fake protein"]})
f1 = SeqFeature(FeatureLocation(0, ExactPosition(10)))
f2 = SeqFeature(FeatureLocation(WithinPosition(12, left=12, right=15), BeforePosition(22)))
f3 = SeqFeature(FeatureLocation(AfterPosition(16),
OneOfPosition(26, [ExactPosition(25), AfterPosition(26)])))
self.record = SeqRecord(Seq("ABCDEFGHIJKLMNOPQRSTUVWZYX", generic_protein),
id="TestID", name="TestName", description="TestDescr",
dbxrefs=["TestXRef"], annotations={"k": "v"},
letter_annotations={"fake": "X" * 26},
features=[f0, f1, f2, f3])
def test_iter(self):
for amino in self.record:
self.assertEqual("A", amino)
break
def test_contains(self):
self.assertTrue(Seq("ABC", generic_protein) in self.record)
def test_str(self):
expected = """
ID: TestID
Name: TestName
Description: TestDescr
Database cross-references: TestXRef
Number of features: 4
/k=v
Per letter annotation for: fake
Seq('ABCDEFGHIJKLMNOPQRSTUVWZYX', ProteinAlphabet())"""
self.assertEqual(expected.lstrip(), str(self.record))
def test_repr(self):
expected = "SeqRecord(seq=Seq('ABCDEFGHIJKLMNOPQRSTUVWZYX', ProteinAlphabet()), " \
"id='TestID', name='TestName', description='TestDescr', dbxrefs=['TestXRef'])"
self.assertEqual(expected, repr(self.record))
def test_format(self):
expected = ">TestID TestDescr\nABCDEFGHIJKLMNOPQRSTUVWZYX\n"
self.assertEqual(expected, self.record.format('fasta'))
def test_upper(self):
self.assertEqual("ABCDEFGHIJKLMNOPQRSTUVWZYX", str(self.record.lower().upper().seq))
def test_lower(self):
self.assertEqual("abcdefghijklmnopqrstuvwzyx", str(self.record.lower().seq))
def test_slicing(self):
self.assertEqual("B", self.record[1])
self.assertEqual("BC", self.record[1:3].seq)
with self.assertRaises(ValueError):
c = self.record['a'].seq
def test_slice_variants(self):
"""Simple slices using different start/end values"""
for start in list(range(-30, 30)) + [None]:
for end in list(range(-30, 30)) + [None]:
if start is None and end is None:
continue
rec = self.record[start:end]
seq = self.record.seq[start:end]
seq_str = str(self.record.seq)[start:end]
self.assertEqual(seq_str, str(seq))
self.assertEqual(seq_str, str(rec.seq))
self.assertEqual("X" * len(seq_str), rec.letter_annotations["fake"])
def test_slice_simple(self):
"""Simple slice"""
rec = self.record
self.assertEqual(len(rec), 26)
left = rec[:10]
self.assertEqual(str(left.seq), str(rec.seq[:10]))
right = rec[-10:]
self.assertEqual(str(right.seq), str(rec.seq[-10:]))
mid = rec[12:22]
self.assertEqual(str(mid.seq), str(rec.seq[12:22]))
for sub in [left, right, mid]:
self.assertEqual(len(sub), 10)
self.assertEqual(sub.id, "TestID")
self.assertEqual(sub.name, "TestName")
self.assertEqual(sub.description, "TestDescr")
self.assertEqual(sub.letter_annotations, {"fake": "X" * 10})
self.assertEqual(sub.dbxrefs, []) # May change this...
self.assertEqual(sub.annotations, {}) # May change this...
self.assertEqual(len(sub.features), 1)
# By construction, each feature matches the full sliced region:
self.assertEqual(str(sub.features[0].extract(sub.seq)), str(sub.seq))
self.assertEqual(sub.features[0].extract(str(sub.seq)), str(sub.seq))
def test_slice_zero(self):
"""Zero slice"""
rec = self.record
self.assertEqual(len(rec), 26)
self.assertEqual(len(rec[2:-2]), 22)
self.assertEqual(len(rec[5:2]), 0)
self.assertEqual(len(rec[5:2][2:-2]), 0)
def test_add_simple(self):
"""Simple addition"""
rec = self.record + self.record
self.assertEqual(len(rec), 52)
self.assertEqual(rec.id, "TestID")
self.assertEqual(rec.name, "TestName")
self.assertEqual(rec.description, "TestDescr")
self.assertEqual(rec.dbxrefs, ["TestXRef"])
self.assertEqual(rec.annotations, {"k": "v"})
self.assertEqual(rec.letter_annotations, {"fake": "X" * 52})
self.assertEqual(len(rec.features), 2 * len(self.record.features))
def test_add_seq(self):
"""Simple addition of Seq or string"""
for other in [Seq("BIO"), "BIO"]:
rec = self.record + other # will use SeqRecord's __add__ method
self.assertEqual(len(rec), 26 + 3)
self.assertEqual(str(rec.seq), str(self.record.seq) + "BIO")
self.assertEqual(rec.id, "TestID")
self.assertEqual(rec.name, "TestName")
self.assertEqual(rec.description, "TestDescr")
self.assertEqual(rec.dbxrefs, ["TestXRef"])
self.assertEqual(rec.annotations, {"k": "v"})
self.assertEqual(rec.letter_annotations, {})
self.assertEqual(len(rec.features), len(self.record.features))
self.assertEqual(rec.features[0].type, "source")
self.assertEqual(rec.features[0].location.nofuzzy_start, 0)
self.assertEqual(rec.features[0].location.nofuzzy_end, 26) # not +3
def test_add_seqrecord(self):
"""Simple left addition of SeqRecord from genbank file."""
other = SeqIO.read("GenBank/dbsource_wrap.gb", "gb")
other.dbxrefs = ["dummy"]
rec = self.record + other
self.assertEqual(len(rec), len(self.record) + len(other))
self.assertEqual(str(rec.seq), str(self.record.seq) + str(other.seq))
self.assertEqual(rec.id, "<unknown id>")
self.assertEqual(rec.name, "<unknown name>")
self.assertEqual(rec.description, "<unknown description>")
self.assertEqual(rec.dbxrefs, ["TestXRef", "dummy"])
self.assertEqual(len(rec.annotations), 0)
self.assertEqual(len(rec.letter_annotations), 0)
self.assertEqual(len(rec.features),
len(self.record.features) + len(other.features))
self.assertEqual(rec.features[0].type, "source")
self.assertEqual(rec.features[0].location.nofuzzy_start, 0)
self.assertEqual(rec.features[0].location.nofuzzy_end, len(self.record)) # not +3
i = len(self.record.features)
self.assertEqual(rec.features[i].type, "source")
self.assertEqual(rec.features[i].location.nofuzzy_start, len(self.record))
self.assertEqual(rec.features[i].location.nofuzzy_end, len(rec))
def test_add_seq_left(self):
"""Simple left addition of Seq or string"""
for other in [Seq("BIO"), "BIO"]:
rec = other + self.record # will use SeqRecord's __radd__ method
self.assertEqual(len(rec), 26 + 3)
self.assertEqual(str(rec.seq), "BIO" + str(self.record.seq))
self.assertEqual(rec.id, "TestID")
self.assertEqual(rec.name, "TestName")
self.assertEqual(rec.description, "TestDescr")
self.assertEqual(rec.dbxrefs, ["TestXRef"])
self.assertEqual(rec.annotations, {"k": "v"})
self.assertEqual(rec.letter_annotations, {})
self.assertEqual(len(rec.features), len(self.record.features))
self.assertEqual(rec.features[0].type, "source")
self.assertEqual(rec.features[0].location.nofuzzy_start, 3)
self.assertEqual(rec.features[0].location.nofuzzy_end, 26 + 3)
def test_slice_add_simple(self):
"""Simple slice and add"""
for cut in range(27):
rec = self.record[:cut] + self.record[cut:]
self.assertEqual(str(rec.seq), str(self.record.seq))
self.assertEqual(len(rec), 26)
self.assertEqual(rec.id, "TestID")
self.assertEqual(rec.name, "TestName")
self.assertEqual(rec.description, "TestDescr")
self.assertEqual(rec.dbxrefs, []) # May change this...
self.assertEqual(rec.annotations, {}) # May change this...
self.assertEqual(rec.letter_annotations, {"fake": "X" * 26})
self.assertTrue(len(rec.features) <= len(self.record.features))
def test_slice_add_shift(self):
"""Simple slice and add to shift"""
for cut in range(27):
rec = self.record[cut:] + self.record[:cut]
self.assertEqual(str(rec.seq), str(self.record.seq[cut:] + self.record.seq[:cut]))
self.assertEqual(len(rec), 26)
self.assertEqual(rec.id, "TestID")
self.assertEqual(rec.name, "TestName")
self.assertEqual(rec.description, "TestDescr")
self.assertEqual(rec.dbxrefs, []) # May change this...
self.assertEqual(rec.annotations, {}) # May change this...
self.assertEqual(rec.letter_annotations, {"fake": "X" * 26})
self.assertTrue(len(rec.features) <= len(self.record.features))
def test_reverse_complement_seq(self):
s = SeqRecord(Seq("ACTG"), id="TestID", name="TestName",
description="TestDescription", dbxrefs=["TestDbxrefs"],
features=[SeqFeature(FeatureLocation(0, 3), type="Site")],
annotations={'organism': 'bombyx'},
letter_annotations={'test': 'abcd'})
rc = s.reverse_complement(id=True, name=True, description=True,
dbxrefs=True, features=True, annotations=True,
letter_annotations=True)
self.assertEqual("CAGT", str(rc.seq))
self.assertEqual("TestID", rc.id)
self.assertEqual("TestID", s.reverse_complement(id="TestID").id)
self.assertEqual("TestName", rc.name)
self.assertEqual("TestName", s.reverse_complement(name="TestName").name)
self.assertEqual("TestDescription", rc.description)
self.assertEqual("TestDescription",
s.reverse_complement(description="TestDescription").description)
self.assertEqual(["TestDbxrefs"], rc.dbxrefs)
self.assertEqual(["TestDbxrefs"],
s.reverse_complement(dbxrefs=["TestDbxrefs"]).dbxrefs)
self.assertEqual("[SeqFeature(FeatureLocation(ExactPosition(1), ExactPosition(4)), type='Site')]",
repr(rc.features))
rc2 = s.reverse_complement(features=[SeqFeature(FeatureLocation(1, 4), type="Site")])
self.assertEqual("[SeqFeature(FeatureLocation(ExactPosition(1), ExactPosition(4)), type='Site')]",
repr(rc2.features))
self.assertEqual({'organism': 'bombyx'}, rc.annotations)
self.assertEqual({'organism': 'bombyx'},
s.reverse_complement(annotations={'organism': 'bombyx'}).annotations)
self.assertEqual({'test': 'dcba'}, rc.letter_annotations)
self.assertEqual({'test': 'abcd'},
s.reverse_complement(letter_annotations={'test': 'abcd'}).letter_annotations)
def test_reverse_complement_mutable_seq(self):
s = SeqRecord(MutableSeq("ACTG"))
self.assertEqual("CAGT", str(s.reverse_complement().seq))
def test_gt_exception(self):
def lt():
SeqRecord(Seq("A")) < SeqRecord(Seq("A"))
self.assertRaises(NotImplementedError, lt)
def test_le_exception(self):
def le():
SeqRecord(Seq("A")) <= SeqRecord(Seq("A"))
self.assertRaises(NotImplementedError, le)
def test_eq_exception(self):
def equality():
SeqRecord(Seq("A")) == SeqRecord(Seq("A"))
self.assertRaises(NotImplementedError, equality)
def test_ne_exception(self):
def notequality():
SeqRecord(Seq("A")) != SeqRecord(Seq("A"))
self.assertRaises(NotImplementedError, notequality)
def test_gt_exception(self):
def gt():
SeqRecord(Seq("A")) > SeqRecord(Seq("A"))
self.assertRaises(NotImplementedError, gt)
def test_ge_exception(self):
def ge():
SeqRecord(Seq("A")) >= SeqRecord(Seq("A"))
self.assertRaises(NotImplementedError, ge)
if __name__ == "__main__":
runner = unittest.TextTestRunner(verbosity=2)
unittest.main(testRunner=runner)
|
