[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashb merged 1 commit into from
Sep 26, 2025
Merged

[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132) #56157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions shared/logging/src/airflow_shared/logging/structlog.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
stdlib_config: dict | None = None,
extra_processors: Sequence[Processor] | None = None,
callsite_parameters: Iterable[CallsiteParameter] | None = None,
colors: bool | None = None,
colors: bool = True,
output: LogOutputType | None = None,
log_levels: str | dict[str, str] | None = None,
cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
:param log_level: The default log level to use for most logs
:param log_format: A percent-style log format to write non JSON logs with.
:param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
:param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
if standard out is a TTY (that is, an interactive session).
:param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
an interactive session), unless overridden by environment variables described below.
Please note that disabling colors also disables all styling, including bold and italics.
The following environment variables control color behavior (set to any non-empty value to activate):

* ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

* ``FORCE_COLOR`` activates colors, regardless of where output is going.
* ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
:param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
if "fatal" not in NAME_TO_LEVEL:
NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

if colors is None:
colors = os.environ.get("NO_COLOR", "") == "" and (
os.environ.get("FORCE_COLOR", "") != ""
or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
)
def is_atty():
return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

colors = os.environ.get("NO_COLOR", "") == "" and (
os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
)

stdlib_config = stdlib_config or {}
extra_processors = extra_processors or ()
Expand Down
49 changes: 48 additions & 1 deletion shared/logging/tests/logging/test_structlog.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
else:
buff = io.StringIO()

configure_logging(**kwargs, output=buff)
with mock.patch("sys.stdout") as mock_stdout:
mock_stdout.isatty.return_value = True
configure_logging(**kwargs, output=buff)

yield buff
buff.seek(0)
finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
)


