Skip to content

Cleanup selecting windows. #968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaltat merged 4 commits into from
Oct 30, 2017
Merged

Cleanup selecting windows. #968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9f1c137
Cleanup selecting windows.
pekkaklarck Oct 23, 2017
c5371ef
Get Window Handles to replace List Windows. See #966.
pekkaklarck Oct 23, 2017
200cddf
Documented cleaned up Select Window.
pekkaklarck Oct 23, 2017
166d048
Moved window keywords to own component
pekkaklarck Oct 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/SeleniumLibrary/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
ScreenshotKeywords,
SelectElementKeywords,
TableElementKeywords,
WaitingKeywords)
WaitingKeywords,
WindowKeywords)
from SeleniumLibrary.locators import ElementFinder, TableElementFinder
from SeleniumLibrary.utils import (BrowserCache, Deprecated, LibraryListener,
timestr_to_secs)
Expand Down Expand Up @@ -339,7 +340,8 @@ def __init__(self, timeout=5.0, implicit_wait=0.0,
ScreenshotKeywords(self),
SelectElementKeywords(self),
TableElementKeywords(self),
WaitingKeywords(self)
WaitingKeywords(self),
WindowKeywords(self)
]
self._browsers = BrowserCache()
DynamicCore.__init__(self, libraries)
Expand Down
4 changes: 4 additions & 0 deletions src/SeleniumLibrary/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@ class SeleniumLibraryException(Exception):

class ElementNotFound(SeleniumLibraryException):
pass


class WindowNotFound(SeleniumLibraryException):
pass
1 change: 1 addition & 0 deletions src/SeleniumLibrary/keywords/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@
from .selectelement import SelectElementKeywords
from .tableelement import TableElementKeywords
from .waiting import WaitingKeywords
from .window import WindowKeywords
161 changes: 6 additions & 155 deletions src/SeleniumLibrary/keywords/browsermanagement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@

from robot.utils import NormalizedDict
from selenium import webdriver
from selenium.common.exceptions import NoSuchWindowException

from SeleniumLibrary.base import keyword, LibraryComponent
from SeleniumLibrary.locators import WindowManager
Expand Down Expand Up @@ -238,150 +237,6 @@ def switch_browser(self, index_or_alias):
self.debug('Switched to browser with Selenium session id %s.'
% self.browser.session_id)

@keyword
def close_window(self):
"""Closes currently opened pop-up window."""
self.browser.close()

@keyword
def get_window_identifiers(self):
"""Returns and logs id attributes of all known browser windows."""
ids = [info.id for info in self._window_manager.get_window_infos()]
return self._log_list(ids)

@keyword
def get_window_names(self):
"""Returns and logs names of all known browser windows."""
names = [info.name for info in self._window_manager.get_window_infos()]
return self._log_list(names)

@keyword
def get_window_titles(self):
"""Returns and logs titles of all known browser windows."""
titles = [info.title for info in self._window_manager.get_window_infos()]
return self._log_list(titles)

@keyword
def maximize_browser_window(self):
"""Maximizes current browser window."""
self.browser.maximize_window()

@keyword
def get_window_size(self):
"""Returns current window width and height as integers.

See also `Set Window Size`.

Example:
| ${width} | ${height}= | `Get Window Size` |
"""
size = self.browser.get_window_size()
return size['width'], size['height']

@keyword
def set_window_size(self, width, height):
"""Sets current windows size to given ``width`` and ``height``.

Values can be given using strings containing numbers or by using
actual numbers. See also `Get Window Size`.

Browsers have a limit how small they can be set. Trying to set them
smaller will cause the actual size to be bigger than the requested
size.

Example:
| `Set Window Size` | 800 | 600 |
"""
return self.browser.set_window_size(int(width), int(height))

@keyword
def get_window_position(self):
"""Returns current window position.

Position is relative to the top left corner of the screen. Returned
values are integers. See also `Set Window Position`.

Example:
| ${x} | ${y}= | `Get Window Position` |
"""
position = self.browser.get_window_position()
return position['x'], position['y']

@keyword
def set_window_position(self, x, y):
"""Sets window position using ``x`` and ``y`` coordinates.

The position is relative to the top left corner of the screen,
but some browsers exclude possible task bar set by the operating
system from the calculation. The actual position may thus be
different with different browsers.

Values can be given using strings containing numbers or by using
actual numbers. See also `Get Window Position`.

Example:
| `Set Window Position` | 100 | 200 |
"""
self.browser.set_window_position(int(x), int(y))

@keyword
def select_window(self, locator=None):
"""Selects the window matching locator and return previous window handle.

locator: any of name, title, url, window handle, excluded handle's list, or special words.
return: either current window handle before selecting, or None if no current window.

If the window is found, all subsequent commands use that window, until
this keyword is used again. If the window is not found, this keyword fails.

By default, when a locator value is provided,
it is matched against the title of the window and the
javascript name of the window. If multiple windows with
same identifier are found, the first one is selected.

There are some special locators for searching target window:
string 'main' (default): select the main window;
string 'self': only return current window handle;
string 'new': select the last-indexed window assuming it is the newest opened window
window list: select the first window not in given list (See 'List Windows' to get the list)

It is also possible to specify the approach SeleniumLibrary should take
to find a window by specifying a locator strategy:

| *Strategy* | *Example* | *Description* |
| title | Select Window `|` title=My Document | Matches by window title |
| name | Select Window `|` name=${name} | Matches by window javascript name |
| url | Select Window `|` url=http://google.com | Matches by window's current URL |

Example:
| Click Link | popup_link | # opens new window |
| Select Window | popupName |
| Title Should Be | Popup Title |
| Select Window | | | # Chooses the main window again |
"""
try:
return self.browser.current_window_handle
except NoSuchWindowException:
pass
finally:
self._window_manager.select(locator)

@keyword
def list_windows(self):
"""Return all current window handles as a list."""
return self.browser.window_handles

@keyword
def get_location(self):
"""Returns the current browser URL."""
return self.browser.current_url

@keyword
def get_locations(self):
"""Returns and logs URLs of all known browser windows."""
urls = [info.url for info in self._window_manager.get_window_infos()]
return self._log_list(urls)

@keyword
def get_source(self):
"""Returns the entire HTML source of the current page or frame."""
Expand All @@ -392,6 +247,12 @@ def get_title(self):
"""Returns the title of current page."""
return self.browser.title

@keyword
def get_location(self):
"""Returns the current browser URL."""
return self.browser.current_url


@keyword
def location_should_be(self, url):
"""Verifies that current URL is exactly ``url``."""
Expand Down Expand Up @@ -696,16 +557,6 @@ def execute(self, driver_command, params=None):
browser.execute = types.MethodType(execute, browser)
browser._speed = self.ctx.speed

def _log_list(self, items, what='item'):
msg = [
'Altogether {} {}.'.format(
len(items), what if len(items) == 1 else '{}s'.format(what))
]
for index, item in enumerate(items):
msg.append('{}: {}'.format(index + 1, item))
self.info('\n'.join(msg))
return items

@property
def _geckodriver_log_config(self):
if SELENIUM_VERSION.major == '3':
Expand Down
Loading