anndata.settings.override

anndata.settings.override#

settings.override(**overrides)[source]#

Provides local override via keyword arguments as a context manager.

Parameters:
remove_unused_categories bool

Whether or not to remove unused categories with Categorical. (default: True).

check_uniqueness bool

Whether or not to check uniqueness of the obs indices on __init__ of AnnData. (default: True).

allow_write_nullable_strings bool | None

Whether or not to allow writing of pd.arrays.[Arrow]StringArray. When set to None, it will be inferred from pd.options.future.infer_string. When set to False explicitly, we will try writing string arrays in the old, non-nullable format. (default: None).

zarr_write_format int

Which version of zarr to write to when anndata must internally open a write-able zarr group. (default: 2).

use_sparse_array_on_read bool

Whether or not to use scipy.sparse.sparray as the default class when reading in data (default: False).

min_rows_for_chunked_h5_copy int

Minimum number of rows at a time to copy when writing out an H5 Dataset to a new location (default: 1000).

disallow_forward_slash_in_h5ad bool

Whether or not to disallow the / character in keys for h5ad files (default: False).

write_csr_csc_indices_with_min_possible_dtype bool

Write a csr or csc matrix with the minimum possible data type for indices, always unsigned integer. (default: False).

auto_shard_zarr_v3 bool

Whether or not to use zarr’s auto computation of sharding for v3. For v2 this setting will be ignored. The setting will apply to all calls to anndata’s writing mechanism (write_zarr / write_elem) and will not override any user-defined kwargs for shards. (default: False).

copy_on_write_X bool

Whether to copy-on-write X. Currently my_adata_view[subset].X = value will write back to the original AnnData object at the subset location. X is the only element where this behavior is implemented though. (default: False).

Yields:

None