perun.configuration
===================

.. py:module:: perun.configuration

.. autoapi-nested-parse::

   Configuration module.



Attributes
----------

.. autoapisummary::

   perun.configuration.log
   perun.configuration._default_config
   perun.configuration.config
   perun.configuration.globalConfigPath
   perun.configuration.localConfigPath


Functions
---------

.. autoapisummary::

   perun.configuration.read_custom_config
   perun.configuration.save_to_config
   perun.configuration.read_environ
   perun.configuration.sanitize_config


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

.. py:data:: log

.. py:data:: _default_config
   :type:  Mapping[str, Mapping[str, Any]]

.. py:data:: config
   :type:  configparser.ConfigParser

.. py:data:: globalConfigPath

.. py:data:: localConfigPath

.. py:function:: read_custom_config(pathStr: str) -> None

   Read INI config file and save in global configuration objects.

   Parameters
   ----------
   pathStr : str
       Path to configuration file.


.. py:function:: save_to_config(key: str, value: Any)

   Save key and value to configuration.

   Parameters
   ----------
   key : str
       Option name
   value : Any
       Option value


.. py:function:: read_environ()

   Read perun environmental variables.


.. py:function:: sanitize_config(config) -> configparser.ConfigParser

   Sanitize configuration values.

   Parameters
   ----------
   config : configparser.ConfigParser
       Configuration object.

   Returns
   -------
   configparser.ConfigParser
       Sanitized configuration object.