-
Notifications
You must be signed in to change notification settings - Fork 21
/
backend.py
863 lines (737 loc) · 30.9 KB
/
backend.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
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
import base64
import collections
import datetime
import os
import re
import sys
import time
import h5py
from twisted.internet import reactor
try:
import numpy as np
use_numpy = True
except ImportError, e:
print e
print "Numpy not imported. The DataVault will operate, but will be slower."
use_numpy = False
from labrad import types as T
from . import errors, util
## Data types for variable defintions
Independent = collections.namedtuple('Independent', ['label', 'shape', 'datatype', 'unit'])
Dependent = collections.namedtuple('Dependent', ['label', 'legend', 'shape', 'datatype', 'unit'])
TIME_FORMAT = '%Y-%m-%d, %H:%M:%S'
PRECISION = 12 # digits of precision to use when saving data
DATA_FORMAT = '%%.%dG' % PRECISION
FILE_TIMEOUT_SEC = 60 # how long to keep datafiles open if not accessed
DATA_TIMEOUT = 300 # how long to keep data in memory if not accessed
DATA_URL_PREFIX = 'data:application/labrad;base64,'
def time_to_str(t):
return t.strftime(TIME_FORMAT)
def time_from_str(s):
return datetime.datetime.strptime(s, TIME_FORMAT)
def labrad_urlencode(data):
if hasattr(T, 'FlatData'):
# pylabrad 0.95+
flat_data = T.flatten(data)
flat_cluster = T.flatten((str(flat_data.tag), flat_data.bytes), 'sy')
all_bytes = flat_cluster.bytes
else:
data_bytes, t = T.flatten(data)
all_bytes, _ = T.flatten((str(t), data_bytes), 'ss')
data_url = DATA_URL_PREFIX + base64.urlsafe_b64encode(all_bytes)
return data_url
def labrad_urldecode(data_url):
if data_url.startswith(DATA_URL_PREFIX):
# decode parameter data from dataurl
all_bytes = base64.urlsafe_b64decode(data_url[len(DATA_URL_PREFIX):])
t, data_bytes = T.unflatten(all_bytes, 'ss')
data = T.unflatten(data_bytes, t)
return data
else:
raise ValueError("Trying to labrad_urldecode data that doesn't start "
"with prefix: {}".format(DATA_URL_PREFIX))
class SelfClosingFile(object):
"""A container for a file object that manages the underlying file handle.
The file will be opened on demand when this container is called, then
closed automatically if not accessed within a specified timeout.
"""
def __init__(self, opener=open, open_args=(), open_kw={},
timeout=FILE_TIMEOUT_SEC, touch=True, reactor=reactor):
self.opener = opener
self.open_args = open_args
self.open_kw = open_kw
self.timeout = timeout
self.callbacks = []
self.reactor = reactor
if touch:
self.__call__()
def __call__(self):
if not hasattr(self, '_file'):
self._file = self.opener(*self.open_args, **self.open_kw)
self._fileTimeoutCall = self.reactor.callLater(
self.timeout, self._fileTimeout)
else:
self._fileTimeoutCall.reset(self.timeout)
return self._file
def _fileTimeout(self):
for callback in self.callbacks:
callback(self)
self._file.close()
del self._file
del self._fileTimeoutCall
def size(self):
return os.fstat(self().fileno()).st_size
def onClose(self, callback):
"""Calls callback *before* the file is closes."""
self.callbacks.append(callback)
class IniData(object):
"""Handles dataset metadata stored in INI files.
This is used via subclassing mostly out of laziness: this was the
easy way to separate it from the code that messes with the acutal
data storage so that the data storage can be modified to use HDF5
and complex data structures. Once the HDF5 stuff is finished,
this can be changed to use composition rather than inheritance.
This provides the load() and save() methods to read and write the
INI file as well as accessors for all the metadata attributes.
"""
def load(self):
S = util.DVSafeConfigParser()
S.read(self.infofile)
gen = 'General'
self.title = S.get(gen, 'Title', raw=True)
self.created = time_from_str(S.get(gen, 'Created'))
self.accessed = time_from_str(S.get(gen, 'Accessed'))
self.modified = time_from_str(S.get(gen, 'Modified'))
def getInd(i):
sec = 'Independent {}'.format(i+1)
label = S.get(sec, 'Label', raw=True)
units = S.get(sec, 'Units', raw=True)
return Independent(label=label, shape=(1,), datatype='v', unit=units)
count = S.getint(gen, 'Independent')
self.independents = [getInd(i) for i in range(count)]
def getDep(i):
sec = 'Dependent {}'.format(i+1)
label = S.get(sec, 'Label', raw=True)
units = S.get(sec, 'Units', raw=True)
categ = S.get(sec, 'Category', raw=True)
return Dependent(label=categ, legend=label, shape=(1,), datatype='v', unit=units)
count = S.getint(gen, 'Dependent')
self.dependents = [getDep(i) for i in range(count)]
self.cols = len(self.independents + self.dependents)
def getPar(i):
sec = 'Parameter {}'.format(i+1)
label = S.get(sec, 'Label', raw=True)
raw = S.get(sec, 'Data', raw=True)
if raw.startswith(DATA_URL_PREFIX):
# decode parameter data from dataurl
data = labrad_urldecode(raw)
else:
# old parameters may have been saved using repr
try:
data = T.evalLRData(raw)
except RuntimeError:
# This is a hack to parse some very old data that seems to
# have been created by converting delphi data to python
# format. '1.#IND' was produced by old versions of the
# delphi labrad api when stringifying NaN.
if '1.#IND' in raw:
data = T.evalLRData(raw.replace('1.#IND', 'nan'))
else:
raise Exception('unable to parse parameter {}: {}'.format(label, raw))
return dict(label=label, data=data)
count = S.getint(gen, 'Parameters')
self.parameters = [getPar(i) for i in range(count)]
# get comments if they're there
if S.has_section('Comments'):
def getComment(i):
sec = 'Comments'
time, user, comment = eval(S.get(sec, 'c{}'.format(i), raw=True))
return time_from_str(time), user, comment
count = S.getint(gen, 'Comments')
self.comments = [getComment(i) for i in range(count)]
else:
self.comments = []
def save(self):
S = util.DVSafeConfigParser()
sec = 'General'
S.add_section(sec)
S.set(sec, 'Created', time_to_str(self.created))
S.set(sec, 'Accessed', time_to_str(self.accessed))
S.set(sec, 'Modified', time_to_str(self.modified))
S.set(sec, 'Title', self.title)
S.set(sec, 'Independent', repr(len(self.independents)))
S.set(sec, 'Dependent', repr(len(self.dependents)))
S.set(sec, 'Parameters', repr(len(self.parameters)))
S.set(sec, 'Comments', repr(len(self.comments)))
for i, ind in enumerate(self.independents):
sec = 'Independent {}'.format(i+1)
S.add_section(sec)
S.set(sec, 'Label', ind.label)
S.set(sec, 'Units', ind.unit)
for i, dep in enumerate(self.dependents):
sec = 'Dependent {}'.format(i+1)
S.add_section(sec)
S.set(sec, 'Label', dep.legend)
S.set(sec, 'Units', dep.unit)
S.set(sec, 'Category', dep.label)
for i, par in enumerate(self.parameters):
sec = 'Parameter {}'.format(i+1)
S.add_section(sec)
S.set(sec, 'Label', par['label'])
# encode the parameter value as a data-url
data_url = labrad_urlencode(par['data'])
S.set(sec, 'Data', data_url)
sec = 'Comments'
S.add_section(sec)
for i, (time, user, comment) in enumerate(self.comments):
time = time_to_str(time)
S.set(sec, 'c{}'.format(i), repr((time, user, comment)))
with open(self.infofile, 'w') as f:
S.write(f)
def initialize_info(self, title, indep, dep):
self.title = title
self.accessed = self.modified = self.created = datetime.datetime.now()
self.independents = indep
self.dependents = dep
self.parameters = []
self.comments = []
self.cols = len(indep) + len(dep)
@property
def dtype(self):
return np.dtype(','.join(['f8']*self.cols))
def access(self):
self.accessed = datetime.datetime.now()
def getIndependents(self):
return self.independents
def getDependents(self):
return self.dependents
def getRowType(self):
units = []
for var in self.independents + self.dependents:
units.append('v[{}]'.format(var.unit))
type_tag = '*({})'.format(','.join(units))
return type_tag
def getTransposeType(self):
units = []
for var in self.independents + self.dependents:
units.append('*v[{}]'.format(var.unit))
type_tag = '({})'.format(','.join(units))
return type_tag
def addParam(self, name, data):
for p in self.parameters:
if p['label'] == name:
raise errors.ParameterInUseError(name)
d = dict(label=name, data=data)
self.parameters.append(d)
def getParameter(self, name, case_sensitive=True):
for p in self.parameters:
if case_sensitive:
if p['label'] == name:
return p['data']
else:
if p['label'].lower() == name.lower():
return p['data']
raise errors.BadParameterError(name)
def getParamNames(self):
return [p['label'] for p in self.parameters]
def addComment(self, user, comment):
self.comments.append((datetime.datetime.now(), user, comment))
def getComments(self, limit, start):
if limit is None:
comments = self.comments[start:]
else:
comments = self.comments[start:start+limit]
return comments, start + len(comments)
def numComments(self):
return len(self.comments)
class CsvListData(IniData):
"""Data backed by a csv-formatted file.
Stores the entire contents of the file in memory as a list or numpy array
"""
def __init__(self,
filename,
file_timeout=FILE_TIMEOUT_SEC,
data_timeout=DATA_TIMEOUT,
reactor=reactor):
self.filename = filename
self._file = SelfClosingFile(open_args=(filename, 'a+'),
timeout=file_timeout,
reactor=reactor)
self.timeout = data_timeout
self.infofile = filename[:-4] + '.ini'
self.reactor = reactor
@property
def file(self):
return self._file()
@property
def version(self):
return np.asarray([1,0,0], np.int32)
@property
def data(self):
"""Read data from file on demand.
The data is scheduled to be cleared from memory unless accessed."""
if not hasattr(self, '_data'):
self._data = []
self._datapos = 0
self._timeout_call = self.reactor.callLater(self.timeout,
self._on_timeout)
else:
self._timeout_call.reset(DATA_TIMEOUT)
f = self.file
f.seek(self._datapos)
lines = f.readlines()
self._data.extend([float(n) for n in line.split(',')] for line in lines)
self._datapos = f.tell()
return self._data
def _on_timeout(self):
del self._data
del self._datapos
del self._timeout_call
def _saveData(self, data):
f = self.file
for row in data:
# always save with dos linebreaks
f.write(', '.join(DATA_FORMAT % v for v in row) + '\r\n')
f.flush()
def addData(self, data):
if not len(data) or not isinstance(data[0], list):
data = [data]
if len(data[0]) != self.cols:
raise errors.BadDataError(self.cols, len(data[0]))
# append the data to the file
self._saveData(data)
def getData(self, limit, start, transpose, simpleOnly):
if transpose:
raise RuntimeError("Transpose specified for simple data format: not supported")
if limit is None:
data = self.data[start:]
else:
data = self.data[start:start+limit]
return data, start + len(data)
def hasMore(self, pos):
return pos < len(self.data)
class CsvNumpyData(CsvListData):
"""Data backed by a csv-formatted file.
Stores the entire contents of the file in memory as a list or numpy array
"""
def __init__(self, filename, reactor=reactor):
self.filename = filename
self._file = SelfClosingFile(open_args=(filename, 'a+'), reactor=reactor)
self.infofile = filename[:-4] + '.ini'
self.reactor = reactor
@property
def file(self):
return self._file()
def _get_data(self):
"""Read data from file on demand.
The data is scheduled to be cleared from memory unless accessed."""
if not hasattr(self, '_data'):
try:
# if the file is empty, this line can barf in certain versions
# of numpy. Clearly, if the file does not exist on disk, this
# will be the case. Even if the file exists on disk, we must
# check its size
if self._file.size() > 0:
self.file.seek(0)
self._data = np.loadtxt(self.file, delimiter=',')
else:
self._data = np.array([[]])
if len(self._data.shape) == 1:
self._data.shape = (1, len(self._data))
except ValueError:
# no data saved yet
# this error is raised by numpy <=1.2
self._data = np.array([[]])
except IOError:
# no data saved yet
# this error is raised by numpy 1.3
self.file.seek(0)
self._data = np.array([[]])
self._timeout_call = self.reactor.callLater(DATA_TIMEOUT, self._on_timeout)
else:
self._timeout_call.reset(DATA_TIMEOUT)
return self._data
def _set_data(self, data):
self._data = data
data = property(_get_data, _set_data)
def _on_timeout(self):
del self._data
del self._timeout_call
def _saveData(self, data):
f = self.file
# always save with dos linebreaks (requires numpy 1.5.0 or greater)
np.savetxt(f, data, fmt=DATA_FORMAT, delimiter=',', newline='\r\n')
f.flush()
def addData(self, data):
# check row length
if len(data[0]) != self.cols:
raise errors.BadDataError(self.cols, len(data[0]))
# Ordinarily, we are using record arrays, but for numpy savetxt we want a 2-D array
record_data = util.from_record_array(data)
# append data to in-memory data
if self.data.size > 0:
self.data = np.vstack((self.data, record_data))
else:
self.data = record_data
# append data to file
self._saveData(data)
def getData(self, limit, start, transpose, simpleOnly):
if transpose:
raise RuntimeError("Transpose specified for simple data format: not supported")
if limit is None:
data = self.data[start:]
else:
data = self.data[start:start+limit]
# nrows should be zero for an empty row
nrows = len(data) if data.size > 0 else 0
return data, start + nrows
def hasMore(self, pos):
# cheesy hack: if pos == 0, we only need to check whether
# the filesize is nonzero
if pos == 0:
return os.path.getsize(self.filename) > 0
else:
nrows = len(self.data) if self.data.size > 0 else 0
return pos < nrows
class HDF5MetaData(object):
"""Class to store metadata inside the file itself.
Like IniData, use this by subclassing. I anticipate simply moving
this code into the HDF5Dataset class once it is working, since we
don't plan to support accessing HDF5 datasets with INI files once
this version works.
"""
comment_type = [
('Timestamp', np.float64),
('User', h5py.special_dtype(vlen=str)),
('Comment', h5py.special_dtype(vlen=str))
]
def load(self):
"""Load and save do nothing because HDF5 metadata is accessed live"""
pass
def save(self):
"""Load and save do nothing because HDF5 metadata is accessed live"""
pass
@property
def dtype(self):
return self.dataset.dtype
def initialize_info(self, title, indep, dep):
"""Initializes the metadata for a newly created dataset."""
t = time.time()
attrs = self.dataset.attrs
attrs['Title'] = title
attrs['Access Time'] = t
attrs['Modification Time'] = t
attrs['Creation Time'] = t
attrs['Comments'] = np.ndarray((0,), dtype=self.comment_type)
for idx, i in enumerate(indep):
prefix = 'Independent{}.'.format(idx)
attrs[prefix + 'label'] = i.label
attrs[prefix + 'shape'] = i.shape
attrs[prefix + 'datatype'] = i.datatype
attrs[prefix + 'unit'] = i.unit
for idx, d, in enumerate(dep):
prefix = 'Dependent{}.'.format(idx)
attrs[prefix + 'label'] = d.label
attrs[prefix + 'legend'] = d.legend
attrs[prefix + 'shape'] = d.shape
attrs[prefix + 'datatype'] = d.datatype
attrs[prefix + 'unit'] = d.unit
def access(self):
self.dataset.attrs['Access Time'] = time.time()
def getIndependents(self):
attrs = self.dataset.attrs
rv = []
for idx in xrange(sys.maxint):
prefix = 'Independent{}.'.format(idx)
key = prefix + 'label'
if key in attrs:
label = attrs[prefix + 'label']
shape = attrs[prefix + 'shape']
datatype = attrs[prefix + 'datatype']
unit = attrs[prefix + 'unit']
rv.append(Independent(label, shape, datatype, unit))
else:
return rv
def getDependents(self):
attrs = self.dataset.attrs
rv = []
for idx in xrange(sys.maxint):
prefix = 'Dependent{}.'.format(idx)
key = prefix + 'label'
if key in attrs:
label = attrs[prefix + 'label']
legend = attrs[prefix + 'legend']
shape = attrs[prefix + 'shape']
datatype = attrs[prefix + 'datatype']
unit = attrs[prefix + 'unit']
rv.append(Dependent(label, legend, shape, datatype, unit))
else:
return rv
def getRowType(self):
column_types = []
for col in self.getIndependents() + self.getDependents():
base_type = col.datatype
if base_type in ['v', 'c']:
unit_tag = '[{}]'.format(col.unit)
else:
unit_tag = ''
if len(col.shape) > 1:
shape_tag = '*{}'.format(len(col.shape))
comment = util.braced(','.join(str(s) for s in col.shape))
elif col.shape[0] > 1:
shape_tag = '*'
comment = util.braced(str(col.shape[0]))
else:
shape_tag = ''
comment = ''
column_types.append(shape_tag + base_type + unit_tag + comment)
type_tag = '*({})'.format(','.join(column_types))
return type_tag
def getTransposeType(self):
column_type = []
for col in self.getIndependents() + self.getDependents():
base_type = col.datatype
if base_type in ['v', 'c']:
unit_tag = '[{}]'.format(col.unit)
else:
unit_tag = ''
if len(col.shape) > 1:
shape_tag = '*{}'.format(len(col.shape) + 1)
comment = util.braced('N,' + ','.join(str(s) for s in col.shape))
elif col.shape[0] > 1:
shape_tag = '*2'
comment = util.braced('N,' + str(col.shape[0]))
else:
shape_tag = '*'
comment = ''
column_type.append(shape_tag + base_type + unit_tag + comment)
type_tag = '({})'.format(','.join(column_type))
return type_tag
def addParam(self, name, data):
keyname = 'Param.{}'.format(name)
if keyname in self.dataset.attrs:
raise errors.ParameterInUseError(name)
value = labrad_urlencode(data)
self.dataset.attrs[keyname] = value
def getParameter(self, name, case_sensitive=True):
"""Get a parameter from the dataset."""
keyname = 'Param.{}'.format(name)
if case_sensitive:
if keyname in self.dataset.attrs:
return labrad_urldecode(self.dataset.attrs[keyname])
else:
for k in self.dataset.attrs:
if k.lower() == keyname.lower():
return labrad_urldecode(self.dataset.attrs[k])
raise errors.BadParameterError(name)
def getParamNames(self):
"""Get the names of all dataset parameters.
Parameter names in the HDF5 file are prefixed with 'Param.' to avoid
conflicts with the other metadata.
"""
names = [str(k[6:]) for k in self.dataset.attrs if k.startswith('Param.')]
return names
def addComment(self, user, comment):
"""Add a comment to the dataset."""
t = time.time()
new_comment = np.array([(t, user, comment)], dtype=self.comment_type)
old_comments = self.dataset.attrs['Comments']
data = np.hstack((old_comments, new_comment))
self.dataset.attrs.create('Comments', data, dtype=self.comment_type)
def getComments(self, limit, start):
"""Get comments in [(datetime, username, comment), ...] format."""
if limit is None:
raw_comments = self.dataset.attrs['Comments'][start:]
else:
raw_comments = self.dataset.attrs['Comments'][start:start+limit]
comments = [(datetime.datetime.fromtimestamp(c[0]), str(c[1]), str(c[2])) for c in raw_comments]
return comments, start+len(comments)
def numComments(self):
return len(self.dataset.attrs['Comments'])
class ExtendedHDF5Data(HDF5MetaData):
"""Dataset backed by HDF5 file
This supports the extended dataset format which allows each column
to have a different type and to be arrays themselves.
"""
def __init__(self, fh):
self._file = fh
if 'Version' not in self.file.attrs:
self.file.attrs['Version'] = np.asarray([3, 0, 0], dtype=np.int32)
self.version = np.asarray(self.file.attrs['Version'], np.int32)
def initialize_info(self, title, indep, dep):
"""Initialize the columns when creating a new dataset"""
dtype = []
for idx, col in enumerate(indep + dep):
shape = col.shape
ttag = col.datatype
unit = col.unit
if len(shape) == 1 and shape[0] == 1:
shapestr = ''
else:
shapestr = str(tuple(shape))
varname = 'f{}'.format(idx)
if unit != '' and ttag not in ['v', 'c']:
raise RuntimeError('Unit {} specfied for datatype {}. Only v and c may have units'.format(unit, ttag))
if ttag == 'i':
dtype.append((varname, shapestr + 'i4'))
elif ttag == 's':
if shapestr:
raise ValueError("Cannot create string array column")
dtype.append((varname, h5py.special_dtype(vlen=str)))
elif ttag == 't':
dtype.append((varname, shapestr + 'i8'))
elif ttag == 'v':
dtype.append((varname, shapestr + 'f8'))
elif ttag == 'c':
dtype.append((varname, shapestr + 'c16'))
else:
raise RuntimeError("Invalid type tag {}".format(ttag))
self.file.create_dataset('DataVault', (0,), dtype=dtype, maxshape=(None,))
HDF5MetaData.initialize_info(self, title, indep, dep)
@property
def file(self):
return self._file()
@property
def dataset(self):
return self.file["DataVault"]
def addData(self, data):
"""Adds one or more rows or data from a numpy struct array."""
new_rows = len(data)
old_rows = self.dataset.shape[0]
self.dataset.resize((old_rows + new_rows,))
self.dataset[old_rows:(old_rows + new_rows)] = data
def getData(self, limit, start, transpose, simpleOnly):
"""Get up to limit rows from a dataset."""
if simpleOnly:
datatype = self.dataset.dtype
for idx in range(len(datatype)):
if datatype[idx] != np.float64:
raise errors.DataVersionMismatchError()
if transpose:
return self.getDataTranspose(limit, start)
data, new_pos = self._getData(limit, start)
row_data = [tuple(row) for row in data]
return row_data, new_pos
def getDataTranspose(self, limit, start):
struct_data, new_pos = self._getData(limit, start)
columns = []
for idx in range(len(struct_data.dtype)):
col = struct_data['f{}'.format(idx)]
# Strings are stored as hdf5 vlen objects. Numpy can't do
# variable length strings, so they get encoded as object
# arrays by hdf5. we don't know how to flatten object
# arrays so we special case vlen types here and convert
# them to lists. Also, h5py has a bug where when you
# index a dataset with a compound type, it loses the
# special dtype information, so we pull it directly from
# self.dataset.dtype rather than the data returned by
# _getData
if self.dataset.dtype[idx] == np.object:
base_type = h5py.check_dtype(vlen=self.dataset.dtype[idx])
if not base_type or not issubclass(base_type, str):
raise RuntimeError("Found object type array, but not vlen str. Not supported. This shouldn't happen")
col = [base_type(x) for x in col]
columns.append(col)
columns = tuple(columns)
return columns, new_pos
def _getData(self, limit, start):
if limit is None:
struct_data = self.dataset[start:]
else:
struct_data = self.dataset[start:start+limit]
return struct_data, start + struct_data.shape[0]
def __len__(self):
return self.dataset.shape[0]
def hasMore(self, pos):
return pos < len(self)
class SimpleHDF5Data(HDF5MetaData):
"""Basic dataset backed by HDF5 file.
This is a very simple implementation that only supports a single 2-D dataset
of all floats. HDF5 files support multiple types, multiple dimensions, and
a filesystem-like tree of datasets within one file. Here, the single dataset
is stored in /DataVault within the HDF5 file.
"""
def __init__(self, fh):
self._file = fh
if 'Version' not in self.file.attrs:
self.file.attrs['Version'] = np.asarray([2, 0, 0], dtype=np.int32)
self.version = np.asarray(self.file.attrs['Version'], dtype=np.int32)
def initialize_info(self, title, indep, dep):
ncol = len(indep) + len(dep)
dtype = [('f{}'.format(idx), np.float64) for idx in range(ncol)]
if 'DataVault' not in self.file:
self.file.create_dataset('DataVault', (0,), dtype=dtype, maxshape=(None,))
HDF5MetaData.initialize_info(self, title, indep, dep)
@property
def file(self):
return self._file()
@property
def dataset(self):
return self.file["DataVault"]
def addData(self, data):
"""Adds one or more rows or data from a 2D array of floats."""
new_rows = data.shape[0]
old_rows = self.dataset.shape[0]
#if data.shape[1] != len(self.dataset.dtype):
# raise errors.BadDataError(len(self.dataset.dtype), data.shape[1])
self.dataset.resize((old_rows + new_rows,))
#new_data = np.zeros((new_rows,), dtype=self.dataset.dtype)
#for col in range(data.shape[1]):
# field = "f%d" % (col,)
# new_data[field] = data[:,col]
self.dataset[old_rows:(old_rows + new_rows)] = data
def getData(self, limit, start, transpose, simpleOnly):
"""Get up to limit rows from a dataset."""
if transpose:
raise RuntimeError("Transpose specified for simple data format: not supported")
if limit is None:
struct_data = self.dataset[start:]
else:
struct_data = self.dataset[start:start+limit]
columns = []
for idx in range(len(struct_data.dtype)):
columns.append(struct_data['f{}'.format(idx)])
data = np.column_stack(columns)
return data, start + data.shape[0]
def __len__(self):
return self.dataset.shape[0]
def hasMore(self, pos):
return pos < len(self)
def open_hdf5_file(filename):
"""Factory for HDF5 files.
We check the version of the file to construct the proper class. Currently, only two
options exist: version 2.0.0 -> legacy format, 3.0.0 -> extended format.
Version 1 is reserved for CSV files.
"""
fh = SelfClosingFile(h5py.File, open_args=(filename, 'a'))
version = fh().attrs['Version']
if version[0] == 2:
return SimpleHDF5Data(fh)
else:
return ExtendedHDF5Data(fh)
def create_backend(filename, title, indep, dep, extended):
hdf5_file = filename + '.hdf5'
fh = SelfClosingFile(h5py.File, open_args=(hdf5_file, 'a'))
if extended:
data = ExtendedHDF5Data(fh)
else:
data = SimpleHDF5Data(fh)
data.initialize_info(title, indep, dep)
return data
def open_backend(filename):
"""Make a data object that manages in-memory and on-disk storage for a dataset.
filename should be specified without a file extension. If there is an existing
file in csv format, we create a backend of the appropriate type. If
no file exists, we create a new backend to store data in binary form.
"""
csv_file = filename + '.csv'
hdf5_file = filename + '.hdf5'
if os.path.exists(csv_file):
if use_numpy:
return CsvNumpyData(csv_file)
else:
return CsvListData(csv_file)
elif os.path.exists(hdf5_file):
return open_hdf5_file(hdf5_file)
else: # We should have already checked, this should not happen
raise errors.DatasetNotFoundError(filename)