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
|
# 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.
from Bio._py3k import range
from Bio._py3k import basestring
from Bio.Seq import UnknownSeq
from Bio.SeqUtils.CheckSum import seguid
from Bio.SeqFeature import ExactPosition, UnknownPosition
from Bio.SeqFeature import FeatureLocation, CompoundLocation, SeqFeature
from Bio.SeqRecord import SeqRecord
def checksum_summary(record):
if isinstance(record.seq, UnknownSeq):
return repr(record.seq)
if len(record.seq) < 25:
short = str(record.seq)
else:
short = str(record.seq)[:19] \
+ "..." + str(record.seq)[-3:]
return "%s [%s] len %i" \
% (short, seguid(record.seq), len(record.seq))
def compare_reference(old_r, new_r):
"""Compare two Reference objects
Note new_r is assumed to be a BioSQL DBSeqRecord, due to limitations
of the BioSQL table structure.
"""
assert old_r.title == new_r.title, \
"%s vs %s" % (old_r.title, new_r.title)
assert old_r.authors == new_r.authors, \
"%s vs %s" % (old_r.authors, new_r.authors)
assert old_r.journal == new_r.journal, \
"%s vs %s" % (old_r.journal, new_r.journal)
assert old_r.medline_id == new_r.medline_id, \
"%s vs %s" % (old_r.medline_id, new_r.medline_id)
if old_r.pubmed_id and new_r.pubmed_id:
assert old_r.pubmed_id == new_r.pubmed_id
#Looking at BioSQL/BioSeq.py function _retrieve_reference
#it seems that it will get either the MEDLINE or PUBMED,
#but not both. I *think* the current schema does not allow
#us to store both... must confirm this.
#TODO - assert old_r.comment == new_r.comment
#Looking at the tables, I *think* the current schema does not
#allow us to store a reference comment. Must confirm this.
assert old_r.comment == new_r.comment or new_r.comment == "", \
"%r vs %r" % (old_r.comment, new_r.comment)
#TODO - assert old_r.consrtm == new_r.consrtm
#Looking at the tables, I *think* the current schema does not
#allow us to store a consortium.
assert old_r.consrtm == new_r.consrtm or new_r.consrtm == ""
if len(old_r.location) == 0:
assert len(new_r.location) == 0
else:
#BioSQL can only store ONE location!
#TODO - Check BioPerl with a GenBank file with multiple ref locations
assert isinstance(old_r.location[0], FeatureLocation)
assert isinstance(new_r.location[0], FeatureLocation)
assert old_r.location[0].start == new_r.location[0].start and \
old_r.location[0].end == new_r.location[0].end
return True
def compare_feature(old_f, new_f):
"""Compare two SeqFeature objects"""
assert isinstance(old_f, SeqFeature)
assert isinstance(new_f, SeqFeature)
assert old_f.type == new_f.type, \
"%s -> %s" % (old_f.type, new_f.type)
assert old_f.strand == new_f.strand, \
"%s -> %s" % (old_f.strand, new_f.strand)
assert old_f.ref == new_f.ref, \
"%s -> %s" % (old_f.ref, new_f.ref)
assert old_f.ref_db == new_f.ref_db, \
"%s -> %s" % (old_f.ref_db, new_f.ref_db)
#TODO - BioSQL does not store/retrieve feature's id (Bug 2526)
assert old_f.id == new_f.id or new_f.id == "<unknown id>"
#TODO - Work out how the location_qualifier_value table should
#be used, given BioPerl seems to ignore it (Bug 2766)
#assert old_f.location_operator == new_f.location_operator, \
# "%s -> %s" % (old_f.location_operator, new_f.location_operator)
# We dont store fuzzy locations:
assert old_f.location.start == new_f.location.start \
or (isinstance(old_f.location.start, UnknownPosition) and \
isinstance(new_f.location.start, UnknownPosition)), \
"%s -> %s" % (old_f.location.start, \
new_f.location.start)
assert old_f.location.end == new_f.location.end \
or (isinstance(old_f.location.end, UnknownPosition) and \
isinstance(new_f.location.end, UnknownPosition)), \
"%s -> %s" % (old_f.location.end, \
new_f.location.end)
assert isinstance(old_f.location, CompoundLocation) == \
isinstance(new_f.location, CompoundLocation)
if isinstance(old_f.location, CompoundLocation):
assert len(old_f.location.parts) == len(new_f.location.parts)
for old_l, new_l in zip(old_f.location.parts, new_f.location.parts):
assert old_l.start == new_l.start
assert old_l.end == new_l.end
assert old_l.strand == new_l.strand
assert old_l.ref == new_l.ref
assert old_l.ref_db == new_l.ref_db
assert len(old_f.location.parts) == len(new_f.location.parts)
for old_sub, new_sub in zip(old_f.location.parts, new_f.location.parts):
#These are FeatureLocation objects
assert old_sub.nofuzzy_start == new_sub.nofuzzy_start
assert old_sub.nofuzzy_end == new_sub.nofuzzy_end
assert old_sub.strand == new_sub.strand
#Using private variable to avoid deprecation warnings
assert len(old_f._sub_features) == len(new_f._sub_features), \
"number of sub_features: %s -> %s" % \
(len(old_f._sub_features), len(new_f._sub_features))
for old_sub, new_sub in zip(old_f._sub_features, new_f._sub_features):
#These are SeqFeature objects
assert old_sub.type == new_sub.type, \
"%s -> %s" % (old_sub.type, new_sub.type)
assert old_sub.strand == new_sub.strand, \
"%s -> %s" % (old_sub.strand, new_sub.strand)
assert old_sub.ref == new_sub.ref, \
"%s -> %s" % (old_sub.ref, new_sub.ref)
assert old_sub.ref_db == new_sub.ref_db, \
"%s -> %s" % (old_sub.ref_db, new_sub.ref_db)
#TODO - Work out how the location_qualifier_value table should
#be used, given BioPerl seems to ignore it (Bug 2766)
#assert old_sub.location_operator == new_sub.location_operator, \
# "%s -> %s" % (old_sub.location_operator, new_sub.location_operator)
# Compare sub-feature Locations:
#
# BioSQL currently does not store fuzzy locations, but instead stores
# them as FeatureLocation.nofuzzy_start FeatureLocation.nofuzzy_end.
# The vast majority of cases will be comparisons of ExactPosition
# class locations, so we'll try that first and catch the exceptions.
try:
assert str(old_sub.location) == str(new_sub.location), \
"%s -> %s" % (str(old_sub.location), str(new_sub.location))
except AssertionError as e:
if isinstance(old_sub.location.start, ExactPosition) and \
isinstance(old_sub.location.end, ExactPosition):
# Its not a problem with fuzzy locations, re-raise
raise e
else:
#At least one of the locations is fuzzy
assert old_sub.location.nofuzzy_start == \
new_sub.location.nofuzzy_start, \
"%s -> %s" % (old_sub.location.nofuzzy_start,
new_sub.location.nofuzzy_start)
assert old_sub.location.nofuzzy_end == \
new_sub.location.nofuzzy_end, \
"%s -> %s" % (old_sub.location.nofuzzy_end,
new_sub.location.nofuzzy_end)
assert len(old_f.qualifiers) == len(new_f.qualifiers)
assert set(old_f.qualifiers) == set(new_f.qualifiers)
for key in old_f.qualifiers:
if isinstance(old_f.qualifiers[key], str):
if isinstance(new_f.qualifiers[key], str):
assert old_f.qualifiers[key] == new_f.qualifiers[key]
elif isinstance(new_f.qualifiers[key], list):
#Maybe a string turning into a list of strings?
assert [old_f.qualifiers[key]] == new_f.qualifiers[key], \
"%s -> %s" \
% (repr(old_f.qualifiers[key]),
repr(new_f.qualifiers[key]))
else:
assert False, "Problem with feature's '%s' qualifier" & key
else:
#Should both be lists of strings...
assert old_f.qualifiers[key] == new_f.qualifiers[key], \
"%s -> %s" % (old_f.qualifiers[key], new_f.qualifiers[key])
return True
def compare_sequence(old, new):
"""Compare two Seq or DBSeq objects"""
assert len(old) == len(new), "%i vs %i" % (len(old), len(new))
assert str(old) == str(new)
if isinstance(old, UnknownSeq):
assert isinstance(new, UnknownSeq)
else:
assert not isinstance(new, UnknownSeq)
ln = len(old)
s = str(old)
assert isinstance(s, str)
#Don't check every single element; for long sequences
#this takes far far far too long to run!
#Test both positive and negative indices
if ln < 50:
indices = list(range(-ln, ln))
else:
#A selection of end cases, and the mid point
indices = [-ln, -ln+1, -(ln//2), -1, 0, 1, ln//2, ln-2, ln-1]
#Test element access,
for i in indices:
expected = s[i]
assert expected == old[i]
assert expected == new[i]
#Test slices
indices.append(ln) # check copes with overflows
indices.append(ln + 1000) # check copes with overflows
for i in indices:
for j in indices:
expected = s[i:j]
assert expected == str(old[i:j]), \
"Slice %s vs %s" % (repr(expected), repr(old[i:j]))
assert expected == str(new[i:j]), \
"Slice %s vs %s" % (repr(expected), repr(new[i:j]))
#Slicing with step of 1 should make no difference.
#Slicing with step 3 might be useful for codons.
for step in [1, 3]:
expected = s[i:j:step]
assert expected == str(old[i:j:step])
assert expected == str(new[i:j:step])
#Check automatic end points
expected = s[i:]
assert expected == str(old[i:])
assert expected == str(new[i:])
expected = s[:i]
assert expected == str(old[:i])
assert expected == str(new[:i])
#Check "copy" splice
assert s == str(old[:])
assert s == str(new[:])
return True
def compare_features(old_list, new_list):
assert isinstance(old_list, list)
assert isinstance(new_list, list)
assert len(old_list) == len(new_list)
for old_f, new_f in zip(old_list, new_list):
if not compare_feature(old_f, new_f):
return False
return True
def compare_record(old, new):
"""Compare two SeqRecord or DBSeqRecord objects"""
assert isinstance(old, SeqRecord)
assert isinstance(new, SeqRecord)
#Sequence:
compare_sequence(old.seq, new.seq)
#Basics:
assert old.id == new.id
assert old.name == new.name
assert old.description == new.description
assert old.dbxrefs == new.dbxrefs, \
"dbxrefs mismatch\nOld: %s\nNew: %s" \
% (old.dbxrefs, new.dbxrefs)
#Features:
if not compare_features(old.features, new.features):
return False
#Annotation:
#We are expecting to see some "extra" annotations appearing,
#such as 'cross_references', 'dates', 'data_file_division',
#'ncbi_taxon' and 'gi'.
#TODO - address these, see Bug 2681?
new_keys = set(new.annotations).difference(old.annotations)
new_keys = new_keys.difference(['cross_references', 'date',
'data_file_division', 'ncbi_taxid', 'gi'])
assert not new_keys, "Unexpected new annotation keys: %s" \
% ", ".join(new_keys)
missing_keys = set(old.annotations).difference(new.annotations)
missing_keys = missing_keys.difference(['ncbi_taxid', # Can't store chimeras
])
assert not missing_keys, "Unexpectedly missing annotation keys: %s" \
% ", ".join(missing_keys)
#In the short term, just compare any shared keys:
for key in set(old.annotations).intersection(new.annotations):
if key == "references":
assert len(old.annotations[key]) == len(new.annotations[key])
for old_r, new_r in zip(old.annotations[key], new.annotations[key]):
compare_reference(old_r, new_r)
elif key == "comment":
#Turn them both into containing strings for comparison - due to
#line wrapping in GenBank etc we don't really expect the white
#space to be 100% the same.
if isinstance(old.annotations[key], list):
old_comment = " ".join(old.annotations[key])
else:
old_comment = old.annotations[key]
if isinstance(new.annotations[key], list):
new_comment = " ".join(new.annotations[key])
else:
new_comment = new.annotations[key]
old_comment = old_comment.replace("\n", " ").replace(" ", " ")
new_comment = new_comment.replace("\n", " ").replace(" ", " ")
assert old_comment == new_comment, \
"Comment annotation changed by load/retrieve\n" \
"Was:%s\nNow:%s" \
% (repr(old_comment), repr(new_comment))
elif key in ["taxonomy", "organism", "source"]:
#If there is a taxon id recorded, these fields get overwritten
#by data from the taxon/taxon_name tables. There is no
#guarantee that they will be identical after a load/retrieve.
assert isinstance(new.annotations[key], basestring) \
or isinstance(new.annotations[key], list)
elif type(old.annotations[key]) == type(new.annotations[key]):
assert old.annotations[key] == new.annotations[key], \
"Annotation '%s' changed by load/retrieve\nWas:%s\nNow:%s" \
% (key, old.annotations[key], new.annotations[key])
elif isinstance(old.annotations[key], str) \
and isinstance(new.annotations[key], list):
#Any annotation which is a single string gets turned into
#a list containing one string by BioSQL at the moment.
assert [old.annotations[key]] == new.annotations[key], \
"Annotation '%s' changed by load/retrieve\nWas:%s\nNow:%s" \
% (key, old.annotations[key], new.annotations[key])
elif isinstance(old.annotations[key], list) \
and isinstance(new.annotations[key], str):
assert old.annotations[key] == [new.annotations[key]], \
"Annotation '%s' changed by load/retrieve\nWas:%s\nNow:%s" \
% (key, old.annotations[key], new.annotations[key])
return True
def compare_records(old_list, new_list):
assert isinstance(old_list, list)
assert isinstance(new_list, list)
assert len(old_list) == len(new_list)
for old_r, new_r in zip(old_list, new_list):
if not compare_record(old_r, new_r):
return False
return True
|