[py] Applied some DRY and extracted out the keys_to_typing()

file_detector_context and custom file_detector
* You can pass custom file_detector right in the constructor, default behaviour is unaltered.
* file_detector_context context manager to safely change file detectors in limited contexts.

Signed-off-by: Luke Inman-Semerau <[email protected]>

Author: Milan Falešník

py/selenium/webdriver/common/action_chains.py

@@ -19,7 +19,9 @@
 The ActionChains implementation,
 """
 from selenium.webdriver.remote.command import Command
-from selenium.webdriver.common.keys import Keys
+
+from .utils import keys_to_typing
+
 
 class ActionChains(object):
     """
@@ -169,7 +171,7 @@ def key_down(self, value, element=None):
         if element: self.click(element)
         self._actions.append(lambda:
             self._driver.execute(Command.SEND_KEYS_TO_ACTIVE_ELEMENT, {
-                "value": self._keys_to_typing(value) }))
+                "value": keys_to_typing(value) }))
         return self
 
     def key_up(self, value, element=None):
@@ -189,7 +191,7 @@ def key_up(self, value, element=None):
         if element: self.click(element)
         self._actions.append(lambda:
             self._driver.execute(Command.SEND_KEYS_TO_ACTIVE_ELEMENT, {
-                "value": self._keys_to_typing(value) }))
+                "value": keys_to_typing(value) }))
         return self
 
     def move_by_offset(self, xoffset, yoffset):
@@ -257,7 +259,7 @@ def send_keys(self, *keys_to_send):
         """
         self._actions.append(lambda:
             self._driver.execute(Command.SEND_KEYS_TO_ACTIVE_ELEMENT, 
-              { 'value': self._keys_to_typing(keys_to_send)}))
+              { 'value': keys_to_typing(keys_to_send)}))
         return self
 
     def send_keys_to_element(self, element, *keys_to_send):
@@ -273,20 +275,6 @@ def send_keys_to_element(self, element, *keys_to_send):
             element.send_keys(*keys_to_send))
         return self
 
-    def _keys_to_typing(self, value):
-        typing = []
-        for val in value:
-            if isinstance(val, Keys):
-                typing.append(val)
-            elif isinstance(val, int):
-                val = str(val)
-                for i in range(len(val)):
-                    typing.append(val[i])
-            else:
-                for i in range(len(val)):
-                    typing.append(val[i])
-        return typing
-
     # Context manager so ActionChains can be used in a 'with .. as' statements.
     def __enter__(self):
         return self # Return created instance of self.

py/selenium/webdriver/common/utils.py

@@ -20,6 +20,12 @@
 """
 import socket
 
+try:
+    basestring
+except NameError:
+    # Python 3
+    basestring = str
+
 
 def free_port():
     """
@@ -71,3 +77,19 @@ def is_url_connectable(port):
             return False
     except:
         return False
+
+
+def keys_to_typing(value):
+    """Processes the values that will be typed in the element."""
+    typing = []
+    for val in value:
+        # If it is a non-string object, make it a string
+        if not isinstance(val, basestring):
+            # This str() call enables for abstraction if one has a custom object that has some
+            # UI representation to implement __str__() to return the representation, making it
+            # possible to pass that object to the filling methods.
+            val = str(val)
+        # Then just add the separate characters in the list
+        # ['e'].extend('asdf')  =>  ['e', 'a', 's', 'd', 'f']
+        typing.extend(val)
+    return typing

py/selenium/webdriver/remote/file_detector.py

@@ -17,7 +17,7 @@
 
 import abc
 import os
-from selenium.webdriver.common.keys import Keys
+from selenium.webdriver.common.utils import keys_to_typing
 
 
 class FileDetector(object):
@@ -45,21 +45,9 @@ class LocalFileDetector(FileDetector):
     Detects files on the local disk.
     """
     def is_local_file(self, *keys):
