Feature/v3/feature/386 use better default logging colors and dont log to file by default (#394)

* Fix `charge_state` Constraint in `Storage` leading to incorrect losses in discharge and therefore incorrect charge states and discharge values (#347)

* Fix equation in Storage

* Fix test for equation in Storage

* Update CHANGELOG.md

* Improve Changelog Message

* Fix CHANGELOG.md

* Simplify changes from next release

* Update CHANGELOG.md

* Fix CHANGELOG.md

* chore(deps): update dependency mkdocs-material to v9.6.20 (#369)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Improve renovate.json to automerge ruff despite 0.x version

* chore(deps): update dependency tsam to v2.3.9 (#379)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency ruff to v0.13.2 (#378)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Feature/Improve Configuration options and handling (#385)

* Refactor configuration management: remove dataclass-based schema and simplify CONFIG structure.

* Refactor configuration loading: switch from `os` to `pathlib`, streamline YAML loading logic.

* Refactor logging setup: split handler creation into dedicated functions, simplify configuration logic.

* Improve logging configurability and safety

- Add support for `RotatingFileHandler` to prevent large log files.
- Introduce `console` flag for optional console logging.
- Default to `NullHandler` when no handlers are configured for better library behavior.

* Temp

* Temp

* Temp

* Temp

* Temp

* Temp

* Refactor configuration and logging: remove unused `merge_configs` function, streamline logging setup, and encapsulate `_setup_logging` as an internal function.

* Remove unused `change_logging_level` import and export.

* Add tests for config.py

* Expand `config.py` test coverage: add tests for custom config loading, logging setup, dict roundtrip, and attribute modification.

* Expand `test_config.py` coverage: add modeling config persistence test, refine logging reset, and improve partial config load assertions.

* Expand `test_config.py` coverage: add teardown for state cleanup and reset modeling config in setup.

* Add `CONFIG.reset()` method and expand test coverage to verify default restoration

* Refactor `CONFIG` to centralize defaults in `_DEFAULTS` and ensure `reset()` aligns with them; add test to verify consistency.

* Refactor `_DEFAULTS` to use `MappingProxyType` for immutability, restructure config hierarchy, and simplify `reset()` implementation for maintainability; update tests accordingly.

* Mark `TestConfigModule` tests to run in a single worker with `@pytest.mark.xdist_group` to prevent global config interference.

* Add default log file

* Update CHANGELOG.md

* Readd change_logging_level() for backwards compatability

* Add more options to config.py

* Add a docstring to config.y

* Add a docstring to config.y

* rename parameter message_format

* Improve color config

* Improve color config

* Update CHANGELOG.md

* Improve color handling

* Improve color handling

* Remove console Logging explicityl from examples

* Make log to console the default

* Make log to console the default

* Add individual level parameters for console and file

* Add extra Handler section

* Use dedicated levels for both handlers

* Switch back to not use Handlers

* Revert "Switch back to not use Handlers"

This reverts commit 05bbccb.

* Revert "Use dedicated levels for both handlers"

This reverts commit ed0542b.

* Revert "Add extra Handler section"

This reverts commit a133cc8.

* Revert "Add individual level parameters for console and file"

This reverts commit 19f81c9.

* Fix CHANGELOG.md

* Update CHANGELOG.md

* Fix CHANGELOG.md

* Allow blank issues

* Change default logging behaviour to other colors and no file logging

* Use white for INFO

* Use terminal default for INFO

* Explicitly use stdout for StreamHandler

* Use terminal default for Logging color

* Add option for loggger name

* Update CHANGELOG.md

* Ensure custom formats are being applied

* Catch empty config files

* Update test to match new defaults

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Author: FBumann

CHANGELOG.md

@@ -181,9 +181,14 @@ Until here -->
 - Added configurable log format settings: `CONFIG.Logging.date_format` and `CONFIG.Logging.format`
 - Added configurable console settings: `CONFIG.Logging.console_width` and `CONFIG.Logging.show_path`
 - Added `CONFIG.Logging.Colors` nested class for customizable log level colors using ANSI escape codes (works with both standard and Rich handlers)
+- All examples now enable console logging to demonstrate proper logging usage
+- Console logging now outputs to `sys.stdout` instead of `sys.stderr` for better compatibility with output redirection
 
 ### ♻️ Changed
 - Logging and Configuration management changed
+- **Breaking**: Console logging is now disabled by default (`CONFIG.Logging.console = False`). Enable it explicitly in your scripts with `CONFIG.Logging.console = True` and `CONFIG.apply()`
+- **Breaking**: File logging is now disabled by default (`CONFIG.Logging.file = None`). Set a file path to enable file logging
+- Improved default logging colors: DEBUG is now gray (`\033[90m`) for de-emphasized messages, INFO uses terminal default color (`\033[0m`) for clean output
 
 ### 🗑️ Deprecated
 - `change_logging_level()` function is now deprecated in favor of `CONFIG.Logging.level` and `CONFIG.apply()`. Will be removed in version 3.0.0.

examples/00_Minmal/minimal_example.py

@@ -9,6 +9,9 @@
 import flixopt as fx
 
 if __name__ == '__main__':
+    # Enable console logging
+    fx.CONFIG.Logging.console = True
+    fx.CONFIG.apply()
     # --- Define the Flow System, that will hold all elements, and the time steps you want to model ---
     timesteps = pd.date_range('2020-01-01', periods=3, freq='h')
     flow_system = fx.FlowSystem(timesteps)

examples/01_Simple/simple_example.py

@@ -8,6 +8,9 @@
 import flixopt as fx
 
 if __name__ == '__main__':
+    # Enable console logging
+    fx.CONFIG.Logging.console = True
+    fx.CONFIG.apply()
     # --- Create Time Series Data ---
     # Heat demand profile (e.g., kW) over time and corresponding power prices
     heat_demand_per_h = np.array([30, 0, 90, 110, 110, 20, 20, 20, 20])

examples/02_Complex/complex_example.py

@@ -9,6 +9,9 @@
 import flixopt as fx
 
 if __name__ == '__main__':
+    # Enable console logging
+    fx.CONFIG.Logging.console = True
+    fx.CONFIG.apply()
     # --- Experiment Options ---
     # Configure options for testing various parameters and behaviors
     check_penalty = False

examples/02_Complex/complex_example_results.py

@@ -5,6 +5,9 @@
 import flixopt as fx
 
 if __name__ == '__main__':
+    # Enable console logging
+    fx.CONFIG.Logging.console = True
+    fx.CONFIG.apply()
     # --- Load Results ---
     try:
         results = fx.results.CalculationResults.from_file('results', 'complex example')

examples/03_Calculation_types/example_calculation_types.py

@@ -11,6 +11,9 @@
 import flixopt as fx
 
 if __name__ == '__main__':
+    # Enable console logging
+    fx.CONFIG.Logging.console = True
+    fx.CONFIG.apply()
     # Calculation Types
     full, segmented, aggregated = True, True, True
 

flixopt/config.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import logging
+import sys
 import warnings
 from logging.handlers import RotatingFileHandler
 from pathlib import Path
@@ -25,19 +26,20 @@
         'logging': MappingProxyType(
             {
                 'level': 'INFO',
-                'file': 'flixopt.log',
+                'file': None,
                 'rich': False,
-                'console': True,
+                'console': False,
                 'max_file_size': 10_485_760,  # 10MB
                 'backup_count': 5,
                 'date_format': '%Y-%m-%d %H:%M:%S',
                 'format': '%(message)s',
                 'console_width': 120,
                 'show_path': False,
+                'show_logger_name': False,
                 'colors': MappingProxyType(
                     {
-                        'DEBUG': '\033[32m',  # Green
-                        'INFO': '\033[34m',  # Blue
+                        'DEBUG': '\033[90m',  # Bright Black/Gray
+                        'INFO': '\033[0m',  # Default/White
                         'WARNING': '\033[33m',  # Yellow
                         'ERROR': '\033[31m',  # Red
                         'CRITICAL': '\033[1m\033[31m',  # Bold Red
@@ -62,7 +64,7 @@ class CONFIG:
     The CONFIG class provides centralized configuration for logging and modeling parameters.
     All changes require calling ``CONFIG.apply()`` to take effect.
 
-    By default, logging outputs to both console and file ('flixopt.log').
+    By default, logging is disabled (no console or file output). Enable logging in your scripts as needed.
 
     Attributes:
         Logging: Nested class containing all logging configuration options.
@@ -73,9 +75,9 @@ class CONFIG:
     Logging Attributes:
         level (str): Logging level: 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'.
             Default: 'INFO'
-        file (str | None): Log file path. Default: 'flixopt.log'.
-            Set to None to disable file logging.
-        console (bool): Enable console (stdout) logging. Default: True
+        file (str | None): Log file path. Default: None (file logging disabled).
+            Set to a file path to enable file logging.
+        console (bool): Enable console (stdout) logging. Default: False
         rich (bool): Use Rich library for enhanced console output. Default: False
         max_file_size (int): Maximum log file size in bytes before rotation.
             Default: 10485760 (10MB)
@@ -85,10 +87,11 @@ class CONFIG:
         format (str): Log message format string. Default: '%(message)s'
         console_width (int): Console width for Rich handler. Default: 120
         show_path (bool): Show file paths in log messages. Default: False
+        show_logger_name (bool): Show logger name in log messages. Default: False
 
     Colors Attributes:
-        DEBUG (str): ANSI color code for DEBUG level. Default: '\\033[32m' (green)
-        INFO (str): ANSI color code for INFO level. Default: '\\033[34m' (blue)
+        DEBUG (str): ANSI color code for DEBUG level. Default: '\\033[90m' (bright black/gray)
+        INFO (str): ANSI color code for INFO level. Default: '\\033[0m' (terminal default)
         WARNING (str): ANSI color code for WARNING level. Default: '\\033[33m' (yellow)
         ERROR (str): ANSI color code for ERROR level. Default: '\\033[31m' (red)
         CRITICAL (str): ANSI color code for CRITICAL level. Default: '\\033[1m\\033[31m' (bold red)
@@ -106,6 +109,8 @@ class CONFIG:
         - '\\033[35m' - Magenta
         - '\\033[36m' - Cyan
         - '\\033[37m' - White
+        - '\\033[90m' - Bright Black/Gray
+        - '\\033[0m' - Reset to default
         - '\\033[1m\\033[3Xm' - Bold color (replace X with color code 0-7)
         - '\\033[2m\\033[3Xm' - Dim color (replace X with color code 0-7)
 
@@ -130,6 +135,12 @@ class CONFIG:
             CONFIG.Logging.level = 'DEBUG'
             CONFIG.apply()
 
+        Show logger names to see which module is logging::
+
+            CONFIG.Logging.console = True
+            CONFIG.Logging.show_logger_name = True
+            CONFIG.apply()
+
         Configure log file rotation::
 
             CONFIG.Logging.file = 'myapp.log'
@@ -139,7 +150,7 @@ class CONFIG:
 
         Customize log colors::
 
-            CONFIG.Logging.Colors.INFO = '\\033[35m'  # Magenta
+            CONFIG.Logging.Colors.INFO = '\\033[32m'  # Green
             CONFIG.Logging.Colors.DEBUG = '\\033[36m'  # Cyan
             CONFIG.Logging.Colors.ERROR = '\\033[1m\\033[31m'  # Bold red
             CONFIG.apply()
@@ -150,7 +161,7 @@ class CONFIG:
             CONFIG.Logging.rich = True
             CONFIG.Logging.console_width = 100
             CONFIG.Logging.show_path = True
-            CONFIG.Logging.Colors.INFO = '\\033[36m'  # Cyan
+            CONFIG.Logging.Colors.INFO = '\\033[32m'  # Green
             CONFIG.apply()
 
         Load from YAML file::
@@ -165,15 +176,16 @@ class CONFIG:
               level: DEBUG
               console: true
               file: app.log
-              rich: true
+              rich: false
+              show_logger_name: true
               max_file_size: 5242880  # 5MB
               backup_count: 3
               date_format: '%H:%M:%S'
               console_width: 100
-              show_path: true
+              show_path: false
               colors:
-                DEBUG: "\\033[36m"              # Cyan
-                INFO: "\\033[32m"               # Green
+                DEBUG: "\\033[90m"              # Bright Black/Gray
+                INFO: "\\033[0m"                # Default
                 WARNING: "\\033[33m"            # Yellow
                 ERROR: "\\033[31m"              # Red
                 CRITICAL: "\\033[1m\\033[31m"   # Bold red
@@ -207,6 +219,7 @@ class Logging:
         format: str = _DEFAULTS['logging']['format']
         console_width: int = _DEFAULTS['logging']['console_width']
         show_path: bool = _DEFAULTS['logging']['show_path']
+        show_logger_name: bool = _DEFAULTS['logging']['show_logger_name']
 
         class Colors:
             DEBUG: str = _DEFAULTS['logging']['colors']['DEBUG']
@@ -262,6 +275,7 @@ def apply(cls):
             format=cls.Logging.format,
             console_width=cls.Logging.console_width,
             show_path=cls.Logging.show_path,
+            show_logger_name=cls.Logging.show_logger_name,
             colors=colors_dict,
         )
 
@@ -273,7 +287,7 @@ def load_from_file(cls, config_file: str | Path):
             raise FileNotFoundError(f'Config file not found: {config_file}')
 
         with config_path.open() as file:
-            config_dict = yaml.safe_load(file)
+            config_dict = yaml.safe_load(file) or {}
             cls._apply_config_dict(config_dict)
 
         cls.apply()
@@ -312,6 +326,7 @@ def to_dict(cls):
                 'format': cls.Logging.format,
                 'console_width': cls.Logging.console_width,
                 'show_path': cls.Logging.show_path,
+                'show_logger_name': cls.Logging.show_logger_name,
                 'colors': {
                     'DEBUG': cls.Logging.Colors.DEBUG,
                     'INFO': cls.Logging.Colors.INFO,
@@ -331,14 +346,22 @@ def to_dict(cls):
 class MultilineFormater(logging.Formatter):
     """Formatter that handles multi-line messages with consistent prefixes."""
 
-    def __init__(self, fmt=None, datefmt=None):
+    def __init__(self, fmt: str = '%(message)s', datefmt=None, show_logger_name=False):
         super().__init__(fmt=fmt, datefmt=datefmt)
+        self.show_logger_name = show_logger_name
 
     def format(self, record):
-        message_lines = record.getMessage().split('\n')
+        record.message = record.getMessage()
+        message_lines = self._style.format(record).split('\n')
         timestamp = self.formatTime(record, self.datefmt)
         log_level = record.levelname.ljust(8)
-        log_prefix = f'{timestamp} | {log_level} |'
+
+        if self.show_logger_name:
+            # Truncate long logger names for readability
+            logger_name = record.name if len(record.name) <= 20 else f'...{record.name[-17:]}'
+            log_prefix = f'{timestamp} | {log_level} | {logger_name.ljust(20)} |'
+        else:
+            log_prefix = f'{timestamp} | {log_level} |'
 
         first_line = [f'{log_prefix} {message_lines[0]}']
         if len(message_lines) > 1:
@@ -354,14 +377,14 @@ class ColoredMultilineFormater(MultilineFormater):
 
     RESET = '\033[0m'
 
-    def __init__(self, fmt=None, datefmt=None, colors=None):
-        super().__init__(fmt=fmt, datefmt=datefmt)
+    def __init__(self, fmt=None, datefmt=None, colors=None, show_logger_name=False):
+        super().__init__(fmt=fmt, datefmt=datefmt, show_logger_name=show_logger_name)
         self.COLORS = (
             colors
             if colors is not None
             else {
-                'DEBUG': '\033[32m',
-                'INFO': '\033[34m',
+                'DEBUG': '\033[90m',
+                'INFO': '\033[0m',
                 'WARNING': '\033[33m',
                 'ERROR': '\033[31m',
                 'CRITICAL': '\033[1m\033[31m',
@@ -379,6 +402,7 @@ def _create_console_handler(
     use_rich: bool = False,
     console_width: int = 120,
     show_path: bool = False,
+    show_logger_name: bool = False,
     date_format: str = '%Y-%m-%d %H:%M:%S',
     format: str = '%(message)s',
     colors: dict[str, str] | None = None,
@@ -389,6 +413,7 @@ def _create_console_handler(
         use_rich: If True, use RichHandler with color support.
         console_width: Width of the console for Rich handler.
         show_path: Show file paths in log messages (Rich only).
+        show_logger_name: Show logger name in log messages.
         date_format: Date/time format string.
         format: Log message format string.
         colors: Dictionary of ANSI color codes for each log level.
@@ -423,8 +448,16 @@ def _create_console_handler(
         )
         handler.setFormatter(logging.Formatter(format))
     else:
-        handler = logging.StreamHandler()
-        handler.setFormatter(ColoredMultilineFormater(fmt=format, datefmt=date_format, colors=colors))
+        # Explicitly use sys.stdout instead of default sys.stderr
+        handler = logging.StreamHandler(stream=sys.stdout)
+        handler.setFormatter(
+            ColoredMultilineFormater(
+                fmt=format,
+                datefmt=date_format,
+                colors=colors,
+                show_logger_name=show_logger_name,
+            )
+        )
 
     return handler
 
@@ -433,6 +466,7 @@ def _create_file_handler(
     log_file: str,
     max_file_size: int = 10_485_760,
     backup_count: int = 5,
+    show_logger_name: bool = False,
     date_format: str = '%Y-%m-%d %H:%M:%S',
     format: str = '%(message)s',
 ) -> RotatingFileHandler:
@@ -442,6 +476,7 @@ def _create_file_handler(
         log_file: Path to the log file.
         max_file_size: Maximum size in bytes before rotation.
         backup_count: Number of backup files to keep.
+        show_logger_name: Show logger name in log messages.
         date_format: Date/time format string.
         format: Log message format string.
 
@@ -454,7 +489,13 @@ def _create_file_handler(
         backupCount=backup_count,
         encoding='utf-8',
     )
-    handler.setFormatter(MultilineFormater(fmt=format, datefmt=date_format))
+    handler.setFormatter(
+        MultilineFormater(
+            fmt=format,
+            datefmt=date_format,
+            show_logger_name=show_logger_name,
+        )
+    )
     return handler
 
 
@@ -469,6 +510,7 @@ def _setup_logging(
     format: str = '%(message)s',
     console_width: int = 120,
     show_path: bool = False,
+    show_logger_name: bool = False,
     colors: dict[str, str] | None = None,
 ):
     """Internal function to setup logging - use CONFIG.apply() instead.
@@ -487,6 +529,7 @@ def _setup_logging(
         format: Log message format string.
         console_width: Console width for Rich handler.
         show_path: Show file paths in log messages (Rich only).
+        show_logger_name: Show logger name in log messages.
         colors: ANSI color codes for each log level.
     """
     logger = logging.getLogger('flixopt')
@@ -500,6 +543,7 @@ def _setup_logging(
                 use_rich=use_rich_handler,
                 console_width=console_width,
                 show_path=show_path,
+                show_logger_name=show_logger_name,
                 date_format=date_format,
                 format=format,
                 colors=colors,
@@ -512,6 +556,7 @@ def _setup_logging(
                 log_file=log_file,
                 max_file_size=max_file_size,
                 backup_count=backup_count,
+                show_logger_name=show_logger_name,
                 date_format=date_format,
                 format=format,
             )