1625022016

Build # 1625022016

Build Type

github-actions

Committed by GitHub

Commit Message

<a href="https://github.com/dynobo/normcap/commit/<a class=hub.com/dynobo/normcap/commit/2fa478bb3766900d3026d07e4aac41364602408c">2fa478bb3<a href="https://github.com/dynobo/normcap/commit/2fa478bb3766900d3026d07e4aac41364602408c">">Merge </a><a class="double-link" href="https://github.com/dynobo/normcap/commit/<a class="double-link" href="https://github.com/dynobo/normcap/commit/db3165b754833eb7ad821dffc2cb5de3255d71c3">db3165b75</a>">db3165b75</a><a href="https://github.com/dynobo/normcap/commit/2fa478bb3766900d3026d07e4aac41364602408c"> into d82fe91ba">d82fe91ba</a>

Pull Request Pull Request #161: Dev

Run Details

125 of 125 new or added lines in 10 files covered. (100.0%)

439 of 1526 relevant lines covered (28.77%)

0.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

76.39

/src/normcap/gui/update_check.py

"""Find new version on github or pypi."""
import json
import re
from distutils.version import LooseVersion
from typing import Optional

from PySide2 import QtCore, QtWidgets

from normcap import __version__
from normcap.data import URLS
from normcap.logger import logger
from normcap.utils import get_icon, set_cursor

try:
    from normcap.gui.downloader_qtnetwork import Downloader

    logger.debug("Using QtNetwork Downloader.")
except ImportError as e:
    logger.warning("Couldn't load QtNetwork Downloader: %s.", e)
    from normcap.gui.downloader_requests import Downloader

    logger.debug("Using Requests Downloader.")


class Communicate(QtCore.QObject):
    """TrayMenus' communication bus."""

    on_version_retrieved = QtCore.Signal(str)
    on_click_get_new_version = QtCore.Signal(str)


class UpdateChecker(QtCore.QObject):
    """Helper to check for a new version."""

    def __init__(self, parent, packaged: bool = False):
        super().__init__(parent)
        self.packaged = packaged
        self.com = Communicate()
        self.downloader = Downloader()
        self.downloader.com.on_download_finished.connect(self._check_if_new)
        self.message_box = self._create_message_box()

    def _check_if_new(self, text: str):
        """Check if retrieved version is new."""
        newest_version = self._parse_response_to_version(text)
        if newest_version:
            logger.debug(
                "Newest version: %s (installed: %s)", newest_version, __version__
            )
            if LooseVersion(newest_version) > LooseVersion(__version__):
                self.com.on_version_retrieved.emit(newest_version)

    def _parse_response_to_version(self, text: str) -> Optional[str]:
        """Parse the tag version from the response and emit version retrieved signal."""
        newest_version = None

        try:
            if self.packaged:
                match = re.search(r"download/v(\d+\.\d+\.\d+.*)/|$", text)
                if match and match.group(1):
                    newest_version = match.group(1)
            else:
                data = json.loads(text)
                newest_version = data["info"]["version"].strip()
        except Exception:  # pylint: disable=broad-except
            logger.exception("Couldn't parse update check response")

        if not newest_version:
            logger.error("Couldn't parse newest version! Update check won't work!")

        return newest_version

    def check(self):
        """Start the update check."""
        url = URLS.releases if self.packaged else f"{URLS.pypi}/json"
        logger.debug("Search for new version on %s", url)
        self.downloader.get(url)

    @staticmethod
    def _create_message_box():
        message_box = QtWidgets.QMessageBox()

        # Necessary on wayland for main window to regain focus:
        message_box.setWindowFlags(QtCore.Qt.Popup)

        message_box.setIconPixmap(get_icon("normcap.png").pixmap(48, 48))
        message_box.setStandardButtons(
            QtWidgets.QMessageBox.Ok | QtWidgets.QMessageBox.Cancel
        )
        message_box.setDefaultButton(QtWidgets.QMessageBox.Ok)
        return message_box

    def show_update_message(self, new_version):
        """Show dialog informing about available update."""

        text = f"<b>NormCap v{new_version} is available.</b> (You have v{__version__})"
        if self.packaged:
            info_text = (
                "You can download the new version for your operating system from "
                "GitHub.\n\n"
                "Do you want to visit the release website now?"
            )
            update_url = URLS.releases
        else:
            info_text = (
                "You should be able to upgrade from command line with "
                "'pip install normcap --upgrade'.\n\n"
                "Do you want to view the changelog on github?"
            )
            update_url = URLS.changelog

        self.message_box.setText(text)
        self.message_box.setInformativeText(info_text)

        set_cursor(QtCore.Qt.ArrowCursor)
        choice = self.message_box.exec_()
        set_cursor(QtCore.Qt.CrossCursor)

        if choice == 1024:
            self.com.on_click_get_new_version.emit(update_url)

