6.2.1.5 Using Parameters

To get parameter settings from the pse.conf file for your module, create a dictionary named plugin_config in the global namespace of your module. The keys are the name of the configuration paramaters, and the values are the default values for the parameters. These will be replaced with values that appear in the [plugins.pluginname] section, where pluginname is the name of the plugin, from the pse.conf file before the plugin is initialized. The values can be either a string, integer, float or list, and any value from the conf file will be required to be and converted into the type of the default value. Do not make a default value of None; instead, use '', 0, 0.0 or [].

Note: The plugin_config variable was previously named just config in versions prior to PSE 3.0; While your PSE 2.x plugins will still function in PSE 3.0, you need to update your plugin to use variable name plugin_config instead of config.

Changed in version 3.0.

There is a special "reserved" parameter for plugins called Enabled, which is by default set to true. You can disable a user plugin from showing up in the pse.plugins package by specifiying Enabled = no in the plugin's configuration section in the pse.conf file.