Add extinfo command #167

dominikl · 2025-02-25T11:40:42Z

This command will automatically set the ExternalInfo for ome.zarr images imported using the omero-zarr-pixel-buffer, if the --set option is specified. Default is to just print the ExternalInfo.

I takes the path from the Fileset "usedFiles", which is assumed to only have one entry ..../SOME.ome.zarr/OME/METADATA.ome.xml and then set the ExternalInfo lsid to the full path of the multiscale 5d image; ..../SOME.ome.zarr/0 for an image ..../SOME.ome.zarr/A/1/1 etc. for plates.

Limitations: Only works for ome.zarr imported from the filesystem.

Get the ExternalInfo path of an ome.zarr image.

Use --set to set the external info path
or --reset in order to remove the ExternalInfo from the image.

Positional Arguments:
  object                   Object in Class:ID format

Optional Arguments:
  In addition to any higher level options

  -h, --help               show this help message and exit
  --set                    Set the ExternalInfo path
  --lsid LSID              Use a specific lsid (path) (default: Determine from clientPath) (only used in combination with --set)
  --entityType ENTITYTYPE  Use a specific entityType (default: com.glencoesoftware.ngff:multiscales) (only used in combination with --set)
  --entityId ENTITYID      Use a specific entityId (default: 3) (only used in combination with --set)
  --reset                  Removes the ExternalInfo

joshmoore · 2025-02-28T14:10:38Z

💯 As a part of this I can imagine wanting to get and to reset as well.

will-moore · 2025-03-03T14:08:40Z

$ omero login
Error loading: /Users/wmoore/Desktop/ZARR/omero-cli-zarr/src/omero/plugins/zarr.py
Traceback (most recent call last):
  File "/Users/wmoore/Desktop/PY/omero-py/target/omero/cli.py", line 1677, in loadpath
    exec(f.read(), loc)
  File "<string>", line 1, in <module>
  File "/Users/wmoore/Desktop/ZARR/omero-cli-zarr/src/omero_zarr/cli.py", line 32, in <module>
    from .extinfo import external_info_str, get_extinfo, get_images, set_external_info
  File "/Users/wmoore/Desktop/ZARR/omero-cli-zarr/src/omero_zarr/extinfo.py", line 92, in <module>
    ) -> tuple[ImageWrapper, str | None, int | None]:
TypeError: unsupported operand type(s) for |: 'type' and 'NoneType'

dominikl · 2025-03-03T14:32:39Z

Interesting... is this a python version thing? I use 3.12.9.

will-moore · 2025-03-03T14:38:32Z

It could be, I'm on an old env python 3.9.15.

dominikl · 2025-03-03T14:45:32Z

Yes, looks like it's supported from 3.10 on. As we still recommend 3.9 I'll remove that stuff again.

will-moore · 2025-03-03T15:16:39Z

src/omero_zarr/extinfo.py

+            select e from ExternalInfo as e
+            where e.id = :id
+        """
+        extinfo = conn.getQueryService().findByQuery(query, params)


In think this needs to be a cross-group query findByQuery(query, params, conn.SERVICE_OPTS) otherwise you won't see it if the extinfo isn't in your default group.

This is still outstanding. Same for the other conn.getQueryService().findByQuery below too.

But I do that one line above conn.SERVICE_OPTS.setOmeroGroup("-1") , is that not enough?

Ah ok, then you have to pass conn.SERVICE_OPTS that into the function call again. Ok, i'll fix that.

src/omero_zarr/extinfo.py

will-moore · 2025-03-07T14:28:56Z

src/omero_zarr/cli.py


 POLYGONS_HELP = """Export ROI Polygons on the Image or Plate in zarr format"""

+EXTINFO_HELP = """Get the ExternalInfo path of an ome.zarr image.


Get or set...

Get, because that's the default action.

will-moore · 2025-03-07T14:43:45Z

