Fixing typing hints for varargs and kwargs

Author: aaltat

atest/DynamicTypesAnnotationsLibrary.py

@@ -1,4 +1,4 @@
-from typing import List, Union, NewType
+from typing import List, Union, NewType, Dict
 
 from robot.api import logger
 
@@ -111,5 +111,5 @@ def keyword_self_and_types(self: 'DynamicTypesAnnotationsLibrary', mandatory: st
         return True
 
     @keyword
-    def keyword_self_and_keyword_only_types(self: 'DynamicTypesAnnotationsLibrary', mandatory, *varargs, other: bool, **kwargs):
+    def keyword_self_and_keyword_only_types(x: 'DynamicTypesAnnotationsLibrary', mandatory, *varargs: int, other: bool, **kwargs: Dict[str, int]):
         return True

src/robotlibcore.py

@@ -140,17 +140,8 @@ def __get_keyword(self, keyword_name):
     def __get_typing_hints(self, method):
         if PY2:
             return {}
-        try:
-            hints = typing.get_type_hints(method)
-        except Exception:
-            hints = method.__annotations__
-        hints.pop('return', None)
         spec = ArgumentSpec.from_function(method)
-        for arg in hints.copy():
-            # Drop self
-            if arg not in spec.positional and arg not in spec.kwonlyargs:
-                hints.pop(arg)
-        return hints
+        return spec.get_typing_hints()
 
     def __join_defaults_with_types(self, method, types):
         spec = ArgumentSpec.from_function(method)
@@ -199,6 +190,8 @@ def __init__(self):
 
 class ArgumentSpec(object):
 
+    _function = None
+
     def __init__(self, positional=None, defaults=None, varargs=None, kwonlyargs=None,
                  kwonlydefaults=None, kwargs=None):
         self.positional = positional or []
@@ -208,6 +201,17 @@ def __init__(self, positional=None, defaults=None, varargs=None, kwonlyargs=None
         self.kwonlydefaults = kwonlydefaults or []
         self.kwargs = kwargs
 
+    def __contains__(self, item):
+        if item in self.positional:
+            return True
+        if self.varargs and item in self.varargs:
+            return True
+        if item in self.kwonlyargs:
+            return True
+        if self.kwargs and item in self.kwargs:
+            return True
+        return False
+
     def get_arguments(self):
         args = self._format_positional(self.positional, self.defaults)
         args += self._format_default(self.defaults)
@@ -219,6 +223,23 @@ def get_arguments(self):
             args.append('**%s' % self.kwargs)
         return args
 
+    def get_typing_hints(self):
+        try:
+            hints = typing.get_type_hints(self._function)
+        except Exception:
+            hints = self._function.__annotations__
+        for arg in list(hints):
+            # remove return and self statements
+            if arg not in self:
+                hints.pop(arg)
+            if self.varargs and arg in self.varargs:
+                hints['*%s' % arg] = hints[arg]
+                del hints[arg]
+            if self.kwargs and arg in self.kwargs:
+                hints['**%s' % arg] = hints[arg]
+                del hints[arg]
+        return hints
+
     def _format_positional(self, positional, defaults):
         for argument, _ in defaults:
             positional.remove(argument)
@@ -231,6 +252,7 @@ def _format_default(self, defaults):
 
     @classmethod
     def from_function(cls, function):
+        cls._function = function
         if PY2:
             spec = inspect.getargspec(function)
         else:

utest/test_get_keyword_types.py

@@ -4,7 +4,7 @@
 from robotlibcore import PY2
 
 if not PY2:
-    from typing import List, Union
+    from typing import List, Union, Dict
     from DynamicTypesAnnotationsLibrary import DynamicTypesAnnotationsLibrary
     from DynamicTypesAnnotationsLibrary import CustomObject
 
@@ -206,7 +206,8 @@ def test_keyword_self_and_types(lib_types):
     types = lib_types.get_keyword_types('keyword_self_and_types')
     assert types == {'mandatory': str, 'other': bool}
 
+
 @pytest.mark.skipif(PY2, reason='Only applicable on Python 3')
 def test_keyword_self_and_keyword_only_types(lib_types):
     types = lib_types.get_keyword_types('keyword_self_and_keyword_only_types')
-    assert types == {'other': bool}
+    assert types == {'*varargs': int, 'other': bool, '**kwargs': Dict[str, int]}

utest/test_robotlibcore.py

@@ -250,7 +250,7 @@ def test_keyword_only_arguments_for_get_keyword_arguments_rf32():
     assert args('keyword_only_arguments_many') == ['*varargs', ('some', 'value'), ('other', None)]
     assert args('keyword_only_arguments_no_default') == ['*varargs', 'other']
     assert args('keyword_only_arguments_default_and_no_default') == ['*varargs', 'other', ('value', False)]
-    all_args = [ 'mandatory', ('positional', 1), '*varargs', 'other', ('value', False), '**kwargs']
+    all_args = ['mandatory', ('positional', 1), '*varargs', 'other', ('value', False), '**kwargs']
     assert args('keyword_all_args') == all_args