MAINT: deprecate append_to_syspath

IPython/utils/tests/test_deprecated.py

@@ -0,0 +1,7 b''
+from IPython.utils.syspathcontext import appended_to_syspath
+import pytest
+
+
+def test_append_deprecated():
+    with pytest.warns(DeprecationWarning):
+        appended_to_syspath(".")

IPython/utils/syspathcontext.py

@@ -1,62 +1,71 b''
 # encoding: utf-8
 """
 Context managers for adding things to sys.path temporarily.
 
 Authors:
 
 * Brian Granger
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 import sys
+import warnings
 
 
 class appended_to_syspath(object):
-    """A context for appending a directory to sys.path for a second."""
+    """
+    Deprecated since IPython 8.1, no replacements.
+
+    A context for appending a directory to sys.path for a second."""
 
     def __init__(self, dir):
+        warnings.warn(
+            "`appended_to_syspath` is deprecated since IPython 8.1, and has no replacements",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         self.dir = dir
 
     def __enter__(self):
         if self.dir not in sys.path:
             sys.path.append(self.dir)
             self.added = True
         else:
             self.added = False
 
     def __exit__(self, type, value, traceback):
         if self.added:
             try:
                 sys.path.remove(self.dir)
             except ValueError:
                 pass
         # Returning False causes any exceptions to be re-raised.
         return False
 
 class prepended_to_syspath(object):
     """A context for prepending a directory to sys.path for a second."""
 
     def __init__(self, dir):
         self.dir = dir
 
     def __enter__(self):
         if self.dir not in sys.path:
             sys.path.insert(0,self.dir)
             self.added = True
         else:
             self.added = False
 
     def __exit__(self, type, value, traceback):
         if self.added:
             try:
                 sys.path.remove(self.dir)
             except ValueError:
                 pass
         # Returning False causes any exceptions to be re-raised.
         return False

IPython/utils/version.py

@@ -1,40 +1,43 b''
 # encoding: utf-8
 """
 Utilities for version comparison
 
 It is a bit ridiculous that we need these.
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2013  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 from warnings import warn
 
-warn("The `IPython.utils.version` module has been deprecated since IPython 8.0.")
+warn(
+    "The `IPython.utils.version` module has been deprecated since IPython 8.0.",
+    DeprecationWarning,
+)
 
 
 def check_version(v, check):
     """check version string v >= check
 
     If dev/prerelease tags result in TypeError for string-number comparison,
     it is assumed that the dependency is satisfied.
     Users on dev branches are responsible for keeping their own packages up to date.
     """
     warn(
         "`check_version` function is deprecated as of IPython 8.0"
         "and will be removed in future versions.",
         DeprecationWarning,
         stacklevel=2,
     )
 
     from distutils.version import LooseVersion
 
     try:
         return LooseVersion(v) >= LooseVersion(check)
     except TypeError:
         return True