Color Output on github actions

[ecs-jnguyen]

Hello, I am trying to use structlog in a github action job and I noticed that there isn't any color output. Is there a setting that I'm missing to enable colors in github actions?

Here's my github actions job run:

https://github.com/ecs-jnguyen/test-actions-colors/actions/runs/4357219988/jobs/7616263866

Here is the python code that I'm using:

import structlog

if __name__ == "__main__":
    logger = structlog.get_logger()
    logger.info("hello", name="me", age=123)
    logger.warning("bye", name="me", age=123)
    logger.error("ohno", name="me", age=123)

[hynek]

structlog checks if the terminal is a tty, which it probably isn't for GHA:

structlog/src/structlog/_config.py

Lines 37 to 42 in 74cdff9

	ConsoleRenderer(
	colors=_has_colors
	and sys.stdout is not None
	and hasattr(sys.stdout, "isatty")
	and sys.stdout.isatty()
	),

You'll have to configure it by hand and explicitly pass colors=True.

[ecs-jnguyen]

I've seen a lot of talks about the use of the environment variable FORCE_COLOR=1 or FORCE_COLOR=true to get colors in CI tools like github actions. Could we do the same with structlog so that users don't have to configure the default list of processors for this one setting?

References:

• Fall back to FORCE_COLOR environment variable if MYPY_FORCE_COLOR is not present python/mypy#13814
• Add support for NO_COLOR and FORCE_COLOR pytest-dev/pytest#7466

[hynek]

This is an interesting question and transition period. structlog has exploded for use-cases that I never anticipated. CLI output used to be just a perk for development. I guess we [cs]ould accept the new role and make it nicer out of the box…