|
20 | 20 | from zarr.core.indexing import SelectorTuple |
21 | 21 |
|
22 | 22 | __all__ = [ |
| 23 | + "CodecBase", |
23 | 24 | "ArrayArrayCodec", |
24 | 25 | "ArrayBytesCodec", |
25 | 26 | "ArrayBytesCodecPartialDecodeMixin", |
|
34 | 35 | CodecOutput = TypeVar("CodecOutput", bound=NDBuffer | Buffer) |
35 | 36 |
|
36 | 37 |
|
37 | | -class _Codec(Metadata, Generic[CodecInput, CodecOutput]): |
| 38 | +class CodecBase(Metadata, Generic[CodecInput, CodecOutput]): |
38 | 39 | """Generic base class for codecs. |
39 | | - Please use ArrayArrayCodec, ArrayBytesCodec or BytesBytesCodec for subclassing. |
40 | 40 |
|
41 | 41 | Codecs can be registered via zarr.codecs.registry. |
| 42 | +
|
| 43 | + Warnings |
| 44 | + -------- |
| 45 | + This class is not intended to be directly, please use |
| 46 | + ArrayArrayCodec, ArrayBytesCodec or BytesBytesCodec for subclassing. |
42 | 47 | """ |
43 | 48 |
|
44 | 49 | is_fixed_size: bool |
@@ -148,19 +153,19 @@ async def encode( |
148 | 153 | return await _batching_helper(self._encode_single, chunks_and_specs) |
149 | 154 |
|
150 | 155 |
|
151 | | -class ArrayArrayCodec(_Codec[NDBuffer, NDBuffer]): |
| 156 | +class ArrayArrayCodec(CodecBase[NDBuffer, NDBuffer]): |
152 | 157 | """Base class for array-to-array codecs.""" |
153 | 158 |
|
154 | 159 | ... |
155 | 160 |
|
156 | 161 |
|
157 | | -class ArrayBytesCodec(_Codec[NDBuffer, Buffer]): |
| 162 | +class ArrayBytesCodec(CodecBase[NDBuffer, Buffer]): |
158 | 163 | """Base class for array-to-bytes codecs.""" |
159 | 164 |
|
160 | 165 | ... |
161 | 166 |
|
162 | 167 |
|
163 | | -class BytesBytesCodec(_Codec[Buffer, Buffer]): |
| 168 | +class BytesBytesCodec(CodecBase[Buffer, Buffer]): |
164 | 169 | """Base class for bytes-to-bytes codecs.""" |
165 | 170 |
|
166 | 171 | ... |
|
0 commit comments