2450167059

Build Type

github-actions

Committed by GitHub

Commit Message

<a href="https://github.com/dynobo/normcap/commit/<a class=hub.com/dynobo/normcap/commit/<a class="double-link" href="https://git"><a class=hub.com/dynobo/normcap/commit/<a class="double-link" href="https://git"><a class=hub.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736a8df0886">8cb4ff988<a href="https://github.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736a8df0886">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/dynobo/normcap/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736a8df0886&quot;&gt;8cb4ff988&lt;/a&gt;&lt;a href=&quot;https://github.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736a8df0886&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736&lt;/a&gt;a8df0886">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/<a class="double-link" href="https://github.com/dynobo/normcap/commit/b49514483c4cf570ec778181cdf983e571bf83a7">b49514483</a><a href="https://github.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736a8df0886">&amp;quot;&amp;gt;b49514483&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;b49514483&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/dynobo/normcap/commit/8cb4ff9889768d0176e8a1c159b1e736a8df0&lt;/a&gt;886&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/dynobo/normcap/commit/<a class="double-link" href="https://github.com/dynobo/normcap/commit/2c49d58b3">2c49d58b3">2c49d58b3</a>

Pull Request Pull Request #215: Introduce nuitka for building appimage

Run Details

43 of 43 new or added lines in 6 files covered. (100.0%)

1687 of 1977 relevant lines covered (85.33%)

0.85 hits per line

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

83.53

/src/normcap/gui/tray.py

"""Create system tray and its menu."""
import io
import logging
import os
import tempfile
import time

from PIL import Image
from PySide6 import QtCore, QtGui, QtWidgets

from normcap import __version__, ocr
from normcap.gui import system_info, utils
from normcap.gui.models import Capture, CaptureMode, DesktopEnvironment, Rect, Screen
from normcap.gui.notifier import Notifier
from normcap.gui.settings import Settings
from normcap.gui.update_check import UpdateChecker
from normcap.gui.window import Window
from normcap.screengrab import grab_screens

logger = logging.getLogger(__name__)

# TODO: Remove pylint disable no-member when https://github.com/PyCQA/pylint/issues/5378


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

    on_tray_menu_capture = QtCore.Signal()
    on_quit = QtCore.Signal()
    on_ocr_performed = QtCore.Signal()
    on_copied_to_clipboard = QtCore.Signal()
    on_send_notification = QtCore.Signal(Capture)
    on_window_positioned = QtCore.Signal()
    on_open_url_and_hide = QtCore.Signal(str)
    on_set_cursor_wait = QtCore.Signal()
    on_close_or_exit = QtCore.Signal(str)
    on_region_selected = QtCore.Signal(Rect)
    on_image_cropped = QtCore.Signal()
    on_minimize_windows = QtCore.Signal()
    on_screenshots_updated = QtCore.Signal()