I was trying to test this on a non-zarr image, by specifying the --path but...

$ omero zarr extinfo Image:2856 --set --path test_extinfo_path
Previous session expired for will on localhost:4064
Server: [localhost:4064]
Username: [will]
Password:
Created session for will@localhost:4064. Idle timeout: 10 min. Current group: Swedlow Lab
Failed to set external info for image (2856) 438CTR_01_4_R3D_D3D.dv_1: Doesn't seem to be an ome.zarr: Users/wmoore/Desktop/images/DVs/438CTR_01_4_R3D_D3D.dv

It seems that there's something strange about --path, like it's being swallowed / overwritten somehow so that args.path was always None. Renaming this argument to anything else seemed to fix it. I suggest using lsid since that corresponds to the field in the extInfo.

dominikl · 2025-03-07T15:03:32Z

There's a check if it is a ome.zarr: https://github.com/ome/omero-cli-zarr/pull/167/files#diff-2d64f99479103ff3050c633344ddf895f61491094e9dab65218a3ec17cbfcb59R177 As that's actually only intended to be used with zarr. Otherwise it wouldn't make sense to have it as omero-cli-zarr plugin!?

will-moore · 2025-03-07T15:27:38Z

The point is that you have a --path argument for...

help="Use a specific path (default: Determine from clientPath) (only used in combination with --set)",

but it doesn't work for me. Does it work for you?

joshmoore · 2025-03-11T16:38:48Z

