cowbird.handlers.handler

Module Contents

Classes

Handler

Helper class that provides a standard way to create an ABC using

Attributes

AnyHandlerParameter
HANDLER_PRIORITY_PARAM
HANDLER_URL_PARAM
HANDLER_WORKSPACE_DIR_PARAM
HANDLER_PARAMETERS
LOGGER

cowbird.handlers.handler.AnyHandlerParameter

cowbird.handlers.handler.HANDLER_PRIORITY_PARAM: AnyHandlerParameter = 'priority'

cowbird.handlers.handler.HANDLER_URL_PARAM: AnyHandlerParameter = 'url'

cowbird.handlers.handler.HANDLER_WORKSPACE_DIR_PARAM: AnyHandlerParameter = 'workspace_dir'

cowbird.handlers.handler.HANDLER_PARAMETERS

cowbird.handlers.handler.LOGGER

exception cowbird.handlers.handler.HandlerConfigurationException

Bases: Exception

Exception thrown when a handler cannot be instantiated because of a bad configuration.

Initialize self. See help(type(self)) for accurate signature.

class cowbird.handlers.handler.Handler(settings: cowbird.typedefs.SettingsType, name: str, **kwargs: Any)

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

• settings – Cowbird settings for convenience

• name – Handler name

• kwargs – The base class handle, but doesn’t require the following variables:

• url – Location of the web service represented by the cowbird handler

• workspace_dir – Workspace directory

• priority – Relative priority between handlers while handling events. Lower value has higher priority, default value is last.

abstract property required_params: List[AnyHandlerParameter]

__slots__

Handler interface used to notify implemented handlers of users/permissions changes.

Todo

At some point we will need a consistency function that goes through all Magpie users and make sure that handlers are up-to-date.

json() → cowbird.typedefs.JSON

_user_workspace_dir(user_name: str) → str

abstract user_created(user_name: str) → None

abstract user_deleted(user_name: str) → None

abstract permission_created(permission: cowbird.permissions_synchronizer.Permission) → None

abstract permission_deleted(permission: cowbird.permissions_synchronizer.Permission) → None

abstract resync() → None