magpie.config
=============

.. py:module:: magpie.config


Attributes
----------

.. autoapisummary::

   magpie.config.LOGGER
   magpie.config.SERVICE_HOOK_ITEM_SCHEMA
   magpie.config.SERVICE_CONFIG_ITEM_SCHEMA
   magpie.config.SERVICES_CONFIGURATION_SCHEMA
   magpie.config.JsonSchemaDefaultValidator


Functions
---------

.. autoapisummary::

   magpie.config.extend_with_default
   magpie.config.validate_services_config


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

.. py:data:: LOGGER

.. py:data:: SERVICE_HOOK_ITEM_SCHEMA

.. py:data:: SERVICE_CONFIG_ITEM_SCHEMA

.. py:data:: SERVICES_CONFIGURATION_SCHEMA

.. py:function:: extend_with_default(validator_class: jsonschema.protocols.Validator) -> jsonschema.protocols.Validator

   Validator that applies inplace defaults in the instance when provided by the schema.


.. py:data:: JsonSchemaDefaultValidator

.. py:function:: validate_services_config(services_configuration: magpie.typedefs.JSON) -> magpie.typedefs.ServicesConfig

   Validate configuration within the ``providers`` section.

   .. seealso::
       :ref:`config_providers` and :ref:`config_file`.

   :param services_configuration: Service definitions loaded from one or more combined configuration files.
   :return: Services configuration with validated schema and applied defaults.