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

.. py:module:: perun.configuration

.. autoapi-nested-parse::

   Configuration module.



Attributes
----------

.. autoapisummary::

   perun.configuration.log
   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:: 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.

   :param pathStr: Path to configuration file.
   :type pathStr: str


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

   Save key and value to configuration.

   :param key: Option name
   :type key: str
   :param value: Option value
   :type value: Any


.. py:function:: read_environ() -> None

   Read perun environmental variables.


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

   Sanitize configuration values.

   :param config: Configuration object.
   :type config: configparser.ConfigParser

   :returns: Sanitized configuration object.
   :rtype: configparser.ConfigParser