gh-133722: Add Difflib theme to _colorize and 'color' option to difflib.unified_diff

Doc/library/difflib.rst

@@ -278,7 +278,7 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
       emu
 
 
-.. function:: unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n')
+.. function:: unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n', color=False)
 
    Compare *a* and *b* (lists of strings); return a delta (a :term:`generator`
    generating the delta lines) in unified diff format.
@@ -297,6 +297,9 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
    For inputs that do not have trailing newlines, set the *lineterm* argument to
    ``""`` so that the output will be uniformly newline free.
 
+   Set ``color`` to ``True`` to inject ANSI color codes and make the output look
+   like what ``git diff --color`` shows.
+
    The unified diff format normally has a header for filenames and modification
    times.  Any or all of these may be specified using strings for *fromfile*,
    *tofile*, *fromfiledate*, and *tofiledate*.  The modification times are normally
@@ -319,6 +322,10 @@ diffs. For comparing directories and files, see also, the :mod:`filecmp` module.
 
    See :ref:`difflib-interface` for a more detailed example.
 
+   .. versionchanged:: next
+      Added the *color* parameter.
+
+
 .. function:: diff_bytes(dfunc, a, b, fromfile=b'', tofile=b'', fromfiledate=b'', tofiledate=b'', n=3, lineterm=b'\n')
 
    Compare *a* and *b* (lists of bytes objects) using *dfunc*; yield a

Lib/_colorize.py

@@ -207,6 +207,16 @@ class Unittest(ThemeSection):
     reset: str = ANSIColors.RESET
 
 
+@dataclass(frozen=True)
+class Difflib(ThemeSection):
+    """A 'git diff'-like theme for `difflib.unified_diff`."""
+    header: str = ANSIColors.BOLD  # eg "---" and "+++" lines
+    hunk: str = ANSIColors.CYAN  # the "@@" lines
+    insert: str = ANSIColors.GREEN
+    delete: str = ANSIColors.RED
+    reset: str = ANSIColors.RESET
+
+
 @dataclass(frozen=True)
 class Theme:
     """A suite of themes for all sections of Python.
@@ -218,6 +228,7 @@ class Theme:
     syntax: Syntax = field(default_factory=Syntax)
     traceback: Traceback = field(default_factory=Traceback)
     unittest: Unittest = field(default_factory=Unittest)
+    difflib: Difflib = field(default_factory=Difflib)
 
     def copy_with(
         self,
@@ -226,6 +237,7 @@ def copy_with(
         syntax: Syntax | None = None,
         traceback: Traceback | None = None,
         unittest: Unittest | None = None,
+        difflib: Difflib | None = None,
     ) -> Self:
         """Return a new Theme based on this instance with some sections replaced.
 
@@ -237,6 +249,7 @@ def copy_with(
             syntax=syntax or self.syntax,
             traceback=traceback or self.traceback,
             unittest=unittest or self.unittest,
+            difflib=difflib or self.difflib,
         )
 
     @classmethod
@@ -252,6 +265,7 @@ def no_colors(cls) -> Self:
             syntax=Syntax.no_colors(),
             traceback=Traceback.no_colors(),
             unittest=Unittest.no_colors(),
+            difflib=Difflib.no_colors(),
         )
 
 

Lib/difflib.py

@@ -30,6 +30,7 @@
            'Differ','IS_CHARACTER_JUNK', 'IS_LINE_JUNK', 'context_diff',
            'unified_diff', 'diff_bytes', 'HtmlDiff', 'Match']
 
+from _colorize import can_colorize, get_theme
 from heapq import nlargest as _nlargest
 from collections import namedtuple as _namedtuple
 from types import GenericAlias
