9.1.2.12. GeoHealthCheck.plugin

9.1.2.12.1. Module Contents

9.1.2.12.1.1. Classes

Plugin

Abstract Base class for all GHC Plugins.

9.1.2.12.1.2. Attributes

LOGGER

GeoHealthCheck.plugin.LOGGER

class GeoHealthCheck.plugin.Plugin

Bases: object

Abstract Base class for all GHC Plugins. Derived classes should fill in all class variables that are UPPER_CASE, unless they ar fine with default-values from superclass(es).

AUTHOR = 'GHC Team'

Plugin author or team.

NAME = 'Name missing in NAME class var'

Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?

DESCRIPTION = 'Description missing in DESCRIPTION class var'

Longer description of Plugin. TODO: optional i18n e.g. DESCRIPTION_de_DE ?

PARAM_DEFS

Plugin Parameter definitions.

get_class_name()

get_param(param_name)

Get actual parameter value. param_name should be defined in PARAM_DEFS.

get_default_parameter_values()

Get all default parameter values

get_var_names()

Get all Plugin variable names as a dict

get_plugin_vars()

Get all (uppercase) class variables of a class as a dict

get_param_defs()

Get all PARAM_DEFS as dict.

static copy(obj)

Deep copy of usually dict object.

static merge(dict1, dict2)

Recursive merge of two dict, mainly used for PARAM_DEFS, CHECKS_AVAIL overriding. :param dict1: base dict :param dict2: dict to merge into dict1 :return: deep copy of dict2 merged into dict1

static get_plugins(baseclass='GeoHealthCheck.plugin.Plugin', filters=None)

Class method to get list of Plugins of particular baseclass (optional), default is all Plugins. filters is a list of tuples to filter out Plugins with class var values: (class var, value), e.g. filters=[(‘RESOURCE_TYPE’, ‘OGC:*’), (‘RESOURCE_TYPE’, ‘OGC:WMS’)].

__str__()

Return str(self).