:py:mod:`GeoHealthCheck.plugin`
===============================

.. py:module:: GeoHealthCheck.plugin


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.plugin.Plugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   GeoHealthCheck.plugin.LOGGER


.. py:data:: LOGGER

   

.. py:class:: Plugin


   Bases: :py:obj:`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).

   .. py:attribute:: AUTHOR
      :value: 'GHC Team'

      Plugin author or team.


   .. py:attribute:: NAME
      :value: 'Name missing in NAME class var'

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


   .. py:attribute:: DESCRIPTION
      :value: 'Description missing in DESCRIPTION class var'

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


   .. py:attribute:: PARAM_DEFS

      Plugin Parameter definitions.


   .. py:method:: get_class_name()


   .. py:method:: get_param(param_name)

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


   .. py:method:: get_default_parameter_values()

      Get all default parameter values


   .. py:method:: get_var_names()

      Get all Plugin variable names as a dict


   .. py:method:: get_plugin_vars()

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


   .. py:method:: get_param_defs()

      Get all PARAM_DEFS as dict.


   .. py:method:: copy(obj)
      :staticmethod:

      Deep copy of usually `dict` object.


   .. py:method:: merge(dict1, dict2)
      :staticmethod:

      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


   .. py:method:: get_plugins(baseclass='GeoHealthCheck.plugin.Plugin', filters=None)
      :staticmethod:

      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')]`.


   .. py:method:: __str__()

      Return str(self).