@@ -1094,7 +1095,7 @@ def _format_range_unified(start, stop):
     return '{},{}'.format(beginning, length)
 
 def unified_diff(a, b, fromfile='', tofile='', fromfiledate='',
-                 tofiledate='', n=3, lineterm='\n'):
+                 tofiledate='', n=3, lineterm='\n', color=False):
     r"""
     Compare two sequences of lines; generate the delta as a unified diff.
 
@@ -1111,6 +1112,9 @@ def unified_diff(a, b, fromfile='', tofile='', fromfiledate='',
     For inputs that do not have trailing newlines, set the lineterm
     argument to "" so that the output will be uniformly newline free.
 
+    Set `color` to True to inject ANSI color codes and make the output look
+    like what `git diff --color` shows.
+
     The unidiff format normally has a header for filenames and modification
     times.  Any or all of these may be specified using strings for
     'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.
@@ -1134,20 +1138,25 @@ def unified_diff(a, b, fromfile='', tofile='', fromfiledate='',
      four
     """
 
+    if color and can_colorize():
+        t = get_theme(force_color=True).difflib
+    else:
+        t = get_theme(force_no_color=True).difflib
+
     _check_types(a, b, fromfile, tofile, fromfiledate, tofiledate, lineterm)
     started = False
     for group in SequenceMatcher(None,a,b).get_grouped_opcodes(n):
         if not started:
             started = True
             fromdate = '\t{}'.format(fromfiledate) if fromfiledate else ''
             todate = '\t{}'.format(tofiledate) if tofiledate else ''
-            yield '--- {}{}{}'.format(fromfile, fromdate, lineterm)
-            yield '+++ {}{}{}'.format(tofile, todate, lineterm)
+            yield '{}--- {}{}{}{}'.format(t.header, fromfile, fromdate, lineterm, t.reset)
+            yield '{}+++ {}{}{}{}'.format(t.header, tofile, todate, lineterm, t.reset)
 
         first, last = group[0], group[-1]
         file1_range = _format_range_unified(first[1], last[2])
         file2_range = _format_range_unified(first[3], last[4])
-        yield '@@ -{} +{} @@{}'.format(file1_range, file2_range, lineterm)
+        yield '{}@@ -{} +{} @@{}{}'.format(t.hunk, file1_range, file2_range, lineterm, t.reset)
 
         for tag, i1, i2, j1, j2 in group:
             if tag == 'equal':
@@ -1156,10 +1165,10 @@ def unified_diff(a, b, fromfile='', tofile='', fromfiledate='',
                 continue
             if tag in {'replace', 'delete'}:
                 for line in a[i1:i2]:
-                    yield '-' + line
+                    yield f'{t.delete}-{line}{t.reset}'
             if tag in {'replace', 'insert'}:
                 for line in b[j1:j2]:
-                    yield '+' + line
+                    yield f'{t.insert}+{line}{t.reset}'
 
 
 ########################################################################

Lib/test/test_difflib.py

@@ -355,6 +355,21 @@ def test_range_format_context(self):
         self.assertEqual(fmt(3,6), '4,6')
         self.assertEqual(fmt(0,0), '0')
 
+    def test_unified_diff_colored_output(self):
+        args = [['one', 'three'], ['two', 'three'], 'Original', 'Current',
+            '2005-01-26 23:30:50', '2010-04-02 10:20:52']
+        actual = list(difflib.unified_diff(*args, lineterm='', color=True))
+
+        expect = [
+            "\033[1m--- Original\t2005-01-26 23:30:50\033[0m",
+            "\033[1m+++ Current\t2010-04-02 10:20:52\033[0m",
+             "\033[36m@@ -1,2 +1,2 @@\033[0m",
+             "\033[31m-one\033[0m",
+             "\033[32m+two\033[0m",
+             " three",
+        ]
+        self.assertEqual(expect, actual)
+
 
 class TestBytes(unittest.TestCase):
     # don't really care about the content of the output, just the fact

Misc/ACKS

@@ -1889,6 +1889,7 @@ Nicolas M. Thiéry
 James Thomas
 Reuben Thomas
 Robin Thomas
+Douglas Thor
 Brian Thorne
 Christopher Thorne
 Stephen Thorne

Misc/NEWS.d/next/Library/2025-05-08-20-03-20.gh-issue-133722.1-B82a.rst

@@ -0,0 +1,2 @@
+Added a ``color`` option to :func:`difflib.unified_diff` that injects ANSI color
+codes to mimic ``git diff`` colors.