-
Notifications
You must be signed in to change notification settings - Fork 80
/
signature.py
339 lines (274 loc) · 9.44 KB
/
signature.py
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
#! /usr/bin/env python
"""
Save and load MinHash sketches in a JSON format, along with some metadata.
"""
from __future__ import print_function
import sys
import os
import weakref
from .logging import error
from . import MinHash
from ._minhash import to_bytes
from ._lowlevel import ffi, lib
from .utils import RustObject, rustcall, decode_str
SIGNATURE_VERSION = 0.4
class SourmashSignature(RustObject):
"Main class for signature information."
__dealloc_func__ = lib.signature_free
def __init__(self, minhash, name="", filename=""):
self._objptr = lib.signature_new()
if name:
self._name = name
if filename:
self.filename = filename
self.minhash = minhash
@property
def minhash(self):
return MinHash._from_objptr(
self._methodcall(lib.signature_first_mh)
)
@minhash.setter
def minhash(self, value):
# TODO: validate value is a MinHash
self._methodcall(lib.signature_set_mh, value._objptr)
def __hash__(self):
return hash(self.md5sum())
def __str__(self):
name = self.name()
md5pref = self.md5sum()[:8]
if name != md5pref:
return "SourmashSignature('{}', {})".format(name, md5pref)
return "SourmashSignature({})".format(md5pref)
__repr__ = __str__
#def minhashes(self):
# size = ffi.new("uintptr_t *")
# mhs_ptr = self._methodcall(lib.signature_get_mhs, size)
# size = ffi.unpack(size, 1)[0]
#
# mhs = []
# for i in range(size):
# mh = MinHash._from_objptr(mhs_ptr[i])
# mhs.append(mh)
#
# return mhs
def md5sum(self):
"Calculate md5 hash of the bottom sketch, specifically."
return decode_str(self.minhash._methodcall(lib.kmerminhash_md5sum), free=True)
def __eq__(self, other):
return self._methodcall(lib.signature_eq, other._objptr)
@property
def _name(self):
return decode_str(self._methodcall(lib.signature_get_name), free=True)
@_name.setter
def _name(self, value):
self._methodcall(lib.signature_set_name, to_bytes(value))
def __ne__(self, other):
return not self == other
def name(self):
"Return as nice a name as possible, defaulting to md5 prefix."
name = self._name
filename = self.filename
if name:
return name
elif filename:
return filename
else:
return self.md5sum()[:8]
@property
def filename(self):
return decode_str(self._methodcall(lib.signature_get_filename), free=True)
@filename.setter
def filename(self, value):
self._methodcall(lib.signature_set_filename, to_bytes(value))
@property
def license(self):
return decode_str(self._methodcall(lib.signature_get_license), free=True)
def _display_name(self, max_length):
name = self._name
filename = self.filename
if name:
if len(name) > max_length:
name = name[: max_length - 3] + "..."
elif filename:
name = filename
if len(name) > max_length:
name = "..." + name[-max_length + 3 :]
else:
name = self.md5sum()[:8]
assert len(name) <= max_length
return name
def similarity(self, other, ignore_abundance=False, downsample=False):
"Compute similarity with the other signature."
return self.minhash.similarity(other.minhash,
ignore_abundance=ignore_abundance,
downsample=downsample)
def jaccard(self, other):
"Compute Jaccard similarity with the other MinHash signature."
return self.minhash.similarity(other.minhash, ignore_abundance=True,
downsample=False)
def contained_by(self, other, downsample=False):
"Compute containment by the other signature. Note: ignores abundance."
return self.minhash.contained_by(other.minhash, downsample)
def add_sequence(self, sequence, force=False):
self._methodcall(lib.signature_add_sequence, to_bytes(sequence), force)
def add_protein(self, sequence):
self._methodcall(lib.signature_add_protein, to_bytes(sequence))
@staticmethod
def from_params(params):
ptr = rustcall(lib.signature_from_params, params._get_objptr())
return SourmashSignature._from_objptr(ptr)
def __len__(self):
return self._methodcall(lib.signature_len)
def __getstate__(self): # enable pickling
return (
self.minhash,
self._name,
self.filename,
)
def __setstate__(self, tup):
(mh, name, filename) = tup
self.__del__()
self._objptr = lib.signature_new()
if name:
self._name = name
if filename:
self.filename = filename
self.minhash = mh
def __reduce__(self):
return (
SourmashSignature,
(
self.minhash,
self._name,
self.filename
),
)
def load_signatures(
data, ksize=None, select_moltype=None, ignore_md5sum=False, do_raise=False,
quiet=False
):
"""Load a JSON string with signatures into classes.
Returns list of SourmashSignature objects.
Note, the order is not necessarily the same as what is in the source file.
"""
if ksize:
ksize = int(ksize)
if not data:
return
is_fp = False
is_filename = False
is_fobj = False
if hasattr(data, "fileno"):
is_fp = True
elif os.path.exists(data): # filename
is_filename = True
elif hasattr(data, "mode"): # file object-like
is_fobj = True
if "t" in data.mode: # need to reopen handler as binary
if sys.version_info >= (3,):
data = data.buffer
elif hasattr(data, "find") and data.find("sourmash_signature") > 0:
# json string containing the data
if hasattr(data, "encode"):
data = data.encode("utf-8")
else:
if do_raise:
raise ValueError("Can't parse data. No such file or invalid data.")
return
if ksize is None:
ksize = 0
if select_moltype is None:
select_moltype = ffi.NULL
else:
try:
select_moltype = select_moltype.encode("utf-8")
except AttributeError:
pass
size = ffi.new("uintptr_t *")
try:
# JSON format
if is_filename:
sigs_ptr = rustcall(
lib.signatures_load_path,
data.encode("utf-8"),
ignore_md5sum,
ksize,
select_moltype,
size,
)
else:
if is_fp or is_fobj:
# TODO: we still can't pass a file-like object to rust...
try:
buf = data.read()
is_fp = False
is_fobj = False
data.close()
data = buf
except AttributeError:
pass
if hasattr(data, "encode"):
data = data.encode("utf-8")
# TODO: use ffi.cast in the future?
# fp_c = ffi.cast("FILE *", data)
# sigs_ptr = rustcall(lib.signatures_load_file, fp_c, ignore_md5sum, size)
sigs_ptr = rustcall(
lib.signatures_load_buffer,
data,
len(data),
ignore_md5sum,
ksize,
select_moltype,
size,
)
size = ffi.unpack(size, 1)[0]
sigs = []
for i in range(size):
sig = SourmashSignature._from_objptr(sigs_ptr[i])
sigs.append(sig)
for sig in sigs:
yield sig
except Exception as e:
if not quiet:
error("Error in parsing signature; quitting.")
error("Exception: {}", str(e))
if do_raise:
raise
finally:
if is_fp or is_fobj:
data.close()
def load_one_signature(data, ksize=None, select_moltype=None, ignore_md5sum=False):
sigiter = load_signatures(
data, ksize=ksize, select_moltype=select_moltype, ignore_md5sum=ignore_md5sum
)
try:
first_sig = next(sigiter)
except StopIteration:
raise ValueError("no signatures to load")
try:
next(sigiter)
except StopIteration:
return first_sig
raise ValueError("expected to load exactly one signature")
def save_signatures(siglist, fp=None):
"Save multiple signatures into a JSON string (or into file handle 'fp')"
attached_refs = weakref.WeakKeyDictionary()
collected = []
for obj in siglist:
rv = obj._get_objptr()
attached_refs[rv] = obj
collected.append(rv)
siglist_c = ffi.new("Signature*[]", collected)
if fp is None:
buf = rustcall(lib.signatures_save_buffer, siglist_c, len(collected))
return decode_str(buf, free=True)
else:
# fp_c = ffi.cast("FILE *", fp)
# buf = rustcall(lib.signatures_save_file, siglist_c, len(collected), fp_c)
buf = rustcall(lib.signatures_save_buffer, siglist_c, len(collected))
result = decode_str(buf, free=True)
try:
fp.write(result)
except TypeError:
fp.write(result.encode('utf-8'))
return None