class SystemTray(QtWidgets.QSystemTrayIcon):
    """System tray icon with menu."""

    capture = Capture()
    windows: dict[int, Window] = {}

    def __init__(self, parent, args):
        logger.debug("Set up tray icon")
        super().__init__(parent)

        self.com = Communicate()
        self.settings = Settings("normcap", "settings", init_settings=args)
        if args.get("reset", False):
            self.settings.reset()

        self.capture.mode = (
            CaptureMode.PARSE
            if self.settings.value("mode") == "parse"
            else CaptureMode.RAW
        )
        self.clipboard = QtWidgets.QApplication.clipboard()
        self.screens: dict[int, Screen] = system_info.screens()

        self.setIcon(utils.get_icon("tray.png", "tool-magic-symbolic"))
        self._add_tray_menu()
        self._add_update_checker()
        self._add_notifier()
        self._set_signals()
        self._update_screenshots()

    def _set_signals(self):
        """Set up signals to trigger program logic."""
        self.com.on_tray_menu_capture.connect(self._delayed_update_screenshots)
        self.com.on_screenshots_updated.connect(self._show_windows)
        self.com.on_quit.connect(lambda: self._exit_application("clicked exit in tray"))
        self.com.on_region_selected.connect(self._crop_image)
        self.com.on_image_cropped.connect(self._capture_to_ocr)
        self.com.on_ocr_performed.connect(self._copy_to_clipboard)
        self.com.on_copied_to_clipboard.connect(self._notify_or_close)

        self.com.on_minimize_windows.connect(self._close_windows)
        self.com.on_set_cursor_wait.connect(
            lambda: utils.set_cursor(QtCore.Qt.WaitCursor)
        )
        self.com.on_close_or_exit.connect(self._close_or_exit)
        self.com.on_open_url_and_hide.connect(self._open_url_and_hide)

    def _add_update_checker(self):
        if self.settings.value("update", type=bool):
            checker = UpdateChecker(self, packaged=system_info.is_prebuild_package())
            checker.com.on_version_retrieved.connect(checker.show_update_message)
            checker.com.on_click_get_new_version.connect(self.com.on_open_url_and_hide)
            QtCore.QTimer.singleShot(500, checker.check)

    def _add_notifier(self):
        self.notifier = Notifier(self)
        self.com.on_send_notification.connect(self.notifier.send_notification)
        self.notifier.com.on_notification_sent.connect(
            lambda: self.com.on_close_or_exit.emit("notification sent")
        )

    def _update_screenshots(self):
        """Get new screenshots and cache them."""
        screens = grab_screens()

        if not screens:
            logger.error("Could not grab screenshots.")
            return

        for idx, screenshot in enumerate(screens):
            utils.save_image_in_tempfolder(screenshot, postfix=f"_raw_screen{idx}")
            self.screens[idx].screenshot = screenshot

        self.com.on_screenshots_updated.emit()

    def _delayed_update_screenshots(self):
        """Wait before updating screenshot to allow tray menu to hide.

        Avoids having the tray menu itself on the screenshot.
        """
        time.sleep(0.15)
        self._update_screenshots()

    def _add_tray_menu(self):
        """Create menu for system tray."""
        menu = QtWidgets.QMenu()

        action = QtGui.QAction("Capture", menu)
        action.triggered.connect(  # pylint: disable=no-member
            self.com.on_tray_menu_capture.emit
        )
        menu.addAction(action)

        action = QtGui.QAction("Exit", menu)
        action.triggered.connect(self.com.on_quit.emit)  # pylint: disable=no-member
        menu.addAction(action)

        self.setContextMenu(menu)

    def _show_windows(self):
        """Initialize child windows with method depending on system."""
        if not system_info.display_manager_is_wayland():
            for index in system_info.screens():
                self._create_window(index)

        elif system_info.desktop_environment() in [
            DesktopEnvironment.GNOME,
            DesktopEnvironment.KDE,
        ]:
            self._create_next_window()

    def _create_next_window(self):
        """Open child window only for next display."""
        if len(system_info.screens()) > len(self.windows):
            index = len(self.windows.keys())
            self._create_window(index)

    def _create_window(self, index: int):
        """Open a child window for the specified screen."""
        new_window = Window(
            screen_idx=index,
            parent=self,
            color=str(self.settings.value("color")),
        )
        if index == 0:
            new_window.add_settings_menu(self)

        new_window.set_fullscreen()
        self.windows[index] = new_window

    #####################
    # OCR Functionality #
    #####################

    def _crop_image(self, grab_info: tuple[Rect, int]):
        """Crop image to selected region."""
        logger.info("Crop image to selected region %s", grab_info[0].points)
        rect, screen_idx = grab_info

        screenshot = self.screens[screen_idx].screenshot
        if not screenshot:
            raise TypeError("Screenshot is None!")

        self.capture.mode = CaptureMode[self.settings.value("mode").upper()]
        self.capture.rect = rect
        self.capture.screen = self.screens[screen_idx]
        self.capture.image = screenshot.copy(QtCore.QRect(*rect.geometry))

        utils.save_image_in_tempfolder(self.capture.image, postfix="_cropped")

        self.com.on_image_cropped.emit()

    @staticmethod
    def _qimage_to_pil_image(image: QtGui.QImage):
        """Cast QImage to pillow Image type."""
        ba = QtCore.QByteArray()
        buffer = QtCore.QBuffer(ba)
        buffer.open(QtCore.QIODevice.ReadWrite)
        image.save(buffer, "PNG")  # type:ignore
        return Image.open(io.BytesIO(buffer.data()))

    def _capture_to_ocr(self):
        """Perform content recognition on grabed image."""
        if self.capture.image_area < 25:
            logger.warning("Area of %s too small. Skip OCR", self.capture.image_area)
            self.com.on_close_or_exit.emit("selection too small")
            return

        logger.debug("Start OCR")
        ocr_result = ocr.recognize(
            languages=self.settings.value("language"),
            image=self._qimage_to_pil_image(self.capture.image),
            tessdata_path=system_info.get_tessdata_path(),
            parse=self.capture.mode is CaptureMode.PARSE,
            resize_factor=3.2,
            padding_size=80,
        )
        utils.save_image_in_tempfolder(ocr_result.image, postfix="_enhanced")

        self.capture.ocr_text = ocr_result.text
        self.capture.ocr_applied_magic = ocr_result.best_scored_magic

        logger.info("Text from OCR:\n%s", self.capture.ocr_text)
        self.com.on_ocr_performed.emit()

    #########################
    # Helper                #
    #########################

    def _open_url_and_hide(self, url):
        """Open url in default browser, then hide to tray or exit."""
        logger.debug("Open %s", url)
        QtGui.QDesktopServices.openUrl(url)
        self.com.on_close_or_exit.emit("opened web browser")

    def _copy_to_clipboard(self):
        """Copy results to clipboard."""
        # Signal is only temporarily connected to avoid being triggered
        # on arbitrary clipboard changes
        self.clipboard.dataChanged.connect(self.com.on_copied_to_clipboard.emit)
        self.clipboard.dataChanged.connect(self.clipboard.dataChanged.disconnect)

        copy = utils.copy_to_clipboard()
        copy(self.capture.ocr_text)
        QtWidgets.QApplication.processEvents()

    def _notify_or_close(self):
        if self.settings.value("notification", type=bool):
            self.com.on_send_notification.emit(self.capture)
        else:
            self.com.on_close_or_exit.emit("detection completed")

    def _close_windows(self):
        """Hide all windows of normcap."""
        logger.debug("Hide %s window(s)", len(self.windows))
        utils.set_cursor(None)
        for window in self.windows.values():
            window.close()
        self.windows = {}

    def _close_or_exit(self, reason: str):
        if self.settings.value("tray", type=bool):
            self._close_windows()
        else:
            self._exit_application(reason)

    def _exit_application(self, reason: str):
        self.hide()
        QtWidgets.QApplication.processEvents()
        time.sleep(0.05)
        logger.debug("Path to debug images: %s%snormcap", tempfile.gettempdir(), os.sep)
        logger.info("Exit normcap (reason: %s)", reason)
        QtWidgets.QApplication.quit()

