Use timedelta for timeout

Author: aaltat

src/SeleniumLibrary/base/librarycomponent.py

@@ -15,12 +15,13 @@
 # limitations under the License.
 
 import os
-from typing import Optional
+from datetime import timedelta
+from typing import Optional, Union
 
 from robot.api import logger
 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
 
-from SeleniumLibrary.utils import is_noney, timestr_to_secs
+from SeleniumLibrary.utils import is_noney
 
 from .context import ContextAware
 
@@ -74,10 +75,12 @@ def assert_page_not_contains(
  raise AssertionError(message)
  logger.info(f"Current page does not contain {tag_message} '{locator}'.")
 
- def get_timeout(self, timeout: Optional[str] = None) -> float:
- if is_noney(timeout):
+ def get_timeout(self, timeout: Union[str, int, timedelta, None] = None) -> float:
+ if timeout is None:
  return self.ctx.timeout
- return timestr_to_secs(timeout)
+ if isinstance(timeout, timedelta):
+ return timeout.total_seconds()
+ return timeout
 
  @property
  def log_dir(self):

src/SeleniumLibrary/keywords/alert.py

@@ -13,7 +13,8 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from typing import Union
+from datetime import timedelta
+from typing import Union, Optional
 
 from selenium.common.exceptions import TimeoutException, WebDriverException
 from selenium.webdriver.support import expected_conditions as EC
@@ -31,7 +32,7 @@ class AlertKeywords(LibraryComponent):
 
  @keyword
  def input_text_into_alert(
- self, text: str, action: str = ACCEPT, timeout: Union[float, str, None] = None
+ self, text: str, action: str = ACCEPT, timeout: Optional[timedelta] = None
  ):
  """Types the given ``text`` into an input field in an alert.
 
@@ -52,7 +53,7 @@ def alert_should_be_present(
  self,
  text: str = "",
  action: str = ACCEPT,
- timeout: Union[float, str, None] = None,
+ timeout: Optional[timedelta] = None,
  ):
  """Verifies that an alert is present and by default, accepts it.
 
@@ -68,6 +69,7 @@ def alert_should_be_present(
  In earlier versions, the alert was always accepted and a timeout was
  hardcoded to one second.
  """
+ self.info(f"{type(timeout)}::{timeout}")
  message = self.handle_alert(action, timeout)
  if text and text != message:
  raise AssertionError(
@@ -76,7 +78,7 @@ def alert_should_be_present(
 
  @keyword
  def alert_should_not_be_present(
- self, action: str = ACCEPT, timeout: Union[float, str, None] = 0
+ self, action: str = ACCEPT, timeout: Union[timedelta] = 0
  ):
  """Verifies that no alert is present.
 
@@ -101,7 +103,7 @@ def alert_should_not_be_present(
 
  @keyword
  def handle_alert(
- self, action: str = ACCEPT, timeout: Union[float, str, None] = None
+ self, action: str = ACCEPT, timeout: Optional[timedelta] = None
  ):
  """Handles the current alert and returns its message.
 
@@ -127,6 +129,7 @@ def handle_alert(
 
  New in SeleniumLibrary 3.0.
  """
+ self.info(f"HANDLE::{type(timeout)}::{timeout}")
  alert = self._wait_alert(timeout)
  return self._handle_alert(alert, action)
 
@@ -143,6 +146,7 @@ def _handle_alert(self, alert, action):
 
  def _wait_alert(self, timeout=None):
  timeout = self.get_timeout(timeout)
+ self.info(f"WAITING::{type(timeout)}::{timeout}")
  wait = WebDriverWait(self.driver, timeout)
  try:
  return wait.until(EC.alert_is_present())

src/SeleniumLibrary/keywords/waiting.py

@@ -15,6 +15,7 @@
 # limitations under the License.
 
 import time
+from datetime import timedelta
 from typing import Optional, Union
 
 from selenium.common.exceptions import StaleElementReferenceException
@@ -29,7 +30,7 @@ class WaitingKeywords(LibraryComponent):
  def wait_for_condition(
  self,
  condition: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until ``condition`` is true or ``timeout`` expires.
@@ -64,7 +65,7 @@ def wait_for_condition(
  def wait_until_location_is(
  self,
  expected: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  message: Optional[str] = None,
  ):
  """Waits until the current URL is ``expected``.
@@ -93,7 +94,7 @@ def wait_until_location_is(
  def wait_until_location_is_not(
  self,
  location: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  message: Optional[str] = None,
  ):
  """Waits until the current URL is not ``location``.
@@ -121,7 +122,7 @@ def wait_until_location_is_not(
  def wait_until_location_contains(
  self,
  expected: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  message: Optional[str] = None,
  ):
  """Waits until the current URL contains ``expected``.
@@ -149,7 +150,7 @@ def wait_until_location_contains(
  def wait_until_location_does_not_contain(
  self,
  location: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  message: Optional[str] = None,
  ):
  """Waits until the current URL does not contains ``location``.
@@ -177,7 +178,7 @@ def wait_until_location_does_not_contain(
  def wait_until_page_contains(
  self,
  text: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until ``text`` appears on the current page.
@@ -199,7 +200,7 @@ def wait_until_page_contains(
  def wait_until_page_does_not_contain(
  self,
  text: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until ``text`` disappears from the current page.
@@ -221,7 +222,7 @@ def wait_until_page_does_not_contain(
  def wait_until_page_contains_element(
  self,
  locator: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  limit: Optional[int] = None,
  ):
@@ -259,7 +260,7 @@ def wait_until_page_contains_element(
  def wait_until_page_does_not_contain_element(
  self,
  locator: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  limit: Optional[int] = None,
  ):
@@ -297,7 +298,7 @@ def wait_until_page_does_not_contain_element(
  def wait_until_element_is_visible(
  self,
  locator: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until the element ``locator`` is visible.
@@ -320,7 +321,7 @@ def wait_until_element_is_visible(
  def wait_until_element_is_not_visible(
  self,
  locator: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until the element ``locator`` is not visible.
@@ -343,7 +344,7 @@ def wait_until_element_is_not_visible(
  def wait_until_element_is_enabled(
  self,
  locator: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until the element ``locator`` is enabled.
@@ -372,7 +373,7 @@ def wait_until_element_contains(
  self,
  locator: str,
  text: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until the element ``locator`` contains ``text``.
@@ -396,7 +397,7 @@ def wait_until_element_does_not_contain(
  self,
  locator: str,
  text: str,
- timeout: Union[str, float, None] = None,
+ timeout: Optional[timedelta] = None,
  error: Optional[str] = None,
  ):
  """Waits until the element ``locator`` does not contain ``text``.

utest/test/api/test_get_timeout.py

@@ -0,0 +1,29 @@
+from datetime import timedelta
+
+import pytest
+from mockito import mock, unstub
+
+from SeleniumLibrary.base import LibraryComponent
+
+
+@pytest.fixture
+def lib():
+ ctx = mock()
+ ctx.timeout = 5.0
+ return LibraryComponent(ctx)
+
+
+def teardown_function():
+ unstub()
+
+
+def test_timeout_as_none(lib: LibraryComponent):
+ assert lib.get_timeout(None) == 5.0
+
+
+def test_timeout_as_float(lib: LibraryComponent):
+ assert lib.get_timeout(1.0) == 1.0
+
+
+def test_timeout_as_timedelta(lib: LibraryComponent):
+ assert lib.get_timeout(timedelta(seconds=0.1)) == 0.1

utest/test/keywords/test_keyword_arguments_waiting.py

@@ -26,7 +26,7 @@ def test_wait_for_condition(waiting):
  assert "did not become true" in str(error.value)
 
  with pytest.raises(AssertionError) as error:
- waiting.wait_for_condition(condition, "None", "foobar")
+ waiting.wait_for_condition(condition, None, "foobar")
  assert "foobar" in str(error.value)
 
 
@@ -38,5 +38,5 @@ def test_wait_until_page_contains(waiting):
  assert "Text 'text' did not" in str(error.value)
 
  with pytest.raises(AssertionError) as error:
- waiting.wait_until_page_contains(text, "None", "error")
+ waiting.wait_until_page_contains(text, None, "error")
  assert "error" in str(error.value)