Merge pull request #280 from eric-wieser/move-kwarg-parser

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/__init__.py

@@ -1,7 +1,9 @@
 """ Internal helpers for use in galgebra """
 
 from .cached_property import cached_property
+from .kwarg_parser import KwargParser
 
 __all__ = [
     'cached_property',
+    'KwargParser',
 ]

galgebra/_utils/kwarg_parser.py

@@ -0,0 +1,43 @@
+class KwargParser:
+    """
+    Helper function to emulate Python 3 keyword-only arguments.
+
+    Use as::
+
+        def func(x1, **kwargs):
+            kw = KwargParser('func', kwargs)
+            a = kw.pop('a')
+            b = kw.pop('b', 2)
+            kw.reject_remaining()
+            ...
+
+    To emulate the Python 3 syntax::
+
+        def func(x1, *, a, b=2):
+            ...
+
+    This is also useful for functions with overloaded signatures, for which
+    a single Python 3 signature cannot be written.
+    """
+    def __init__(self, func_name, kwargs):
+        self._func_name = func_name
+        self._kwargs = kwargs
+
+    def pop(self, arg_name, *default):
+        try:
+            return self._kwargs.pop(arg_name, *default)
+        except KeyError:
+            pass
+        raise TypeError(
+            '{}() missing required keyword-only argument {!r}'
+            .format(self._func_name, arg_name)
+        )
+
+    def reject_remaining(self):
+        if self._kwargs:
+            # match the error message to what Python 3 produces
+            bad_arg = next(iter(self._kwargs))
+            raise TypeError(
+                '{}() got an unexpected keyword argument {!r}'
+                .format(self._func_name, bad_arg)
+            )

galgebra/mv.py

@@ -19,7 +19,7 @@
 from . import printer
 from . import metric
 from .printer import ZERO_STR
-from .utils import _KwargParser
+from ._utils import KwargParser as _KwargParser
 from . import dop
 
 ONE = S(1)

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
@@ -29,45 +36,3 @@ def flatten(x):
 
 def isstr(s):
     return isinstance(s, str)
-
-
-class _KwargParser:
-    """
-    Helper function to emulate Python 3 keyword-only arguments.
-
-    Use as::
-
-        def func(x1, **kwargs):
-            kw = KwargParser('func', kwargs)
-            a = kw.pop('a')
-            b = kw.pop('b', 2)
-            kw.reject_remaining()
-            ...
-
-    To emulate the Python 3 syntax::
-
-        def func(x1, *, a, b=2):
-            ...
-    """
-    def __init__(self, func_name, kwargs):
-        self._func_name = func_name
-        self._kwargs = kwargs
-
-    def pop(self, arg_name, *default):
-        try:
-            return self._kwargs.pop(arg_name, *default)
-        except KeyError:
-            pass
-        raise TypeError(
-            '{}() missing required keyword-only argument {!r}'
-            .format(self._func_name, arg_name)
-        )
-
-    def reject_remaining(self):
-        if self._kwargs:
-            # match the error message to what Python 3 produces
-            bad_arg = next(iter(self._kwargs))
-            raise TypeError(
-                '{}() got an unexpected keyword argument {!r}'
-                .format(self._func_name, bad_arg)
-            )

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