term-background 1.0.5

Determine if a shell has a light or dark background

The Python module contained is part of a broader set of scripts.

For the shell scripts, if you source this from a shell session, it will set and export COLORFGBG to 0;15 for dark backgrounds and 15;0 for light backgrounds, which is a convention used by some programs. Since I find this a little arcane, the program also sets and exports LC_DARK_BG to 1 for dark backgrounds and 0 for light. The LC_ (locale) assists in some SSH configurations, which often will let environment variables with that prefix get passed along and set to a remote SSH session.

From Python, you can call term_background.is_dark_background() which returns a True if we think the background is dark.

To see if your environment variables are color consistent, run:

$ python -m term_background

The heuristics used are to try to query the background color using an xterm control sequence.

Many, but not all, terminals support this query. So as a fallback, we query the environment variable COLORFGBG, and failing this, we use some defaults for some known terminals set from the TERM environment variable. MacOS has its way of querying characteristics, so we use that too if you are running on that OS.

If either NO_COLOR or CLI_THEME are set, this is noted.

When we can get pixel intensities of red, blue, and green values of the background, we can use that to determine light and dark based on the combined sum: zero values indicate an absence of a particular color, and we can compare that with the values of the foreground.

You can set any of these environment variables to influence the output decision.

Many thanks to Thomas Dickey, Egmont Koblinger, and Gilles, for explanations (and code!) via unix.stackexchange. John Green had the idea to compare the foreground and background colors instead of comparing the background against the midway gray color and implemented that change here.

Of course, the bugs and lacunae in this code are mine.