feat: add termlog_colors option to force/disable color output - #8280
Open
gaurav0107 wants to merge 1 commit into
Open
gaurav0107 wants to merge 1 commit into
gaurav0107 wants to merge 1 commit into
Conversation
gaurav0107
marked this pull request as ready for review
June 10, 2026 04:12
Add a termlog_colors option (auto/always/never) that lets users force-enable or force-disable ANSI color output for log and mitmdump flow output, independent of TTY auto-detection. This is useful when piping mitmdump output to a pager while keeping colors (e.g. mitmdump | less -R), or when disabling colors in environments that are incorrectly detected as a TTY. The option is honored by termlog, dumper, and the vt_codes TTY detection helper, with errorcheck validating the allowed values.
gaurav0107
force-pushed
the
fix/7824-add-color-always
branch
from
July 2, 2026 15:11
853c142 to
353e361
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a
termlog_colorsoption (auto/always/never) so users can override mitmproxy's automaticisatty()-based color detection. The primary motivation is to keep colored output when pipingmitmdumpthrough a pager:mitmdump --set termlog_colors=always | less -RThis mirrors the well-known
--color={auto,always,never}flag from coreutils (ls,grep).The override threads through
vt_codes.ensure_supported(f, override=...), which is called from:termlog(logging output)dumper(mitmdump flow output)errorcheck(startup-error stderr printing)Default behavior is unchanged:
"auto"preserves the existingisatty()/ Windows console-mode detection. The new option is keyword-only onensure_supported, so any third-party callers continue to work without modification.Checklist
Summary
Closes #7824.
Tests added:
test/mitmproxy/utils/test_vt_codes.py—test_override_always,test_override_never,test_override_auto_defaulttest/mitmproxy/addons/test_termlog.py—test_force_color,test_disable_colortest/mitmproxy/addons/test_dumper.py—test_force_color,test_disable_colorLocal verification:
uv run pytest test/mitmproxy/utils/test_vt_codes.py test/mitmproxy/addons/test_termlog.py test/mitmproxy/addons/test_dumper.py test/mitmproxy/addons/test_errorcheck.py— 31 passeduv run pytest test/mitmproxy/addons/— 533 passed, 1 skippeduv run mypy— 288 source files, no issuesuv run ruff check . && uv run ruff format --check .— clean