1	"""Create system tray and its menu."""
2	import io	1✔
3	import logging	1✔
4	import os	1✔
5	import tempfile	1✔
6	import time	1✔
7
8	from PIL import Image	1✔
9	from PySide6 import QtCore, QtGui, QtWidgets	1✔
10
11	from normcap import __version__, ocr	1✔
12	from normcap.gui import system_info, utils	1✔
13	from normcap.gui.models import Capture, CaptureMode, DesktopEnvironment, Rect, Screen	1✔
14	from normcap.gui.notifier import Notifier	1✔
15	from normcap.gui.settings import Settings	1✔
16	from normcap.gui.update_check import UpdateChecker	1✔
17	from normcap.gui.window import Window	1✔
18	from normcap.screengrab import grab_screens	1✔
19
20	logger = logging.getLogger(__name__)	1✔
21
22	# TODO: Remove pylint disable no-member when https://github.com/PyCQA/pylint/issues/5378
23
24
25	class Communicate(QtCore.QObject):	1✔
26	"""TrayMenus' communication bus."""
27
28	on_tray_menu_capture = QtCore.Signal()	1✔
29	on_quit = QtCore.Signal()	1✔
30	on_ocr_performed = QtCore.Signal()	1✔
31	on_copied_to_clipboard = QtCore.Signal()	1✔
32	on_send_notification = QtCore.Signal(Capture)	1✔
33	on_window_positioned = QtCore.Signal()	1✔
34	on_open_url_and_hide = QtCore.Signal(str)	1✔
35	on_set_cursor_wait = QtCore.Signal()	1✔
36	on_close_or_exit = QtCore.Signal(str)	1✔
37	on_region_selected = QtCore.Signal(Rect)	1✔
38	on_image_cropped = QtCore.Signal()	1✔
39	on_minimize_windows = QtCore.Signal()	1✔
40	on_screenshots_updated = QtCore.Signal()	1✔
41
42
43	class SystemTray(QtWidgets.QSystemTrayIcon):	1✔
44	"""System tray icon with menu."""
45
46	capture = Capture()	1✔
47	windows: dict[int, Window] = {}	1✔
48
49	def __init__(self, parent, args):	1✔
50	logger.debug("Set up tray icon")	1✔
51	super().__init__(parent)	1✔
52
53	self.com = Communicate()	1✔
54	self.settings = Settings("normcap", "settings", init_settings=args)	1✔
55	if args.get("reset", False):	1✔
56	self.settings.reset()	×
57
58	self.capture.mode = (	1✔
59	CaptureMode.PARSE
60	if self.settings.value("mode") == "parse"
61	else CaptureMode.RAW
62	)
63	self.clipboard = QtWidgets.QApplication.clipboard()	1✔
64	self.screens: dict[int, Screen] = system_info.screens()	1✔
65
66	self.setIcon(utils.get_icon("tray.png", "tool-magic-symbolic"))	1✔
67	self._add_tray_menu()	1✔
68	self._add_update_checker()	1✔
69	self._add_notifier()	1✔
70	self._set_signals()	1✔
71	self._update_screenshots()	1✔
72
73	def _set_signals(self):	1✔
74	"""Set up signals to trigger program logic."""
75	self.com.on_tray_menu_capture.connect(self._delayed_update_screenshots)	1✔
76	self.com.on_screenshots_updated.connect(self._show_windows)	1✔
77	self.com.on_quit.connect(lambda: self._exit_application("clicked exit in tray"))	1✔
78	self.com.on_region_selected.connect(self._crop_image)	1✔
79	self.com.on_image_cropped.connect(self._capture_to_ocr)	1✔
80	self.com.on_ocr_performed.connect(self._copy_to_clipboard)	1✔
81	self.com.on_copied_to_clipboard.connect(self._notify_or_close)	1✔
82
83	self.com.on_minimize_windows.connect(self._close_windows)	1✔
84	self.com.on_set_cursor_wait.connect(	1✔
85	lambda: utils.set_cursor(QtCore.Qt.WaitCursor)
86	)
87	self.com.on_close_or_exit.connect(self._close_or_exit)	1✔
88	self.com.on_open_url_and_hide.connect(self._open_url_and_hide)	1✔
89
90	def _add_update_checker(self):	1✔
91	if self.settings.value("update", type=bool):	1✔
92	checker = UpdateChecker(self, packaged=system_info.is_prebuild_package())	×
93	checker.com.on_version_retrieved.connect(checker.show_update_message)	×
94	checker.com.on_click_get_new_version.connect(self.com.on_open_url_and_hide)	×
95	QtCore.QTimer.singleShot(500, checker.check)	×
96
97	def _add_notifier(self):	1✔
98	self.notifier = Notifier(self)	1✔
99	self.com.on_send_notification.connect(self.notifier.send_notification)	1✔
100	self.notifier.com.on_notification_sent.connect(	1✔
101	lambda: self.com.on_close_or_exit.emit("notification sent")
102	)
103
104	def _update_screenshots(self):	1✔
105	"""Get new screenshots and cache them."""
106	screens = grab_screens()	1✔
107
108	if not screens:	1✔
109	logger.error("Could not grab screenshots.")	×
110	return	×
111
112	for idx, screenshot in enumerate(screens):	1✔
113	utils.save_image_in_tempfolder(screenshot, postfix=f"_raw_screen{idx}")	1✔
114	self.screens[idx].screenshot = screenshot	1✔
115
116	self.com.on_screenshots_updated.emit()	1✔
117
118	def _delayed_update_screenshots(self):	1✔
119	"""Wait before updating screenshot to allow tray menu to hide.
120
121	Avoids having the tray menu itself on the screenshot.
122	"""
123	time.sleep(0.15)	×
124	self._update_screenshots()	×
125
126	def _add_tray_menu(self):	1✔
127	"""Create menu for system tray."""
128	menu = QtWidgets.QMenu()	1✔
129
130	action = QtGui.QAction("Capture", menu)	1✔
131	action.triggered.connect( # pylint: disable=no-member	1✔
132	self.com.on_tray_menu_capture.emit
133	)
134	menu.addAction(action)	1✔
135
136	action = QtGui.QAction("Exit", menu)	1✔
137	action.triggered.connect(self.com.on_quit.emit) # pylint: disable=no-member	1✔
138	menu.addAction(action)	1✔
139
140	self.setContextMenu(menu)	1✔
141
142	def _show_windows(self):	1✔
143	"""Initialize child windows with method depending on system."""
144	if not system_info.display_manager_is_wayland():	1✔
145	for index in system_info.screens():	1✔
146	self._create_window(index)	1✔
147
148	elif system_info.desktop_environment() in [	×
149	DesktopEnvironment.GNOME,
150	DesktopEnvironment.KDE,
151	]:
152	self._create_next_window()	×
153
154	def _create_next_window(self):	1✔
155	"""Open child window only for next display."""
156	if len(system_info.screens()) > len(self.windows):	×
157	index = len(self.windows.keys())	×
158	self._create_window(index)	×
159
160	def _create_window(self, index: int):	1✔
161	"""Open a child window for the specified screen."""
162	new_window = Window(	1✔
163	screen_idx=index,
164	parent=self,
165	color=str(self.settings.value("color")),
166	)
167	if index == 0:	1✔
168	new_window.add_settings_menu(self)	1✔
169
170	new_window.set_fullscreen()	1✔
171	self.windows[index] = new_window	1✔
172
173	#####################
174	# OCR Functionality #
175	#####################
176
177	def _crop_image(self, grab_info: tuple[Rect, int]):	1✔
178	"""Crop image to selected region."""
179	logger.info("Crop image to selected region %s", grab_info[0].points)	1✔
180	rect, screen_idx = grab_info	1✔
181
182	screenshot = self.screens[screen_idx].screenshot	1✔
183	if not screenshot:	1✔
184	raise TypeError("Screenshot is None!")	×
185
186	self.capture.mode = CaptureMode[self.settings.value("mode").upper()]	1✔
187	self.capture.rect = rect	1✔
188	self.capture.screen = self.screens[screen_idx]	1✔
189	self.capture.image = screenshot.copy(QtCore.QRect(*rect.geometry))	1✔
190
191	utils.save_image_in_tempfolder(self.capture.image, postfix="_cropped")	1✔
192
193	self.com.on_image_cropped.emit()	1✔
194
195	@staticmethod	1✔
196	def _qimage_to_pil_image(image: QtGui.QImage):	1✔
197	"""Cast QImage to pillow Image type."""
198	ba = QtCore.QByteArray()	1✔
199	buffer = QtCore.QBuffer(ba)	1✔
200	buffer.open(QtCore.QIODevice.ReadWrite)	1✔
201	image.save(buffer, "PNG") # type:ignore	1✔
202	return Image.open(io.BytesIO(buffer.data()))	1✔
203
204	def _capture_to_ocr(self):	1✔
205	"""Perform content recognition on grabed image."""
206	if self.capture.image_area < 25:	1✔
207	logger.warning("Area of %s too small. Skip OCR", self.capture.image_area)	×
208	self.com.on_close_or_exit.emit("selection too small")	×
209	return	×
210
211	logger.debug("Start OCR")	1✔
212	ocr_result = ocr.recognize(	1✔
213	languages=self.settings.value("language"),
214	image=self._qimage_to_pil_image(self.capture.image),
215	tessdata_path=system_info.get_tessdata_path(),
216	parse=self.capture.mode is CaptureMode.PARSE,
217	resize_factor=3.2,
218	padding_size=80,
219	)
220	utils.save_image_in_tempfolder(ocr_result.image, postfix="_enhanced")	1✔
221
222	self.capture.ocr_text = ocr_result.text	1✔
223	self.capture.ocr_applied_magic = ocr_result.best_scored_magic	1✔
224
225	logger.info("Text from OCR:\n%s", self.capture.ocr_text)	1✔
226	self.com.on_ocr_performed.emit()	1✔
227
228	#########################
229	# Helper #
230	#########################
231
232	def _open_url_and_hide(self, url):	1✔
233	"""Open url in default browser, then hide to tray or exit."""
234	logger.debug("Open %s", url)	×
235	QtGui.QDesktopServices.openUrl(url)	×
236	self.com.on_close_or_exit.emit("opened web browser")	×
237
238	def _copy_to_clipboard(self):	1✔
239	"""Copy results to clipboard."""
240	# Signal is only temporarily connected to avoid being triggered
241	# on arbitrary clipboard changes
242	self.clipboard.dataChanged.connect(self.com.on_copied_to_clipboard.emit)	1✔
243	self.clipboard.dataChanged.connect(self.clipboard.dataChanged.disconnect)	1✔
244
245	copy = utils.copy_to_clipboard()	1✔
246	copy(self.capture.ocr_text)	1✔
247	QtWidgets.QApplication.processEvents()	1✔
248
249	def _notify_or_close(self):	1✔
250	if self.settings.value("notification", type=bool):	1✔
251	self.com.on_send_notification.emit(self.capture)	1✔
252	else:
253	self.com.on_close_or_exit.emit("detection completed")	×
254
255	def _close_windows(self):	1✔
256	"""Hide all windows of normcap."""
257	logger.debug("Hide %s window(s)", len(self.windows))	×
258	utils.set_cursor(None)	×
259	for window in self.windows.values():	×
260	window.close()	×
261	self.windows = {}	×
262
263	def _close_or_exit(self, reason: str):	1✔
264	if self.settings.value("tray", type=bool):	1✔
265	self._close_windows()	×
266	else:
267	self._exit_application(reason)	1✔
268
269	def _exit_application(self, reason: str):	1✔
270	self.hide()	1✔
271	QtWidgets.QApplication.processEvents()	1✔
272	time.sleep(0.05)	1✔
273	logger.debug("Path to debug images: %s%snormcap", tempfile.gettempdir(), os.sep)	1✔
274	logger.info("Exit normcap (reason: %s)", reason)	1✔
275	QtWidgets.QApplication.quit()	1✔

dynobo / normcap / 2450167059

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