.pre-commit-config.yaml

    hooks:
      - id: flake8
        additional_dependencies: [
-          flake8-blind-except,


Too re-enable, we'll probably need help from @will-moore on knowing what exceptions can be thrown.

joshmoore · 2025-03-11T16:39:30Z

.pre-commit-config.yaml

-          flake8-blind-except,
          flake8-builtins,
          flake8-rst-docstrings,
-          flake8-logging-format,


This looks like it broke in Python 3.12: pytest-dev/pytest-testinfra#765

Over at https://github.com/ome/omero-cli-zarr/pull/168/files#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9R56 I fixed this by including setuptools as dependency.
That is now conflicting with this PR.
I wonder if you could review that PR @dominikl or @joshmoore and we can get it merged (if that fix looks good)?

I temporarly close this PR and then rebase it after #168 is merged, would that work?

I don't think you need to close this one. Just merge in origin/master (and fix conflicts) once #168 is merged

dominikl · 2025-03-12T09:22:43Z

Thanks Josh for fixing the precommit stuff! So this now suppports single image ome.zarrs, multi-series zarrs, and plates. Did I forget another use case?

will-moore · 2025-05-20T10:14:18Z

Thanks. A few flake8 and mypy failures at https://github.com/ome/omero-cli-zarr/actions/runs/15108557228/job/42462569460?pr=167

dominikl · 2025-05-22T12:35:44Z

Changing to draft PR. Probably not gonna be merged, because this functionality will have to go somewhere else (possible omero import...).

jburel · 2025-05-23T12:56:01Z

cf a88d9b8 I am not keen on the fake option. I think we should focus on creating an XML file.

dominikl · 2025-05-23T13:03:48Z

I'd just need it to test a zarr plate. Setting up a fake file for it would be much quicker/easier than a full metadata.ome.xml.

jburel · 2025-05-23T14:38:52Z

it is an easy way to get data in but the metadata in the xml file are then read and handle by the XML reader stored accordingly. Such support does not exist in the fake reader. It will be preferable to handle as much metadata as possible and not look at a quick access in my opinion

jburel · 2025-05-26T08:50:15Z

Quick discussion this am post standup: We will look at the Python snippet to generate the ome-xml file see https://github.com/IDR/idr0167-li-cellcyclenet/blob/main/scripts/ome-zarr-to-ome-xml.py

for more information, see https://pre-commit.ci

dominikl · 2025-05-29T14:50:46Z

The extinfo command can now be used for different scenarios:

Import a zarr with metadata.xml which is part of the zarr.
omero import -l /tmp/reader.txt ... /data/testing/plate.ome.zarr/OME/METADATA.ome.xml
omero zarr extinfo --set Plate:1234 (it'll get the paths to set for lsid from the clientpath)
Import a metadata.xml from anywhere and then point to the actual zarr:
omero import -l /tmp/reader.txt ... /tmp/some_plate_metadata.xml
omero zarr extinfo --set --zarrPath /data/testing/plate.ome.zarr Plate:10667

Same for image zarrs.

dominikl force-pushed the extinfo branch 2 times, most recently from 03bde3a to 5f3f675 Compare February 28, 2025 13:30

dominikl force-pushed the extinfo branch from 8b7844d to 837af45 Compare March 3, 2025 13:43

will-moore reviewed Mar 3, 2025

View reviewed changes

src/omero_zarr/extinfo.py Outdated Show resolved Hide resolved

dominikl force-pushed the extinfo branch from 3ee3cca to c7f2252 Compare March 5, 2025 14:54

will-moore reviewed Mar 7, 2025

View reviewed changes

dominikl force-pushed the extinfo branch 11 times, most recently from 3cc6c05 to ad4a5b2 Compare March 11, 2025 15:56

joshmoore reviewed Mar 11, 2025

View reviewed changes

dominikl marked this pull request as ready for review March 11, 2025 16:52

dominikl added 7 commits May 19, 2025 09:45

Add support for plates

25b366c

Add set and reset options

4efcf46

Make sure query are cross groups

38b5428

Add series support, changed path arg to lsid

b2af0eb

Fix formatting and minor issues

d3eac37

Fix imports

ed0bea9

Fix group issues

47ebb38

dominikl force-pushed the extinfo branch from 0455157 to 47ebb38 Compare May 19, 2025 08:49

dominikl marked this pull request as draft May 22, 2025 12:35

dominikl force-pushed the extinfo branch 2 times, most recently from e9aff8d to a88d9b8 Compare May 23, 2025 12:53

will-moore mentioned this pull request May 26, 2025

getObject() and getExternalInfo() load externalInfo ome/omero-py#453

Merged

Support other names than METADATA.ome.xml

71bf2d0

dominikl force-pushed the extinfo branch 6 times, most recently from f9c911a to b558927 Compare May 29, 2025 14:37

Enable custom path also for plates

1772f98

dominikl force-pushed the extinfo branch from 07273dd to 1772f98 Compare May 29, 2025 14:38

[pre-commit.ci] auto fixes from pre-commit.com hooks

38b38f9

for more information, see https://pre-commit.ci

Don't change custom path

52c2f26


		POLYGONS_HELP = """Export ROI Polygons on the Image or Plate in zarr format"""

		EXTINFO_HELP = """Get the ExternalInfo path of an ome.zarr image.

Add extinfo command #167

Are you sure you want to change the base?

Add extinfo command #167

Uh oh!

Conversation

dominikl commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joshmoore commented Feb 28, 2025

Uh oh!

will-moore commented Mar 3, 2025

Uh oh!

dominikl commented Mar 3, 2025

Uh oh!

will-moore commented Mar 3, 2025

Uh oh!

dominikl commented Mar 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

will-moore commented Mar 7, 2025

Uh oh!

dominikl commented Mar 7, 2025

Uh oh!

will-moore commented Mar 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dominikl commented Mar 12, 2025

Uh oh!

will-moore commented May 20, 2025

Uh oh!

dominikl commented May 22, 2025

Uh oh!

jburel commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dominikl commented May 23, 2025

Uh oh!

jburel commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jburel commented May 26, 2025

Uh oh!

dominikl commented May 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dominikl commented Feb 25, 2025 •

edited

Loading

jburel commented May 23, 2025 •

edited

Loading

jburel commented May 23, 2025 •

edited

Loading