Test and doc that type conversion works with embedded args.

pekkaklarck · pekkaklarck · commit 60c75af02f29 · 2018-11-11T13:08:02.000+02:00
See robotframework#2890 and robotframework#2947.
diff --git a/atest/robot/keywords/type_conversion/embedded_arguments.robot b/atest/robot/keywords/type_conversion/embedded_arguments.robot
@@ -0,0 +1,14 @@
+*** Settings ***
+Suite Setup      Run Tests    ${EMPTY}    keywords/type_conversion/embedded_arguments.robot
+Resource         atest_resource.robot
+
+*** Test Cases ***
+Types via annotations
+    [Tags]    require-py3
+    Check Test Case    ${TESTNAME}
+
+Types via @keyword
+    Check Test Case    ${TESTNAME}
+
+Types via defaults
+    Check Test Case    ${TESTNAME}
diff --git a/atest/testdata/keywords/type_conversion/EmbeddedArguments.py b/atest/testdata/keywords/type_conversion/EmbeddedArguments.py
@@ -0,0 +1,24 @@
+from robot.api.deco import keyword
+
+
+try:
+    exec('''
+@keyword(name=r'${num1:\d+} + ${num2:\d+} = ${exp:\d+}')
+def add(num1: int, num2: int, expected: int):
+    result = num1 + num2
+    assert result == expected, (result, expected)
+''')
+except SyntaxError:
+    pass
+
+
+@keyword(name=r'${num1:\d+} - ${num2:\d+} = ${exp:\d+}', types=(int, int, int))
+def sub(num1, num2, expected):
+    result = num1 - num2
+    assert result == expected, (result, expected)
+
+
+@keyword(name=r'${num1:\d+} * ${num2:\d+} = ${exp:\d+}')
+def mul(num1=0, num2=0, expected=0):
+    result = num1 * num2
+    assert result == expected, (result, expected)
diff --git a/atest/testdata/keywords/type_conversion/embedded_arguments.robot b/atest/testdata/keywords/type_conversion/embedded_arguments.robot
@@ -0,0 +1,16 @@
+*** Settings ***
+Library                  EmbeddedArguments.py
+
+*** Test Cases ***
+Types via annotations
+    [Tags]    require-py3
+    1 + 2 = 3
+    2 + 2 = 4
+
+Types via @keyword
+    2 - 1 = 1
+    2 - 2 = 0
+
+Types via defaults
+    1 * 2 = 2
+    2 * 2 = 4
diff --git a/doc/userguide/src/ExtendingRobotFramework/CreatingTestLibraries.rst b/doc/userguide/src/ExtendingRobotFramework/CreatingTestLibraries.rst
@@ -1320,15 +1320,33 @@ __ `Using a custom keyword name`_
 
     from robot.api.deco import keyword
 
-    @keyword('Add ${quantity:\d+} Copies Of ${item} To Cart')
+    @keyword('Add ${quantity:\d+} copies of ${item} to cart')
     def add_copies_to_cart(quantity, item):
         # ...
 
 .. sourcecode:: robotframework
 
    *** Test Cases ***
    My Test
-       Add 7 Copies Of Coffee To Cart
+       Add 7 copies of coffee to cart
+
+By default arguments are passed to implementing keywords as strings, but
+automatic `argument type conversion`__ works if type information is specified
+somehow. With Python 3 it is convenient to use `function annotations`__,
+and alternatively it is possible to pass types to the `@keyword decorator`__:
+
+.. sourcecode:: python
+
+    @keyword('Add ${quantity:\d+} copies of ${item} to cart',
+             types={'quantity': int})
+    def add_copies_to_cart(quantity: int, item):
+        # ...
+
+__ `Argument types`_
+__ `Specifying argument types using function annotations`_
+__ `Specifying argument types using @keyword decorator`_
+
+.. note:: Automatic type conversion is new in Robot Framework 3.1.
 
 Communicating with Robot Framework
 ----------------------------------
