Plugin API¶

Interface¶

The plugin interface module is named __hpx__. Import it in your plugin to access the methods and classes defined by the module:

import __hpx__ as hpx
logger = hpx.get_logger(__name__)

In addition to what is defined here, exceptions and enums defined by HPX are also available at the module-level and can be imported like so:

import __hpx__ as hpx
from __hpx__ import PluginError, PluginState
print(PluginState) # -> <enum 'PluginState'>
print(hpx.ImageSize) # -> <enum 'ImageSize'>
raise PluginError("", "")
raise hpx.PluginError("", "")

command

The object command is available on the module-level and provides access to the various different commands defined by HPX:

from __hpx__ import command
command.CheckUpdate()

See Commands for all the various commands available information.

constants

The object constants is available on the module-level and provides various useful constant values.:

from __hpx__ import constants
print(constants.version) # -> (0, 0, 0)

• version: current HPX version

• database_version: current HPX database version

• webclient_version: current HPX webclient version

• dev: developer mode enabled

• debug: debug mode enabled

• is_frozen: application has been made into an executable

• is_osx: application is running on OS X

• is_linux: application is running on Linux

• is_win: application is running on Windows

• is_posix: application is running on a posix-compliant OS (true for both OS X and Linux)

• download_path: path to the downloads folder

• tumbnail_path: path to the thumbnails folder

• translation_path: path to the translations folder

• current_dir: path to the plugin’s folder

current_dir : str =

database_version : tuple = (0, 9, 0)

debug : bool = False

dev : bool = False

download_path : str = downloads

is_frozen : bool = False

is_linux : bool = True

is_osx : bool = False

is_posix : bool = True

is_win : bool = False

thumbnail_path : str = static/thumbnails

translation_path : str = translations

version : tuple = (0, 13, 3)

webclient_version : tuple = (0, 13, 1)

addfilter(f=None, command=None, on=None)¶

Add a callable to a pipeline command

Parameters

• f (Optional[Callable]) – a callable

• command (Optional[str]) – name of pipeline command

• on (Optional[str]) – on a specific action

attach(f=None, command=None, trigger=None)¶

Attach a handler to a command entry

Parameters

• f (Optional[Callable]) – command handler

• command (Optional[str]) – a fully qualified command name, required

• trigger (Union[str, list, tuple, None]) – trigger only on a special keyword

get_logger(name=None)¶

Get the logging.Logger object for this plugin

Parameters

name (Optional[str]) – name of logger

get_plugin_config()¶

Get a dict-like object with configuration specific to this plugin

Returns

dict-like object

get_setting(namespace, key, default=<class 'happypanda.core.plugin_interface._NO_DEFAULT'>)¶

Get the value of any setting in the configuration. See Settings.

Parameters

• namespace (str) – setting namespace

• key (str) – setting key

• default – default value if no key was found

Returns

value of setting or default value if default was set, else raise a KeyError

removefilter(f=None, command=None, on=None)¶

Remove a callable from a pipeline command

Parameters

• f (Optional[Callable]) – a callable

• command (Optional[str]) – name of pipeline command

• on (Optional[str]) – on a specific action

Returns

a boolean indicating whether the filter was removed

save_plugin_config(obj)¶

Save configuration specific to this plugin

The configuration will appear in the plugin.config.<plugin shortname> namespace.

Parameters

obj (dict) – dict-like object

Returns

bool on if config was saved

subscribe(f=None, commandevent=None, trigger=None)¶

Subscribe a handler to a command event

Parameters

• f (Optional[Callable]) – command event handler

• commandevent (Optional[str]) – a fully qualified command event name, required

• trigger (Union[str, list, tuple, None]) – trigger only on a special keyword

update_setting(namespace, key, value, user=True)¶

Update the value of any setting in the configuration. See Settings.

Parameters

• namespace (str) – setting namespace

• key (str) – setting key

• value (Union[dict, list, int, float, tuple, str]) – value to set

• user (bool) – the value should only apply to the current client user. Note that a user haven’t necessarily been assigned.

Special Commands¶

Besides the command entries and events listed here, HPX also provides some plugin meta events that are specific for each plugin. These events are emitted on plugin state changes. See PluginState for the different kinds of plugin states.

• init – this event is emitted for a plugin after it has initialized and after all its dependencies has been initialized.

  It is therefore ideal to put the plugin’s own initialization on this event.

• disable – this event is emitted when a plugin has been disabled, either manually by the user or because of some other cause.

  The plugin should listen to this event to terminate any on-going process it has running.

• remove – this event is emitted just before a plugin is to be removed. HPX will handle the deletion of the plugin folder.

  The disable event will always be emitted before this event. The plugin should listen to this event to remove any produced items that would still be lingering even after its folder has been deleted.

• before_update – this event is emitted just before a plugin is updated.

  The plugin should listen to this event to perform actions before it is updated.

• after_update – this event is emitted just after a plugin has been updated.

  The plugin should listen to this event to perform actions after it has been updated.

• config_update (dict) – this event is emitted with a dict of configuration that has been updated, usually from a client.

  The plugin should listen to this event to be notified when its configuration has been updated.

These are special entries each plugin can attach to.

• message (dict) -> dict – this entry is called is called with a message, usually from a client. A dict is expected to be returned.

  The plugin should attach to this entry when wanting to exchange messages with a client or another plugin.

Summary¶

Meta

I/O

Database

Item

Gallery

Item Data

Login

Metadata

Search

Network

Download

Commands¶

GetDefaultSession()¶

Retrieve the default session

Available entries:

Available events:

MultiGETRequest(*args, **kwargs)¶

A convenience wrapper around MultiRequest for GET requests

Available entries:

Available events:

MultiPOSTRequest(*args, **kwargs)¶

A convenience wrapper around MultiRequest for POST requests

Available entries:

Available events:

MultiRequest(*args, **kwargs)¶

Make multiple HTTP requests

Available entries:

Available events:

Response(_url, _request_method, _request_kwargs, _props, _session)¶

A request response. Not meant to be instanced publicly.

Available entries:

Available events:

SingleGETRequest(*args, **kwargs)¶

A convenience wrapper around SingleRequest for GET requests

Available entries:

Available events:

SinglePOSTRequest(*args, **kwargs)¶

A convenience wrapper around SingleRequest for POST requests

Available entries:

Available events:

SingleRequest(*args, **kwargs)¶

Make a HTTP request

Available entries:

Available events: