Deprecate galgebra.utils

Author: eric-wieser

doc/changelog.rst

@@ -2,6 +2,8 @@
 Changelog
 =========
 
+- :support:`280` The ``galgebra.utils`` module, which provided Python 2 compatibility helpers, has been deprecated.
+
 - :support:`245` (also :issue:`248`) The following attributes have been deprecated to reduce the number of similar members in :class:`~galgebra.ga.Ga`.
 
   * Unified into :attr:`galgebra.ga.Ga.blade_expansion_dict`:

galgebra/utils.py

@@ -4,9 +4,16 @@
 
 import sys
 import collections
+import warnings
 
 from io import StringIO  # noqa: F401
 
+# galgebra 0.5.0
+warnings.warn(
+    "galgebra.utils is deprecated and will be removed. "
+    "If you need python 2 compatibility helpers, use a decdicated module like "
+    "`six`.", DeprecationWarning, stacklevel=2)
+
 # From https://github.com/benjaminp/six/blob/master/six.py
 PY2 = sys.version_info[0] == 2
 PY3 = sys.version_info[0] == 3

test/test_test.py

@@ -475,3 +475,6 @@ def test_deprecations(self):
         # all derived from
         ga.blade_expansion_dict
         ga.base_expansion_dict
+
+        with pytest.warns(DeprecationWarning):
+            import galgebra.utils