omero.plugins.tag module

Tag plugin for command-line tag manipulation

class plugins.tag.Tag(tag_id=None, name=None, description=None, owner=None, children=None)

Bases: object

class plugins.tag.TagCollection

Bases: object

class plugins.tag.TagControl(*args: Any, **kwargs: Any)

Bases: BaseControl

add_newtag_params(parser)

add_standard_params(parser)

add_tag_common_params(parser)

create(args)

create a tag command.

create_tag(name, description, text='tag')

Creates a new tag object. Returns the new tag object.

If name parameter is None, the user will be prompted to input it.

The “text” parameter should be the text description to use upon user input. For example, if we were creating a tag, this would be “tag” (the default). If we were creating a tagset, this could be “tag set”.

createset(args)

Create a tag set command.

determine_console_size()

Will attempt to determine console size based upon the current platform.

Returns tuple of width and length.

generate_empties(empties, args)

Given a list of empty tagsets, return a list of lines representing the empty tagset output.

generate_orphans(orphans, args)

Given a list of orphaned tags, return a list of lines representing the orphan output.

generate_tagset(tags, mapping, args)

Given a dict of tags and mappings for parent/child relationships return a list of lines representing the tagset output.

link(args)

Links an object to a tag annotation.

list(args)

List tags command.

list_tags(args, tagset=None)

Returns a TagCollection object

list_tags_recursive(args, tagset=None)

Returns a TagCollection object

list_tagsets(args, tag)

Returns a TagCollection of just the tagsets.

If tag is provided, will return the tagsets with those tags.

listsets(args)

List tag sets command.

load(args)

Import new tag(s) from json.

pagetext(lines)

pagetext_format(format, elements)

print_line(line, index)

plugins.tag.clip(s, width)

Given a string, s, and a width, will clip the string to that width or fill it with spaces up to that width.

Returns modified string

plugins.tag.exec_command(cmd)

given a command, will execute it in the parent environment Returns a list containing the output