1	"""Find new version on github or pypi."""
2	import json	1✔
3	import re	1✔
4	from distutils.version import LooseVersion	1✔
5	from typing import Optional	1✔
6
7	from PySide2 import QtCore, QtWidgets	1✔
8
9	from normcap import __version__	1✔
10	from normcap.data import URLS	1✔
11	from normcap.logger import logger	1✔
12	from normcap.utils import get_icon, set_cursor	1✔
13
14	try:	1✔
15	from normcap.gui.downloader_qtnetwork import Downloader	1✔
16
17	logger.debug("Using QtNetwork Downloader.")	1✔
18	except ImportError as e:	×
19	logger.warning("Couldn't load QtNetwork Downloader: %s.", e)	×
20	from normcap.gui.downloader_requests import Downloader	×
21
22	logger.debug("Using Requests Downloader.")	×
23
24
25	class Communicate(QtCore.QObject):	1✔
26	"""TrayMenus' communication bus."""
27
28	on_version_retrieved = QtCore.Signal(str)	1✔
29	on_click_get_new_version = QtCore.Signal(str)	1✔
30
31
32	class UpdateChecker(QtCore.QObject):	1✔
33	"""Helper to check for a new version."""
34
35	def __init__(self, parent, packaged: bool = False):	1✔
36	super().__init__(parent)	1✔
37	self.packaged = packaged	1✔
38	self.com = Communicate()	1✔
39	self.downloader = Downloader()	1✔
40	self.downloader.com.on_download_finished.connect(self._check_if_new)	1✔
41	self.message_box = self._create_message_box()	1✔
42
43	def _check_if_new(self, text: str):	1✔
44	"""Check if retrieved version is new."""
45	newest_version = self._parse_response_to_version(text)	1✔
46	if newest_version:	1✔
47	logger.debug(	1✔
48	"Newest version: %s (installed: %s)", newest_version, __version__
49	)
50	if LooseVersion(newest_version) > LooseVersion(__version__):	1✔
51	self.com.on_version_retrieved.emit(newest_version)	1✔
52
53	def _parse_response_to_version(self, text: str) -> Optional[str]:	1✔
54	"""Parse the tag version from the response and emit version retrieved signal."""
55	newest_version = None	1✔
56
57	try:	1✔
58	if self.packaged:	1✔
59	match = re.search(r"download/v(\d+\.\d+\.\d+.*)/\|$", text)	1✔
60	if match and match.group(1):	1✔
61	newest_version = match.group(1)	1✔
62	else:
63	data = json.loads(text)	1✔
64	newest_version = data["info"]["version"].strip()	1✔
65	except Exception: # pylint: disable=broad-except	1✔
66	logger.exception("Couldn't parse update check response")	1✔
67
68	if not newest_version:	1✔
69	logger.error("Couldn't parse newest version! Update check won't work!")	1✔
70
71	return newest_version	1✔
72
73	def check(self):	1✔
74	"""Start the update check."""
75	url = URLS.releases if self.packaged else f"{URLS.pypi}/json"	1✔
76	logger.debug("Search for new version on %s", url)	1✔
77	self.downloader.get(url)	1✔
78
79	@staticmethod	1✔
80	def _create_message_box():
81	message_box = QtWidgets.QMessageBox()	1✔
82
83	# Necessary on wayland for main window to regain focus:
84	message_box.setWindowFlags(QtCore.Qt.Popup)	1✔
85
86	message_box.setIconPixmap(get_icon("normcap.png").pixmap(48, 48))	1✔
87	message_box.setStandardButtons(	1✔
88	QtWidgets.QMessageBox.Ok \| QtWidgets.QMessageBox.Cancel
89	)
90	message_box.setDefaultButton(QtWidgets.QMessageBox.Ok)	1✔
91	return message_box	1✔
92
93	def show_update_message(self, new_version):	1✔
94	"""Show dialog informing about available update."""
95
96	text = f"<b>NormCap v{new_version} is available.</b> (You have v{__version__})"	×
97	if self.packaged:	×
98	info_text = (	×
99	"You can download the new version for your operating system from "
100	"GitHub.\n\n"
101	"Do you want to visit the release website now?"
102	)
103	update_url = URLS.releases	×
104	else:
105	info_text = (	×
106	"You should be able to upgrade from command line with "
107	"'pip install normcap --upgrade'.\n\n"
108	"Do you want to view the changelog on github?"
109	)
110	update_url = URLS.changelog	×
111
112	self.message_box.setText(text)	×
113	self.message_box.setInformativeText(info_text)	×
114
115	set_cursor(QtCore.Qt.ArrowCursor)	×
116	choice = self.message_box.exec_()	×
117	set_cursor(QtCore.Qt.CrossCursor)	×
118
119	if choice == 1024:	×
120	self.com.on_click_get_new_version.emit(update_url)	×

dynobo / normcap / 1625022016

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous