Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Helper function to return keys in the sdata.attrs slot in an specific format #806

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

timtreis
Copy link
Member

@timtreis timtreis commented Dec 10, 2024

Gets a specific key from sdata.attrs and then returns it either

a) as is (return_as=None) or
b) converted (return_as="dict" | "json" | "df") and potentially flattened (flatten=True, separated by sep)

Needed for spatialdata-db project, but tried to keep it general.

import spatialdata
from spatialdata.datasets import blobs

sdata = blobs()

sdata.attrs  # empty dictionnary
sdata.attrs["test"] = {"a": {"b": 12}, "c": 8}

sdata.write("blobs.zarr", overwrite=True) 
sdata = spatialdata.read_zarr("blobs.zarr") 

sdata.get_attrs(key="test", return_as=None, flatten=False)

{'a': {'b': 12}, 'c': 8}

import spatialdata
from spatialdata.datasets import blobs

sdata = blobs()

sdata.attrs  # empty dictionnary
sdata.attrs["test"] = {"a": {"b": 12}, "c": 8}

sdata.write("blobs.zarr", overwrite=True) 
sdata = spatialdata.read_zarr("blobs.zarr") 

sdata.get_attrs(key="test", return_as="df", flatten=False)
image
import spatialdata
from spatialdata.datasets import blobs

sdata = blobs()

sdata.attrs  # empty dictionnary
sdata.attrs["test"] = {"a": {"b": 12}, "c": 8}

sdata.write("blobs.zarr", overwrite=True) 
sdata = spatialdata.read_zarr("blobs.zarr") 

sdata.get_attrs(key="test", return_as="df", flatten=True)
image
import spatialdata
from spatialdata.datasets import blobs

sdata = blobs()

sdata.attrs  # empty dictionnary
sdata.attrs["test"] = {"a": {"b": 12}, "c": 8}

sdata.write("blobs.zarr", overwrite=True) 
sdata = spatialdata.read_zarr("blobs.zarr") 

sdata.get_attrs(key="test", return_as="json", flatten=True)
image

FYI @Zethson

@timtreis timtreis added the enhancement ✨ New feature or request label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ✨ New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant