File tree Expand file tree Collapse file tree 2 files changed +11
-3
lines changed Expand file tree Collapse file tree 2 files changed +11
-3
lines changed Original file line number Diff line number Diff line change
1
+ .. _CompStorParams :
2
+
1
3
Compression, decompression and storage parameters
2
4
=================================================
3
5
Original file line number Diff line number Diff line change @@ -1441,13 +1441,19 @@ def open(
1441
1441
The path where the :ref:`SChunk` (or :ref:`NDArray`)
1442
1442
is stored. If it is a remote array, a :ref:`URLPath` must be passed.
1443
1443
mode: str, optional
1444
- The open mode.
1444
+ Persistence mode: 'r' means read only (must exist);
1445
+ 'a' means read/write (create if it doesn't exist);
1446
+ 'w' means create (overwrite if it exists). Default is 'a'.
1445
1447
offset: int, optional
1446
1448
An offset in the file where super-chunk or array data is located
1447
1449
(e.g. in a file containing several such objects).
1448
1450
kwargs: dict, optional
1449
- mmap_mode: The memory mapping mode.
1450
- initial_mapping_size: The initial size of the memory mapping.
1451
+ mmap_mode: str, optional
1452
+ If set, the file will be memory-mapped instead of using the default
1453
+ I/O functions and the `mode` argument will be ignored.
1454
+ For more info, see :class:`blosc2.Storage`.
1455
+ initial_mapping_size: int, optional
1456
+ The initial size of the memory mapping. For more info, see :class:`blosc2.Storage`.
1451
1457
cparams: dict
1452
1458
A dictionary with the compression parameters, which are the same that can be
1453
1459
used in the :func:`~blosc2.compress2` function.
You can’t perform that action at this time.
0 commit comments