Skip to content

Commit f383efa

Browse files
committed
Deprecate rechunk_bgen that uses rechunker in favour of using Xarray chunk function directly
1 parent 2b747a1 commit f383efa

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

sgkit/io/bgen/bgen_reader.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
import logging
33
import tempfile
44
import time
5+
import warnings
56
from pathlib import Path
67
from typing import (
78
Any,
@@ -446,6 +447,11 @@ def rechunk_bgen(
446447
will run inline so calls to it may be slow. The resulting Dataset is
447448
generated based on the final, serialized Zarr data.
448449
450+
.. deprecated:: 0.11.0
451+
Using rechunker for rechunking in sgkit is deprecated, please use the the
452+
`Xarray chunk <https://docs.xarray.dev/en/stable/generated/xarray.Dataset.chunk.html#xarray.Dataset.chunk>`_
453+
function directly.
454+
449455
Parameters
450456
----------
451457
ds
@@ -486,6 +492,12 @@ def rechunk_bgen(
486492
Dataset
487493
The rechunked dataset.
488494
"""
495+
warnings.warn(
496+
"Using rechunker for rechunking in sgkit is deprecated, please use the the Xarray 'chunk' function directly.",
497+
DeprecationWarning,
498+
stacklevel=2,
499+
)
500+
489501
if isinstance(output, Path):
490502
output = str(output)
491503

0 commit comments

Comments
 (0)