Clean up the logger setup (#276)

* Simplify logger setup

* setup_logging has been removed

* changes for coping with removed setup_logging

* skip setting log level

* InputVar.ent and ent_fut have changed parameters

Co-authored-by: emanuel-schmid <[email protected]>

Author: tovogt

climada/__init__.py

@@ -21,12 +21,10 @@
 from shutil import copyfile
 from pathlib import Path
 
-from .util.config import CONFIG, setup_logging
+from .util.config import CONFIG
 from .util.constants import *
 
 
-__all__ = ['init']
-
 GSDP_DIR = SYSTEM_DIR.joinpath('GSDP')
 
 REPO_DATA = {
@@ -75,10 +73,4 @@ def setup_climada_data(reload=False):
                 src = Path(__file__).parent.parent.joinpath(src_dir, path.name)
                 copyfile(src, path)
 
-
-def init():
-    setup_climada_data()
-    setup_logging(CONFIG.log_level.str())
-
-
-init()
+setup_climada_data()

climada/engine/uncertainty_quantification/calc_base.py

@@ -28,11 +28,9 @@
 import numpy as np
 
 from climada.util.value_representation import sig_dig as u_sig_dig
-from climada.util.config import setup_logging as u_setup_logging
 from climada.engine.uncertainty_quantification import UncOutput
 
 LOGGER = logging.getLogger(__name__)
-u_setup_logging()
 
 
 class Calc():
@@ -69,15 +67,15 @@ def check_distr(self):
                     x = np.linspace(func.ppf(0.01), func.ppf(0.99), 100)
                     if not np.all(func.pdf(x) == input_param_func.pdf(x)):
                         raise ValueError(
-                            "The input parameter %s" %input_param_name +
-                            " is shared amond two input variables with "
-                            "different distributions."
+                            f"The input parameter {input_param_name}"
+                            " is shared amond two input variables with"
+                            " different distributions."
                             )
                     LOGGER.warning(
-                        "\n\nThe input parameter %s is shared " %input_param_name +
+                        "\n\nThe input parameter %s is shared " +
                         "among at least 2 input variables. Their uncertainty is " +
                         "thus computed with the same samples for this " +
-                        "input paramter.\n\n"
+                        "input paramter.\n\n", input_param_name
                         )
                 distr_dict[input_param_name] = input_param_func
         return True

climada/engine/uncertainty_quantification/calc_cost_benefit.py

@@ -30,10 +30,8 @@
 from climada.engine.cost_benefit import CostBenefit
 from climada.engine.uncertainty_quantification import Calc, InputVar, UncCostBenefitOutput
 from climada.util import log_level
-from climada.util.config import setup_logging as u_setup_logging
 
 LOGGER = logging.getLogger(__name__)
-u_setup_logging()
 
 # Future planed features:
 # - Add 'efc' (frequency curve) to UncCostBenenfit

climada/engine/uncertainty_quantification/calc_impact.py

@@ -31,10 +31,7 @@
 from climada.engine.uncertainty_quantification import Calc, InputVar, UncImpactOutput
 from climada.util import log_level
 
-from climada.util.config import setup_logging as u_setup_logging
-
 LOGGER = logging.getLogger(__name__)
-u_setup_logging()
 
 
 class CalcImpact(Calc):

climada/engine/uncertainty_quantification/input_var.py

@@ -487,7 +487,7 @@ def ent(impf_set, disc_rate, exp, meas_set, haz_id_dict= None,
             kwargs['EN'] = None
 
         if haz_id_dict is None:
-            {'TC': [1]}
+            haz_id_dict = {'TC': [1]}
 
         return InputVar(
             partial(_ent_unc_func, impf_set=impf_set, haz_id_dict=haz_id_dict,
@@ -593,7 +593,7 @@ def entfut(impf_set, exp, meas_set, haz_id_dict=None,
             kwargs['EN'] = None
 
         if haz_id_dict is None:
-            {'TC': [1]}
+            haz_id_dict = {'TC': [1]}
 
         return InputVar(
             partial(_entfut_unc_func, haz_id_dict=haz_id_dict,

climada/engine/uncertainty_quantification/unc_output.py

@@ -37,11 +37,9 @@
 
 from climada.util.value_representation import value_to_monetary_unit as u_vtm
 from climada.util import plot as u_plot
-from climada.util.config import setup_logging as u_setup_logging
 import climada.util.hdf5_handler as u_hdf5
 
 LOGGER = logging.getLogger(__name__)
-u_setup_logging()
 
 # Metrics that are multi-dimensional
 METRICS_2D = ['eai_exp', 'at_event']
@@ -62,6 +60,7 @@
     'ff' : ['ff'],
     }
 
+
 class UncOutput():
     """
     Class to store and plot uncertainty and sensitivity analysis output data

climada/util/config.py

@@ -21,7 +21,6 @@
 
 __all__ = [
     'CONFIG',
-    'setup_logging',
 ]
 
 import sys
@@ -31,31 +30,14 @@
 from pathlib import Path
 
 
-def remove_handlers(logger):
-    """Remove logger handlers."""
-    if logger.hasHandlers():
-        for handler in logger.handlers:
-            logger.removeHandler(handler)
-
 LOGGER = logging.getLogger('climada')
-LOGGER.setLevel(logging.DEBUG)
-LOGGER.propagate = False
-remove_handlers(LOGGER)
 FORMATTER = logging.Formatter(
     "%(asctime)s - %(name)s - %(levelname)s - %(message)s")
 CONSOLE = logging.StreamHandler(stream=sys.stdout)
 CONSOLE.setFormatter(FORMATTER)
 LOGGER.addHandler(CONSOLE)
 
 
-def setup_logging(log_level='DEBUG'):
-    """Setup logging configuration"""
-    remove_handlers(LOGGER)
-    LOGGER.propagate = False
-    LOGGER.setLevel(getattr(logging, log_level))
-    LOGGER.addHandler(CONSOLE)
-
-
 class Config():
     """Convenience Class. A Config object is a slow JSON object like nested dictonary who's values
     can be accessed by their names right away. E.g.: `a.b.c.str()` instead of `a['b']['c']`
@@ -321,3 +303,4 @@ def _fetch_conf(directories, config_name):
     Path(Path.home(), '.config'),  # ~/.config directory
     Path.cwd(),  # current working directory
 ], CONFIG_NAME))
+LOGGER.setLevel(getattr(logging, CONFIG.log_level.str()))

doc/guide/Guide_Installation.ipynb

@@ -2,7 +2,6 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "metadata": {},
    "source": [
     "# Installation\r\n",
     "\r\n",
@@ -95,12 +94,13 @@
     "* No 'impf\\_TC' column in GeoDataFrame: This may happen when a demo file from CLIMADA was not updated after the change in the impact function naming pattern from 'if\\_' to 'impf\\_' ([climada v2.2.0](https://github.com/CLIMADA-project/climada_python/releases/tag/v2.2.0)).\r\n",
     "  To solve it, run `python -c 'import climada; climada.setup_climada_data(reload=True)` in a terminal.\r\n",
     "\r\n",
-    "* How to change the log level: By default the logging level is set to ``'INFO'``. This can be changed\r\n",
+    "* How to change the log level: By default the logging level is set to ``'INFO'``, which is quite verbose. This can be changed\r\n",
     "\r\n",
-    "  * programmatically, in a script or interactive python environment (Spyder, Jupyter, IPython) by executing e.g., ``CLIMADA.util.config.setup_logging('DEBUG')``, \r\n",
+    "  * programmatically, in a script or interactive python environment (Spyder, Jupyter, IPython) by executing e.g., ``from climada.util.config import LOGGER; from logging import WARNING; LOGGER.setLevel(WARNING)``, \r\n",
     "  \r\n",
     "  * through configuration, by editing the config file ``CLIMADA/conf/defaults.conf`` and setting the value of the ``global.log_level`` property.\r\n"
-   ]
+   ],
+   "metadata": {}
   }
  ],
  "metadata": {

doc/guide/Guide_PythonDos-n-Donts.ipynb

@@ -939,12 +939,12 @@
     }
    },
    "source": [
-    "You can set the level of the LOGGER using `util.config.setup_logging(\"level\")`. This way you can for instance 'turn-off' info messages when you are making an application. For example, setting the logger to the \"ERROR\" level, use:"
+    "You can set the level of the LOGGER using `climada.util.config.LOGGER.setLevel(logging.XXX)`. This way you can for instance 'turn-off' info messages when you are making an application. For example, setting the logger to the \"ERROR\" level, use:"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {
     "ExecuteTime": {
      "end_time": "2021-01-15T17:57:29.203374Z",
@@ -954,18 +954,11 @@
      "slide_type": "slide"
     }
    },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "2021-01-15 18:57:27,342 - climada - DEBUG - Loading default config file: /Users/ckropf/Documents/Climada/climada_python/climada/conf/defaults.conf\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
-    "from climada import util\n",
-    "util.config.setup_logging(\"ERROR\")"
+    "import logging\n",
+    "from climada.util.config import LOGGER\n",
+    "LOGGER.setLevel(logging.ERROR)"
    ]
   },
   {

doc/tutorial/climada_engine_uncertainty.ipynb

@@ -14,23 +14,6 @@
     "This is a tutorial for the uncertainty quantification package in CLIMADA."
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {
-    "ExecuteTime": {
-     "end_time": "2021-09-29T08:17:07.260649Z",
-     "start_time": "2021-09-29T08:17:03.552693Z"
-    }
-   },
-   "outputs": [],
-   "source": [
-    "#Run this cell to set the logger to level error for this notebook and \n",
-    "#reduce the number of warnings and info given by the CLIMADA methods.\n",
-    "from climada import util\n",
-    "util.config.setup_logging(\"ERROR\")"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {
@@ -12264,7 +12247,7 @@
     "                           bounds_impfi=bounds_impfi,\n",
     "                           bounds_mdd=bounds_mdd,\n",
     "                           bounds_paa=bounds_paa,\n",
-    "                           haz_id_dict = {'TC': [1]})"
+    "                           haz_id_dict={'TC': [1]})"
    ]
   },
   {
@@ -12390,8 +12373,7 @@
     "    bounds_mdd=[0.9, 1.05],\n",
     "    bounds_paa=None,\n",
     "    bounds_impfi=[-2, 5],\n",
-    "    haz_type='TC',\n",
-    "    fun_id=1\n",
+    "    haz_id_dict={'TC': [1]}\n",
     "    )"
    ]
   },
@@ -12512,8 +12494,7 @@
     "    bounds_noise=None,\n",
     "    bounds_mdd=[0.7, 0.9],\n",
     "    bounds_paa=[1.3, 2],\n",
-    "    haz_type='TC',\n",
-    "    fun_id=1\n",
+    "    haz_id_dict={'TC': [1]}\n",
     "    )"
    ]
   },