anki/qt/aqt/stats.py

# Copyright: Ankitects Pty Ltd and contributors
# -*- coding: utf-8 -*-
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html

import time

import aqt
from anki.lang import _
from aqt.qt import *
from aqt.theme import theme_manager
from aqt.utils import (
    addCloseShortcut,
    getSaveFile,
    maybeHideClose,
    restoreGeom,
    saveGeom,
    tooltip,
)

# Deck Stats
######################################################################


class DeckStats(QDialog):
    def __init__(self, mw):
        QDialog.__init__(self, mw, Qt.Window)
        mw.setupDialogGC(self)
        self.mw = mw
        self.name = "deckStats"
        self.period = 0
        self.form = aqt.forms.stats.Ui_Dialog()
        self.oldPos = None
        self.wholeCollection = False
        self.setMinimumWidth(700)
        f = self.form
        if theme_manager.night_mode and not theme_manager.macos_dark_mode():
            self.setStyleSheet("QGroupBox { padding-top: 0; }")
        f.setupUi(self)
        restoreGeom(self, self.name)
        b = f.buttonBox.addButton(_("Save PDF"), QDialogButtonBox.ActionRole)
        b.clicked.connect(self.saveImage)
        b.setAutoDefault(False)
        f.groups.clicked.connect(lambda: self.changeScope("deck"))
        f.groups.setShortcut("g")
        f.all.clicked.connect(lambda: self.changeScope("collection"))
        f.month.clicked.connect(lambda: self.changePeriod(0))
        f.year.clicked.connect(lambda: self.changePeriod(1))
        f.life.clicked.connect(lambda: self.changePeriod(2))
        maybeHideClose(self.form.buttonBox)
        addCloseShortcut(self)
        self.show()
        self.refresh()
        self.activateWindow()

    def reject(self):
        self.form.web = None
        saveGeom(self, self.name)
        aqt.dialogs.markClosed("DeckStats")
        QDialog.reject(self)

    def closeWithCallback(self, callback):
        self.reject()
        callback()

    def _imagePath(self):
        name = time.strftime("-%Y-%m-%d@%H-%M-%S.pdf", time.localtime(time.time()))
        name = "anki-" + _("stats") + name
        file = getSaveFile(
            self,
            title=_("Save PDF"),
            dir_description="stats",
            key="stats",
            ext=".pdf",
            fname=name,
        )
        return file

    def saveImage(self):
        path = self._imagePath()
        if not path:
            return
        self.form.web.page().printToPdf(path)
        tooltip(_("Saved."))

    def changePeriod(self, n):
        self.period = n
        self.refresh()

    def changeScope(self, type):
        self.wholeCollection = type == "collection"
        self.refresh()

    def refresh(self):
        self.mw.progress.start(immediate=True, parent=self)
        stats = self.mw.col.stats()
        stats.wholeCollection = self.wholeCollection
        self.report = stats.report(type=self.period)
        self.form.web.title = "deck stats"
        self.form.web.stdHtml(
            "<html><body>" + self.report + "</body></html>",
            js=["jquery.js", "plot.js"],
            context=self,
        )
        self.mw.progress.finish()
update copyright and clarify licenses 2019-02-05 04:59:03 +01:00			`# Copyright: Ankitects Pty Ltd and contributors`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`# -- coding: utf-8 --`
			`# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html`

use isort to tidy up imports 2019-12-20 10:19:03 +01:00			`import time`

merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`import aqt`
explicitly import _ and ngettext 2019-03-04 02:58:34 +01:00			`from anki.lang import _`
use isort to tidy up imports 2019-12-20 10:19:03 +01:00			`from aqt.qt import *`
only apply padding fix to stats screen It was breaking the display of dialogs like the filtered deck screen 2020-02-02 04:07:24 +01:00			`from aqt.theme import theme_manager`
apply black to all files 2019-12-23 01:34:10 +01:00			`from aqt.utils import (`
			`addCloseShortcut,`
			`getSaveFile,`
			`maybeHideClose,`
			`restoreGeom,`
			`saveGeom,`
			`tooltip,`
			`)`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00
			`# Deck Stats`
			`######################################################################`


apply black to all files 2019-12-23 01:34:10 +01:00			`class DeckStats(QDialog):`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`def __init__(self, mw):`
			`QDialog.__init__(self, mw, Qt.Window)`
fix mem leaks in dialogs - ensure we're cleaning them up after they're rejected - run the garbage collector afterwards so the qwebengineprocess instances get cleaned up 2016-07-04 05:22:35 +02:00			`mw.setupDialogGC(self)`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`self.mw = mw`
			`self.name = "deckStats"`
			`self.period = 0`
			`self.form = aqt.forms.stats.Ui_Dialog()`
			`self.oldPos = None`
			`self.wholeCollection = False`
			`self.setMinimumWidth(700)`
			`f = self.form`
only apply padding fix to stats screen It was breaking the display of dialogs like the filtered deck screen 2020-02-02 04:07:24 +01:00			`if theme_manager.night_mode and not theme_manager.macos_dark_mode():`
			`self.setStyleSheet("QGroupBox { padding-top: 0; }")`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`f.setupUi(self)`
			`restoreGeom(self, self.name)`