@pytest.mark.parametrize(
("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
[
# NO_COLOR takes precedence over everything
pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
# FORCE_COLOR takes precedence when NO_COLOR is not set
pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
# When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
pytest.param("", "", True, True, True, id="tty_colors_true"),
pytest.param("", "", True, False, False, id="tty_colors_false"),
pytest.param("", "", False, True, False, id="no_tty_colors_true"),
pytest.param("", "", False, False, False, id="no_tty_colors_false"),
],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
"""Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

monkeypatch.setenv("NO_COLOR", no_color)
monkeypatch.setenv("FORCE_COLOR", force_color)

with mock.patch("sys.stdout") as mock_stdout:
mock_stdout.isatty.return_value = is_tty

with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
mock_processors.return_value = ([], None, None)

structlog_module.configure_logging(colors=colors_param)

mock_processors.assert_called_once()
assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
("get_logger", "extra_kwargs", "extra_output"),
[
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)#56157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ashb
merged 1 commit into

from

Sep 26, 2025
 Merged


[v3-1-test] Detect interactive terminal to set colored logging + support override env variables (#56132)
#56157
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


29 changes: 16 additions & 13 deletions
shared/logging/src/airflow_shared/logging/structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -384,7 +384,7 @@ def configure_logging(
 stdlib_config: dict | None = None,
 extra_processors: Sequence[Processor] | None = None,
 callsite_parameters: Iterable[CallsiteParameter] | None = None,
 colors: bool | None = None,
 colors: bool = True,
 output: LogOutputType | None = None,
 log_levels: str | dict[str, str] | None = None,
 cache_logger_on_first_use: bool = True,
Expand All@@ -399,15 +399,17 @@ def configure_logging(
 :param log_level: The default log level to use for most logs
 :param log_format: A percent-style log format to write non JSON logs with.
 :param output: Where to write the logs too. If ``json_output`` is true this must be a binary stream
 :param colors: Whether to use colors for non-JSON logs. If `None` is passed, then colors are used
 if standard out is a TTY (that is, an interactive session).
 :param colors: Whether to use colors for non-JSON logs. This only works if standard out is a TTY (that is,
 an interactive session), unless overridden by environment variables described below.
 Please note that disabling colors also disables all styling, including bold and italics.
 The following environment variables control color behavior (set to any non-empty value to activate):

 * ``NO_COLOR`` - Disables colors completely. This takes precedence over all other settings,
 including ``FORCE_COLOR``.

It's possible to override this behavior by setting two standard environment variables to any value
except an empty string:
* ``FORCE_COLOR`` - Forces colors to be enabled, even when output is not going to a TTY. This only
takes effect if ``NO_COLOR`` is not set.

 * ``FORCE_COLOR`` activates colors, regardless of where output is going.
 * ``NO_COLOR`` disables colors, regardless of where the output is going and regardless the value of
 ``FORCE_COLOR``. Please note that ``NO_COLOR`` disables all styling, including bold and italics.
 :param callsite_parameters: A list parameters about the callsite (line number, function name etc) to
 include in the logs.

Expand All@@ -425,11 +427,12 @@ def configure_logging(
 if "fatal" not in NAME_TO_LEVEL:
 NAME_TO_LEVEL["fatal"] = NAME_TO_LEVEL["critical"]

 if colors is None:
 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != ""
 or (sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty())
 )
 def is_atty():
 return sys.stdout is not None and hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

 colors = os.environ.get("NO_COLOR", "") == "" and (
 os.environ.get("FORCE_COLOR", "") != "" or (colors and is_atty())
 )

 stdlib_config = stdlib_config or {}
 extra_processors = extra_processors or ()
Expand Down

49 changes: 48 additions & 1 deletion
shared/logging/tests/logging/test_structlog.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,12 +25,14 @@
import sys
import textwrap
from datetime import datetime, timezone
from unittest import mock

import pytest
import structlog
from structlog.dev import BLUE, BRIGHT, CYAN, DIM, GREEN, MAGENTA, RESET_ALL as RESET
from structlog.processors import CallsiteParameter

from airflow_shared.logging import structlog as structlog_module
from airflow_shared.logging.structlog import configure_logging

# We don't want to use the caplog fixture in this test, as the main purpose of this file is to capture the
Expand All@@ -56,7 +58,10 @@ def configurer(**kwargs):
 else:
 buff = io.StringIO()

 configure_logging(**kwargs, output=buff)
 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = True
 configure_logging(**kwargs, output=buff)

 yield buff
 buff.seek(0)
 finally:
Expand DownExpand Up@@ -114,6 +119,48 @@ def test_colorful(structlog_config, get_logger, config_kwargs, extra_kwargs, ext
 )


@pytest.mark.parametrize(
 ("no_color", "force_color", "is_tty", "colors_param", "expected_colors"),
 [
 # NO_COLOR takes precedence over everything
 pytest.param("1", "", True, True, False, id="no_color_set_tty_colors_true"),
 pytest.param("1", "", True, False, False, id="no_color_set_tty_colors_false"),
 pytest.param("1", "", False, True, False, id="no_color_set_no_tty_colors_true"),
 pytest.param("1", "", False, False, False, id="no_color_set_no_tty_colors_false"),
 pytest.param("1", "1", True, True, False, id="no_color_and_force_color_tty_colors_true"),
 pytest.param("1", "1", True, False, False, id="no_color_and_force_color_tty_colors_false"),
 pytest.param("1", "1", False, True, False, id="no_color_and_force_color_no_tty_colors_true"),
 pytest.param("1", "1", False, False, False, id="no_color_and_force_color_no_tty_colors_false"),
 # FORCE_COLOR takes precedence when NO_COLOR is not set
 pytest.param("", "1", True, True, True, id="force_color_tty_colors_true"),
 pytest.param("", "1", True, False, True, id="force_color_tty_colors_false"),
 pytest.param("", "1", False, True, True, id="force_color_no_tty_colors_true"),
 pytest.param("", "1", False, False, True, id="force_color_no_tty_colors_false"),
 # When neither NO_COLOR nor FORCE_COLOR is set, check TTY and colors param
 pytest.param("", "", True, True, True, id="tty_colors_true"),
 pytest.param("", "", True, False, False, id="tty_colors_false"),
 pytest.param("", "", False, True, False, id="no_tty_colors_true"),
 pytest.param("", "", False, False, False, id="no_tty_colors_false"),
 ],
)
def test_color_config(monkeypatch, no_color, force_color, is_tty, colors_param, expected_colors):
 """Test all combinations of NO_COLOR, FORCE_COLOR, is_atty(), and colors parameter."""

 monkeypatch.setenv("NO_COLOR", no_color)
 monkeypatch.setenv("FORCE_COLOR", force_color)

 with mock.patch("sys.stdout") as mock_stdout:
 mock_stdout.isatty.return_value = is_tty

 with mock.patch.object(structlog_module, "structlog_processors") as mock_processors:
 mock_processors.return_value = ([], None, None)

 structlog_module.configure_logging(colors=colors_param)

 mock_processors.assert_called_once()
 assert mock_processors.call_args.kwargs["colors"] == expected_colors


@pytest.mark.parametrize(
 ("get_logger", "extra_kwargs", "extra_output"),
 [
Expand Down