Hydra Colorlog

1.2.0 · active · verified Tue Apr 14

Hydra-colorlog is a plugin for the Hydra configuration framework that enables colored logging output for Hydra applications. It specifically integrates the 'colorlog' library into Hydra's internal (`hydra_logging`) and job-specific (`job_logging`) logging mechanisms, enhancing readability. The current version is 1.2.0, and its release cadence is tied to that of the main Hydra project, which sees several updates per year.

Warnings

breaking When using older Hydra 1.0.x with OmegaConf 2.1, attempting to load `hydra/hydra_logging/colorlog` could result in a `MissingConfigException`. This often indicates an incompatibility between the specific minor versions of Hydra and OmegaConf.
Fix: Upgrade `hydra-core` to at least 1.0.5 or ensure your `hydra-colorlog` version is compatible with your `hydra-core` and `omegaconf` versions. Check the `hydra-colorlog` PyPI page for required dependencies.
gotcha For `hydra-colorlog` to function, you must explicitly override `hydra/job_logging` and `hydra/hydra_logging` to `colorlog` within your Hydra configuration's `defaults` list. Without this configuration, the plugin will not be active, and you will not see colored output.
Fix: Add the following to your main Hydra config file (e.g., `config.yaml`): ```yaml defaults: - override hydra/job_logging: colorlog - override hydra/hydra_logging: colorlog ```
deprecated Documentation for older Hydra versions (e.g., 1.0, 1.2) explicitly states they are 'no longer actively maintained'. While `hydra-colorlog` 1.2.0 works with Hydra 1.x, users should target newer Hydra documentation and versions for active support and features.
Fix: Consider upgrading to the latest stable version of Hydra (e.g., 1.3.x or newer if available) to benefit from continued maintenance, bug fixes, and new features. Ensure `hydra-colorlog` is compatible with the target Hydra version.
gotcha Older versions of Hydra (specifically around 1.1.0/1.1.1) had a bug where enabling the `colorlog` override could inadvertently disable other logging overrides, leading to unexpected logging behavior.
Fix: Ensure you are using a patched version of Hydra 1.1.x (e.g., 1.1.2 or later) or upgrade to Hydra 1.2.0+ where this issue should be resolved.

Install

pip install hydra-colorlog Install with pip

Imports

hydra_colorlog
```
# hydra-colorlog is typically enabled via Hydra's configuration, not direct Python import.
```
Users enable the plugin by configuring Hydra's defaults, rather than importing Python symbols from hydra_colorlog directly into their application code.
ColoredFormatter
```
from colorlog import ColoredFormatter
```
While 'colorlog.ColoredFormatter' is used internally by the plugin, direct import is only necessary if you're customizing log formats beyond the plugin's defaults.

Quickstart

To enable `hydra-colorlog`, install the package and then create a Hydra configuration file (e.g., `config.yaml` in a `conf` directory) that overrides the default Hydra logging settings. This minimal example demonstrates how to set up a Hydra application and activate colored logging by explicitly specifying `colorlog` for both `hydra/job_logging` and `hydra/hydra_logging` in the defaults list.

import hydra
from omegaconf import DictConfig
import logging

log = logging.getLogger(__name__)

@hydra.main(config_path="conf", config_name="config", version_base="1.2")
def my_app(cfg: DictConfig) -> None:
    log.info("This is an info message.")
    log.warning("This is a warning message.")
    log.error("This is an error message.")
    print(f"Config: {cfg.pretty()}")

if __name__ == "__main__":
    # Create a 'conf' directory and 'config.yaml' file alongside this script.
    # In config.yaml, add:
    # defaults:
    #   - override hydra/job_logging: colorlog
    #   - override hydra/hydra_logging: colorlog
    # Example to run: python your_script_name.py
    my_app()

view raw JSON →