apply black to all files 2019-12-23 01:34:10 +01:00			`b = f.buttonBox.addButton(_("Save PDF"), QDialogButtonBox.ActionRole)`
support for saving stats to a pdf 2017-01-13 08:36:26 +01:00			`b.clicked.connect(self.saveImage)`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`b.setAutoDefault(False)`
port majority of code to qt5.5+ - a few issues to work out still, and editor changes not done yet - for communication between webengine and python code, we set window .location to 'http://anki/<something>' - the leading http is necessary for qt to call the link handler, which was introduced in qt5.5 - the designer files now use a promoted qobject to create instances of AnkiWebView - we use the css zoom property to alter webengine font size based on system dpi - prefs and addons folder stored in new location (at least for now) 2016-05-31 10:51:40 +02:00			`f.groups.clicked.connect(lambda: self.changeScope("deck"))`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`f.groups.setShortcut("g")`
port majority of code to qt5.5+ - a few issues to work out still, and editor changes not done yet - for communication between webengine and python code, we set window .location to 'http://anki/<something>' - the leading http is necessary for qt to call the link handler, which was introduced in qt5.5 - the designer files now use a promoted qobject to create instances of AnkiWebView - we use the css zoom property to alter webengine font size based on system dpi - prefs and addons folder stored in new location (at least for now) 2016-05-31 10:51:40 +02:00			`f.all.clicked.connect(lambda: self.changeScope("collection"))`
			`f.month.clicked.connect(lambda: self.changePeriod(0))`
			`f.year.clicked.connect(lambda: self.changePeriod(1))`
			`f.life.clicked.connect(lambda: self.changePeriod(2))`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`maybeHideClose(self.form.buttonBox)`
add cmd+w shortcut to add cards window & stats window 2012-12-22 01:11:29 +01:00			`addCloseShortcut(self)`
port majority of code to qt5.5+ - a few issues to work out still, and editor changes not done yet - for communication between webengine and python code, we set window .location to 'http://anki/<something>' - the leading http is necessary for qt to call the link handler, which was introduced in qt5.5 - the designer files now use a promoted qobject to create instances of AnkiWebView - we use the css zoom property to alter webengine font size based on system dpi - prefs and addons folder stored in new location (at least for now) 2016-05-31 10:51:40 +02:00			`self.show()`
fix black flash on stats load on osx/qt5.11 2018-10-23 09:09:16 +02:00			`self.refresh()`
make sure stats window starts focused on osx 2017-06-06 08:16:00 +02:00			`self.activateWindow()`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00
			`def reject(self):`
fix qtwebengineprocess leak in stats screen https://anki.tenderapp.com/discussions/ankidesktop/35941-closing-stats-window-doesnt-end-its-extra-qt-process 2019-09-16 07:16:41 +02:00			`self.form.web = None`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`saveGeom(self, self.name)`
use callback when closing windows remove the old forceClose hack in favour of a callback when closing, so all windows have a chance to save properly before the collection is unloaded also: - fix a warning shown when opening about screen - require a call to editor.cleanup() when closing a window, to make sure any pending js callbacks don't try to fire on a deleted object - make sure we gc webview when closing editcurrent - main.py still needs refactoring to make use of the change 2017-08-16 04:45:33 +02:00			`aqt.dialogs.markClosed("DeckStats")`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`QDialog.reject(self)`

use callback when closing windows remove the old forceClose hack in favour of a callback when closing, so all windows have a chance to save properly before the collection is unloaded also: - fix a warning shown when opening about screen - require a call to editor.cleanup() when closing a window, to make sure any pending js callbacks don't try to fire on a deleted object - make sure we gc webview when closing editcurrent - main.py still needs refactoring to make use of the change 2017-08-16 04:45:33 +02:00			`def closeWithCallback(self, callback):`
			`self.reject()`
			`callback()`

support for saving stats to a pdf 2017-01-13 08:36:26 +01:00			`def _imagePath(self):`
apply black to all files 2019-12-23 01:34:10 +01:00			`name = time.strftime("-%Y-%m-%d@%H-%M-%S.pdf", time.localtime(time.time()))`
			`name = "anki-" + _("stats") + name`
			`file = getSaveFile(`
			`self,`
			`title=_("Save PDF"),`
			`dir_description="stats",`
			`key="stats",`
			`ext=".pdf",`
			`fname=name,`
			`)`
allow user to pick graph save location 2017-09-10 07:50:34 +02:00			`return file`
support for saving stats to a pdf 2017-01-13 08:36:26 +01:00
			`def saveImage(self):`
			`path = self._imagePath()`
allow user to pick graph save location 2017-09-10 07:50:34 +02:00			`if not path:`
			`return`
support for saving stats to a pdf 2017-01-13 08:36:26 +01:00			`self.form.web.page().printToPdf(path)`
allow user to pick graph save location 2017-09-10 07:50:34 +02:00			`tooltip(_("Saved."))`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00
			`def changePeriod(self, n):`
			`self.period = n`
			`self.refresh()`

			`def changeScope(self, type):`
			`self.wholeCollection = type == "collection"`
			`self.refresh()`

			`def refresh(self):`
fix black flash on stats load on osx/qt5.11 2018-10-23 09:09:16 +02:00			`self.mw.progress.start(immediate=True, parent=self)`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`stats = self.mw.col.stats()`
			`stats.wholeCollection = self.wholeCollection`
			`self.report = stats.report(type=self.period)`
Refactor web view title setting and add titles to all web views Simplifies debugging web views 2020-02-12 21:03:11 +01:00			`self.form.web.title = "deck stats"`
apply black to all files 2019-12-23 01:34:10 +01:00			`self.form.web.stdHtml(`
Add webview_will_set_content hook & update supporting code accordingly 2020-02-12 22:00:13 +01:00			`"<html><body>" + self.report + "</body></html>",`
Assume that web assets without a specified subpath are under /_anki Maintains compatibility with existing add-ons 2020-02-15 15:03:43 +01:00			`js=["jquery.js", "plot.js"],`
Add webview_will_set_content hook & update supporting code accordingly 2020-02-12 22:00:13 +01:00			`context=self,`
apply black to all files 2019-12-23 01:34:10 +01:00			`)`
merged libanki and ankiqt into single distro 2012-12-21 08:51:59 +01:00			`self.mw.progress.finish()`