_{Official ZPE/YASS documentation}ZPE module

Module description

Provides information about the running ZPE environment and operations that act on ZPE itself. This includes module, function, plugin and library discovery, installation information and in-process benchmarking of YASS callables.

Availability: ZPE 1.14.11 is the first version to support the ZPE module.

Module functions

The following is a list of all functions available in this module.

• benchmark [1.14.11+]

  Benchmarks a lambda or function reference inside the current ZPE process and returns millisecond timing statistics.

• feedback [1.5.0+]

  Sends feedback directly to Jamie Balfour using his website.

  This functionality was originally available as a predefined function from ZPE 1.5.0, before it became a function of the ZPE module.

• get_function_information [1.8.7+]

  Returns the internal documentation on a function within ZPE. The <em>as_html</em> parameter can be used to convert the function entry information to HTML before returning it.

• get_install_path [1.14.11+]

  Returns the path of the current ZPE installation when ZPE is running as a process.

• get_property [1.5.1+]

  Returns the value of a ZPE property used by the ZPE core. If the key does not exist, it returns <code class="keyword">false</code> and displays an error message explaining that the key was not found.

• get_version [1.6.6+]

  Gets the current version of ZPE as a string. If minor is specified and given a <code class="keyword">true</code> value, it will return the minor version instead of the major.

• list_libraries [1.12.12+]

  Returns a list containing all libraries currently available.

• list_plugins [1.8.7+]

  Returns a list containing all plugins currently running. It will also force ZPE to load all library plugins at this point, even if they haven't loaded.

• list_zpe_aliases [1.8.10+]

  Returns a map containing all defined ZPE aliases.

• list_zpe_functions [1.8.2+]

  Returns a map containing all ZPE functions.

• update_zpe [1.8.6+]

  Manual entry not found for function: update_zpe.