Have the deprecated Commit.trailers property issue a warning

EliahKagan · EliahKagan · commit 03464d90a66c · 2024-03-27T21:12:41.000-04:00
diff --git a/git/objects/commit.py b/git/objects/commit.py
@@ -14,6 +14,7 @@
 from subprocess import Popen, PIPE
 import sys
 from time import altzone, daylight, localtime, time, timezone
+import warnings
 
 from gitdb import IStream
 
@@ -399,6 +400,11 @@ def trailers(self) -> Dict[str, str]:
             Dictionary containing whitespace stripped trailer information.
             Only contains the latest instance of each trailer key.
         """
+        warnings.warn(
+            "Commit.trailers is deprecated, use Commit.trailers_list or Commit.trailers_dict instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return {k: v[0] for k, v in self.trailers_dict.items()}
 
     @property
