Extract no-deprecation-warning asserter as a context manager

EliahKagan · EliahKagan · commit ff4b58dd56d3 · 2024-03-27T20:57:40.000-04:00
+ Remove the TODO suggesting the diff not be computed from a real
  commit, since we're going to have the logic for that in use in
  forthcoming commit-specific deprecation warning tests anyway.
diff --git a/test/deprecation/test_various.py b/test/deprecation/test_various.py
@@ -3,6 +3,7 @@
 
 """Tests of assorted deprecation warnings with no extra subtleties to check."""
 
+import contextlib
 import gc
 import warnings
 
@@ -12,6 +13,15 @@
 from git.repo import Repo
 
 
+@contextlib.contextmanager
+def _assert_no_deprecation_warning():
+    """Context manager to assert that code does not issue any deprecation warnings."""
+    with warnings.catch_warnings():
+        # FIXME: Refine this to filter for deprecation warnings from GitPython.
+        warnings.simplefilter("error", DeprecationWarning)
+        yield
+
+
 @pytest.fixture
 def commit(tmp_path):
     """Fixture to supply a one-commit repo's commit, enough for deprecation tests."""
@@ -26,7 +36,6 @@ def commit(tmp_path):
 @pytest.fixture
 def diff(commit):
     """Fixture to supply a single-file diff."""
-    # TODO: Consider making a fake diff rather than using a real repo and commit.
     (diff,) = commit.diff(NULL_TREE)  # Exactly one file in the diff.
     yield diff
 
@@ -39,7 +48,5 @@ def test_diff_renamed_warns(diff):
 
 def test_diff_renamed_file_does_not_warn(diff):
     """The preferred Diff.renamed_file property issues no deprecation warning."""
-    with warnings.catch_warnings():
-        # FIXME: Refine this to filter for deprecation warnings from GitPython.
-        warnings.simplefilter("error", DeprecationWarning)
+    with _assert_no_deprecation_warning():
         diff.renamed_file