-        file_path = ''
-        typing = []
-        for val in keys:
-            if isinstance(val, Keys):
-                typing.append(val)
-            elif isinstance(val, int):
-                val = val.__str__()
-                for i in range(len(val)):
-                    typing.append(val[i])
-            else:
-                for i in range(len(val)):
-                    typing.append(val[i])
-        file_path = ''.join(typing)
+        file_path = ''.join(keys_to_typing(keys))
 
-        if file_path is '':
+        if not file_path:
             return None
 
         try:

py/selenium/webdriver/remote/webdriver.py

@@ -19,6 +19,7 @@
 
 import base64
 import warnings
+from contextlib import contextmanager
 
 from .command import Command
 from .webelement import WebElement
@@ -54,7 +55,8 @@ class WebDriver(object):
     """
 
     def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
-        desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False):
+            desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False,
+            file_detector=None):
         """
         Create a new driver that will issue commands using the wire protocol.
 
@@ -69,6 +71,8 @@ def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
              be started with given proxy settings, if possible. Optional.
          - keep_alive - Whether to configure remote_connection.RemoteConnection to use
              HTTP keep-alive. Defaults to False.
+         - file_detector - Pass custom file detector object during instantiation. If None,
+             then default LocalFileDetector() will be used.
         """
         if desired_capabilities is None:
             raise WebDriverException("Desired Capabilities can't be None")
@@ -87,12 +91,40 @@ def __init__(self, command_executor='http://127.0.0.1:4444/wd/hub',
         self.start_session(desired_capabilities, browser_profile)
         self._switch_to = SwitchTo(self)
         self._mobile = Mobile(self)
-        self.file_detector = LocalFileDetector()
+        self.file_detector = file_detector or LocalFileDetector()
 
     def __repr__(self):
         return '<{0.__module__}.{0.__name__} (session="{1}")>'.format(
             type(self), self.session_id)
 
+    @contextmanager
+    def file_detector_context(self, file_detector_class, *args, **kwargs):
+        """
+        Overrides the current file detector (if necessary) in limited context.
+        Ensures the original file detector is set afterwards.
+
+        Example:
+
+        with webdriver.file_detector_context(UselessFileDetector):
+            someinput.send_keys('/etc/hosts')
+
+        :Args:
+         - file_detector_class - Class of the desired file detector. If the class is different
+             from the current file_detector, then the class is instantiated with args and kwargs
+             and used as a file detector during the duration of the context manager.
+         - args - Optional arguments that get passed to the file detector class during
+             instantiation.
+         - kwargs - Keyword arguments, passed the same way as args.
+        """
+        last_detector = None
+        if not isinstance(self.file_detector, file_detector_class):
+            last_detector = self.file_detector
+            self.file_detector = file_detector_class(*args, **kwargs)
+        try:
+            yield
+        finally:
+            if last_detector is not None:
+                self.file_detector = last_detector
 
     @property
     def mobile(self):

py/selenium/webdriver/remote/webelement.py

@@ -16,7 +16,6 @@
 # under the License.
 
 import hashlib
-from numbers import Number
 import os
 import zipfile
 try:
@@ -29,7 +28,7 @@
 from selenium.common.exceptions import WebDriverException
 from selenium.common.exceptions import InvalidSelectorException
 from selenium.webdriver.common.by import By
-from selenium.webdriver.common.keys import Keys
+from selenium.webdriver.common.utils import keys_to_typing
 
 
 try:
@@ -320,18 +319,7 @@ def send_keys(self, *value):
             if local_file is not None:
                 value = self._upload(local_file)
 
-        typing = []
-        for val in value:
-            if isinstance(val, Keys):
-                typing.append(val)
-            elif isinstance(val, Number):
-                val = val.__str__()
-                for i in range(len(val)):
-                    typing.append(val[i])
-            else:
-                for i in range(len(val)):
-                    typing.append(val[i])
-        self._execute(Command.SEND_KEYS_TO_ELEMENT, {'value': typing})
+        self._execute(Command.SEND_KEYS_TO_ELEMENT, {'value': keys_to_typing(value)})
 
     # RenderedWebElement Items
     def is_displayed(self):