diff options
| author | Lembrun <amadeusk7@free.fr> | 2021-03-11 19:11:06 +0100 |
|---|---|---|
| committer | Lembrun <amadeusk7@free.fr> | 2021-03-11 19:11:06 +0100 |
| commit | 3707234c3ae95c9ee7cc0721b668a5e96a9cfa6f (patch) | |
| tree | 60c027d9fa59c1c24537fcd4284458e0c1751006 | |
| parent | ef5ba1a0360b39f9eff027fbdc57f363597c3c3b (diff) | |
| parent | 40054ac944a988e02ca8f3de414581f1e77688d8 (diff) | |
| download | qutebrowser-3707234c3ae95c9ee7cc0721b668a5e96a9cfa6f.tar.gz qutebrowser-3707234c3ae95c9ee7cc0721b668a5e96a9cfa6f.zip | |
Merge branch 'master' into pathlib-/unit/commands
32 files changed, 718 insertions, 397 deletions
diff --git a/misc/requirements/requirements-dev.txt b/misc/requirements/requirements-dev.txt index 5e679e879..8a088a6b0 100644 --- a/misc/requirements/requirements-dev.txt +++ b/misc/requirements/requirements-dev.txt @@ -15,10 +15,10 @@ packaging==20.9 pycparser==2.20 Pympler==0.9 pyparsing==2.4.7 -PyQt-builder==1.9.0 +PyQt-builder==1.9.1 python-dateutil==2.8.1 requests==2.25.1 -sip==6.0.2 +sip==6.0.3 six==1.15.0 toml==0.10.2 uritemplate==3.0.1 diff --git a/misc/requirements/requirements-pyqt-5.15.txt b/misc/requirements/requirements-pyqt-5.15.txt index 646b67baf..a5b3a5787 100644 --- a/misc/requirements/requirements-pyqt-5.15.txt +++ b/misc/requirements/requirements-pyqt-5.15.txt @@ -1,7 +1,7 @@ # This file is automatically generated by scripts/dev/recompile_requirements.py -PyQt5==5.15.3 # rq.filter: < 5.16 -PyQt5-Qt==5.15.2 +PyQt5==5.15.4 # rq.filter: < 5.16 +PyQt5-Qt5==5.15.2 PyQt5-sip==12.8.1 -PyQtWebEngine==5.15.3 # rq.filter: < 5.16 -PyQtWebEngine-Qt==5.15.2 +PyQtWebEngine==5.15.4 # rq.filter: < 5.16 +PyQtWebEngine-Qt5==5.15.2 diff --git a/misc/requirements/requirements-pyqt.txt b/misc/requirements/requirements-pyqt.txt index 31ecefad5..7e28f7dc2 100644 --- a/misc/requirements/requirements-pyqt.txt +++ b/misc/requirements/requirements-pyqt.txt @@ -1,7 +1,7 @@ # This file is automatically generated by scripts/dev/recompile_requirements.py -PyQt5==5.15.3 -PyQt5-Qt==5.15.2 +PyQt5==5.15.4 +PyQt5-Qt5==5.15.2 PyQt5-sip==12.8.1 -PyQtWebEngine==5.15.3 -PyQtWebEngine-Qt==5.15.2 +PyQtWebEngine==5.15.4 +PyQtWebEngine-Qt5==5.15.2 diff --git a/misc/userscripts/readability-js b/misc/userscripts/readability-js index 532df51c6..d9474aeb1 100755 --- a/misc/userscripts/readability-js +++ b/misc/userscripts/readability-js @@ -39,8 +39,8 @@ const HEADER = ` <!DOCTYPE html> <html> <head> - <meta name="viewport" content="width=device-width, initial-scale=1, text/html, charset=UTF-8" http-equiv="Content-Type"> - </meta> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta charset="UTF-8"> <title>%s</title> <style type="text/css"> body { @@ -106,7 +106,12 @@ const HEADER = ` SAwLTIgMC44OTUtMiAyczAuODk1IDIgMiAyaDIwYzEuMTEgMCAyLTAuODk1IDItMnMtMC44OTUtMi0yLTJ6bTAgOGgtMjBjLTEuMTEgMC0yIDAuODk1LTIg MnMwLjg5NSAyIDIgMmgyMGMxLjExIDAgMi0wLjg5NSAyLTJzLTAuODk1LTItMi0yem0tMTIgOGgtOGMtMS4xMSAwLTIgMC44OTUtMiAyczAuODk1IDIgMiA yaDhjMS4xMSAwIDItMC44OTUgMi0ycy0wLjg5NS0yLTItMnoiIGZpbGw9IiNmZmYiLz4KPC9nPgo8L3N2Zz4K"/> -</head>`; +</head> +<body class="qute-readability"> + %s +</body> +</html> +`; const scriptsDir = path.join(process.env.QUTE_DATA_DIR, 'userscripts'); const tmpFile = path.join(scriptsDir, '/readability.html'); @@ -129,10 +134,7 @@ else { getDOM(target, domOpts).then(dom => { let reader = new Readability(dom.window.document); let article = reader.parse(); - let content = util.format(HEADER, article.title) + article.content; - - // add a class to make styling the page easier - content = content.replace('<body>', '<body class="qute-readability">') + let content = util.format(HEADER, article.title, article.content); fs.writeFile(tmpFile, content, (err) => { if (err) { diff --git a/qutebrowser/app.py b/qutebrowser/app.py index 5a9c956b0..1a18881b5 100644 --- a/qutebrowser/app.py +++ b/qutebrowser/app.py @@ -66,7 +66,8 @@ from qutebrowser.misc import (ipc, savemanager, sessions, crashsignal, earlyinit, sql, cmdhistory, backendproblem, objects, quitter) from qutebrowser.utils import (log, version, message, utils, urlutils, objreg, - usertypes, standarddir, error, qtutils, debug) + resources, usertypes, standarddir, + error, qtutils, debug) # pylint: disable=unused-import # We import those to run the cmdutils.register decorators. from qutebrowser.mainwindow.statusbar import command @@ -86,7 +87,7 @@ def run(args): log.init.debug("Initializing directories...") standarddir.init(args) - utils.preload_resources() + resources.preload() log.init.debug("Initializing config...") configinit.early_init(args) @@ -395,7 +396,7 @@ def _open_special_pages(args): return try: - changelog = utils.read_file('html/doc/changelog.html') + changelog = resources.read_file('html/doc/changelog.html') except OSError as e: log.init.warning(f"Not showing changelog due to {e}") return diff --git a/qutebrowser/browser/network/pac.py b/qutebrowser/browser/network/pac.py index 4a4768dde..5ade5d4ac 100644 --- a/qutebrowser/browser/network/pac.py +++ b/qutebrowser/browser/network/pac.py @@ -29,7 +29,7 @@ from PyQt5.QtNetwork import (QNetworkProxy, QNetworkRequest, QHostInfo, QHostAddress) from PyQt5.QtQml import QJSEngine, QJSValue -from qutebrowser.utils import log, utils, qtutils +from qutebrowser.utils import log, utils, qtutils, resources class ParseProxyError(Exception): @@ -190,7 +190,7 @@ class PACResolver: self._engine.globalObject().setProperty( "PAC", self._engine.newQObject(self._ctx)) self._evaluate(_PACContext.JS_DEFINITIONS, "pac_js_definitions") - self._evaluate(utils.read_file("javascript/pac_utils.js"), "pac_utils") + self._evaluate(resources.read_file("javascript/pac_utils.js"), "pac_utils") proxy_config = self._engine.newObject() proxy_config.setProperty("bindings", self._engine.newObject()) self._engine.globalObject().setProperty("ProxyConfig", proxy_config) diff --git a/qutebrowser/browser/pdfjs.py b/qutebrowser/browser/pdfjs.py index 97074767b..c180c55f8 100644 --- a/qutebrowser/browser/pdfjs.py +++ b/qutebrowser/browser/pdfjs.py @@ -24,7 +24,7 @@ import os from PyQt5.QtCore import QUrl, QUrlQuery -from qutebrowser.utils import utils, javascript, jinja, standarddir, log +from qutebrowser.utils import resources, javascript, jinja, standarddir, log from qutebrowser.config import config @@ -149,7 +149,7 @@ def get_pdfjs_res_and_path(path): if content is None: res_path = '3rdparty/pdfjs/{}'.format(path) try: - content = utils.read_file_binary(res_path) + content = resources.read_file_binary(res_path) except FileNotFoundError: raise PDFJSNotFound(path) from None except OSError as e: diff --git a/qutebrowser/browser/qutescheme.py b/qutebrowser/browser/qutescheme.py index 169c92325..cb04586ff 100644 --- a/qutebrowser/browser/qutescheme.py +++ b/qutebrowser/browser/qutescheme.py @@ -40,7 +40,7 @@ import qutebrowser from qutebrowser.browser import pdfjs, downloads, history from qutebrowser.config import config, configdata, configexc from qutebrowser.utils import (version, utils, jinja, log, message, docutils, - objreg, standarddir) + resources, objreg, standarddir) from qutebrowser.qt import sip @@ -271,7 +271,7 @@ def qute_javascript(url: QUrl) -> _HandlerRet: path = url.path() if path: path = "javascript" + os.sep.join(path.split('/')) - return 'text/html', utils.read_file(path) + return 'text/html', resources.read_file(path) else: raise UrlInvalidError("No file specified") @@ -345,14 +345,14 @@ def qute_log(url: QUrl) -> _HandlerRet: @add_handler('gpl') def qute_gpl(_url: QUrl) -> _HandlerRet: """Handler for qute://gpl. Return HTML content as string.""" - return 'text/html', utils.read_file('html/license.html') + return 'text/html', resources.read_file('html/license.html') def _asciidoc_fallback_path(html_path: str) -> Optional[str]: """Fall back to plaintext asciidoc if the HTML is unavailable.""" path = html_path.replace('.html', '.asciidoc') try: - return utils.read_file(path) + return resources.read_file(path) except OSError: return None @@ -372,14 +372,14 @@ def qute_help(url: QUrl) -> _HandlerRet: path = 'html/doc/{}'.format(urlpath) if not urlpath.endswith('.html'): try: - bdata = utils.read_file_binary(path) + bdata = resources.read_file_binary(path) except OSError as e: raise SchemeOSError(e) mimetype = utils.guess_mimetype(urlpath) return mimetype, bdata try: - data = utils.read_file(path) + data = resources.read_file(path) except OSError: asciidoc = _asciidoc_fallback_path(path) @@ -575,7 +575,7 @@ def qute_resource(url: QUrl) -> _HandlerRet: path = url.path().lstrip('/') mimetype = utils.guess_mimetype(path, fallback=True) try: - data = utils.read_file_binary(path) + data = resources.read_file_binary(path) except FileNotFoundError as e: raise NotFoundError(str(e)) return mimetype, data diff --git a/qutebrowser/browser/webengine/webenginetab.py b/qutebrowser/browser/webengine/webenginetab.py index 450d68751..69ddbe6e1 100644 --- a/qutebrowser/browser/webengine/webenginetab.py +++ b/qutebrowser/browser/webengine/webenginetab.py @@ -38,7 +38,7 @@ from qutebrowser.browser.webengine import (webview, webengineelem, tabhistory, webengineinspector) from qutebrowser.utils import (usertypes, qtutils, log, javascript, utils, - message, jinja, debug, version) + resources, message, jinja, debug, version) from qutebrowser.qt import sip from qutebrowser.misc import objects, miscwidgets @@ -1038,9 +1038,9 @@ class _WebEngineScripts(QObject): """Initialize global qutebrowser JavaScript.""" js_code = javascript.wrap_global( 'scripts', - utils.read_file('javascript/scroll.js'), - utils.read_file('javascript/webelem.js'), - utils.read_file('javascript/caret.js'), + resources.read_file('javascript/scroll.js'), + resources.read_file('javascript/webelem.js'), + resources.read_file('javascript/caret.js'), ) # FIXME:qtwebengine what about subframes=True? self._inject_js('js', js_code, subframes=True) @@ -1061,7 +1061,7 @@ class _WebEngineScripts(QObject): css = shared.get_user_stylesheet() js_code = javascript.wrap_global( 'stylesheet', - utils.read_file('javascript/stylesheet.js'), + resources.read_file('javascript/stylesheet.js'), javascript.assemble('stylesheet', 'set_css', css), ) self._inject_js('stylesheet', js_code, subframes=True) @@ -1169,7 +1169,7 @@ class _WebEngineScripts(QObject): for quirk in quirks: if not quirk.predicate: continue - src = utils.read_file(f'javascript/quirks/{quirk.filename}.user.js') + src = resources.read_file(f'javascript/quirks/{quirk.filename}.user.js') self._inject_js( f'quirk_{quirk.filename}', src, diff --git a/qutebrowser/browser/webkit/webkittab.py b/qutebrowser/browser/webkit/webkittab.py index f910cf676..df3491ec2 100644 --- a/qutebrowser/browser/webkit/webkittab.py +++ b/qutebrowser/browser/webkit/webkittab.py @@ -34,8 +34,7 @@ from PyQt5.QtPrintSupport import QPrinter from qutebrowser.browser import browsertab, shared from qutebrowser.browser.webkit import (webview, tabhistory, webkitelem, webkitsettings, webkitinspector) - -from qutebrowser.utils import qtutils, usertypes, utils, log, debug +from qutebrowser.utils import qtutils, usertypes, utils, log, debug, resources from qutebrowser.keyinput import modeman from qutebrowser.qt import sip @@ -228,7 +227,7 @@ class WebKitCaret(browsertab.AbstractCaret): # true in caret mode. if self._selection_state is browsertab.SelectionState.none: self._widget.page().currentFrame().evaluateJavaScript( - utils.read_file('javascript/position_caret.js')) + resources.read_file('javascript/position_caret.js')) @pyqtSlot(usertypes.KeyMode) def _on_mode_left(self, _mode): diff --git a/qutebrowser/config/configdata.py b/qutebrowser/config/configdata.py index 6cead0732..ec4efc375 100644 --- a/qutebrowser/config/configdata.py +++ b/qutebrowser/config/configdata.py @@ -30,7 +30,7 @@ import functools import dataclasses from qutebrowser.config import configtypes -from qutebrowser.utils import usertypes, qtutils, utils +from qutebrowser.utils import usertypes, qtutils, utils, resources from qutebrowser.misc import debugcachestats DATA = cast(Mapping[str, 'Option'], None) @@ -272,4 +272,4 @@ def is_valid_prefix(prefix: str) -> bool: def init() -> None: """Initialize configdata from the YAML file.""" global DATA, MIGRATIONS - DATA, MIGRATIONS = _read_yaml(utils.read_file('config/configdata.yml')) + DATA, MIGRATIONS = _read_yaml(resources.read_file('config/configdata.yml')) diff --git a/qutebrowser/config/configfiles.py b/qutebrowser/config/configfiles.py index 9031c9b96..04aa4ec49 100644 --- a/qutebrowser/config/configfiles.py +++ b/qutebrowser/config/configfiles.py @@ -128,22 +128,21 @@ class StateConfig(configparser.ConfigParser): # https://github.com/python/typeshed/issues/2093 return # type: ignore[unreachable] - old_version = utils.parse_version(old_qutebrowser_version) - new_version = utils.parse_version(qutebrowser.__version__) - - if old_version.isNull(): + try: + old_version = utils.VersionNumber.parse(old_qutebrowser_version) + except ValueError: log.init.warning(f"Unable to parse old version {old_qutebrowser_version}") return - assert not new_version.isNull(), qutebrowser.__version__ + new_version = utils.VersionNumber.parse(qutebrowser.__version__) if old_version == new_version: self.qutebrowser_version_changed = VersionChange.equal elif new_version < old_version: self.qutebrowser_version_changed = VersionChange.downgrade - elif old_version.segments()[:2] == new_version.segments()[:2]: + elif old_version.segments[:2] == new_version.segments[:2]: self.qutebrowser_version_changed = VersionChange.patch - elif old_version.majorVersion() == new_version.majorVersion(): + elif old_version.major == new_version.major: self.qutebrowser_version_changed = VersionChange.minor else: self.qutebrowser_version_changed = VersionChange.major diff --git a/qutebrowser/config/qtargs.py b/qutebrowser/config/qtargs.py index 3e35e6908..407ccb37e 100644 --- a/qutebrowser/config/qtargs.py +++ b/qutebrowser/config/qtargs.py @@ -165,6 +165,30 @@ def _get_locale_pak_path(locales_path: pathlib.Path, locale_name: str) -> pathli return locales_path / (locale_name + '.pak') +def _get_pak_name(locale_name: str) -> str: + """Get the Chromium .pak name for a locale name. + + Based on Chromium's behavior in l10n_util::CheckAndResolveLocale: + https://source.chromium.org/chromium/chromium/src/+/master:ui/base/l10n/l10n_util.cc;l=344-428;drc=43d5378f7f363dab9271ca37774c71176c9e7b69 + """ + if locale_name in {'en', 'en-PH', 'en-LR'}: + return 'en-US' + elif locale_name.startswith('en-'): + return 'en-GB' + elif locale_name.startswith('es-'): + return 'es-419' + elif locale_name == 'pt': + return 'pt-BR' + elif locale_name.startswith('pt-'): # pragma: no cover + return 'pt-PT' + elif locale_name in {'zh-HK', 'zh-MO'}: + return 'zh-TW' + elif locale_name == 'zh' or locale_name.startswith('zh-'): + return 'zh-CN' + + return locale_name.split('-')[0] + + def _get_lang_override( webengine_version: utils.VersionNumber, locale_name: str @@ -191,25 +215,7 @@ def _get_lang_override( log.init.debug(f"Found {pak_path}, skipping workaround") return None - # Based on Chromium's behavior in l10n_util::CheckAndResolveLocale: - # https://source.chromium.org/chromium/chromium/src/+/master:ui/base/l10n/l10n_util.cc;l=344-428;drc=43d5378f7f363dab9271ca37774c71176c9e7b69 - if locale_name in {'en', 'en-PH', 'en-LR'}: - pak_name = 'en-US' - elif locale_name.startswith('en-'): - pak_name = 'en-GB' - elif locale_name.startswith('es-'): - pak_name = 'es-419' - elif locale_name == 'pt': - pak_name = 'pt-BR' - elif locale_name.startswith('pt-'): - pak_name = 'pt-PT' - elif locale_name in {'zh-HK', 'zh-MO'}: - pak_name = 'zh-TW' - elif locale_name == 'zh' or locale_name.startswith('zh-'): - pak_name = 'zh-CN' - else: - pak_name = locale_name.split('-')[0] - + pak_name = _get_pak_name(locale_name) pak_path = _get_locale_pak_path(locales_path, pak_name) if pak_path.exists(): log.init.debug(f"Found {pak_path}, applying workaround") diff --git a/qutebrowser/mainwindow/tabbedbrowser.py b/qutebrowser/mainwindow/tabbedbrowser.py index 8d2801d31..e081284ee 100644 --- a/qutebrowser/mainwindow/tabbedbrowser.py +++ b/qutebrowser/mainwindow/tabbedbrowser.py @@ -35,7 +35,7 @@ from qutebrowser.keyinput import modeman from qutebrowser.mainwindow import tabwidget, mainwindow from qutebrowser.browser import signalfilter, browsertab, history from qutebrowser.utils import (log, usertypes, utils, qtutils, objreg, - urlutils, message, jinja) + urlutils, message, jinja, version) from qutebrowser.misc import quitter @@ -936,15 +936,37 @@ class TabbedBrowser(QWidget): } msg = messages[status] + f" (status {code})" + # WORKAROUND for https://bugreports.qt.io/browse/QTBUG-91715 + versions = version.qtwebengine_versions() + is_qtbug_91715 = ( + status == browsertab.TerminationStatus.unknown and + code == 1002 and + versions.webengine == utils.VersionNumber(5, 15, 3)) + def show_error_page(html): tab.set_html(html) log.webview.error(msg) - url_string = tab.url(requested=True).toDisplayString() - error_page = jinja.render( - 'error.html', title="Error loading {}".format(url_string), - url=url_string, error=msg) - QTimer.singleShot(100, lambda: show_error_page(error_page)) + if is_qtbug_91715: + log.webview.error(msg) + log.webview.error('') + log.webview.error( + 'NOTE: If you see this and "Network service crashed, restarting ' + 'service.", please see:') + log.webview.error('https://github.com/qutebrowser/qutebrowser/issues/6235') + log.webview.error( + 'You can set the "qt.workarounds.locale" setting in qutebrowser to ' + 'work around the issue.') + log.webview.error( + 'A proper fix is likely available in QtWebEngine soon (which is why ' + 'the workaround is disabled by default).') + log.webview.error('') + else: + url_string = tab.url(requested=True).toDisplayString() + error_page = jinja.render( + 'error.html', title="Error loading {}".format(url_string), + url=url_string, error=msg) + QTimer.singleShot(100, lambda: show_error_page(error_page)) def resizeEvent(self, e): """Extend resizeEvent of QWidget to emit a resized signal afterwards. diff --git a/qutebrowser/misc/crashdialog.py b/qutebrowser/misc/crashdialog.py index ac292dcdb..430553433 100644 --- a/qutebrowser/misc/crashdialog.py +++ b/qutebrowser/misc/crashdialog.py @@ -359,8 +359,8 @@ class _CrashDialog(QDialog): Args: newest: The newest version as a string. """ - new_version = utils.parse_version(newest) - cur_version = utils.parse_version(qutebrowser.__version__) + new_version = utils.VersionNumber.parse(newest) + cur_version = utils.VersionNumber.parse(qutebrowser.__version__) lines = ['The report has been sent successfully. Thanks!'] if new_version > cur_version: lines.append("<b>Note:</b> The newest available version is v{}, " diff --git a/qutebrowser/utils/jinja.py b/qutebrowser/utils/jinja.py index e5cd853aa..61d8ccdad 100644 --- a/qutebrowser/utils/jinja.py +++ b/qutebrowser/utils/jinja.py @@ -31,7 +31,7 @@ import jinja2 import jinja2.nodes from PyQt5.QtCore import QUrl -from qutebrowser.utils import utils, urlutils, log, qtutils +from qutebrowser.utils import utils, urlutils, log, qtutils, resources from qutebrowser.misc import debugcachestats @@ -56,7 +56,7 @@ html_fallback = """ class Loader(jinja2.BaseLoader): - """Jinja loader which uses utils.read_file to load templates. + """Jinja loader which uses resources.read_file to load templates. Attributes: _subdir: The subdirectory to find templates in. @@ -72,7 +72,7 @@ class Loader(jinja2.BaseLoader): ) -> Tuple[str, str, Callable[[], bool]]: path = os.path.join(self._subdir, template) try: - source = utils.read_file(path) + source = resources.read_file(path) except OSError as e: source = html_fallback.replace("%ERROR%", html.escape(str(e))) source = source.replace("%FILE%", html.escape(template)) @@ -119,7 +119,7 @@ class Environment(jinja2.Environment): def _data_url(self, path: str) -> str: """Get a data: url for the broken qutebrowser logo.""" - data = utils.read_file_binary(path) + data = resources.read_file_binary(path) mimetype = utils.guess_mimetype(path) return urlutils.data_url(mimetype, data).toString() diff --git a/qutebrowser/utils/qtutils.py b/qutebrowser/utils/qtutils.py index f7c5a3ce0..01234a42b 100644 --- a/qutebrowser/utils/qtutils.py +++ b/qutebrowser/utils/qtutils.py @@ -98,15 +98,15 @@ def version_check(version: str, if compiled and exact: raise ValueError("Can't use compiled=True with exact=True!") - parsed = utils.parse_version(version) + parsed = utils.VersionNumber.parse(version) op = operator.eq if exact else operator.ge - result = op(utils.parse_version(qVersion()), parsed) + result = op(utils.VersionNumber.parse(qVersion()), parsed) if compiled and result: # qVersion() ==/>= parsed, now check if QT_VERSION_STR ==/>= parsed. - result = op(utils.parse_version(QT_VERSION_STR), parsed) + result = op(utils.VersionNumber.parse(QT_VERSION_STR), parsed) if compiled and result: # Finally, check PYQT_VERSION_STR as well. - result = op(utils.parse_version(PYQT_VERSION_STR), parsed) + result = op(utils.VersionNumber.parse(PYQT_VERSION_STR), parsed) return result @@ -116,8 +116,8 @@ MAX_WORLD_ID = 256 def is_new_qtwebkit() -> bool: """Check if the given version is a new QtWebKit.""" assert qWebKitVersion is not None - return (utils.parse_version(qWebKitVersion()) > - utils.parse_version('538.1')) + return (utils.VersionNumber.parse(qWebKitVersion()) > + utils.VersionNumber.parse('538.1')) def is_single_process() -> bool: diff --git a/qutebrowser/utils/resources.py b/qutebrowser/utils/resources.py new file mode 100644 index 000000000..ff5ec9d9a --- /dev/null +++ b/qutebrowser/utils/resources.py @@ -0,0 +1,133 @@ +# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et: + +# Copyright 2014-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org> +# +# This file is part of qutebrowser. +# +# qutebrowser is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# qutebrowser is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with qutebrowser. If not, see <https://www.gnu.org/licenses/>. + +"""Resources related utilities.""" + +import os.path +import sys +import contextlib +import posixpath +import pathlib +from typing import Iterator, Iterable + + +# We cannot use the stdlib version on 3.7-3.8 because we need the files() API. +if sys.version_info >= (3, 9): + import importlib.resources as importlib_resources +else: # pragma: no cover + import importlib_resources + +import qutebrowser +_cache = {} + +def _path(filename: str) -> pathlib.Path: + """Get a pathlib.Path object for a resource.""" + assert not posixpath.isabs(filename), filename + assert os.path.pardir not in filename.split(posixpath.sep), filename + + if hasattr(sys, 'frozen'): + # For PyInstaller, where we can't store resource files in a qutebrowser/ folder + # because the executable is already named "qutebrowser" (at least on macOS). + return pathlib.Path(sys.executable).parent / filename + + return importlib_resources.files(qutebrowser) / filename + +@contextlib.contextmanager +def _keyerror_workaround() -> Iterator[None]: + """Re-raise KeyErrors as FileNotFoundErrors. + + WORKAROUND for zipfile.Path resources raising KeyError when a file was notfound: + https://bugs.python.org/issue43063 + + Only needed for Python 3.8 and 3.9. + """ + try: + yield + except KeyError as e: + raise FileNotFoundError(str(e)) + + +def _glob( + resource_path: pathlib.Path, + subdir: str, + ext: str, +) -> Iterable[str]: + """Find resources with the given extension. + + Yields a resource name like "html/log.html" (as string). + """ + assert '*' not in ext, ext + assert ext.startswith('.'), ext + glob_path = resource_path / subdir + + if isinstance(resource_path, pathlib.Path): + for full_path in glob_path.glob(f'*{ext}'): # . is contained in ext + yield full_path.relative_to(resource_path).as_posix() + else: # zipfile.Path or importlib_resources compat object + # Unfortunately, we can't tell mypy about resource_path being of type + # Union[pathlib.Path, zipfile.Path] because we set "python_version = 3.6" in + # .mypy.ini, but the zipfiel stubs (correctly) only declare zipfile.Path with + # Python 3.8... + assert glob_path.is_dir(), glob_path # type: ignore[unreachable] + for subpath in glob_path.iterdir(): + if subpath.name.endswith(ext): + yield posixpath.join(subdir, subpath.name) + + +def preload() -> None: + """Load resource files into the cache.""" + resource_path = _path('') + for subdir, ext in [ + ('html', '.html'), + ('javascript', '.js'), + ('javascript/quirks', '.js'), + ]: + for name in _glob(resource_path, subdir, ext): + _cache[name] = read_file(name) + + +def read_file(filename: str) -> str: + """Get the contents of a file contained with qutebrowser. + + Args: + filename: The filename to open as string. + + Return: + The file contents as string. + """ + if filename in _cache: + return _cache[filename] + + path = _path(filename) + with _keyerror_workaround(): + return path.read_text(encoding='utf-8') + + +def read_file_binary(filename: str) -> bytes: + """Get the contents of a binary file contained with qutebrowser. + + Args: + filename: The filename to open as string. + + Return: + The file contents as a bytes object. + """ + path = _path(filename) + with _keyerror_workaround(): + return path.read_bytes() diff --git a/qutebrowser/utils/utils.py b/qutebrowser/utils/utils.py index 698a608ef..03a3c7842 100644 --- a/qutebrowser/utils/utils.py +++ b/qutebrowser/utils/utils.py @@ -30,14 +30,13 @@ import datetime import traceback import functools import contextlib -import posixpath import shlex import mimetypes -import pathlib import ctypes import ctypes.util -from typing import (Any, Callable, IO, Iterator, Optional, Sequence, Tuple, Type, Union, - Iterable, TypeVar, TYPE_CHECKING) +from typing import (Any, Callable, IO, Iterator, + Optional, Sequence, Tuple, Type, Union, + TypeVar, TYPE_CHECKING) try: # Protocol was added in Python 3.8 from typing import Protocol @@ -50,11 +49,7 @@ except ImportError: # pragma: no cover from PyQt5.QtCore import QUrl, QVersionNumber, QRect from PyQt5.QtGui import QClipboard, QDesktopServices from PyQt5.QtWidgets import QApplication -# We cannot use the stdlib version on 3.7-3.8 because we need the files() API. -if sys.version_info >= (3, 9): - import importlib.resources as importlib_resources -else: # pragma: no cover - import importlib_resources + import yaml try: from yaml import (CSafeLoader as YamlLoader, @@ -65,13 +60,10 @@ except ImportError: # pragma: no cover SafeDumper as YamlDumper) YAML_C_EXT = False -import qutebrowser from qutebrowser.utils import log - fake_clipboard = None log_clipboard = False -_resource_cache = {} is_mac = sys.platform.startswith('darwin') is_linux = sys.platform.startswith('linux') @@ -92,26 +84,74 @@ class Comparable(Protocol): ... -if TYPE_CHECKING: - class VersionNumber(Comparable, QVersionNumber): +class VersionNumber: + + """A representation of a version number.""" + + def __init__(self, *args: int) -> None: + self._ver = QVersionNumber(*args) + if self._ver.isNull(): + raise ValueError("Can't construct a null version") + + normalized = self._ver.normalized() + if normalized != self._ver: + raise ValueError( + f"Refusing to construct non-normalized version from {args} " + f"(normalized: {tuple(normalized.segments())}).") + + self.major = self._ver.majorVersion() + self.minor = self._ver.minorVersion() + self.patch = self._ver.microVersion() + self.segments = self._ver.segments() + + assert len(self.segments) <= 3, self.segments + + def __str__(self) -> str: + return ".".join(str(s) for s in self.segments) + + def __repr__(self) -> str: + args = ", ".join(str(s) for s in self.segments) + return f'VersionNumber({args})' + + def strip_patch(self) -> 'VersionNumber': + """Get a new VersionNumber with the patch version removed.""" + return VersionNumber(*self.segments[:2]) + + @classmethod + def parse(cls, s: str) -> 'VersionNumber': + """Parse a version number from a string.""" + ver, _suffix = QVersionNumber.fromString(s) + # FIXME: Should we support a suffix? + + if ver.isNull(): + raise ValueError(f"Failed to parse {s}") - """WORKAROUND for incorrect PyQt stubs.""" -else: - class VersionNumber(QVersionNumber): + return cls(*ver.normalized().segments()) - """We can't inherit from Protocol and QVersionNumber at runtime.""" + def __hash__(self) -> int: + return hash(self._ver) - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - normalized = self.normalized() - if normalized != self: - raise ValueError( - f"Refusing to construct non-normalized version from {args} " - f"(normalized: {tuple(normalized.segments())}).") + def __eq__(self, other: object) -> bool: + if not isinstance(other, VersionNumber): + return NotImplemented + return self._ver == other._ver - def __repr__(self): - args = ", ".join(str(s) for s in self.segments()) - return f'VersionNumber({args})' + def __ne__(self, other: object) -> bool: + if not isinstance(other, VersionNumber): + return NotImplemented + return self._ver != other._ver + + def __ge__(self, other: 'VersionNumber') -> bool: + return self._ver >= other._ver # type: ignore[operator] + + def __gt__(self, other: 'VersionNumber') -> bool: + return self._ver > other._ver # type: ignore[operator] + + def __le__(self, other: 'VersionNumber') -> bool: + return self._ver <= other._ver # type: ignore[operator] + + def __lt__(self, other: 'VersionNumber') -> bool: + return self._ver < other._ver # type: ignore[operator] class Unreachable(Exception): @@ -196,110 +236,6 @@ def compact_text(text: str, elidelength: int = None) -> str: return out -def _resource_path(filename: str) -> pathlib.Path: - """Get a pathlib.Path object for a resource.""" - assert not posixpath.isabs(filename), filename - assert os.path.pardir not in filename.split(posixpath.sep), filename - - if hasattr(sys, 'frozen'): - # For PyInstaller, where we can't store resource files in a qutebrowser/ folder - # because the executable is already named "qutebrowser" (at least on macOS). - return pathlib.Path(sys.executable).parent / filename - - return importlib_resources.files(qutebrowser) / filename - - -@contextlib.contextmanager -def _resource_keyerror_workaround() -> Iterator[None]: - """Re-raise KeyErrors as FileNotFoundErrors. - - WORKAROUND for zipfile.Path resources raising KeyError when a file was notfound: - https://bugs.python.org/issue43063 - - Only needed for Python 3.8 and 3.9. - """ - try: - yield - except KeyError as e: - raise FileNotFoundError(str(e)) - - -def _glob_resources( - resource_path: pathlib.Path, - subdir: str, - ext: str, -) -> Iterable[str]: - """Find resources with the given extension. - - Yields a resource name like "html/log.html" (as string). - """ - assert '*' not in ext, ext - assert ext.startswith('.'), ext - path = resource_path / subdir - - if isinstance(resource_path, pathlib.Path): - for full_path in path.glob(f'*{ext}'): # . is contained in ext - yield full_path.relative_to(resource_path).as_posix() - else: # zipfile.Path or importlib_resources compat object - # Unfortunately, we can't tell mypy about resource_path being of type - # Union[pathlib.Path, zipfile.Path] because we set "python_version = 3.6" in - # .mypy.ini, but the zipfiel stubs (correctly) only declare zipfile.Path with - # Python 3.8... - assert path.is_dir(), path # type: ignore[unreachable] - for subpath in path.iterdir(): - if subpath.name.endswith(ext): - yield posixpath.join(subdir, subpath.name) - - -def preload_resources() -> None: - """Load resource files into the cache.""" - resource_path = _resource_path('') - for subdir, ext in [ - ('html', '.html'), - ('javascript', '.js'), - ('javascript/quirks', '.js'), - ]: - for name in _glob_resources(resource_path, subdir, ext): - _resource_cache[name] = read_file(name) - - -def read_file(filename: str) -> str: - """Get the contents of a file contained with qutebrowser. - - Args: - filename: The filename to open as string. - - Return: - The file contents as string. - """ - if filename in _resource_cache: - return _resource_cache[filename] - - path = _resource_path(filename) - with _resource_keyerror_workaround(): - return path.read_text(encoding='utf-8') - - -def read_file_binary(filename: str) -> bytes: - """Get the contents of a binary file contained with qutebrowser. - - Args: - filename: The filename to open as string. - - Return: - The file contents as a bytes object. - """ - path = _resource_path(filename) - with _resource_keyerror_workaround(): - return path.read_bytes() - - -def parse_version(version: str) -> VersionNumber: - """Parse a version string.""" - ver, _suffix = QVersionNumber.fromString(version) - return VersionNumber(ver.normalized()) - - def format_seconds(total_seconds: int) -> str: """Format a count of seconds to get a [H:]M:SS string.""" prefix = '-' if total_seconds < 0 else '' diff --git a/qutebrowser/utils/version.py b/qutebrowser/utils/version.py index 0e3927948..46916c516 100644 --- a/qutebrowser/utils/version.py +++ b/qutebrowser/utils/version.py @@ -53,7 +53,7 @@ except ImportError: # pragma: no cover import qutebrowser -from qutebrowser.utils import log, utils, standarddir, usertypes, message +from qutebrowser.utils import log, utils, standarddir, usertypes, message, resources from qutebrowser.misc import objects, earlyinit, sql, httpclient, pastebin, elf from qutebrowser.browser import pdfjs from qutebrowser.config import config, websettings @@ -160,7 +160,7 @@ def distribution() -> Optional[DistributionInfo]: dist_version: Optional[utils.VersionNumber] = None for version_key in ['VERSION', 'VERSION_ID']: if version_key in info: - dist_version = utils.parse_version(info[version_key]) + dist_version = utils.VersionNumber.parse(info[version_key]) break dist_id = info.get('ID', None) @@ -218,7 +218,7 @@ def _git_str() -> Optional[str]: return commit # If that fails, check the git-commit-id file. try: - return utils.read_file('git-commit-id') + return resources.read_file('git-commit-id') except (OSError, ImportError): return None @@ -492,6 +492,9 @@ def _get_pyqt_webengine_qt_version() -> Optional[str]: https://www.riverbankcomputing.com/pipermail/pyqt/2021-February/043591.html https://www.riverbankcomputing.com/pipermail/pyqt/2021-February/043638.html + PyQtWebEngine 5.15.4 renamed it to PyQtWebEngine-Qt5...: + https://www.riverbankcomputing.com/pipermail/pyqt/2021-March/043699.html + Here, we try to use importlib.metadata or its backport (optional dependency) to figure out that version number. If PyQtWebEngine is installed via pip, this will give us an accurate answer. @@ -505,11 +508,13 @@ def _get_pyqt_webengine_qt_version() -> Optional[str]: log.misc.debug("Neither importlib.metadata nor backport available") return None - try: - return importlib_metadata.version('PyQtWebEngine-Qt') - except importlib_metadata.PackageNotFoundError: - log.misc.debug("PyQtWebEngine-Qt not found") - return None + for suffix in ['Qt5', 'Qt']: + try: + return importlib_metadata.version(f'PyQtWebEngine-{suffix}') + except importlib_metadata.PackageNotFoundError: + log.misc.debug(f"PyQtWebEngine-{suffix} not found") + + return None @dataclasses.dataclass @@ -521,7 +526,7 @@ class WebEngineVersions: chromium: Optional[str] source: str - _CHROMIUM_VERSIONS: ClassVar[Dict[str, str]] = { + _CHROMIUM_VERSIONS: ClassVar[Dict[utils.VersionNumber, str]] = { # Qt 5.12: Chromium 69 # (LTS) 69.0.3497.128 (~2018-09-11) # 5.12.0: Security fixes up to 70.0.3538.102 (~2018-10-24) @@ -535,21 +540,21 @@ class WebEngineVersions: # 5.12.8: Security fixes up to 80.0.3987.149 (2020-03-18) # 5.12.9: Security fixes up to 83.0.4103.97 (2020-06-03) # 5.12.10: Security fixes up to 86.0.4240.75 (2020-10-06) - '5.12': '69.0.3497.128', + utils.VersionNumber(5, 12): '69.0.3497.128', # Qt 5.13: Chromium 73 # 73.0.3683.105 (~2019-02-28) # 5.13.0: Security fixes up to 74.0.3729.157 (2019-05-14) # 5.13.1: Security fixes up to 76.0.3809.87 (2019-07-30) # 5.13.2: Security fixes up to 77.0.3865.120 (2019-10-10) - '5.13': '73.0.3683.105', + utils.VersionNumber(5, 13): '73.0.3683.105', # Qt 5.14: Chromium 77 # 77.0.3865.129 (~2019-10-10) # 5.14.0: Security fixes up to 77.0.3865.129 (~2019-09-10) # 5.14.1: Security fixes up to 79.0.3945.117 (2020-01-07) # 5.14.2: Security fixes up to 80.0.3987.132 (2020-03-03) - '5.14': '77.0.3865.129', + utils.VersionNumber(5, 14): '77.0.3865.129', # Qt 5.15: Chromium 80 # 80.0.3987.163 (2020-04-02) @@ -557,13 +562,13 @@ class WebEngineVersions: # 5.15.1: Security fixes up to 85.0.4183.83 (2020-08-25) # 5.15.2: Updated to 83.0.4103.122 (~2020-06-24) # Security fixes up to 86.0.4240.183 (2020-11-02) - '5.15': '80.0.3987.163', - '5.15.2': '83.0.4103.122', - '5.15.3': '87.0.4280.144', + utils.VersionNumber(5, 15): '80.0.3987.163', + utils.VersionNumber(5, 15, 2): '83.0.4103.122', + utils.VersionNumber(5, 15, 3): '87.0.4280.144', } def __str__(self) -> str: - s = f'QtWebEngine {self.webengine.toString()}' + s = f'QtWebEngine {self.webengine}' if self.chromium is not None: s += f', Chromium {self.chromium}' if self.source != 'UA': @@ -580,7 +585,7 @@ class WebEngineVersions: """ assert ua.qt_version is not None, ua return cls( - webengine=utils.parse_version(ua.qt_version), + webengine=utils.VersionNumber.parse(ua.qt_version), chromium=ua.upstream_browser_version, source='UA', ) @@ -597,19 +602,30 @@ class WebEngineVersions: (though hackish) way to get a more accurate result. """ return cls( - webengine=utils.parse_version(versions.webengine), + webengine=utils.VersionNumber.parse(versions.webengine), chromium=versions.chromium, source='ELF', ) @classmethod - def _infer_chromium_version(cls, pyqt_webengine_version: str) -> Optional[str]: + def _infer_chromium_version( + cls, + pyqt_webengine_version: utils.VersionNumber, + ) -> Optional[str]: """Infer the Chromium version based on the PyQtWebEngine version.""" chromium_version = cls._CHROMIUM_VERSIONS.get(pyqt_webengine_version) if chromium_version is not None: return chromium_version - # 5.14.2 -> 5.14 - minor_version = pyqt_webengine_version.rsplit('.', maxsplit=1)[0] + + # 5.15 patch versions change their QtWebEngine version, but no changes are + # expected after 5.15.3. + v5_15_3 = utils.VersionNumber(5, 15, 3) + if v5_15_3 <= pyqt_webengine_version < utils.VersionNumber(6): + minor_version = v5_15_3 + else: + # e.g. 5.14.2 -> 5.14 + minor_version = pyqt_webengine_version.strip_patch() + return cls._CHROMIUM_VERSIONS.get(minor_version) @classmethod @@ -631,9 +647,10 @@ class WebEngineVersions: Note that we only can get the PyQtWebEngine version with PyQt 5.13 or newer. With Qt 5.12, we instead rely on qVersion(). """ + parsed = utils.VersionNumber.parse(pyqt_webengine_version) return cls( - webengine=utils.parse_version(pyqt_webengine_version), - chromium=cls._infer_chromium_version(pyqt_webengine_version), + webengine=parsed, + chromium=cls._infer_chromium_version(parsed), source=source, ) diff --git a/scripts/dev/check_coverage.py b/scripts/dev/check_coverage.py index bc1894e43..c66cb3e8d 100644 --- a/scripts/dev/check_coverage.py +++ b/scripts/dev/check_coverage.py @@ -187,6 +187,8 @@ PERFECT_FILES = [ 'qutebrowser/utils/usertypes.py'), ('tests/unit/utils/test_utils.py', 'qutebrowser/utils/utils.py'), + ('tests/unit/utils/test_resources.py', + 'qutebrowser/utils/resources.py'), ('tests/unit/utils/test_version.py', 'qutebrowser/utils/version.py'), ('tests/unit/utils/test_debug.py', diff --git a/scripts/dev/misc_checks.py b/scripts/dev/misc_checks.py index 91baec926..3a93b05e1 100644 --- a/scripts/dev/misc_checks.py +++ b/scripts/dev/misc_checks.py @@ -247,7 +247,23 @@ def check_spelling(args: argparse.Namespace) -> Optional[bool]: ( re.compile(fr'qtbot\.(?!{qtbot_excludes})[a-z]+[A-Z].*'), "use snake-case instead", - ) + ), + ( + re.compile(r'\.joinpath\('), + "use the / operator for joining paths", + ), + ( + re.compile(r"""pathlib\.Path\(["']~["']\)\.expanduser\(\)"""), + "use pathlib.Path.home() instead", + ), + ( + re.compile(r'pathlib\.Path\(tmp_path\)'), + "tmp_path already is a pathlib.Path", + ), + ( + re.compile(r'pathlib\.Path\(tmpdir\)'), + "use tmp_path instead", + ), ] # Files which should be ignored, e.g. because they come from another diff --git a/scripts/dev/recompile_requirements.py b/scripts/dev/recompile_requirements.py index cafb393aa..1849a5218 100644 --- a/scripts/dev/recompile_requirements.py +++ b/scripts/dev/recompile_requirements.py @@ -137,9 +137,9 @@ CHANGELOG_URLS = { 'cryptography': 'https://cryptography.io/en/latest/changelog.html', 'toml': 'https://github.com/uiri/toml/releases', 'PyQt5': 'https://www.riverbankcomputing.com/news', - 'PyQt5-Qt': 'https://www.riverbankcomputing.com/news', + 'PyQt5-Qt5': 'https://www.riverbankcomputing.com/news', 'PyQtWebEngine': 'https://www.riverbankcomputing.com/news', - 'PyQtWebEngine-Qt': 'https://www.riverbankcomputing.com/news', + 'PyQtWebEngine-Qt5': 'https://www.riverbankcomputing.com/news', 'PyQt-builder': 'https://www.riverbankcomputing.com/news', 'PyQt5-sip': 'https://www.riverbankcomputing.com/news', 'PyQt5-stubs': 'https://github.com/stlehmann/PyQt5-stubs/blob/master/CHANGELOG.md', diff --git a/tests/end2end/test_invocations.py b/tests/end2end/test_invocations.py index f3d74d1f0..38e40f9b7 100644 --- a/tests/end2end/test_invocations.py +++ b/tests/end2end/test_invocations.py @@ -657,7 +657,7 @@ def test_dark_mode(webengine_versions, quteproc_new, request, quteproc_new.start(args) ver = webengine_versions.webengine - minor_version = f'{ver.majorVersion()}.{ver.minorVersion()}' + minor_version = str(ver.strip_patch()) expected = colors.get(minor_version, colors[None]) quteproc_new.open_path(f'data/darkmode/{filename}.html') diff --git a/tests/unit/browser/test_pdfjs.py b/tests/unit/browser/test_pdfjs.py index 788209d6f..86b875be5 100644 --- a/tests/unit/browser/test_pdfjs.py +++ b/tests/unit/browser/test_pdfjs.py @@ -77,7 +77,7 @@ class TestResources: @pytest.fixture def read_file_mock(self, mocker): - return mocker.patch.object(pdfjs.utils, 'read_file_binary', autospec=True) + return mocker.patch.object(pdfjs.resources, 'read_file_binary', autospec=True) def test_get_pdfjs_res_system(self, read_system_mock): read_system_mock.return_value = (b'content', 'path') diff --git a/tests/unit/browser/test_qutescheme.py b/tests/unit/browser/test_qutescheme.py index 213df4e0c..2ae939596 100644 --- a/tests/unit/browser/test_qutescheme.py +++ b/tests/unit/browser/test_qutescheme.py @@ -28,7 +28,7 @@ from PyQt5.QtCore import QUrl, QUrlQuery import pytest from qutebrowser.browser import qutescheme, pdfjs, downloads -from qutebrowser.utils import utils +from qutebrowser.utils import resources class TestJavascriptHandler: @@ -43,15 +43,15 @@ class TestJavascriptHandler: @pytest.fixture(autouse=True) def patch_read_file(self, monkeypatch): - """Patch utils.read_file to return few fake JS files.""" + """Patch resources.read_file to return few fake JS files.""" def _read_file(path): - """Faked utils.read_file.""" + """Faked resources.read_file.""" for filename, content in self.js_files: if path == os.path.join('javascript', filename): return content raise OSError("File not found {}!".format(path)) - monkeypatch.setattr(utils, 'read_file', _read_file) + monkeypatch.setattr(resources, 'read_file', _read_file) @pytest.mark.parametrize("filename, content", js_files) def test_qutejavascript(self, filename, content): @@ -165,8 +165,9 @@ class TestHelpHandler: assert path == name return data - monkeypatch.setattr(qutescheme.utils, 'read_file', _read_file) - monkeypatch.setattr(qutescheme.utils, 'read_file_binary', _read_file_binary) + monkeypatch.setattr(qutescheme.resources, 'read_file', _read_file) + monkeypatch.setattr(qutescheme.resources, + 'read_file_binary', _read_file_binary) return _patch def test_unknown_file_type(self, data_patcher): diff --git a/tests/unit/config/test_qtargs.py b/tests/unit/config/test_qtargs.py index e7dbd5d95..695649213 100644 --- a/tests/unit/config/test_qtargs.py +++ b/tests/unit/config/test_qtargs.py @@ -530,6 +530,22 @@ class TestWebEngineArgs: for arg in expected: assert arg in args + @pytest.mark.linux + def test_locale_workaround(self, config_stub, monkeypatch, version_patcher, + parser): + class FakeLocale: + + def bcp47Name(self): + return 'de-CH' + + monkeypatch.setattr(qtargs.objects, 'backend', usertypes.Backend.QtWebEngine) + monkeypatch.setattr(qtargs, 'QLocale', FakeLocale) + version_patcher('5.15.3') + config_stub.val.qt.workarounds.locale = True + parsed = parser.parse_args([]) + args = qtargs.qt_args(parsed) + assert '--lang=de' in args + class TestEnvVars: diff --git a/tests/unit/config/test_qtargs_locale_workaround.py b/tests/unit/config/test_qtargs_locale_workaround.py index 977118198..7e313377b 100644 --- a/tests/unit/config/test_qtargs_locale_workaround.py +++ b/tests/unit/config/test_qtargs_locale_workaround.py @@ -16,6 +16,7 @@ # You should have received a copy of the GNU General Public License # along with qutebrowser. If not, see <https://www.gnu.org/licenses/>. +import os import pathlib import pytest @@ -403,6 +404,7 @@ def qtwe_version(): ("zh_XX.UTF-8", "zh-CN"), # locale not available on my system ("zu_ZA.UTF-8", "en-US"), ]) +@pytest.mark.linux def test_lang_workaround_all_locales(lang, expected, qtwe_version): locale_name = QLocale(lang).bcp47Name() print(locale_name) @@ -444,3 +446,12 @@ def test_non_linux(qtwe_version): def test_disabled(qtwe_version, config_stub): config_stub.val.qt.workarounds.locale = False assert qtargs._get_lang_override(qtwe_version, "de-CH") is None + + +@pytest.mark.fake_os('linux') +def test_no_locales_available(qtwe_version, monkeypatch, caplog): + monkeypatch.setattr(qtargs.QLibraryInfo, 'location', lambda _path: '/doesnotexist') + assert qtargs._get_lang_override(qtwe_version, "de-CH") is None + assert caplog.messages == [ + f"{os.sep}doesnotexist{os.sep}qtwebengine_locales not found, skipping " + "workaround!"] diff --git a/tests/unit/utils/test_jinja.py b/tests/unit/utils/test_jinja.py index 5555560bf..0ef03725c 100644 --- a/tests/unit/utils/test_jinja.py +++ b/tests/unit/utils/test_jinja.py @@ -33,7 +33,7 @@ from qutebrowser.config import configexc @pytest.fixture(autouse=True) def patch_read_file(monkeypatch): - """pytest fixture to patch utils.read_file.""" + """pytest fixture to patch resources.read_file.""" def _read_file(path): """A read_file which returns a simple template if the path is right.""" if path == os.path.join('html', 'test.html'): @@ -55,8 +55,8 @@ def patch_read_file(monkeypatch): else: raise OSError("Invalid path {}!".format(path)) - monkeypatch.setattr(jinja.utils, 'read_file', _read_file) - monkeypatch.setattr(jinja.utils, 'read_file_binary', _read_file_binary) + monkeypatch.setattr(jinja.resources, 'read_file', _read_file) + monkeypatch.setattr(jinja.resources, 'read_file_binary', _read_file_binary) def test_simple_template(): diff --git a/tests/unit/utils/test_resources.py b/tests/unit/utils/test_resources.py new file mode 100644 index 000000000..d8af64cb9 --- /dev/null +++ b/tests/unit/utils/test_resources.py @@ -0,0 +1,146 @@ +# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et: + +# Copyright 2014-2021 Florian Bruhin (The Compiler) <mail@qutebrowser.org> +# +# This file is part of qutebrowser. +# +# qutebrowser is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# qutebrowser is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with qutebrowser. If not, see <https://www.gnu.org/licenses/>. + +"""Tests for qutebrowser.utils.resources.""" + +import sys +import os.path +import zipfile +import pytest +import qutebrowser +from qutebrowser.utils import utils, resources + + +@pytest.fixture(params=[True, False]) +def freezer(request, monkeypatch): + if request.param and not getattr(sys, 'frozen', False): + monkeypatch.setattr(sys, 'frozen', True, raising=False) + monkeypatch.setattr(sys, 'executable', qutebrowser.__file__) + elif not request.param and getattr(sys, 'frozen', False): + # Want to test unfrozen tests, but we are frozen + pytest.skip("Can't run with sys.frozen = True!") + + +@pytest.mark.usefixtures('freezer') +class TestReadFile: + + @pytest.fixture + def package_path(self, tmp_path): + return tmp_path / 'qutebrowser' + + @pytest.fixture + def html_path(self, package_path): + path = package_path / 'html' + path.mkdir(parents=True) + + for filename in ['test1.html', 'test2.html', 'README', 'unrelatedhtml']: + (path / filename).touch() + + subdir = path / 'subdir' + subdir.mkdir() + (subdir / 'subdir-file.html').touch() + + return path + + @pytest.fixture + def html_zip(self, tmp_path, html_path): + if not hasattr(zipfile, 'Path'): + pytest.skip("Needs zipfile.Path") + + zip_path = tmp_path / 'qutebrowser.zip' + with zipfile.ZipFile(zip_path, 'w') as zf: + for path in html_path.rglob('*'): + zf.write(path, path.relative_to(tmp_path)) + + assert sorted(zf.namelist()) == [ + 'qutebrowser/html/README', + 'qutebrowser/html/subdir/', + 'qutebrowser/html/subdir/subdir-file.html', + 'qutebrowser/html/test1.html', + 'qutebrowser/html/test2.html', + 'qutebrowser/html/unrelatedhtml', + ] + + yield zipfile.Path(zip_path) / 'qutebrowser' + + @pytest.fixture(params=['pathlib', 'zipfile']) + def resource_root(self, request): + """Resource files packaged either directly or via a zip.""" + if request.param == 'pathlib': + request.getfixturevalue('html_path') + return request.getfixturevalue('package_path') + elif request.param == 'zipfile': + return request.getfixturevalue('html_zip') + raise utils.Unreachable(request.param) + + def test_glob_resources(self, resource_root): + files = sorted(resources._glob(resource_root, 'html', '.html')) + assert files == ['html/test1.html', 'html/test2.html'] + + def test_glob_resources_subdir(self, resource_root): + files = sorted(resources._glob(resource_root, 'html/subdir', '.html')) + assert files == ['html/subdir/subdir-file.html'] + + def test_readfile(self): + """Read a test file.""" + content = resources.read_file(os.path.join('utils', 'testfile')) + assert content.splitlines()[0] == "Hello World!" + + @pytest.mark.parametrize('filename', ['javascript/scroll.js', + 'html/error.html']) + def test_read_cached_file(self, mocker, filename): + resources.preload() + m = mocker.patch('qutebrowser.utils.resources.importlib_resources.files') + resources.read_file(filename) + m.assert_not_called() + + def test_readfile_binary(self): + """Read a test file in binary mode.""" + content = resources.read_file_binary(os.path.join('utils', 'testfile')) + assert content.splitlines()[0] == b"Hello World!" + + @pytest.mark.parametrize('name', ['read_file', 'read_file_binary']) + @pytest.mark.parametrize('fake_exception', [KeyError, FileNotFoundError, None]) + def test_not_found(self, name, fake_exception, monkeypatch): + """Test behavior when a resources file wasn't found. + + With fake_exception, we emulate the rather odd error handling of certain Python + versions: https://bugs.python.org/issue43063 + """ + class BrokenFileFake: + + def __init__(self, exc): + self.exc = exc + + def read_bytes(self): + raise self.exc("File does not exist") + + def read_text(self, encoding): + raise self.exc("File does not exist") + + def __truediv__(self, _other): + return self + + if fake_exception is not None: + monkeypatch.setattr(resources.importlib_resources, 'files', + lambda _pkg: BrokenFileFake(fake_exception)) + + meth = getattr(resources, name) + with pytest.raises(FileNotFoundError): + meth('doesnotexist') diff --git a/tests/unit/utils/test_utils.py b/tests/unit/utils/test_utils.py index 4cf60943c..b43638cb3 100644 --- a/tests/unit/utils/test_utils.py +++ b/tests/unit/utils/test_utils.py @@ -28,7 +28,7 @@ import functools import re import shlex import math -import zipfile +import operator from PyQt5.QtCore import QUrl, QRect from PyQt5.QtGui import QClipboard @@ -40,22 +40,117 @@ import yaml import qutebrowser import qutebrowser.utils # for test_qualname from qutebrowser.utils import utils, version, usertypes +from qutebrowser.utils.utils import VersionNumber class TestVersionNumber: - @pytest.mark.parametrize('args, expected', [ - ([5, 15, 2], 'VersionNumber(5, 15, 2)'), - ([5, 15], 'VersionNumber(5, 15)'), - ([5], 'VersionNumber(5)'), + @pytest.mark.parametrize('num, expected', [ + (VersionNumber(5, 15, 2), 'VersionNumber(5, 15, 2)'), + (VersionNumber(5, 15), 'VersionNumber(5, 15)'), + (VersionNumber(5), 'VersionNumber(5)'), ]) - def test_repr(self, args, expected): - num = utils.VersionNumber(*args) + def test_repr(self, num, expected): assert repr(num) == expected + @pytest.mark.parametrize('num, expected', [ + (VersionNumber(5, 15, 2), '5.15.2'), + (VersionNumber(5, 15), '5.15'), + (VersionNumber(5), '5'), + ]) + def test_str(self, num, expected): + assert str(num) == expected + def test_not_normalized(self): with pytest.raises(ValueError, match='Refusing to construct'): - utils.VersionNumber(5, 15, 0) + VersionNumber(5, 15, 0) + + @pytest.mark.parametrize('num, expected', [ + (VersionNumber(5, 15, 2), VersionNumber(5, 15)), + (VersionNumber(5, 15), VersionNumber(5, 15)), + (VersionNumber(6), VersionNumber(6)), + ]) + def test_strip_patch(self, num, expected): + assert num.strip_patch() == expected + + @pytest.mark.parametrize('s, expected', [ + ('1x6.2', VersionNumber(1)), + ('6', VersionNumber(6)), + ('5.15', VersionNumber(5, 15)), + ('5.15.3', VersionNumber(5, 15, 3)), + ('5.15.3.dev1234', VersionNumber(5, 15, 3)), + ]) + def test_parse_valid(self, s, expected): + assert VersionNumber.parse(s) == expected + + @pytest.mark.parametrize('s, message', [ + ('foo6', "Failed to parse foo6"), + ('.6', "Failed to parse .6"), + ('0x6.2', "Can't construct a null version"), + ]) + def test_parse_invalid(self, s, message): + with pytest.raises(ValueError, match=message): + VersionNumber.parse(s) + + @pytest.mark.parametrize('lhs, op, rhs, outcome', [ + # == + (VersionNumber(6), operator.eq, VersionNumber(6), True), + (VersionNumber(6), operator.eq, object(), False), + + # != + (VersionNumber(6), operator.ne, VersionNumber(5), True), + (VersionNumber(6), operator.ne, object(), True), + + # >= + (VersionNumber(5, 14), operator.ge, VersionNumber(5, 13, 5), True), + (VersionNumber(5, 14), operator.ge, VersionNumber(5, 14, 2), False), + (VersionNumber(5, 14, 3), operator.ge, VersionNumber(5, 14, 2), True), + (VersionNumber(5, 14, 3), operator.ge, VersionNumber(5, 14, 3), True), + (VersionNumber(5, 14), operator.ge, VersionNumber(5, 13), True), + (VersionNumber(5, 14), operator.ge, VersionNumber(5, 14), True), + (VersionNumber(5, 14), operator.ge, VersionNumber(5, 15), False), + (VersionNumber(5, 14), operator.ge, VersionNumber(4), True), + (VersionNumber(5, 14), operator.ge, VersionNumber(5), True), + (VersionNumber(5, 14), operator.ge, VersionNumber(6), False), + + # > + (VersionNumber(5, 14), operator.gt, VersionNumber(5, 13, 5), True), + (VersionNumber(5, 14), operator.gt, VersionNumber(5, 14, 2), False), + (VersionNumber(5, 14, 3), operator.gt, VersionNumber(5, 14, 2), True), + (VersionNumber(5, 14, 3), operator.gt, VersionNumber(5, 14, 3), False), + (VersionNumber(5, 14), operator.gt, VersionNumber(5, 13), True), + (VersionNumber(5, 14), operator.gt, VersionNumber(5, 14), False), + (VersionNumber(5, 14), operator.gt, VersionNumber(5, 15), False), + (VersionNumber(5, 14), operator.gt, VersionNumber(4), True), + (VersionNumber(5, 14), operator.gt, VersionNumber(5), True), + (VersionNumber(5, 14), operator.gt, VersionNumber(6), False), + + # <= + (VersionNumber(5, 14), operator.le, VersionNumber(5, 13, 5), False), + (VersionNumber(5, 14), operator.le, VersionNumber(5, 14, 2), True), + (VersionNumber(5, 14, 3), operator.le, VersionNumber(5, 14, 2), False), + (VersionNumber(5, 14, 3), operator.le, VersionNumber(5, 14, 3), True), + (VersionNumber(5, 14), operator.le, VersionNumber(5, 13), False), + (VersionNumber(5, 14), operator.le, VersionNumber(5, 14), True), + (VersionNumber(5, 14), operator.le, VersionNumber(5, 15), True), + (VersionNumber(5, 14), operator.le, VersionNumber(4), False), + (VersionNumber(5, 14), operator.le, VersionNumber(5), False), + (VersionNumber(5, 14), operator.le, VersionNumber(6), True), + + # < + (VersionNumber(5, 14), operator.lt, VersionNumber(5, 13, 5), False), + (VersionNumber(5, 14), operator.lt, VersionNumber(5, 14, 2), True), + (VersionNumber(5, 14, 3), operator.lt, VersionNumber(5, 14, 2), False), + (VersionNumber(5, 14, 3), operator.lt, VersionNumber(5, 14, 3), False), + (VersionNumber(5, 14), operator.lt, VersionNumber(5, 13), False), + (VersionNumber(5, 14), operator.lt, VersionNumber(5, 14), False), + (VersionNumber(5, 14), operator.lt, VersionNumber(5, 15), True), + (VersionNumber(5, 14), operator.lt, VersionNumber(4), False), + (VersionNumber(5, 14), operator.lt, VersionNumber(5), False), + (VersionNumber(5, 14), operator.lt, VersionNumber(6), True), + ]) + def test_comparisons(self, lhs, op, rhs, outcome): + assert op(lhs, rhs) == outcome ELLIPSIS = '\u2026' @@ -132,115 +227,6 @@ def freezer(request, monkeypatch): pytest.skip("Can't run with sys.frozen = True!") -@pytest.mark.usefixtures('freezer') -class TestReadFile: - - @pytest.fixture - def package_path(self, tmp_path): - return tmp_path / 'qutebrowser' - - @pytest.fixture - def html_path(self, package_path): - path = package_path / 'html' - path.mkdir(parents=True) - - for filename in ['test1.html', 'test2.html', 'README', 'unrelatedhtml']: - (path / filename).touch() - - subdir = path / 'subdir' - subdir.mkdir() - (subdir / 'subdir-file.html').touch() - - return path - - @pytest.fixture - def html_zip(self, tmp_path, html_path): - if not hasattr(zipfile, 'Path'): - pytest.skip("Needs zipfile.Path") - - zip_path = tmp_path / 'qutebrowser.zip' - with zipfile.ZipFile(zip_path, 'w') as zf: - for path in html_path.rglob('*'): - zf.write(path, path.relative_to(tmp_path)) - - assert sorted(zf.namelist()) == [ - 'qutebrowser/html/README', - 'qutebrowser/html/subdir/', - 'qutebrowser/html/subdir/subdir-file.html', - 'qutebrowser/html/test1.html', - 'qutebrowser/html/test2.html', - 'qutebrowser/html/unrelatedhtml', - ] - - yield zipfile.Path(zip_path) / 'qutebrowser' - - @pytest.fixture(params=['pathlib', 'zipfile']) - def resource_root(self, request): - """Resource files packaged either directly or via a zip.""" - if request.param == 'pathlib': - request.getfixturevalue('html_path') - return request.getfixturevalue('package_path') - elif request.param == 'zipfile': - return request.getfixturevalue('html_zip') - raise utils.Unreachable(request.param) - - def test_glob_resources(self, resource_root): - files = sorted(utils._glob_resources(resource_root, 'html', '.html')) - assert files == ['html/test1.html', 'html/test2.html'] - - def test_glob_resources_subdir(self, resource_root): - files = sorted(utils._glob_resources(resource_root, 'html/subdir', '.html')) - assert files == ['html/subdir/subdir-file.html'] - - def test_readfile(self): - """Read a test file.""" - content = utils.read_file(os.path.join('utils', 'testfile')) - assert content.splitlines()[0] == "Hello World!" - - @pytest.mark.parametrize('filename', ['javascript/scroll.js', - 'html/error.html']) - def test_read_cached_file(self, mocker, filename): - utils.preload_resources() - m = mocker.patch('qutebrowser.utils.utils.importlib_resources.files') - utils.read_file(filename) - m.assert_not_called() - - def test_readfile_binary(self): - """Read a test file in binary mode.""" - content = utils.read_file_binary(os.path.join('utils', 'testfile')) - assert content.splitlines()[0] == b"Hello World!" - - @pytest.mark.parametrize('name', ['read_file', 'read_file_binary']) - @pytest.mark.parametrize('fake_exception', [KeyError, FileNotFoundError, None]) - def test_not_found(self, name, fake_exception, monkeypatch): - """Test behavior when a resources file wasn't found. - - With fake_exception, we emulate the rather odd error handling of certain Python - versions: https://bugs.python.org/issue43063 - """ - class BrokenFileFake: - - def __init__(self, exc): - self.exc = exc - - def read_bytes(self): - raise self.exc("File does not exist") - - def read_text(self, encoding): - raise self.exc("File does not exist") - - def __truediv__(self, _other): - return self - - if fake_exception is not None: - monkeypatch.setattr(utils.importlib_resources, 'files', - lambda _pkg: BrokenFileFake(fake_exception)) - - meth = getattr(utils, name) - with pytest.raises(FileNotFoundError): - meth('doesnotexist') - - @pytest.mark.parametrize('seconds, out', [ (-1, '-0:01'), (0, '0:00'), @@ -784,7 +770,7 @@ class TestOpenFile: info = version.DistributionInfo( id='org.kde.Platform', parsed=version.Distribution.kde_flatpak, - version=utils.parse_version('5.12'), + version=VersionNumber.parse('5.12'), pretty='Unknown') monkeypatch.setattr(version, 'distribution', lambda: info) diff --git a/tests/unit/utils/test_version.py b/tests/unit/utils/test_version.py index f846c91ac..879f84a1f 100644 --- a/tests/unit/utils/test_version.py +++ b/tests/unit/utils/test_version.py @@ -357,14 +357,14 @@ class TestGitStr: @pytest.fixture def commit_file_mock(self, mocker): - """Fixture providing a mock for utils.read_file for git-commit-id. + """Fixture providing a mock for resources.read_file for git-commit-id. On fixture teardown, it makes sure it got called with git-commit-id as argument. """ mocker.patch('qutebrowser.utils.version.subprocess', side_effect=AssertionError) - m = mocker.patch('qutebrowser.utils.version.utils.read_file') + m = mocker.patch('qutebrowser.utils.version.resources.read_file') yield m m.assert_called_with('git-commit-id') @@ -413,7 +413,7 @@ class TestGitStr: """Test with things raising OSError.""" m = mocker.patch('qutebrowser.utils.version.os') m.path.join.side_effect = OSError - mocker.patch('qutebrowser.utils.version.utils.read_file', + mocker.patch('qutebrowser.utils.version.resources.read_file', side_effect=OSError) with caplog.at_level(logging.ERROR, 'misc'): assert version._git_str() is None @@ -956,10 +956,13 @@ class TestWebEngineVersions: ('5.14.2', '77.0.3865.129'), ('5.15.1', '80.0.3987.163'), ('5.15.2', '83.0.4103.122'), + ('5.15.3', '87.0.4280.144'), + ('5.15.4', '87.0.4280.144'), + ('5.15.5', '87.0.4280.144'), ]) def test_from_pyqt(self, qt_version, chromium_version): expected = version.WebEngineVersions( - webengine=utils.parse_version(qt_version), + webengine=utils.VersionNumber.parse(qt_version), chromium=chromium_version, source='PyQt', ) @@ -982,15 +985,9 @@ class TestWebEngineVersions: versions = version.WebEngineVersions.from_pyqt(pyqt_webengine_version) - if pyqt_webengine_version == '5.15.3': - # Transient situation - we expect to get QtWebEngine 5.15.3 soon, - # so this will line up again. - assert versions.chromium == '87.0.4280.144' - pytest.xfail("Transient situation") - else: - from qutebrowser.browser.webengine import webenginesettings - webenginesettings.init_user_agent() - expected = webenginesettings.parsed_user_agent.upstream_browser_version + from qutebrowser.browser.webengine import webenginesettings + webenginesettings.init_user_agent() + expected = webenginesettings.parsed_user_agent.upstream_browser_version assert versions.chromium == expected @@ -1079,18 +1076,34 @@ class TestChromiumVersion: import_fake.patch() @pytest.fixture - def patch_importlib_no_package(self, monkeypatch): - """Simulate importlib not finding PyQtWebEngine-Qt.""" - try: - import importlib.metadata as importlib_metadata - except ImportError: - importlib_metadata = pytest.importorskip("importlib_metadata") - - def _fake_version(name): - assert name == 'PyQtWebEngine-Qt' - raise importlib_metadata.PackageNotFoundError(name) + def importlib_patcher(self, monkeypatch): + """Patch the importlib module.""" + def _patch(*, qt, qt5): + try: + import importlib.metadata as importlib_metadata + except ImportError: + importlib_metadata = pytest.importorskip("importlib_metadata") + + def _fake_version(name): + if name == 'PyQtWebEngine-Qt': + outcome = qt + elif name == 'PyQtWebEngine-Qt5': + outcome = qt5 + else: + raise utils.Unreachable(outcome) + + if outcome is None: + raise importlib_metadata.PackageNotFoundError(name) + return outcome + + monkeypatch.setattr(importlib_metadata, 'version', _fake_version) + + return _patch - monkeypatch.setattr(importlib_metadata, 'version', _fake_version) + @pytest.fixture + def patch_importlib_no_package(self, importlib_patcher): + """Simulate importlib not finding PyQtWebEngine-Qt[5].""" + importlib_patcher(qt=None, qt5=None) @pytest.mark.parametrize('patches, sources', [ (['elf_fail'], ['importlib', 'PyQt', 'Qt']), @@ -1114,6 +1127,21 @@ class TestChromiumVersion: versions = version.qtwebengine_versions(avoid_init=True) assert versions.source in sources + @pytest.mark.parametrize('qt, qt5, expected', [ + (None, '5.15.4', utils.VersionNumber(5, 15, 4)), + ('5.15.3', None, utils.VersionNumber(5, 15, 3)), + ('5.15.3', '5.15.4', utils.VersionNumber(5, 15, 4)), # -Qt5 takes precedence + ]) + def test_importlib(self, qt, qt5, expected, patch_elf_fail, importlib_patcher): + """Test the importlib version logic with different Qt packages. + + With PyQtWebEngine 5.15.4, PyQtWebEngine-Qt was renamed to PyQtWebEngine-Qt5. + """ + importlib_patcher(qt=qt, qt5=qt5) + versions = version.qtwebengine_versions(avoid_init=True) + assert versions.source == 'importlib' + assert versions.webengine == expected + @dataclasses.dataclass class VersionParams: |