-
Notifications
You must be signed in to change notification settings - Fork 191
Expand file tree
/
Copy pathmethods.py
More file actions
1376 lines (1163 loc) · 45.4 KB
/
methods.py
File metadata and controls
1376 lines (1163 loc) · 45.4 KB
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
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import annotations
import warnings
from collections.abc import Mapping
from copy import copy
from functools import partial
from itertools import product
from types import MappingProxyType
from typing import TYPE_CHECKING
from warnings import warn
import h5py
import numpy as np
import pandas as pd
from packaging.version import Version
from scipy import sparse
import anndata as ad
from anndata import AnnData, Raw
from anndata._core import views
from anndata._core.index import _normalize_indices
from anndata._core.merge import intersect_keys
from anndata._core.sparse_dataset import _CSCDataset, _CSRDataset, sparse_dataset
from anndata._io.utils import H5PY_V3, check_key, zero_dim_array_as_scalar
from anndata._warnings import OldFormatWarning
from anndata.compat import (
NULLABLE_NUMPY_STRING_TYPE,
AwkArray,
CupyArray,
CupyCSCMatrix,
CupyCSRMatrix,
DaskArray,
H5Array,
H5File,
H5Group,
ZarrArray,
ZarrGroup,
_decode_structured_array,
_from_fixed_length_strings,
_read_attr,
_require_group_write_dataframe,
)
from ..._settings import settings
from ...compat import is_zarr_v2
from .registry import _REGISTRY, IOSpec, read_elem, read_elem_partial
if TYPE_CHECKING:
from collections.abc import Callable, Iterator
from os import PathLike
from typing import Any, Literal
from numpy import typing as npt
from numpy.typing import NDArray
from anndata._types import ArrayStorageType, GroupStorageType
from anndata.compat import CSArray, CSMatrix
from anndata.typing import AxisStorable, InMemoryArrayOrScalarType
from .registry import Reader, Writer
####################
# Dask utils #
####################
try:
from dask.utils import SerializableLock as Lock
except ImportError:
from threading import Lock
# to fix https://github.com/dask/distributed/issues/780
GLOBAL_LOCK = Lock()
####################
# Dispatch methods #
####################
# def is_full_slice(idx):
# if isinstance(idx, tuple)len(idx) == 1:
# if isinstance(idx, type(None)):
# return True
# elif idx is Ellipsis:
# return True
# elif isinstance(idx, tuple):
# for el in idx:
# if isinstance(el, type(None)):
# pass
# elif isinstance(el, slice):
# if el != slice(None):
# return False
# else:
# return False
# return True
# return False
def zarr_v3_compressor_compat(dataset_kwargs) -> dict:
if not is_zarr_v2() and (compressor := dataset_kwargs.pop("compressor", None)):
dataset_kwargs["compressors"] = compressor
return dataset_kwargs
def _to_cpu_mem_wrapper(write_func):
"""
Wrapper to bring cupy types into cpu memory before writing.
Ideally we do direct writing at some point.
"""
def wrapper(
f,
k,
cupy_val: CupyArray | CupyCSCMatrix | CupyCSRMatrix,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
return write_func(
f, k, cupy_val.get(), _writer=_writer, dataset_kwargs=dataset_kwargs
)
return wrapper
################################
# Fallbacks / backwards compat #
################################
# Note: there is no need for writing in a backwards compatible format, maybe
@_REGISTRY.register_read(H5File, IOSpec("", ""))
@_REGISTRY.register_read(H5Group, IOSpec("", ""))
@_REGISTRY.register_read(H5Array, IOSpec("", ""))
def read_basic(
elem: H5File | H5Group | H5Array, *, _reader: Reader
) -> dict[str, InMemoryArrayOrScalarType] | npt.NDArray | CSMatrix | CSArray:
from anndata._io import h5ad
warn(
f"Element '{elem.name}' was written without encoding metadata.",
OldFormatWarning,
stacklevel=3,
)
if isinstance(elem, Mapping):
# Backwards compat sparse arrays
if "h5sparse_format" in elem.attrs:
return sparse_dataset(elem).to_memory()
return {k: _reader.read_elem(v) for k, v in dict(elem).items()}
elif isinstance(elem, h5py.Dataset):
return h5ad.read_dataset(elem) # TODO: Handle legacy
@_REGISTRY.register_read(ZarrGroup, IOSpec("", ""))
@_REGISTRY.register_read(ZarrArray, IOSpec("", ""))
def read_basic_zarr(
elem: ZarrGroup | ZarrArray, *, _reader: Reader
) -> dict[str, InMemoryArrayOrScalarType] | npt.NDArray | CSMatrix | CSArray:
from anndata._io import zarr
warn(
f"Element '{elem.name}' was written without encoding metadata.",
OldFormatWarning,
stacklevel=3,
)
if isinstance(elem, ZarrGroup):
# Backwards compat sparse arrays
if "h5sparse_format" in elem.attrs:
return sparse_dataset(elem).to_memory()
return {k: _reader.read_elem(v) for k, v in dict(elem).items()}
elif isinstance(elem, ZarrArray):
return zarr.read_dataset(elem) # TODO: Handle legacy
# @_REGISTRY.register_read_partial(IOSpec("", ""))
# def read_basic_partial(elem, *, items=None, indices=(slice(None), slice(None))):
# if isinstance(elem, Mapping):
# return _read_partial(elem, items=items, indices=indices)
# elif indices != (slice(None), slice(None)):
# return elem[indices]
# else:
# return elem[()]
###########
# AnnData #
###########
def read_indices(group):
obs_group = group["obs"]
obs_idx_elem = obs_group[_read_attr(obs_group.attrs, "_index")]
obs_idx = read_elem(obs_idx_elem)
var_group = group["var"]
var_idx_elem = var_group[_read_attr(var_group.attrs, "_index")]
var_idx = read_elem(var_idx_elem)
return obs_idx, var_idx
def read_partial( # noqa: PLR0913
pth: PathLike[str] | str,
*,
obs_idx=slice(None),
var_idx=slice(None),
X=True,
obs=None,
var=None,
obsm=None,
varm=None,
obsp=None,
varp=None,
layers=None,
uns=None,
) -> ad.AnnData:
result = {}
with h5py.File(pth, "r") as f:
obs_idx, var_idx = _normalize_indices((obs_idx, var_idx), *read_indices(f))
result["obs"] = read_elem_partial(
f["obs"], items=obs, indices=(obs_idx, slice(None))
)
result["var"] = read_elem_partial(
f["var"], items=var, indices=(var_idx, slice(None))
)
if X:
result["X"] = read_elem_partial(f["X"], indices=(obs_idx, var_idx))
else:
result["X"] = sparse.csr_matrix((len(result["obs"]), len(result["var"])))
if "obsm" in f:
result["obsm"] = _read_partial(
f["obsm"], items=obsm, indices=(obs_idx, slice(None))
)
if "varm" in f:
result["varm"] = _read_partial(
f["varm"], items=varm, indices=(var_idx, slice(None))
)
if "obsp" in f:
result["obsp"] = _read_partial(
f["obsp"], items=obsp, indices=(obs_idx, obs_idx)
)
if "varp" in f:
result["varp"] = _read_partial(
f["varp"], items=varp, indices=(var_idx, var_idx)
)
if "layers" in f:
result["layers"] = _read_partial(
f["layers"], items=layers, indices=(obs_idx, var_idx)
)
if "uns" in f:
result["uns"] = _read_partial(f["uns"], items=uns)
return ad.AnnData(**result)
def _read_partial(group, *, items=None, indices=(slice(None), slice(None))):
if group is None:
return None
keys = intersect_keys((group,)) if items is None else intersect_keys((group, items))
result = {}
for k in keys:
next_items = items.get(k, None) if isinstance(items, Mapping) else None
result[k] = read_elem_partial(group[k], items=next_items, indices=indices)
return result
@_REGISTRY.register_write(ZarrGroup, AnnData, IOSpec("anndata", "0.1.0"))
@_REGISTRY.register_write(H5Group, AnnData, IOSpec("anndata", "0.1.0"))
def write_anndata(
f: GroupStorageType,
k: str,
adata: AnnData,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
g = f.require_group(k)
if adata.X is not None:
_writer.write_elem(g, "X", adata.X, dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "obs", adata.obs, dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "var", adata.var, dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "obsm", dict(adata.obsm), dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "varm", dict(adata.varm), dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "obsp", dict(adata.obsp), dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "varp", dict(adata.varp), dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "layers", dict(adata.layers), dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "uns", dict(adata.uns), dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "raw", adata.raw, dataset_kwargs=dataset_kwargs)
@_REGISTRY.register_read(H5Group, IOSpec("anndata", "0.1.0"))
@_REGISTRY.register_read(H5Group, IOSpec("raw", "0.1.0"))
@_REGISTRY.register_read(H5File, IOSpec("anndata", "0.1.0"))
@_REGISTRY.register_read(H5File, IOSpec("raw", "0.1.0"))
@_REGISTRY.register_read(ZarrGroup, IOSpec("anndata", "0.1.0"))
@_REGISTRY.register_read(ZarrGroup, IOSpec("raw", "0.1.0"))
def read_anndata(elem: GroupStorageType | H5File, *, _reader: Reader) -> AnnData:
d = {}
for k in [
"X",
"obs",
"var",
"obsm",
"varm",
"obsp",
"varp",
"layers",
"uns",
"raw",
]:
if k in elem:
d[k] = _reader.read_elem(elem[k])
return AnnData(**d)
@_REGISTRY.register_write(H5Group, Raw, IOSpec("raw", "0.1.0"))
@_REGISTRY.register_write(ZarrGroup, Raw, IOSpec("raw", "0.1.0"))
def write_raw(
f: GroupStorageType,
k: str,
raw: Raw,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
g = f.require_group(k)
_writer.write_elem(g, "X", raw.X, dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "var", raw.var, dataset_kwargs=dataset_kwargs)
_writer.write_elem(g, "varm", dict(raw.varm), dataset_kwargs=dataset_kwargs)
########
# Null #
########
@_REGISTRY.register_read(H5Array, IOSpec("null", "0.1.0"))
@_REGISTRY.register_read(ZarrArray, IOSpec("null", "0.1.0"))
def read_null(_elem, _reader) -> None:
return None
@_REGISTRY.register_write(H5Group, type(None), IOSpec("null", "0.1.0"))
def write_null_h5py(f, k, _v, _writer, dataset_kwargs=MappingProxyType({})):
dataset_kwargs = _remove_scalar_compression_args(dataset_kwargs)
f.create_dataset(k, data=h5py.Empty("f"), **dataset_kwargs)
@_REGISTRY.register_write(ZarrGroup, type(None), IOSpec("null", "0.1.0"))
def write_null_zarr(f, k, _v, _writer, dataset_kwargs=MappingProxyType({})):
dataset_kwargs = _remove_scalar_compression_args(dataset_kwargs)
# zarr has no first-class null dataset
if is_zarr_v2():
import zarr
# zarr has no first-class null dataset
f.create_dataset(k, data=zarr.empty(()), **dataset_kwargs)
else:
# TODO: why is this not actually storing the empty info with a f.empty call?
# It fails complaining that k doesn't exist when updating the attributes.
f.create_array(k, shape=(), dtype="bool")
############
# Mappings #
############
@_REGISTRY.register_read(H5Group, IOSpec("dict", "0.1.0"))
@_REGISTRY.register_read(ZarrGroup, IOSpec("dict", "0.1.0"))
def read_mapping(elem: GroupStorageType, *, _reader: Reader) -> dict[str, AxisStorable]:
return {k: _reader.read_elem(v) for k, v in dict(elem).items()}
@_REGISTRY.register_write(H5Group, dict, IOSpec("dict", "0.1.0"))
@_REGISTRY.register_write(ZarrGroup, dict, IOSpec("dict", "0.1.0"))
def write_mapping(
f: GroupStorageType,
k: str,
v: dict[str, AxisStorable],
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
g = f.require_group(k)
for sub_k, sub_v in v.items():
_writer.write_elem(g, sub_k, sub_v, dataset_kwargs=dataset_kwargs)
##############
# np.ndarray #
##############
@_REGISTRY.register_write(H5Group, list, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, list, IOSpec("array", "0.2.0"))
def write_list(
f: GroupStorageType,
k: str,
elem: list[AxisStorable],
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
_writer.write_elem(f, k, np.array(elem), dataset_kwargs=dataset_kwargs)
# TODO: Is this the right behavior for MaskedArrays?
# It's in the `AnnData.concatenate` docstring, but should we keep it?
@_REGISTRY.register_write(H5Group, views.ArrayView, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(H5Group, np.ndarray, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(H5Group, np.ma.MaskedArray, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, views.ArrayView, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, np.ndarray, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, np.ma.MaskedArray, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, ZarrArray, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, H5Array, IOSpec("array", "0.2.0"))
@zero_dim_array_as_scalar
def write_basic(
f: GroupStorageType,
k: str,
elem: views.ArrayView | np.ndarray | h5py.Dataset | np.ma.MaskedArray | ZarrArray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
"""Write methods which underlying library handles natively."""
dataset_kwargs = dataset_kwargs.copy()
dtype = dataset_kwargs.pop("dtype", elem.dtype)
if isinstance(f, H5Group) or is_zarr_v2():
f.create_dataset(k, data=elem, shape=elem.shape, dtype=dtype, **dataset_kwargs)
else:
dataset_kwargs = zarr_v3_compressor_compat(dataset_kwargs)
f.create_array(k, shape=elem.shape, dtype=dtype, **dataset_kwargs)
# see https://github.com/zarr-developers/zarr-python/discussions/2712
if isinstance(elem, ZarrArray | H5Array):
f[k][...] = elem[...]
else:
f[k][...] = elem
def _iter_chunks_for_copy(
elem: ArrayStorageType, dest: ArrayStorageType
) -> Iterator[slice | tuple[list[slice]]]:
"""
Returns an iterator of tuples of slices for copying chunks from `elem` to `dest`.
* If `dest` has chunks, it will return the chunks of `dest`.
* If `dest` is not chunked, we write it in ~100MB chunks or 1000 rows, whichever is larger.
"""
if dest.chunks and hasattr(dest, "iter_chunks"):
return dest.iter_chunks()
else:
shape = elem.shape
# Number of rows that works out to
n_rows = max(
ad.settings.min_rows_for_chunked_h5_copy,
elem.chunks[0] if elem.chunks is not None else 1,
)
return (slice(i, min(i + n_rows, shape[0])) for i in range(0, shape[0], n_rows))
@_REGISTRY.register_write(H5Group, H5Array, IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(H5Group, ZarrArray, IOSpec("array", "0.2.0"))
def write_chunked_dense_array_to_group(
f: H5Group,
k: str,
elem: ArrayStorageType,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
"""Write to a h5py.Dataset in chunks.
`h5py.Group.create_dataset(..., data: h5py.Dataset)` will load all of `data` into memory
before writing. Instead, we will write in chunks to avoid this. We don't need to do this for
zarr since zarr handles this automatically.
"""
dtype = dataset_kwargs.get("dtype", elem.dtype)
kwargs = {**dataset_kwargs, "dtype": dtype}
dest = f.create_dataset(k, shape=elem.shape, **kwargs)
for chunk in _iter_chunks_for_copy(elem, dest):
dest[chunk] = elem[chunk]
_REGISTRY.register_write(H5Group, CupyArray, IOSpec("array", "0.2.0"))(
_to_cpu_mem_wrapper(write_basic)
)
_REGISTRY.register_write(ZarrGroup, CupyArray, IOSpec("array", "0.2.0"))(
_to_cpu_mem_wrapper(write_basic)
)
@_REGISTRY.register_write(ZarrGroup, DaskArray, IOSpec("array", "0.2.0"))
def write_basic_dask_zarr(
f: ZarrGroup,
k: str,
elem: DaskArray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
import dask.array as da
dataset_kwargs = dataset_kwargs.copy()
dataset_kwargs = zarr_v3_compressor_compat(dataset_kwargs)
if is_zarr_v2():
g = f.require_dataset(k, shape=elem.shape, dtype=elem.dtype, **dataset_kwargs)
else:
g = f.require_array(k, shape=elem.shape, dtype=elem.dtype, **dataset_kwargs)
da.store(elem, g, lock=GLOBAL_LOCK)
# Adding this separately because h5py isn't serializable
# https://github.com/pydata/xarray/issues/4242
@_REGISTRY.register_write(H5Group, DaskArray, IOSpec("array", "0.2.0"))
def write_basic_dask_h5(
f: H5Group,
k: str,
elem: DaskArray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
import dask.array as da
import dask.config as dc
if dc.get("scheduler", None) == "dask.distributed":
msg = "Cannot write dask arrays to hdf5 when using distributed scheduler"
raise ValueError(msg)
g = f.require_dataset(k, shape=elem.shape, dtype=elem.dtype, **dataset_kwargs)
da.store(elem, g)
@_REGISTRY.register_read(H5Array, IOSpec("array", "0.2.0"))
@_REGISTRY.register_read(ZarrArray, IOSpec("array", "0.2.0"))
@_REGISTRY.register_read(ZarrArray, IOSpec("string-array", "0.2.0"))
def read_array(elem: ArrayStorageType, *, _reader: Reader) -> npt.NDArray:
return elem[()]
@_REGISTRY.register_read_partial(H5Array, IOSpec("array", "0.2.0"))
@_REGISTRY.register_read_partial(ZarrArray, IOSpec("string-array", "0.2.0"))
def read_array_partial(elem, *, items=None, indices=(slice(None, None))):
return elem[indices]
@_REGISTRY.register_read_partial(ZarrArray, IOSpec("array", "0.2.0"))
def read_zarr_array_partial(elem, *, items=None, indices=(slice(None, None))):
return elem.oindex[indices]
# arrays of strings
@_REGISTRY.register_read(H5Array, IOSpec("string-array", "0.2.0"))
def read_string_array(d: H5Array, *, _reader: Reader):
return read_array(d.asstr(), _reader=_reader)
@_REGISTRY.register_read_partial(H5Array, IOSpec("string-array", "0.2.0"))
def read_string_array_partial(d, items=None, indices=slice(None)):
return read_array_partial(d.asstr(), items=items, indices=indices)
@_REGISTRY.register_write(
H5Group, (views.ArrayView, "U"), IOSpec("string-array", "0.2.0")
)
@_REGISTRY.register_write(
H5Group, (views.ArrayView, "O"), IOSpec("string-array", "0.2.0")
)
@_REGISTRY.register_write(H5Group, (np.ndarray, "U"), IOSpec("string-array", "0.2.0"))
@_REGISTRY.register_write(H5Group, (np.ndarray, "O"), IOSpec("string-array", "0.2.0"))
@_REGISTRY.register_write(H5Group, (np.ndarray, "T"), IOSpec("string-array", "0.2.0"))
@zero_dim_array_as_scalar
def write_vlen_string_array(
f: H5Group,
k: str,
elem: np.ndarray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
"""Write methods which underlying library handles nativley."""
str_dtype = h5py.special_dtype(vlen=str)
f.create_dataset(k, data=elem.astype(str_dtype), dtype=str_dtype, **dataset_kwargs)
@_REGISTRY.register_write(
ZarrGroup, (views.ArrayView, "U"), IOSpec("string-array", "0.2.0")
)
@_REGISTRY.register_write(
ZarrGroup, (views.ArrayView, "O"), IOSpec("string-array", "0.2.0")
)
@_REGISTRY.register_write(ZarrGroup, (np.ndarray, "U"), IOSpec("string-array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, (np.ndarray, "O"), IOSpec("string-array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, (np.ndarray, "T"), IOSpec("string-array", "0.2.0"))
@zero_dim_array_as_scalar
def write_vlen_string_array_zarr(
f: ZarrGroup,
k: str,
elem: np.ndarray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
if is_zarr_v2():
import numcodecs
if Version(numcodecs.__version__) < Version("0.13"):
msg = "Old numcodecs version detected. Please update for improved performance and stability."
warnings.warn(msg, UserWarning, stacklevel=2)
# Workaround for https://github.com/zarr-developers/numcodecs/issues/514
if hasattr(elem, "flags") and not elem.flags.writeable:
elem = elem.copy()
f.create_dataset(
k,
shape=elem.shape,
dtype=object,
object_codec=numcodecs.VLenUTF8(),
**dataset_kwargs,
)
f[k][:] = elem
else:
from numcodecs import VLenUTF8
from zarr.core.dtype import VariableLengthUTF8
dataset_kwargs = dataset_kwargs.copy()
dataset_kwargs = zarr_v3_compressor_compat(dataset_kwargs)
dtype = VariableLengthUTF8()
filters, fill_value = None, None
if ad.settings.zarr_write_format == 2:
filters, fill_value = [VLenUTF8()], ""
f.create_array(
k,
shape=elem.shape,
dtype=dtype,
filters=filters,
fill_value=fill_value,
**dataset_kwargs,
)
f[k][:] = elem
###############
# np.recarray #
###############
def _to_hdf5_vlen_strings(value: np.ndarray) -> np.ndarray:
"""This corrects compound dtypes to work with hdf5 files."""
new_dtype = []
for dt_name, (dt_type, _) in value.dtype.fields.items():
if dt_type.kind in {"U", "O"}:
new_dtype.append((dt_name, h5py.special_dtype(vlen=str)))
else:
new_dtype.append((dt_name, dt_type))
return value.astype(new_dtype)
@_REGISTRY.register_read(H5Array, IOSpec("rec-array", "0.2.0"))
@_REGISTRY.register_read(ZarrArray, IOSpec("rec-array", "0.2.0"))
def read_recarray(d: ArrayStorageType, *, _reader: Reader) -> np.recarray | npt.NDArray:
value = d[()]
dtype = value.dtype
value = _from_fixed_length_strings(value)
if H5PY_V3:
value = _decode_structured_array(value, dtype=dtype)
return value
@_REGISTRY.register_write(H5Group, (np.ndarray, "V"), IOSpec("rec-array", "0.2.0"))
@_REGISTRY.register_write(H5Group, np.recarray, IOSpec("rec-array", "0.2.0"))
def write_recarray(
f: H5Group,
k: str,
elem: np.ndarray | np.recarray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
f.create_dataset(k, data=_to_hdf5_vlen_strings(elem), **dataset_kwargs)
@_REGISTRY.register_write(ZarrGroup, (np.ndarray, "V"), IOSpec("rec-array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, np.recarray, IOSpec("rec-array", "0.2.0"))
def write_recarray_zarr(
f: ZarrGroup,
k: str,
elem: np.ndarray | np.recarray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
from anndata.compat import _to_fixed_length_strings
elem = _to_fixed_length_strings(elem)
if isinstance(f, H5Group) or is_zarr_v2():
f.create_dataset(k, data=elem, shape=elem.shape, **dataset_kwargs)
else:
dataset_kwargs = dataset_kwargs.copy()
dataset_kwargs = zarr_v3_compressor_compat(dataset_kwargs)
# TODO: zarr’s on-disk format v3 doesn’t support this dtype
f.create_array(k, shape=elem.shape, dtype=elem.dtype, **dataset_kwargs)
f[k][...] = elem
#################
# Sparse arrays #
#################
def write_sparse_compressed(
f: GroupStorageType,
key: str,
value: CSMatrix | CSArray,
*,
_writer: Writer,
fmt: Literal["csr", "csc"],
dataset_kwargs=MappingProxyType({}),
):
g = f.require_group(key)
g.attrs["shape"] = value.shape
dataset_kwargs = dict(dataset_kwargs)
indptr_dtype = dataset_kwargs.pop("indptr_dtype", value.indptr.dtype)
# Allow resizing for hdf5
if isinstance(f, H5Group):
dataset_kwargs = dict(maxshape=(None,), **dataset_kwargs)
dataset_kwargs = zarr_v3_compressor_compat(dataset_kwargs)
for attr_name in ["data", "indices", "indptr"]:
attr = getattr(value, attr_name)
dtype = indptr_dtype if attr_name == "indptr" else attr.dtype
if isinstance(f, H5Group) or is_zarr_v2():
g.create_dataset(
attr_name, data=attr, shape=attr.shape, dtype=dtype, **dataset_kwargs
)
else:
arr = g.create_array(
attr_name, shape=attr.shape, dtype=dtype, **dataset_kwargs
)
# see https://github.com/zarr-developers/zarr-python/discussions/2712
arr[...] = attr[...]
write_csr = partial(write_sparse_compressed, fmt="csr")
write_csc = partial(write_sparse_compressed, fmt="csc")
for store_type, (cls, spec, func) in product(
(H5Group, ZarrGroup),
[
# spmatrix
(sparse.csr_matrix, IOSpec("csr_matrix", "0.1.0"), write_csr),
(views.SparseCSRMatrixView, IOSpec("csr_matrix", "0.1.0"), write_csr),
(sparse.csc_matrix, IOSpec("csc_matrix", "0.1.0"), write_csc),
(views.SparseCSCMatrixView, IOSpec("csc_matrix", "0.1.0"), write_csc),
# sparray
(sparse.csr_array, IOSpec("csr_matrix", "0.1.0"), write_csr),
(views.SparseCSRArrayView, IOSpec("csr_matrix", "0.1.0"), write_csr),
(sparse.csc_array, IOSpec("csc_matrix", "0.1.0"), write_csc),
(views.SparseCSCArrayView, IOSpec("csc_matrix", "0.1.0"), write_csc),
# cupy spmatrix
(CupyCSRMatrix, IOSpec("csr_matrix", "0.1.0"), _to_cpu_mem_wrapper(write_csr)),
(
views.CupySparseCSRView,
IOSpec("csr_matrix", "0.1.0"),
_to_cpu_mem_wrapper(write_csr),
),
(CupyCSCMatrix, IOSpec("csc_matrix", "0.1.0"), _to_cpu_mem_wrapper(write_csc)),
(
views.CupySparseCSCView,
IOSpec("csc_matrix", "0.1.0"),
_to_cpu_mem_wrapper(write_csc),
),
],
):
_REGISTRY.register_write(store_type, cls, spec)(func)
@_REGISTRY.register_write(H5Group, _CSRDataset, IOSpec("", "0.1.0"))
@_REGISTRY.register_write(H5Group, _CSCDataset, IOSpec("", "0.1.0"))
@_REGISTRY.register_write(ZarrGroup, _CSRDataset, IOSpec("", "0.1.0"))
@_REGISTRY.register_write(ZarrGroup, _CSCDataset, IOSpec("", "0.1.0"))
def write_sparse_dataset(
f: GroupStorageType,
k: str,
elem: _CSCDataset | _CSRDataset,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
write_sparse_compressed(
f,
k,
elem._to_backed(),
_writer=_writer,
fmt=elem.format,
dataset_kwargs=dataset_kwargs,
)
# TODO: Cleaner way to do this
f[k].attrs["encoding-type"] = f"{elem.format}_matrix"
f[k].attrs["encoding-version"] = "0.1.0"
@_REGISTRY.register_write(H5Group, (DaskArray, CupyArray), IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, (DaskArray, CupyArray), IOSpec("array", "0.2.0"))
@_REGISTRY.register_write(
H5Group, (DaskArray, CupyCSRMatrix), IOSpec("csr_matrix", "0.1.0")
)
@_REGISTRY.register_write(
H5Group, (DaskArray, CupyCSCMatrix), IOSpec("csc_matrix", "0.1.0")
)
@_REGISTRY.register_write(
ZarrGroup, (DaskArray, CupyCSRMatrix), IOSpec("csr_matrix", "0.1.0")
)
@_REGISTRY.register_write(
ZarrGroup, (DaskArray, CupyCSCMatrix), IOSpec("csc_matrix", "0.1.0")
)
def write_cupy_dask_sparse(f, k, elem, _writer, dataset_kwargs=MappingProxyType({})):
_writer.write_elem(
f,
k,
elem.map_blocks(lambda x: x.get(), dtype=elem.dtype, meta=elem._meta.get()),
dataset_kwargs=dataset_kwargs,
)
@_REGISTRY.register_write(
H5Group, (DaskArray, sparse.csr_matrix), IOSpec("csr_matrix", "0.1.0")
)
@_REGISTRY.register_write(
H5Group, (DaskArray, sparse.csc_matrix), IOSpec("csc_matrix", "0.1.0")
)
@_REGISTRY.register_write(
ZarrGroup, (DaskArray, sparse.csr_matrix), IOSpec("csr_matrix", "0.1.0")
)
@_REGISTRY.register_write(
ZarrGroup, (DaskArray, sparse.csc_matrix), IOSpec("csc_matrix", "0.1.0")
)
def write_dask_sparse(
f: GroupStorageType,
k: str,
elem: DaskArray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
sparse_format = elem._meta.format
def as_int64_indices(x):
x.indptr = x.indptr.astype(np.int64, copy=False)
x.indices = x.indices.astype(np.int64, copy=False)
return x
if sparse_format == "csr":
axis = 0
elif sparse_format == "csc":
axis = 1
else:
msg = f"Cannot write dask sparse arrays with format {sparse_format}"
raise NotImplementedError(msg)
def chunk_slice(start: int, stop: int) -> tuple[slice | None, slice | None]:
result = [slice(None), slice(None)]
result[axis] = slice(start, stop)
return tuple(result)
axis_chunks = elem.chunks[axis]
chunk_start = 0
chunk_stop = axis_chunks[0]
_writer.write_elem(
f,
k,
as_int64_indices(elem[chunk_slice(chunk_start, chunk_stop)].compute()),
dataset_kwargs=dataset_kwargs,
)
disk_mtx = sparse_dataset(f[k])
for chunk_size in axis_chunks[1:]:
chunk_start = chunk_stop
chunk_stop += chunk_size
disk_mtx.append(elem[chunk_slice(chunk_start, chunk_stop)].compute())
@_REGISTRY.register_read(H5Group, IOSpec("csc_matrix", "0.1.0"))
@_REGISTRY.register_read(H5Group, IOSpec("csr_matrix", "0.1.0"))
@_REGISTRY.register_read(ZarrGroup, IOSpec("csc_matrix", "0.1.0"))
@_REGISTRY.register_read(ZarrGroup, IOSpec("csr_matrix", "0.1.0"))
def read_sparse(elem: GroupStorageType, *, _reader: Reader) -> CSMatrix | CSArray:
return sparse_dataset(elem).to_memory()
@_REGISTRY.register_read_partial(H5Group, IOSpec("csc_matrix", "0.1.0"))
@_REGISTRY.register_read_partial(H5Group, IOSpec("csr_matrix", "0.1.0"))
@_REGISTRY.register_read_partial(ZarrGroup, IOSpec("csc_matrix", "0.1.0"))
@_REGISTRY.register_read_partial(ZarrGroup, IOSpec("csr_matrix", "0.1.0"))
def read_sparse_partial(elem, *, items=None, indices=(slice(None), slice(None))):
return sparse_dataset(elem)[indices]
#################
# Awkward array #
#################
@_REGISTRY.register_write(H5Group, AwkArray, IOSpec("awkward-array", "0.1.0"))
@_REGISTRY.register_write(ZarrGroup, AwkArray, IOSpec("awkward-array", "0.1.0"))
@_REGISTRY.register_write(
H5Group, views.AwkwardArrayView, IOSpec("awkward-array", "0.1.0")
)
@_REGISTRY.register_write(
ZarrGroup, views.AwkwardArrayView, IOSpec("awkward-array", "0.1.0")
)
def write_awkward(
f: GroupStorageType,
k: str,
v: views.AwkwardArrayView | AwkArray,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
from anndata.compat import awkward as ak
group = f.require_group(k)
del k
if isinstance(v, views.AwkwardArrayView):
# copy to remove the view attributes
v = copy(v)
form, length, container = ak.to_buffers(ak.to_packed(v))
group.attrs["length"] = length
group.attrs["form"] = form.to_json()
for k, v in container.items():
_writer.write_elem(group, k, v, dataset_kwargs=dataset_kwargs)
@_REGISTRY.register_read(H5Group, IOSpec("awkward-array", "0.1.0"))
@_REGISTRY.register_read(ZarrGroup, IOSpec("awkward-array", "0.1.0"))
def read_awkward(elem: GroupStorageType, *, _reader: Reader) -> AwkArray:
from anndata.compat import awkward as ak
form = _read_attr(elem.attrs, "form")
length = _read_attr(elem.attrs, "length")
container = {k: _reader.read_elem(elem[k]) for k in elem}
return ak.from_buffers(form, int(length), container)
##############
# DataFrames #
##############
@_REGISTRY.register_write(H5Group, views.DataFrameView, IOSpec("dataframe", "0.2.0"))
@_REGISTRY.register_write(H5Group, pd.DataFrame, IOSpec("dataframe", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, views.DataFrameView, IOSpec("dataframe", "0.2.0"))
@_REGISTRY.register_write(ZarrGroup, pd.DataFrame, IOSpec("dataframe", "0.2.0"))
def write_dataframe(
f: GroupStorageType,
key: str,
df: views.DataFrameView | pd.DataFrame,
*,
_writer: Writer,
dataset_kwargs: Mapping[str, Any] = MappingProxyType({}),
):
# Check arguments
for reserved in ("_index",):
if reserved in df.columns:
msg = f"{reserved!r} is a reserved name for dataframe columns."
raise ValueError(msg)
group = _require_group_write_dataframe(f, key, df)
if not df.columns.is_unique:
duplicates = list(df.columns[df.columns.duplicated()])
msg = f"Found repeated column names: {duplicates}. Column names must be unique."
raise ValueError(msg)
col_names = [check_key(c) for c in df.columns]
group.attrs["column-order"] = col_names
if df.index.name is not None:
if df.index.name in col_names and not pd.Series(
df.index, index=df.index
).equals(df[df.index.name]):
msg = (
f"DataFrame.index.name ({df.index.name!r}) is also used by a column "
"whose values are different. This is not supported. Please make sure "
"the values are the same, or use a different name."
)
raise ValueError(msg)
index_name = df.index.name
else:
index_name = "_index"
group.attrs["_index"] = check_key(index_name)
# ._values is "the best" array representation. It's the true array backing the
# object, where `.values` is always a np.ndarray and .array is always a pandas
# array.