ImportError raised when climada logging.managed is false

[spjuhel]

Setting the following configuration for logging in climada configuration

"logging": {
        "managed": false
    }

Raises the following error when importing anything from petals due to CONSOLE not being defined:

ImportError                               Traceback (most recent call last)

     22 from pathlib import Path
     24 import climada
---> 25 import climada_petals.util.config
     26 from .util.constants import *
     28 REPO_DATA = {
     29     'climada_petals[/data/gdp_asset](http://localhost:8888/data/gdp_asset)': [
     30         SYSTEM_DIR.joinpath('GDP2Asset_converter_2.5arcmin.nc'),
   (...)     57     ],
     58 }

      1 """
      2 This file is part of CLIMADA.
      3 
   (...)     19 init util
     20 """
---> 21 from .config import *
     22 from .constants import *

     30 import climada
     31 import climada.util.config
---> 32 from climada.util.config import (
     33     Config, _fetch_conf, CONFIG_NAME, CONFIG, CONSOLE)
     35 LOGGER = logging.getLogger('climada_petals')
     36 LOGGER.propagate = False

ImportError: cannot import name 'CONSOLE' from 'climada.util.config'

This comes from the fact that config.py in climada core only defines CONSOLE if CONFIG.logging.managed is True:

# set climada style logging
if CONFIG.logging.managed.bool():
    LOGGER = logging.getLogger("climada")
    LOGGER.propagate = False
    FORMATTER = logging.Formatter(
        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
    )
    CONSOLE = logging.StreamHandler(stream=sys.stdout)
    CONSOLE.setFormatter(FORMATTER)
    LOGGER.addHandler(CONSOLE)

    LOGGER.setLevel(getattr(logging, CONFIG.log_level.str()))

[spjuhel]

No idea what would be an acceptable approach here? I haven't given much attention to config handling in either core or petals.

My guess is that, import in petals should be conditional?

[peanutfun]

I guess you mean that the error occurs when

# climada.conf
"logging": {
        "managed": false
    }

?

[spjuhel]

Yes, wrote too fast.

[peanutfun]

Looks like Core should propagate if logging is "managed", and all following statements relating to logging should only be executed if this is indeed the case:

climada_petals/climada_petals/util/config.py

Lines 32 to 49 in 0ff4d1d

	from climada.util.config import (
	Config, _fetch_conf, CONFIG_NAME, CONFIG, CONSOLE)
	LOGGER = logging.getLogger('climada_petals')
	LOGGER.propagate = False
	LOGGER.addHandler(CONSOLE)
	CORE_DIR = Path(climada.__file__).parent
	SOURCE_DIR = Path(__file__).absolute().parent.parent
	CONFIG.__dict__ = Config.from_dict(_fetch_conf([
	CORE_DIR / 'conf', # default config from the climada repository
	SOURCE_DIR / 'conf', # default config from the climada_petals repository
	Path.home() / 'climada' / 'conf', # ~/climada/conf directory
	Path.home() / '.config', # ~/.config directory
	Path.cwd(), # current working directory
	], CONFIG_NAME)).__dict__
	LOGGER.setLevel(getattr(logging, CONFIG.log_level.str()))

[peanutfun]

CONSOLE could also be defined for the non-managed case in core:
https://github.com/CLIMADA-project/climada_python/blob/bb9595944fcf673152ea53e61efbafeb0b1e4406/climada/util/config.py#L390-L391