Skip to content

← control_flow package

Import

Import definitions from another pipeline.

Importing a definition allows portions of another pipeline (e.g., function) to be reused, and behaves as if the definitions had been pasted into the present pipeline (without the duplication). One may either list one or more names (e.g., of functions) to import, or one may import the entire pipeline under its name. In the former case, the definitions can be referred to by their names in the present pipeline, and in the latter, they need to be prefixed by the name of the source pipeline (e.g., mypipeline.myname1). It is possible to alias either the pipeline (using the "as" keyword in the source) one or more of the definitions (using the "as" keyword in the names), but not both at the same time. Version 0.9.0

Ports/Properties

source

Path to the pipeline to import. This can be a relative or absolute path, and relative paths are relative to the current search path, which is first the directory of the present pipeline file, and then the pipeline_searchpath configuration setting. Path generally use forward slashes, and ~ stands for the user's home directory. If the path contains spaces, it must be enclosed in quotes. If the names option is empty, then this can also include the special keyword "as", to rename (e.g., abbreviate) the pipeline in the present pipeline, as in mypath/mypipeline as mypype.

  • verbose name: Source
  • default value: mypipeline
  • port type: StringPort
  • value type: str (can be None)

names

Names of the definitions to import. The names may include the special keyword "as" to indicate a rename, as in "oldname as newname". This means that a definition named oldname in the source pipeline will be imported under the name newname in the present pipeline. If this list is empty, the source package will be imported under its name, and definitions within it can be referred to using the dot notation, i.e., as in mypipeline.myname1. At this time, only functions can be imported.

  • verbose name: Names
  • default value: ['myname1', 'myname2']
  • port type: ListPort
  • value type: list (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)