anndata.AnnData.unwriteable

AnnData.unwriteable(*, store_type=None, compat=<WriteCompat.V0_13: '0.13'>)

Whether or not an AnnData object can be written to disk for a given store type.

Parameters:

store_type Literal['h5', 'zarr'] | None

Which backing store - None indicates that it can be writeable to either.

compat WriteConfig | WriteCompatStr

Which anndata python package version’s write behavior to check against, see WriteCompat.

Return type:

bool

Returns:

Whether or not this object is writeable. While the return type may change to include richer output about which elements cannot be written, this new type’s evaluation as a boolean will not change from the current behavior i.e., bool(adata.unwriteable()) will always evaluate the same.