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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
|
#cython: language_level=3
import sys
from obitools3.utils cimport str2bytes, bytes2str, tobytes, tostr
from ..capi.obidms cimport OBIDMS_p, obi_dms_get_full_path
from ..capi.obitaxonomy cimport obi_taxonomy_exists, \
obi_read_taxonomy, \
obi_read_taxdump, \
obi_write_taxonomy, \
obi_close_taxonomy, \
obi_taxo_get_taxon_with_taxid, \
obi_taxo_add_local_taxon, \
obi_taxo_add_preferred_name_with_taxon, \
obi_taxo_rank_index_to_label, \
obi_taxo_get_species, \
obi_taxo_get_genus, \
obi_taxo_get_family, \
ecotx_t, \
econame_t, \
obi_taxo_get_name_from_name_idx, \
obi_taxo_get_taxon_from_name_idx
from cpython.pycapsule cimport PyCapsule_New, PyCapsule_GetPointer
import tarfile
from pathlib import Path
from libc.stdlib cimport free
cdef class Taxonomy(OBIWrapper) :
# TODO function to import taxonomy?
cdef inline OBIDMS_taxonomy_p pointer(self) :
return <OBIDMS_taxonomy_p>(self._pointer)
cdef fill_name_dict(self):
print("Indexing taxon names...", file=sys.stderr)
cdef OBIDMS_taxonomy_p pointer = self.pointer()
cdef ecotx_t* taxon_p
cdef object taxon_capsule
cdef bytes name
cdef int count
cdef int n
count = (<OBIDMS_taxonomy_p>pointer).names.count
for n in range(count) :
name = obi_taxo_get_name_from_name_idx(pointer, n)
taxon_p = obi_taxo_get_taxon_from_name_idx(pointer, n)
taxon_capsule = PyCapsule_New(taxon_p, NULL, NULL)
self._name_dict[name] = Taxon(taxon_capsule, self)
@staticmethod
def exists(DMS dms, object name) :
e = obi_taxonomy_exists(dms.pointer(), tobytes(name))
if e < 0:
raise RuntimeError("Error : Cannot check if taxonomy %s exists"
% tostr(name))
else:
return e
@staticmethod
def list_taxos(DMS dms):
cdef OBIDMS_p dms_p
cdef const char* path
dms_p = dms.pointer()
path = obi_dms_get_full_path(dms_p, b"TAXONOMY")
if path == NULL:
raise RuntimeError("Cannot retrieve the taxonomy directory path")
p = Path(bytes2str(path))
free(path)
for tax in p.glob("*") :
yield str2bytes(tax.stem)
@staticmethod
def open(DMS dms, object name) :
cdef void* pointer
cdef Taxonomy taxo
pointer = <void*>obi_read_taxonomy(dms.pointer(), tobytes(name), True)
if pointer == NULL :
raise RuntimeError("Error : Cannot read taxonomy %s"
% tostr(name))
print("Taxonomy read", file=sys.stderr)
taxo = OBIWrapper.new_wrapper(Taxonomy, pointer)
dms.register(taxo)
taxo._dms = dms
taxo._name = tobytes(name)
taxo._name_dict = {}
taxo.fill_name_dict()
taxo._ranks = []
for r in range((<OBIDMS_taxonomy_p>pointer).ranks.count) :
taxo._ranks.append(obi_taxo_rank_index_to_label(r, (<OBIDMS_taxonomy_p>pointer).ranks))
return taxo
@staticmethod
def open_taxdump(DMS dms, object path) :
cdef void* pointer
cdef Taxonomy taxo
cdef bytes path_b
cdef int idx
path_b = tobytes(path)
folder_path = path_b
if path_b.endswith(b"tar.gz") or path_b.endswith(b"tar"):
idx = path_b.index(b".tar")
folder_path = path_b[:idx]
if path_b.endswith(b"tar.gz"):
tar = tarfile.open(path_b, "r:gz")
tar.extractall(path=tostr(folder_path))
tar.close()
elif path_b.endswith(b"tar"):
tar = tarfile.open(path_b, "r:")
tar.extractall(path=tostr(folder_path))
tar.close()
pointer = <void*>obi_read_taxdump(folder_path)
if pointer == NULL :
raise RuntimeError("Error : Cannot read taxonomy %s"
% tostr(folder_path))
taxo = OBIWrapper.new_wrapper(Taxonomy, pointer)
dms.register(taxo)
taxo._dms = dms
taxo._name = folder_path
taxo._name_dict = {}
taxo.fill_name_dict()
taxo._ranks = []
for r in range((<OBIDMS_taxonomy_p>pointer).ranks.count) :
taxo._ranks.append(obi_taxo_rank_index_to_label(r, (<OBIDMS_taxonomy_p>pointer).ranks))
print('Read %d taxa' % len(taxo), file=sys.stderr)
return taxo
def __getitem__(self, object ref):
if type(ref) == int :
return self.get_taxon_by_taxid(ref)
elif type(ref) == str or type(ref) == bytes :
return self.get_taxon_by_name(ref)
cpdef Taxon get_taxon_by_taxid(self, int taxid):
cdef ecotx_t* taxon_p
cdef object taxon_capsule
taxon_p = obi_taxo_get_taxon_with_taxid(self.pointer(), taxid)
if taxon_p == NULL:
raise Exception("Error getting a taxon with given taxid", taxid)
taxon_capsule = PyCapsule_New(taxon_p, NULL, NULL)
return Taxon(taxon_capsule, self)
cpdef Taxon get_taxon_by_name(self, object taxon_name, object restricting_taxid=None):
#print(taxon_name)
taxon = self._name_dict.get(tobytes(taxon_name), None)
if not taxon:
return None
elif restricting_taxid:
if self.is_ancestor(restricting_taxid, taxon.taxid):
return taxon
else:
return None
else:
return taxon
cpdef Taxon get_taxon_by_idx(self, int idx):
cdef ecotx_t* taxa
cdef ecotx_t* taxon_p
cdef object taxon_capsule
if idx >= self.pointer().taxa.count :
raise Exception("Error getting a taxon with given index: no taxid with this index", idx)
taxa = self.pointer().taxa.taxon
taxon_p = <ecotx_t*> (taxa+idx)
taxon_capsule = PyCapsule_New(taxon_p, NULL, NULL)
return Taxon(taxon_capsule, self)
cpdef object get_species(self, int taxid):
cdef ecotx_t* taxon_p
cdef ecotx_t* species_p
taxon_p = obi_taxo_get_taxon_with_taxid(self.pointer(), taxid)
if taxon_p == NULL:
raise Exception("Error getting a taxon with given taxid", taxid)
species_p = obi_taxo_get_species(taxon_p, self.pointer())
if species_p == NULL :
return None
else :
return <int>(species_p.taxid)
cpdef object get_genus(self, int taxid):
cdef ecotx_t* taxon_p
cdef ecotx_t* genus_p
taxon_p = obi_taxo_get_taxon_with_taxid(self.pointer(), taxid)
if taxon_p == NULL:
raise Exception("Error getting a taxon with given taxid", taxid)
genus_p = obi_taxo_get_genus(taxon_p, self.pointer())
if genus_p == NULL :
return None
else :
return <int>(genus_p.taxid)
cpdef object get_family(self, int taxid):
cdef ecotx_t* taxon_p
cdef ecotx_t* family_p
taxon_p = obi_taxo_get_taxon_with_taxid(self.pointer(), taxid)
if taxon_p == NULL:
raise Exception("Error getting a taxon with given taxid", taxid)
family_p = obi_taxo_get_family(taxon_p, self.pointer())
if family_p == NULL :
return None
else :
return <int>(family_p.taxid)
cpdef bytes get_scientific_name(self, int taxid):
cdef ecotx_t* taxon_p
taxon_p = obi_taxo_get_taxon_with_taxid(self.pointer(), taxid)
if taxon_p == NULL:
raise Exception("Error getting a taxon with given taxid", taxid)
return taxon_p.name
cpdef bytes get_rank(self, int taxid):
cdef ecotx_t* taxon_p
taxon_p = obi_taxo_get_taxon_with_taxid(self.pointer(), taxid)
if taxon_p == NULL:
raise Exception("Error getting a taxon with given taxid", taxid)
return self._ranks[taxon_p.rank]
cpdef object get_taxon_at_rank(self, int taxid, object rank):
if isinstance(rank, str) or isinstance(rank, bytes):
rank = self._ranks.index(tobytes(rank))
try:
return [x.taxid for x in self.parental_tree_iterator(taxid) if x.rank_idx==rank][0]
except IndexError:
return None
def __len__(self):
return self.pointer().taxa.count
def __iter__(self):
cdef ecotx_t* taxa
cdef ecotx_t* taxon_p
cdef object taxon_capsule
cdef int t
taxa = self.pointer().taxa.taxon
# Yield each taxon
for t in range(self.pointer().taxa.count):
taxon_p = <ecotx_t*> (taxa+t)
taxon_capsule = PyCapsule_New(taxon_p, NULL, NULL)
yield Taxon(taxon_capsule, self)
cpdef write(self, object prefix, bint update=False) :
if obi_write_taxonomy(self._dms.pointer(), self.pointer(), tobytes(prefix), update) < 0 :
raise Exception("Error writing the taxonomy to binary files")
cpdef int add_taxon(self, object name, object rank_name, int parent_taxid, int min_taxid=10000000) :
cdef int taxid
taxid = obi_taxo_add_local_taxon(self.pointer(), tobytes(name), tobytes(rank_name), parent_taxid, min_taxid)
if taxid < 0 :
raise Exception("Error adding a new taxon to the taxonomy")
else :
return taxid
def close(self) :
if self.active() :
self._dms.unregister(self)
OBIWrapper.close(self)
if (obi_close_taxonomy(self.pointer()) < 0) :
raise Exception("Problem closing the taxonomy %s" %
self._name)
# name property getter
@property
def name(self):
return self._name
# ranks property getter
@property
def ranks(self):
return self._ranks
def parental_tree_iterator(self, int taxid):
"""
return parental tree for given taxonomic id starting from
first ancestor to the root.
"""
cdef Taxon taxon
try:
taxon = self.get_taxon_by_taxid(taxid)
except Exception as e:
print('\n'+e, file=sys.stderr)
return
if taxon is not None:
while taxon.taxid != 1:
yield taxon
#print(taxon.taxid)
taxon = taxon.parent
yield taxon
else:
return
def is_ancestor(self, int ancestor_taxid, int taxid):
return ancestor_taxid in [x.taxid for x in self.parental_tree_iterator(taxid)]
def last_common_taxon(self, *taxids):
cdef list t1
cdef list t2
cdef Taxon x
cdef int count
cdef int i
cdef int ancestor
if not taxids:
return None
if len(taxids)==1:
return taxids[0]
if len(taxids)==2:
t1 = [x.taxid for x in self.parental_tree_iterator(taxids[0])]
t2 = [x.taxid for x in self.parental_tree_iterator(taxids[1])]
t1.reverse()
t2.reverse()
count = min(len(t1),len(t2))
i=0
while(i < count and t1[i]==t2[i]):
i+=1
i-=1
return t1[i]
ancestor = taxids[0]
for taxon in taxids[1:]:
ancestor = self.last_common_taxon(ancestor, taxon)
return ancestor
cdef class Taxon : # TODO dict subclass?
def __init__(self, object taxon_capsule, Taxonomy tax) :
self._pointer = <ecotx_t*> PyCapsule_GetPointer(taxon_capsule, NULL)
if self._pointer == NULL :
raise Exception("Error reading a taxon (NULL pointer)")
self._tax = tax
# To test equality
def __richcmp__(self, Taxon taxon2, int op):
return (self.name == taxon2.name) and \
(self.taxid == taxon2.taxid) and \
(self.rank_idx == taxon2.rank_idx) and \
(self.farest == taxon2.farest) and \
(self.parent.taxid == taxon2.parent.taxid) and \
(self.preferred_name == taxon2.preferred_name)
# name property getter
@property
def name(self):
return self._pointer.name
# taxid property getter
@property
def taxid(self):
return self._pointer.taxid
# rank property getter
@property
def rank(self):
return ((self._tax)._ranks)[(self._pointer).rank]
# rank_idx property getter
@property
def rank_idx(self):
return (self._pointer).rank
# farest property getter
@property
def farest(self):
return self._pointer.farest
# parent property getter
@property
def parent(self):
cdef object parent_capsule
parent_capsule = PyCapsule_New(self._pointer.parent, NULL, NULL)
return Taxon(parent_capsule, self._tax)
# preferred name property getter and setter
@property
def preferred_name(self):
if self._pointer.preferred_name != NULL :
return bytes2str(self._pointer.preferred_name)
@preferred_name.setter
def preferred_name(self, str new_preferred_name) : # @DuplicatedSignature
if (obi_taxo_add_preferred_name_with_taxon(self._tax.pointer(), self._pointer, tobytes(new_preferred_name)) < 0) :
raise Exception("Error adding a new preferred name to a taxon")
def __repr__(self):
d = {}
d['taxid'] = self.taxid
d['name'] = self.name
d['rank'] = self.rank
d['rank_idx'] = self.rank_idx
d['preferred name'] = self.preferred_name
d['parent'] = self.parent.taxid
d['farest'] = self.farest
return str(d)
|