Merge pull request #474 from HelioGuilherme66/press_key_#275

Add named keys to Press Key.

Author: zephraph

src/Selenium2Library/keywords/_element.py

@@ -479,19 +479,25 @@ def simulate(self, locator, event):
     def press_key(self, locator, key):
         """Simulates user pressing key on element identified by `locator`.
 
-        `key` is either a single character, or a numerical ASCII code of the key
-        lead by '\\\\'.
+        `key` is either a single character, a numerical ASCII code of the key lead by '\\\\',
+         or a NAMED KEY as described in the [https://selenium.googlecode.com/git/docs/api/py/webdriver/selenium.webdriver.common.keys.html|Selenium docs].
 
         Examples:
-        | Press Key | text_field   | q |
-        | Press Key | login_button | \\\\13 | # ASCII code for enter key |
+        | Press Key | text_field   | q        | # The letter 'q'                              |
+        | Press Key | nav_console  | ARROW_UP | # Named ARROW_UP key                          |
+        | Press Key | login_button | \\\\13   | # ASCII code for Enter key                    |
+
+        It's recommended to use named keys over ascii escapes (.i.e ``ENTER`` over ``\\\\13``)
+
+        NAMED KEY value is new in Selenium2Library 1.7.3.
         """
-        if key.startswith('\\') and len(key) > 1:
-            key = self._map_ascii_key_code_to_key(int(key[1:]))
-        #if len(key) > 1:
-        #    raise ValueError("Key value '%s' is invalid.", key)
+        if len(key) > 1:
+            if key.startswith('\\'):
+                key = self._map_ascii_key_code_to_key(int(key[1:]))
+            else:
+                key = self._map_named_key_code_to_special_key(key)
         element = self._element_find(locator, True, True)
-        #select it
+        # select it
         element.send_keys(key)
 
     # Public, links
@@ -599,7 +605,7 @@ def get_matching_xpath_count(self, xpath):
         """Returns number of elements matching `xpath`
 
         One should not use the xpath= prefix for 'xpath'. XPath is assumed.
-        
+
         Correct:
         | count = | Get Matching Xpath Count | //div[@id='sales-pop']
         Incorrect:
@@ -615,7 +621,7 @@ def xpath_should_match_x_times(self, xpath, expected_xpath_count, message='', lo
         """Verifies that the page contains the given number of elements located by the given `xpath`.
 
         One should not use the xpath= prefix for 'xpath'. XPath is assumed.
-        
+
         Correct:
         | Xpath Should Match X Times | //div[@id='sales-pop'] | 1
         Incorrect:
@@ -748,6 +754,14 @@ def _map_ascii_key_code_to_key(self, key_code):
             key = chr(key_code)
         return key
 
+    def _map_named_key_code_to_special_key(self, key_name):
+        try:
+           return getattr(Keys, key_name)
+        except AttributeError:
+           message = "Unknown key named '%s'." % (key_name)
+           self._debug(message)
+           raise ValueError(message)
+
     def _parse_attribute_locator(self, attribute_locator):
         parts = attribute_locator.rpartition('@')
         if len(parts[0]) == 0:

test/acceptance/keywords/textfields.robot

@@ -1,40 +1,50 @@
-*Setting*
-Variables  variables.py
-Resource  ../resource.robot
-Test Setup  Go To Page "forms/prefilled_email_form.html"
-
-
-*Test Cases*
+*** Setting ***
+Test Setup        Go To Page "forms/prefilled_email_form.html"
+Variables         variables.py
+Resource          ../resource.robot
 
+*** Test Cases ***
 Get Value From Text Field
-  ${text} =  Get Value  name
-  Should Be Equal  ${text}  Prefilled Name
-  Clear Element Text  name
-  ${text} =  Get Value  name
-  Should Be Equal  ${text}  ${EMPTY}
-  
+    ${text} =    Get Value    name
+    Should Be Equal    ${text}    Prefilled Name
+    Clear Element Text    name
+    ${text} =    Get Value    name
+    Should Be Equal    ${text}    ${EMPTY}
+
 
 Input Unicode In Text Field
-  Input Text  name  ${unic_text}
-  ${text} =  Get Value  name
-  Should Be Equal  ${text}  ${unic_text}
+    Input Text    name    ${unic_text}
+    ${text} =    Get Value    name
+    Should Be Equal    ${text}    ${unic_text}
 
 Input Password
-  [Documentation]  LOG 3 Typing password into text field 'password_field'
-  [Setup]  Go To Page "forms/login.html"
-  Input Text  username_field  username
-  Input Password  password_field  password
-  Submit Form
-  Verify Location Is "forms/submit.html"
+    [Documentation]    LOG 3 Typing password into text field 'password_field'
+    [Setup]    Go To Page "forms/login.html"
+    Input Text    username_field    username
+    Input Password    password_field    password
+    Submit Form
+    Verify Location Is "forms/submit.html"
 
 Press Key
-  [Setup]  Go To Page "forms/login.html"
-  Cannot Be Executed in IE
-  Input Text  username_field  James Bond
-  Press Key  password_field  f
-  Press Key  password_field   \\9
-  Press Key  login_button  \\10
-  Verify Location Is "forms/submit.html"
+    [Setup]    Go To Page "forms/login.html"
+    #Cannot Be Executed in IE
+    Input Text    username_field    James Bond
+    Press Key    username_field    HOME
+    Press Key    username_field    END
+    Press Key    username_field    ARROW_LEFT
+    Press Key    username_field    ARROW_LEFT
+    Press Key    username_field    ARROW_LEFT
+    Press Key    username_field    DELETE
+    Press Key    username_field    ARROW_LEFT
+    Press Key    username_field    ARROW_RIGHT
+    Press Key    username_field    \\108    #This is the 'l' char
+    Press Key    username_field    o
+    ${text} =    Get Value    username_field
+    Should Be Equal    ${text}    James Blond
+    Press Key    password_field    f
+    Press Key    password_field    9
+    Press Key    login_button    ENTER
+    Verify Location Is "forms/submit.html"
 
 Attempt Clear Element Text On Non-Editable Field
-  Run Keyword And Expect Error  *  Clear Element Text  can_send_email
+    Run Keyword And Expect Error    *    Clear Element Text    can_send_email