pass more options to `omero.util.import_candidates`

[glyg]

I would like to be able to pass more options to import_candidates, such as

• the import depth (currently limited to the default 4 levels)
• the exclude="filepath" if this makes sense in that context? (would the exluded files not appear in the output?)

Adding a **kwargs agument to the as_stdout could do the trick (or a more explicit extra_opts):

def as_stdout(path, readers="", extra_opts=None):
    if extra_opts is None:
        extra_opts = []
    path = _to_list(path)
    readers = str(readers)
    cli = CLI()
    cli.loadplugins()
    if readers:
        cli.invoke(["import",] + extra_opts + [ "-l", readers, "-f"] + path)
    else:
        cli.invoke(["import", "-f"]  + extra_opts + path)
  ...

There's no rush, as I'm anticipating on problems I haven't had yet ;-)

Thanks!

[joshmoore]

• would the exluded files not appear in the output?

-f is a local-only operation where as --exclude requires a login so that won't do what you want.

Otherwise, :+1: for having other options like depth. Others that might make sense include:

• debugging
• report
• logback

but I'd be happy with a catch-all solution like you propose.

[glyg]

great (could have guessed for --exclude).

I can open a PR if you want (and can point me to the relevant tests to update / implement).

[joshmoore]

Sorry for the slow response, @glyg. When I went looking for such tests, I got lost. (i.e. they don't seem to exist)

[glyg]

Ha! Well it would not be bad for me as an exercise to get to know omero better to write those, would it? Maybe I can build on https://github.com/ome/omero-py/blob/master/test/unit/clitest/test_import.py ?

[joshmoore]

:) Indeed. There are a few that have -f options, but they aren't necessarily testing the functionality itself.