window.py

Go to the documentation of this file.

# Copyright 2008-2011 Nokia Networks
# Copyright 2011-2016 Ryan Tomac, Ed Manlove and contributors
# Copyright 2016-     Robot Framework Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# 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.
import time
 
from SeleniumLibrary.utils import is_truthy, is_falsy, timestr_to_secs
from selenium.common.exceptions import NoSuchWindowException
 
from SeleniumLibrary.base import keyword, LibraryComponent
from SeleniumLibrary.locators import WindowManager
from SeleniumLibrary.utils import plural_or_not
 
 
class WindowKeywords(LibraryComponent):
 
    def __init__(self, ctx):
        LibraryComponent.__init__(self, ctx)
        self._window_manager_window_manager = WindowManager(ctx)
 
    @keyword
    
    def select_window(self, locator='MAIN', timeout=None):
        epoch = time.time()
        timeout = epoch if is_falsy(timeout) else timestr_to_secs(timeout) + epoch
        try:
            return self.driverdriverdriver.current_window_handle
        except NoSuchWindowException:
            pass
        finally:
            self._window_manager_window_manager.select(locator, timeout)
 
    @keyword
    
    def close_window(self):
        self.driverdriverdriver.close()
 
    @keyword
    
    def get_window_handles(self):
        return self.driverdriverdriver.window_handles
 
    @keyword
    
    def get_window_identifiers(self):
        ids = [info.id for info in self._window_manager_window_manager.get_window_infos()]
        return self._log_list_log_list(ids)
 
    @keyword
    
    def get_window_names(self):
        names = [info.name for info in self._window_manager_window_manager.get_window_infos()]
        return self._log_list_log_list(names)
 
    @keyword
    
    def get_window_titles(self):
        titles = [info.title for info in self._window_manager_window_manager.get_window_infos()]
        return self._log_list_log_list(titles)
 
    @keyword
    
    def get_locations(self):
        urls = [info.url for info in self._window_manager_window_manager.get_window_infos()]
        return self._log_list_log_list(urls)
 
    @keyword
    
    def maximize_browser_window(self):
        self.driverdriverdriver.maximize_window()
 
    @keyword
    
    def get_window_size(self, inner=False):
        if is_truthy(inner):
            inner_width = int(self.driverdriverdriver.execute_script("return window.innerWidth;"))
            inner_height = int(self.driverdriverdriver.execute_script("return window.innerHeight;"))
            return inner_width, inner_height
        size = self.driverdriverdriver.get_window_size()
        return size['width'], size['height']
 
    @keyword
    
    def set_window_size(self, width, height, inner=False):
        width, height = int(width), int(height)
        if is_falsy(inner):
            return self.driverdriverdriver.set_window_size(width, height)
        self.driverdriverdriver.set_window_size(width, height)
        inner_width = int(self.driverdriverdriver.execute_script("return window.innerWidth;"))
        inner_height = int(self.driverdriverdriver.execute_script("return window.innerHeight;"))
        self.infoinfo('window.innerWidth is %s and window.innerHeight is %s' % (inner_width, inner_height))
        width_offset = width - inner_width
        height_offset = height - inner_height
        window_width = width + width_offset
        window_height = height + height_offset
        self.infoinfo('Setting window size to %s %s' % (window_width, window_height))
        self.driverdriverdriver.set_window_size(window_width, window_height)
        result_width = int(self.driverdriverdriver.execute_script("return window.innerWidth;"))
        result_height = int(self.driverdriverdriver.execute_script("return window.innerHeight;"))
        if result_width != width or result_height != height:
            raise AssertionError("Keyword failed setting correct window size.")
 
    @keyword
    
    def get_window_position(self):
        position = self.driverdriverdriver.get_window_position()
        return position['x'], position['y']
 
    @keyword
    
    def set_window_position(self, x, y):
        self.driverdriverdriver.set_window_position(int(x), int(y))
 
    def _log_list(self, items, what='item'):
        msg = [
            'Altogether %s %s%s.'
            % (len(items), what, plural_or_not(items))
        ]
        for index, item in enumerate(items):
            msg.append('%s: %s' % (index + 1, item))
        self.infoinfo('\n'.join(msg))
        return items