Package omero :: Module scripts
[hide private]
[frames] | no frames]

Module scripts

source code

Scripting types

Copyright 2008 Glencoe Software, Inc. All rights reserved. Use is subject to license terms supplied in LICENSE.txt

Classes [hide private]
  Type
  Long
  String
  Bool
  Point
  Plane
  Set
  Map
  ParseExit
Raised when this script should just parse parameters and return.
Functions [hide private]
 
client(name, description=None, *args, **kwargs)
Entry point for all script engine scripts.
source code
 
handleParse(c) source code

Imports: exceptions, omero


Function Details [hide private]

client(name, description=None, *args, **kwargs)

source code 

Entry point for all script engine scripts.

Typical usage consists of:

   client = omero.scripts.client("name","description",             omero.scripts.Long("name"),...)

where the returned client is created via the empty constructor to omero.client using only --Ice.Config or ICE_CONFIG, and the function arguments are taken as metdata about the current script. With this information, all script consumers should be able to determine the required types for execution.

Possible types are all subclasses of omero.scripts.Type

To change the omero.model.Format of the stdout and stderr produced by this script, use the constructor arguments:

   client = omero.scripts.client(...,             stdoutFormat = "text/plain",
       stderrFormat = "text/plain")

If you would like to prevent stdout and/or stderr from being uploaded, set the corresponding value to None. If you would like to overwrite the value with another file, use client.setOutput(). Though it is possible to attach any RType to "stdout" or "stderr", there is an assumption that the value will be an robject(OriginalFileI())

Providing your own client is possible via the kwarg "client = ...", but be careful since this may break usage with the rest of the scripting framework. The client should not have a session, and must be configured for the argumentless version of createSession()