Create pylinter#_handle_force_color_no_color

Use the `_is_env_set_and_non_empty`, and the logic decided in the issue,
to modify the reporter(s) list accordingly.

At most, one reporter should be modified - the one going to `stdout`.

Hooking before the `self.set_reporter` was deemed as the smallest incision.

For no particular reason, it was decided that
`_handle_force_color_no_color` would modify its input;
so there would be no need for re-assigning the input we want to modify anyway.

Signed-off-by: Stavros Ntentos <[email protected]>

Author: stdedos

pylint/lint/pylinter.py

@@ -12,6 +12,7 @@
 import sys
 import tokenize
 import traceback
+import warnings
 from collections import defaultdict
 from collections.abc import Callable, Iterable, Iterator, Sequence
 from io import TextIOWrapper
@@ -48,13 +49,15 @@
     report_total_messages_stats,
 )
 from pylint.lint.utils import (
+    _is_env_set_and_non_empty,
     augmented_sys_path,
     get_fatal_error_message,
     prepare_crash_report,
 )
 from pylint.message import Message, MessageDefinition, MessageDefinitionStore
+from pylint.reporters import ReporterWarning
 from pylint.reporters.base_reporter import BaseReporter
-from pylint.reporters.text import TextReporter
+from pylint.reporters.text import ColorizedTextReporter, TextReporter
 from pylint.reporters.ureports import nodes as report_nodes
 from pylint.typing import (
     DirectoryNamespaceDict,
@@ -69,6 +72,14 @@
 
 MANAGER = astroid.MANAGER
 
+NO_COLOR = "NO_COLOR"
+FORCE_COLOR = "FORCE_COLOR"
+PY_COLORS = "PY_COLORS"
+
+WARN_FORCE_COLOR_SET = "FORCE_COLOR is set; ignoring `text` at stdout"
+WARN_NO_COLOR_SET = "NO_COLOR is set; ignoring `colorized` at stdout"
+WARN_BOTH_COLOR_SET = "Both NO_COLOR and FORCE_COLOR are set! (disabling colors)"
+
 
 class GetAstProtocol(Protocol):
     def __call__(
@@ -250,6 +261,68 @@ def _load_reporter_by_class(reporter_class: str) -> type[BaseReporter]:
 }
 
 
+def _handle_force_color_no_color(reporter: list[reporters.BaseReporter]) -> None:
+    """
+    Check ``NO_COLOR``, ``FORCE_COLOR``, ``PY_COLOR`` and modify the reporter list
+    accordingly.
+
+    Rules are presented in this table:
+    +--------------+---------------+-----------------+------------------------------------------------------------+
+    | `NO_COLOR`   | `FORCE_COLOR` | `output-format` | Behavior                                                   |
+    +==============+===============+=================+============================================================+
+    | `bool: True` | `bool: True`  | colorized       | not colorized + warnings (override + inconsistent env var) |
+    | `bool: True` | `bool: True`  | /               | not colorized + warnings (inconsistent env var)            |
+    | unset        | `bool: True`  | colorized       | colorized                                                  |
+    | unset        | `bool: True`  | /               | colorized + warnings (override)                            |
+    | `bool: True` | unset         | colorized       | not colorized + warnings (override)                        |
+    | `bool: True` | unset         | /               | not colorized                                              |
+    | unset        | unset         | colorized       | colorized                                                  |
+    | unset        | unset         | /               | not colorized                                              |
+    +--------------+---------------+-----------------+------------------------------------------------------------+
+    """
+    no_color = _is_env_set_and_non_empty(NO_COLOR)
+    force_color = _is_env_set_and_non_empty(FORCE_COLOR) or _is_env_set_and_non_empty(
+        PY_COLORS
+    )
+
+    if no_color and force_color:
+        warnings.warn(
+            WARN_BOTH_COLOR_SET,
+            ReporterWarning,
+            stacklevel=2,
+        )
+        force_color = False
+
+    if no_color:
+        for idx, rep in enumerate(list(reporter)):
+            if not isinstance(rep, ColorizedTextReporter):
+                continue
+
+            if rep.out.buffer is sys.stdout.buffer:
+                warnings.warn(
+                    WARN_NO_COLOR_SET,
+                    ReporterWarning,
+                    stacklevel=2,
+                )
+                reporter.pop(idx)
+                reporter.append(TextReporter())
+
+    elif force_color:
+        for idx, rep in enumerate(list(reporter)):
+            # pylint: disable=unidiomatic-typecheck # Want explicit type check
+            if type(rep) is not TextReporter:
+                continue
+
+            if rep.out.buffer is sys.stdout.buffer:
+                warnings.warn(
+                    WARN_FORCE_COLOR_SET,
+                    ReporterWarning,
+                    stacklevel=2,
+                )
+                reporter.pop(idx)
+                reporter.append(ColorizedTextReporter())
+
+
 # pylint: disable=too-many-instance-attributes,too-many-public-methods
 class PyLinter(
     _ArgumentsManager,
@@ -435,6 +508,8 @@ def _load_reporters(self, reporter_names: str) -> None:
             # Extend the lifetime of all opened output files
             close_output_files = stack.pop_all().close
 
+        _handle_force_color_no_color(sub_reporters)
+
         if len(sub_reporters) > 1 or output_files:
             self.set_reporter(
                 reporters.MultiReporter(

pylint/reporters/__init__.py

@@ -19,6 +19,10 @@
     from pylint.lint.pylinter import PyLinter
 
 
+class ReporterWarning(Warning):
+    """Warning class for reporters."""
+
+
 def initialize(linter: PyLinter) -> None:
     """Initialize linter with reporters in this package."""
     utils.register_plugins(linter, __path__[0])