Added new posargs2kwargs function.

Author: domdfcoding

domdf_python_tools/utils.py

@@ -44,9 +44,10 @@
 #
 
 # stdlib
+import inspect
 import itertools
 import sys
-from typing import Any, Generator, Iterable, List, Sequence, Tuple, Union
+from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Sequence, Tuple, Union
 
 __all__ = [
 		"pyversion",
@@ -68,6 +69,7 @@
 		"enquote_value",
 		"Len",
 		"double_chain",
+		"posargs2kwargs",
 		]
 
 pyversion: int = int(sys.version_info.major)  # Python Version
@@ -339,3 +341,33 @@ def double_chain(iterable: Iterable[Iterable]):
 	"""
 
 	yield from itertools.chain.from_iterable(itertools.chain.from_iterable(iterable))
+
+
+def posargs2kwargs(
+		args: Iterable[Any],
+		posarg_names: Union[Iterable[str], Callable],
+		kwargs: Optional[Dict[str, Any]] = None,
+		) -> Dict[str, Any]:
+	"""
+	Convert the positional args in ``args`` to kwargs, based on the relative order of ``args`` and ``posarg_names``.
+
+	:param args: List of positional arguments provided to a function.
+	:param posarg_names: Either a list of positional argument names for the function, or the function object.
+	:param kwargs: Optional mapping of keyword argument names to values.
+		The arguments will be added to this dictionary if provided.
+	:default kwargs: ``{}``
+
+	:return: Dictionary mapping argument names to values.
+
+	.. versionadded:: 0.4.10
+	"""
+
+	if kwargs is None:
+		kwargs = {}
+
+	if callable(posarg_names):
+		posarg_names = inspect.getfullargspec(posarg_names).args
+
+	kwargs.update(zip(posarg_names, args))
+
+	return kwargs

tests/test_utils.py

@@ -20,7 +20,7 @@
 # this package
 from domdf_python_tools import utils
 from domdf_python_tools.testing import testing_boolean_values
-from domdf_python_tools.utils import Len, chunks, double_chain, list2str, list2string, pyversion, str2tuple
+from domdf_python_tools.utils import Len, chunks, double_chain, list2str, posargs2kwargs, pyversion, str2tuple
 
 
 def test_pyversion():
@@ -96,10 +96,6 @@ def test_list2str(value, expects):
 	assert isinstance(str_representation, str)
 	assert str_representation == expects
 
-	str_representation = list2string(value)
-	assert isinstance(str_representation, str)
-	assert str_representation == expects
-
 
 @pytest.mark.parametrize(
 		"value, expects",
@@ -115,10 +111,6 @@ def test_list2str_semicolon(value, expects):
 	assert isinstance(str_representation, str)
 	assert str_representation == expects
 
-	str_representation = list2string(value, sep=';')
-	assert isinstance(str_representation, str)
-	assert str_representation == expects
-
 
 def test_permutations():
 	data = ["egg and bacon", "egg sausage and bacon", "egg and spam", "egg bacon and spam"]
@@ -384,3 +376,24 @@ def test_len(capsys):
 	assert captured.out.splitlines() == ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]
 
 	assert Len("Hello") == range(5)
+
+
+def demo_function(arg1, arg2, arg3):
+	pass
+
+
+@pytest.mark.parametrize(
+		"args, posarg_names, kwargs, expects",
+		[
+				((1, 2, 3), ("arg1", "arg2", "arg3"), {}, {"arg1": 1, "arg2": 2, "arg3": 3}),
+				((1, 2, 3), ("arg1", "arg2", "arg3"), None, {"arg1": 1, "arg2": 2, "arg3": 3}),
+				((1, 2, 3), ("arg1", "arg2", "arg3"), {"arg4": 4}, {"arg1": 1, "arg2": 2, "arg3": 3, "arg4": 4}),
+				((1, 2, 3), demo_function, None, {
+						"arg1": 1,
+						"arg2": 2,
+						"arg3": 3,
+						}),
+				]
+		)
+def test_posargs2kwargs(args, posarg_names, kwargs, expects):
+	assert posargs2kwargs(args, posarg_names, kwargs) == expects