Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
Target release2.0
Epic
Jira Legacy
serverJIRA (senbox.atlassian.net)
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId34c99a62-e5be-31ca-898a-01c2aded1b99
keySNAP-79
Document status
Status
titleDRAFT
Document owner

Former user (Deleted)

DesignerFormer user (Deleted)
DevelopersFormer user (Deleted), Marco Peters
QA@Olga Faber

...

A Python extension module is a JAR file or directory which must contain a plain text file META-INF/snappy.def which lists all Python extensions contained in the modulePython extension modules are found in the following locations:

  • <module-jar-file>   a module JAR file
  • ${user.home}/.snap/snappy/ext/*    the directories in directory snappy/ext in the SNAP user directory
  • ${snap.snappy.ext}   from the directory paths given in the special system property snap.snappy.ext

The text file snappy.def contains either empty lines, comment lines starting with the '#' character, or lines declaring a Python extension as follows:

[<ext-rel-path>/]<ext>      ExtClassNameClass

The type of the extension is derived from the Python class ExtClassNameClass. If it the class name ends with Op it is assumed to be a GPF operator, if it ends with Action it is assumed to be an action to be placed in the menu or in a toolbar. A single <ext> may contain any number of Python classes that provide extensions to SNAP.

Each Python extension must follow this schema:

[<ext-rel-path>/]

<ext>.py   contains the Python extension ExtClassNamecode containing the class ExtClass  

<ext>-info.xml   contains the operator metadata such as processing parameter definitions (for GPF operators only)

Questions

Below is a list of questions to be addressed as a result of this requirements document:

...