From 06a6daee343fcb63c7ec1c247e20957419010326 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Fri, 8 Jul 2016 12:53:48 +0200 Subject: [PATCH] Add stubs for QtWebEngine --- qutebrowser/browser/webengine/webenginetab.py | 139 ++++++++++++++---- qutebrowser/utils/log.py | 10 ++ tests/unit/utils/test_log.py | 11 ++ 3 files changed, 131 insertions(+), 29 deletions(-) diff --git a/qutebrowser/browser/webengine/webenginetab.py b/qutebrowser/browser/webengine/webenginetab.py index d178c2e4e..9bcb5f9b4 100644 --- a/qutebrowser/browser/webengine/webenginetab.py +++ b/qutebrowser/browser/webengine/webenginetab.py @@ -17,49 +17,102 @@ # You should have received a copy of the GNU General Public License # along with qutebrowser. If not, see . +# FIXME:qtwebengine remove this once the stubs are gone +# pylint: disable=unused-variable + """Wrapper over a QWebEngineView.""" -from PyQt5.QtCore import pyqtSlot, Qt, QEvent +from PyQt5.QtCore import pyqtSlot, Qt, QEvent, QPoint from PyQt5.QtGui import QKeyEvent from PyQt5.QtWidgets import QApplication # pylint: disable=no-name-in-module,import-error,useless-suppression from PyQt5.QtWebEngineWidgets import QWebEnginePage # pylint: enable=no-name-in-module,import-error,useless-suppression -from qutebrowser.browser import tab +from qutebrowser.browser import tab as tabmod from qutebrowser.browser.webengine import webview -from qutebrowser.utils import usertypes, qtutils +from qutebrowser.utils import usertypes, qtutils, log -## FIXME:qtwebengine add stubs for abstract things which aren't implemented -## yet. -## pylint: disable=abstract-method - - -class WebEngineSearch(tab.AbstractSearch): +class WebEngineSearch(tabmod.AbstractSearch): """QtWebEngine implementations related to searching on the page.""" - ## TODO + def search(self, text, *, ignore_case=False, wrap=False, reverse=False): + log.stub() - pass + def clear(self): + log.stub() + + def prev_result(self): + log.stub() + + def next_result(self): + log.stub() -class WebEngineCaret(tab.AbstractCaret): +class WebEngineCaret(tabmod.AbstractCaret): """QtWebEngine implementations related to moving the cursor/selection.""" - ## TODO - @pyqtSlot(usertypes.KeyMode) def _on_mode_entered(self, mode): - ## TODO - pass + log.stub() @pyqtSlot(usertypes.KeyMode) def _on_mode_left(self): - ## TODO - pass + log.stub() + + def move_to_next_line(self, count=1): + log.stub() + + def move_to_prev_line(self, count=1): + log.stub() + + def move_to_next_char(self, count=1): + log.stub() + + def move_to_prev_char(self, count=1): + log.stub() + + def move_to_end_of_word(self, count=1): + log.stub() + + def move_to_next_word(self, count=1): + log.stub() + + def move_to_prev_word(self, count=1): + log.stub() + + def move_to_start_of_line(self): + log.stub() + + def move_to_end_of_line(self): + log.stub() + + def move_to_start_of_next_block(self, count=1): + log.stub() + + def move_to_start_of_prev_block(self, count=1): + log.stub() + + def move_to_end_of_next_block(self, count=1): + log.stub() + + def move_to_end_of_prev_block(self, count=1): + log.stub() + + def move_to_start_of_document(self): + log.stub() + + def move_to_end_of_document(self): + log.stub() + + def toggle_selection(self): + log.stub() + + def drop_selection(self): + log.stub() def has_selection(self): return self._widget.hasSelection() @@ -69,8 +122,12 @@ class WebEngineCaret(tab.AbstractCaret): raise NotImplementedError return self._widget.selectedText() + def follow_selected(self, *, tab=False): + log.stub() -class WebEngineScroller(tab.AbstractScroller): + + +class WebEngineScroller(tabmod.AbstractScroller): """QtWebEngine implementations related to scrolling.""" @@ -85,6 +142,10 @@ class WebEngineScroller(tab.AbstractScroller): QApplication.postEvent(recipient, press_evt) QApplication.postEvent(recipient, release_evt) + def pos_px(self): + log.stub() + return QPoint(0, 0) + def pos_perc(self): page = self._widget.page() try: @@ -92,6 +153,7 @@ class WebEngineScroller(tab.AbstractScroller): pos = page.scrollPosition() except AttributeError: # Added in Qt 5.7 + log.stub('on Qt < 5.7') return (None, None) else: # FIXME:qtwebengine is this correct? @@ -99,6 +161,18 @@ class WebEngineScroller(tab.AbstractScroller): perc_y = 100 / size.height() * pos.y() return (perc_x, perc_y) + def to_perc(self, x=None, y=None): + log.stub() + + def to_point(self, point): + log.stub() + + def delta(self, x=0, y=0): + log.stub() + + def delta_page(self, x=0, y=0): + log.stub() + def up(self, count=1): self._key_press(Qt.Key_Up, count) @@ -123,10 +197,14 @@ class WebEngineScroller(tab.AbstractScroller): def page_down(self, count=1): self._key_press(Qt.Key_PageDown, count) - ## TODO + def at_top(self): + log.stub() + + def at_bottom(self): + log.stub() -class WebEngineHistory(tab.AbstractHistory): +class WebEngineHistory(tabmod.AbstractHistory): """QtWebEngine implementations related to page history.""" @@ -152,11 +230,10 @@ class WebEngineHistory(tab.AbstractHistory): return qtutils.deserialize(data, self._history) def load_items(self, items): - # TODO - raise NotImplementedError + log.stub() -class WebEngineZoom(tab.AbstractZoom): +class WebEngineZoom(tabmod.AbstractZoom): """QtWebEngine implementations related to zooming.""" @@ -167,7 +244,7 @@ class WebEngineZoom(tab.AbstractZoom): return self._widget.zoomFactor() -class WebEngineViewTab(tab.AbstractTab): +class WebEngineViewTab(tabmod.AbstractTab): """A QtWebEngine tab in the browser.""" @@ -182,7 +259,7 @@ class WebEngineViewTab(tab.AbstractTab): self.search = WebEngineSearch(parent=self) self._set_widget(widget) self._connect_signals() - self.backend = tab.Backend.QtWebEngine + self.backend = tabmod.Backend.QtWebEngine def openurl(self, url): self._widget.load(url) @@ -191,9 +268,11 @@ class WebEngineViewTab(tab.AbstractTab): return self._widget.url() def progress(self): - return 0 # FIXME:qtwebengine + log.stub() + return 0 def load_status(self): + log.stub() return usertypes.LoadStatus.success def dump_async(self, callback, *, plain=False): @@ -209,8 +288,7 @@ class WebEngineViewTab(tab.AbstractTab): self._widget.page().runJavaScript(code, callback) def shutdown(self): - # TODO - pass + log.stub() def reload(self, *, force=False): if force: @@ -236,6 +314,9 @@ class WebEngineViewTab(tab.AbstractTab): # percent encoded content is 2 megabytes minus 30 bytes. self._widget.setHtml(html, base_url) + def clear_ssl_errors(self): + log.stub() + def _connect_signals(self): view = self._widget page = view.page() diff --git a/qutebrowser/utils/log.py b/qutebrowser/utils/log.py index 37c1c6bcd..7f67ae9f2 100644 --- a/qutebrowser/utils/log.py +++ b/qutebrowser/utils/log.py @@ -29,6 +29,7 @@ import faulthandler import traceback import warnings import json +import inspect from PyQt5 import QtCore # Optional imports @@ -130,6 +131,15 @@ sessions = logging.getLogger('sessions') ram_handler = None +def stub(suffix=''): + """Show a STUB: message for the calling function.""" + function = inspect.stack()[1][3] + text = "STUB: {}".format(function) + if suffix: + text = '{} ({})'.format(text, suffix) + misc.warning(text) + + class CriticalQtWarning(Exception): """Exception raised when there's a critical Qt warning.""" diff --git a/tests/unit/utils/test_log.py b/tests/unit/utils/test_log.py index 27332efdf..5554717d9 100644 --- a/tests/unit/utils/test_log.py +++ b/tests/unit/utils/test_log.py @@ -267,3 +267,14 @@ class TestHideQtWarning: with caplog.at_level(logging.WARNING, 'qt-tests'): logger.warning(" Hello World ") assert not caplog.records + + +@pytest.mark.parametrize('suffix, expected', [ + ('', 'STUB: test_stub'), + ('foo', 'STUB: test_stub (foo)'), +]) +def test_stub(caplog, suffix, expected): + with caplog.at_level(logging.WARNING, 'misc'): + log.stub(suffix) + assert len(caplog.records) == 1 + assert caplog.records[0].message == expected