anki/qt/aqt/reviewer.py

1177 lines
40 KiB
Python
Raw Normal View History

2019-02-05 04:59:03 +01:00
# Copyright: Ankitects Pty Ltd and contributors
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
2021-04-13 10:45:05 +02:00
from __future__ import annotations
import functools
2019-03-04 08:25:19 +01:00
import json
import random
2019-12-20 10:19:03 +01:00
import re
from dataclasses import dataclass
from enum import Enum, auto
Migrate to protobuf-es (#2547) * Fix .no-reduce-motion missing from graphs spinner, and not being honored * Begin migration from protobuf.js -> protobuf-es Motivation: - Protobuf-es has a nicer API: messages are represented as classes, and fields which should exist are not marked as nullable. - As it uses modules, only the proto messages we actually use get included in our bundle output. Protobuf.js put everything in a namespace, which prevented tree-shaking, and made it awkward to access inner messages. - ./run after touching a proto file drops from about 8s to 6s on my machine. The tradeoff is slower decoding/encoding (#2043), but that was mainly a concern for the graphs page, and was unblocked by https://github.com/ankitects/anki/commit/37151213cd9d431f449ba4b3bc4c0329a1d9af78 Approach/notes: - We generate the new protobuf-es interface in addition to existing protobuf.js interface, so we can migrate a module at a time, starting with the graphs module. - rslib:proto now generates RPC methods for TS in addition to the Python interface. The input-arg-unrolling behaviour of the Python generation is not required here, as we declare the input arg as a PlainMessage<T>, which marks it as requiring all fields to be provided. - i64 is represented as bigint in protobuf-es. We were using a patch to protobuf.js to get it to output Javascript numbers instead of long.js types, but now that our supported browser versions support bigint, it's probably worth biting the bullet and migrating to bigint use. Our IDs fit comfortably within MAX_SAFE_INTEGER, but that may not hold for future fields we add. - Oneofs are handled differently in protobuf-es, and are going to need some refactoring. Other notable changes: - Added a --mkdir arg to our build runner, so we can create a dir easily during the build on Windows. - Simplified the preference handling code, by wrapping the preferences in an outer store, instead of a separate store for each individual preference. This means a change to one preference will trigger a redraw of all components that depend on the preference store, but the redrawing is cheap after moving the data processing to Rust, and it makes the code easier to follow. - Drop async(Reactive).ts in favour of more explicit handling with await blocks/updating. - Renamed add_inputs_to_group() -> add_dependency(), and fixed it not adding dependencies to parent groups. Renamed add() -> add_action() for clarity. * Remove a couple of unused proto imports * Migrate card info * Migrate congrats, image occlusion, and tag editor + Fix imports for multi-word proto files. * Migrate change-notetype * Migrate deck options * Bump target to es2020; simplify ts lib list Have used caniuse.com to confirm Chromium 77, iOS 14.5 and the Chrome on Android support the full es2017-es2020 features. * Migrate import-csv * Migrate i18n and fix missing output types in .js * Migrate custom scheduling, and remove protobuf.js To mostly maintain our old API contract, we make use of protobuf-es's ability to convert to JSON, which follows the same format as protobuf.js did. It doesn't cover all case: users who were previously changing the variant of a type will need to update their code, as assigning to a new variant no longer automatically removes the old one, which will cause an error when we try to convert back from JSON. But I suspect the large majority of users are adjusting the current variant rather than creating a new one, and this saves us having to write proxy wrappers, so it seems like a reasonable compromise. One other change I made at the same time was to rename value->kind for the oneofs in our custom study protos, as 'value' was easily confused with the 'case/value' output that protobuf-es has. With protobuf.js codegen removed, touching a proto file and invoking ./run drops from about 8s to 6s. This closes #2043. * Allow tree-shaking on protobuf types * Display backend error messages in our ts alert() * Make sourcemap generation opt-in for ts-run Considerably slows down build, and not used most of the time.
2023-06-14 14:47:37 +02:00
from typing import Any, Literal, Match, Sequence, cast
2020-02-27 04:11:21 +01:00
import aqt
import aqt.browser
import aqt.operations
from anki.cards import Card, CardId
from anki.collection import Config, OpChanges, OpChangesWithCount
from anki.scheduler.base import ScheduleCardsAsNew
from anki.scheduler.v3 import CardAnswer, QueuedCards
from anki.scheduler.v3 import Scheduler as V3Scheduler
Migrate to protobuf-es (#2547) * Fix .no-reduce-motion missing from graphs spinner, and not being honored * Begin migration from protobuf.js -> protobuf-es Motivation: - Protobuf-es has a nicer API: messages are represented as classes, and fields which should exist are not marked as nullable. - As it uses modules, only the proto messages we actually use get included in our bundle output. Protobuf.js put everything in a namespace, which prevented tree-shaking, and made it awkward to access inner messages. - ./run after touching a proto file drops from about 8s to 6s on my machine. The tradeoff is slower decoding/encoding (#2043), but that was mainly a concern for the graphs page, and was unblocked by https://github.com/ankitects/anki/commit/37151213cd9d431f449ba4b3bc4c0329a1d9af78 Approach/notes: - We generate the new protobuf-es interface in addition to existing protobuf.js interface, so we can migrate a module at a time, starting with the graphs module. - rslib:proto now generates RPC methods for TS in addition to the Python interface. The input-arg-unrolling behaviour of the Python generation is not required here, as we declare the input arg as a PlainMessage<T>, which marks it as requiring all fields to be provided. - i64 is represented as bigint in protobuf-es. We were using a patch to protobuf.js to get it to output Javascript numbers instead of long.js types, but now that our supported browser versions support bigint, it's probably worth biting the bullet and migrating to bigint use. Our IDs fit comfortably within MAX_SAFE_INTEGER, but that may not hold for future fields we add. - Oneofs are handled differently in protobuf-es, and are going to need some refactoring. Other notable changes: - Added a --mkdir arg to our build runner, so we can create a dir easily during the build on Windows. - Simplified the preference handling code, by wrapping the preferences in an outer store, instead of a separate store for each individual preference. This means a change to one preference will trigger a redraw of all components that depend on the preference store, but the redrawing is cheap after moving the data processing to Rust, and it makes the code easier to follow. - Drop async(Reactive).ts in favour of more explicit handling with await blocks/updating. - Renamed add_inputs_to_group() -> add_dependency(), and fixed it not adding dependencies to parent groups. Renamed add() -> add_action() for clarity. * Remove a couple of unused proto imports * Migrate card info * Migrate congrats, image occlusion, and tag editor + Fix imports for multi-word proto files. * Migrate change-notetype * Migrate deck options * Bump target to es2020; simplify ts lib list Have used caniuse.com to confirm Chromium 77, iOS 14.5 and the Chrome on Android support the full es2017-es2020 features. * Migrate import-csv * Migrate i18n and fix missing output types in .js * Migrate custom scheduling, and remove protobuf.js To mostly maintain our old API contract, we make use of protobuf-es's ability to convert to JSON, which follows the same format as protobuf.js did. It doesn't cover all case: users who were previously changing the variant of a type will need to update their code, as assigning to a new variant no longer automatically removes the old one, which will cause an error when we try to convert back from JSON. But I suspect the large majority of users are adjusting the current variant rather than creating a new one, and this saves us having to write proxy wrappers, so it seems like a reasonable compromise. One other change I made at the same time was to rename value->kind for the oneofs in our custom study protos, as 'value' was easily confused with the 'case/value' output that protobuf-es has. With protobuf.js codegen removed, touching a proto file and invoking ./run drops from about 8s to 6s. This closes #2043. * Allow tree-shaking on protobuf types * Display backend error messages in our ts alert() * Make sourcemap generation opt-in for ts-run Considerably slows down build, and not used most of the time.
2023-06-14 14:47:37 +02:00
from anki.scheduler.v3 import (
SchedulingContext,
SchedulingStates,
SetSchedulingStatesRequest,
)
2021-03-18 03:06:45 +01:00
from anki.tags import MARKED_TAG
from anki.types import assert_exhaustive
from aqt import AnkiQt, gui_hooks
from aqt.browser.card_info import PreviousReviewerCardInfo, ReviewerCardInfo
from aqt.deckoptions import confirm_deck_then_display_options
2021-04-03 08:26:10 +02:00
from aqt.operations.card import set_card_flag
from aqt.operations.note import remove_notes
from aqt.operations.scheduling import (
answer_card,
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
bury_cards,
bury_notes,
forget_cards,
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
set_due_date_dialog,
suspend_cards,
suspend_note,
)
2021-04-03 08:26:10 +02:00
from aqt.operations.tag import add_tags_to_notes, remove_tags_from_notes
from aqt.profiles import VideoDriver
from aqt.qt import *
from aqt.sound import av_player, play_clicked_audio, record_audio
from aqt.theme import theme_manager
from aqt.toolbar import BottomBar
from aqt.utils import (
askUserDialog,
downArrow,
qtMenuShortcutWorkaround,
show_warning,
tooltip,
tr,
)
2013-10-22 07:28:45 +02:00
class RefreshNeeded(Enum):
NOTE_TEXT = auto()
QUEUES = auto()
FLAG = auto()
class ReviewerBottomBar:
2020-02-27 04:11:21 +01:00
def __init__(self, reviewer: Reviewer) -> None:
self.reviewer = reviewer
2020-04-13 01:04:30 +02:00
def replay_audio(card: Card, question_side: bool) -> None:
if question_side:
av_player.play_tags(card.question_av_tags())
else:
tags = card.answer_av_tags()
if card.replay_question_audio_on_answer_side():
tags = card.question_av_tags() + tags
av_player.play_tags(tags)
2020-04-13 01:04:30 +02:00
@dataclass
class V3CardInfo:
"""Stores the top of the card queue for the v3 scheduler.
This includes current and potential next states of the displayed card,
which may be mutated by a user's custom scheduling.
"""
queued_cards: QueuedCards
states: SchedulingStates
context: SchedulingContext
@staticmethod
def from_queue(queued_cards: QueuedCards) -> V3CardInfo:
top_card = queued_cards.cards[0]
states = top_card.states
states.current.custom_data = top_card.card.custom_data
return V3CardInfo(
queued_cards=queued_cards, states=states, context=top_card.context
)
def top_card(self) -> QueuedCards.QueuedCard:
return self.queued_cards.cards[0]
def counts(self) -> tuple[int, list[int]]:
"Returns (idx, counts)."
counts = [
self.queued_cards.new_count,
self.queued_cards.learning_count,
self.queued_cards.review_count,
]
card = self.top_card()
if card.queue == QueuedCards.NEW:
idx = 0
elif card.queue == QueuedCards.LEARNING:
idx = 1
else:
idx = 2
return idx, counts
@staticmethod
def rating_from_ease(ease: int) -> CardAnswer.Rating.V:
if ease == 1:
return CardAnswer.AGAIN
elif ease == 2:
return CardAnswer.HARD
elif ease == 3:
return CardAnswer.GOOD
else:
return CardAnswer.EASY
class AnswerAction(Enum):
BURY_CARD = 0
ANSWER_AGAIN = 1
ANSWER_GOOD = 2
ANSWER_HARD = 3
SHOW_REMINDER = 4
class Reviewer:
def __init__(self, mw: AnkiQt) -> None:
self.mw = mw
self.web = mw.web
self.card: Card | None = None
self.previous_card: Card | None = None
self._answeredIds: list[CardId] = []
self._recordedAudio: str | None = None
2020-02-27 04:11:21 +01:00
self.typeCorrect: str = None # web init happens before this is set
self.state: Literal["question", "answer", "transition", None] = None
self._refresh_needed: RefreshNeeded | None = None
self._v3: V3CardInfo | None = None
self._state_mutation_key = str(random.randint(0, 2**64 - 1))
self.bottom = BottomBar(mw, mw.bottomWeb)
self._card_info = ReviewerCardInfo(self.mw)
self._previous_card_info = PreviousReviewerCardInfo(self.mw)
self._states_mutated = True
self._reps: int = None
self._show_question_timer: QTimer | None = None
self._show_answer_timer: QTimer | None = None
self.auto_advance_enabled = False
gui_hooks.av_player_did_end_playing.append(self._on_av_player_did_end_playing)
2020-02-27 04:11:21 +01:00
def show(self) -> None:
Integrate FSRS into Anki (#2654) * Pack FSRS data into card.data * Update FSRS card data when preset or weights change + Show FSRS stats in card stats * Show a warning when there's a limited review history * Add some translations; tweak UI * Fix default requested retention * Add browser columns, fix calculation of R * Property searches eg prop:d>0.1 * Integrate FSRS into reviewer * Warn about long learning steps * Hide minimum interval when FSRS is on * Don't apply interval multiplier to FSRS intervals * Expose memory state to Python * Don't set memory state on new cards * Port Jarret's new tests; add some helpers to make tests more compact https://github.com/open-spaced-repetition/fsrs-rs/pull/64 * Fix learning cards not being given memory state * Require update to v3 scheduler * Don't exclude single learning step when calculating memory state * Use relearning step when learning steps unavailable * Update docstring * fix single_card_revlog_to_items (#2656) * not need check the review_kind for unique_dates * add email address to CONTRIBUTORS * fix last first learn & keep early review * cargo fmt * cargo clippy --fix * Add Jarrett to about screen * Fix fsrs_memory_state being initialized to default in get_card() * Set initial memory state on graduate * Update to latest FSRS * Fix experiment.log being empty * Fix broken colpkg imports Introduced by "Update FSRS card data when preset or weights change" * Update memory state during (re)learning; use FSRS for graduating intervals * Reset memory state when cards are manually rescheduled as new * Add difficulty graph; hide eases when FSRS enabled * Add retrievability graph * Derive memory_state from revlog when it's missing and shouldn't be --------- Co-authored-by: Jarrett Ye <jarrett.ye@outlook.com>
2023-09-16 08:09:26 +02:00
if self.mw.col.sched_ver() == 1 or not self.mw.col.v3_scheduler():
2021-11-24 04:33:01 +01:00
self.mw.moveToState("deckBrowser")
Integrate FSRS into Anki (#2654) * Pack FSRS data into card.data * Update FSRS card data when preset or weights change + Show FSRS stats in card stats * Show a warning when there's a limited review history * Add some translations; tweak UI * Fix default requested retention * Add browser columns, fix calculation of R * Property searches eg prop:d>0.1 * Integrate FSRS into reviewer * Warn about long learning steps * Hide minimum interval when FSRS is on * Don't apply interval multiplier to FSRS intervals * Expose memory state to Python * Don't set memory state on new cards * Port Jarret's new tests; add some helpers to make tests more compact https://github.com/open-spaced-repetition/fsrs-rs/pull/64 * Fix learning cards not being given memory state * Require update to v3 scheduler * Don't exclude single learning step when calculating memory state * Use relearning step when learning steps unavailable * Update docstring * fix single_card_revlog_to_items (#2656) * not need check the review_kind for unique_dates * add email address to CONTRIBUTORS * fix last first learn & keep early review * cargo fmt * cargo clippy --fix * Add Jarrett to about screen * Fix fsrs_memory_state being initialized to default in get_card() * Set initial memory state on graduate * Update to latest FSRS * Fix experiment.log being empty * Fix broken colpkg imports Introduced by "Update FSRS card data when preset or weights change" * Update memory state during (re)learning; use FSRS for graduating intervals * Reset memory state when cards are manually rescheduled as new * Add difficulty graph; hide eases when FSRS enabled * Add retrievability graph * Derive memory_state from revlog when it's missing and shouldn't be --------- Co-authored-by: Jarrett Ye <jarrett.ye@outlook.com>
2023-09-16 08:09:26 +02:00
show_warning(tr.scheduling_update_required().replace("V2", "v3"))
2021-11-24 04:33:01 +01:00
return
2020-02-27 04:11:21 +01:00
self.mw.setStateShortcuts(self._shortcutKeys()) # type: ignore
self.web.set_bridge_command(self._linkHandler, self)
self.bottom.web.set_bridge_command(self._linkHandler, ReviewerBottomBar(self))
self._state_mutation_js = self.mw.col.get_config("cardStateCustomizer")
self._reps = None
self._refresh_needed = RefreshNeeded.QUEUES
self.refresh_if_needed()
# this is only used by add-ons
def lastCard(self) -> Card | None:
if self._answeredIds:
if not self.card or self._answeredIds[-1] != self.card.id:
try:
return self.mw.col.get_card(self._answeredIds[-1])
except TypeError:
# id was deleted
2020-02-27 04:11:21 +01:00
return None
return None
def cleanup(self) -> None:
2020-01-15 07:53:24 +01:00
gui_hooks.reviewer_will_end()
2020-10-14 11:54:29 +02:00
self.card = None
self.auto_advance_enabled = False
def refresh_if_needed(self) -> None:
if self._refresh_needed is RefreshNeeded.QUEUES:
self.nextCard()
self.mw.fade_in_webview()
self._refresh_needed = None
elif self._refresh_needed is RefreshNeeded.NOTE_TEXT:
self._redraw_current_card()
self.mw.fade_in_webview()
self._refresh_needed = None
elif self._refresh_needed is RefreshNeeded.FLAG:
self.card.load()
self._update_flag_icon()
# for when modified in browser
self.mw.fade_in_webview()
self._refresh_needed = None
elif self._refresh_needed:
assert_exhaustive(self._refresh_needed)
def op_executed(
self, changes: OpChanges, handler: object | None, focused: bool
) -> bool:
if handler is not self:
if changes.study_queues:
self._refresh_needed = RefreshNeeded.QUEUES
elif changes.note_text:
self._refresh_needed = RefreshNeeded.NOTE_TEXT
elif changes.card:
self._refresh_needed = RefreshNeeded.FLAG
if focused and self._refresh_needed:
self.refresh_if_needed()
return bool(self._refresh_needed)
def _redraw_current_card(self) -> None:
self.card.load()
if self.state == "answer":
self._showAnswer()
else:
self._showQuestion()
# Fetching a card
##########################################################################
2020-02-27 04:11:21 +01:00
def nextCard(self) -> None:
2021-09-08 04:52:33 +02:00
self.previous_card = self.card
self.card = None
self._v3 = None
self._get_next_v3_card()
self._previous_card_info.set_card(self.previous_card)
self._card_info.set_card(self.card)
if not self.card:
self.mw.moveToState("overview")
return
if self._reps is None:
self._initWeb()
self._showQuestion()
def _get_next_v3_card(self) -> None:
assert isinstance(self.mw.col.sched, V3Scheduler)
output = self.mw.col.sched.get_queued_cards()
if not output.cards:
return
self._v3 = V3CardInfo.from_queue(output)
self.card = Card(self.mw.col, backend_card=self._v3.top_card().card)
2021-06-27 04:12:23 +02:00
self.card.start_timer()
def get_scheduling_states(self) -> SchedulingStates:
return self._v3.states
def get_scheduling_context(self) -> SchedulingContext:
return self._v3.context
Migrate to protobuf-es (#2547) * Fix .no-reduce-motion missing from graphs spinner, and not being honored * Begin migration from protobuf.js -> protobuf-es Motivation: - Protobuf-es has a nicer API: messages are represented as classes, and fields which should exist are not marked as nullable. - As it uses modules, only the proto messages we actually use get included in our bundle output. Protobuf.js put everything in a namespace, which prevented tree-shaking, and made it awkward to access inner messages. - ./run after touching a proto file drops from about 8s to 6s on my machine. The tradeoff is slower decoding/encoding (#2043), but that was mainly a concern for the graphs page, and was unblocked by https://github.com/ankitects/anki/commit/37151213cd9d431f449ba4b3bc4c0329a1d9af78 Approach/notes: - We generate the new protobuf-es interface in addition to existing protobuf.js interface, so we can migrate a module at a time, starting with the graphs module. - rslib:proto now generates RPC methods for TS in addition to the Python interface. The input-arg-unrolling behaviour of the Python generation is not required here, as we declare the input arg as a PlainMessage<T>, which marks it as requiring all fields to be provided. - i64 is represented as bigint in protobuf-es. We were using a patch to protobuf.js to get it to output Javascript numbers instead of long.js types, but now that our supported browser versions support bigint, it's probably worth biting the bullet and migrating to bigint use. Our IDs fit comfortably within MAX_SAFE_INTEGER, but that may not hold for future fields we add. - Oneofs are handled differently in protobuf-es, and are going to need some refactoring. Other notable changes: - Added a --mkdir arg to our build runner, so we can create a dir easily during the build on Windows. - Simplified the preference handling code, by wrapping the preferences in an outer store, instead of a separate store for each individual preference. This means a change to one preference will trigger a redraw of all components that depend on the preference store, but the redrawing is cheap after moving the data processing to Rust, and it makes the code easier to follow. - Drop async(Reactive).ts in favour of more explicit handling with await blocks/updating. - Renamed add_inputs_to_group() -> add_dependency(), and fixed it not adding dependencies to parent groups. Renamed add() -> add_action() for clarity. * Remove a couple of unused proto imports * Migrate card info * Migrate congrats, image occlusion, and tag editor + Fix imports for multi-word proto files. * Migrate change-notetype * Migrate deck options * Bump target to es2020; simplify ts lib list Have used caniuse.com to confirm Chromium 77, iOS 14.5 and the Chrome on Android support the full es2017-es2020 features. * Migrate import-csv * Migrate i18n and fix missing output types in .js * Migrate custom scheduling, and remove protobuf.js To mostly maintain our old API contract, we make use of protobuf-es's ability to convert to JSON, which follows the same format as protobuf.js did. It doesn't cover all case: users who were previously changing the variant of a type will need to update their code, as assigning to a new variant no longer automatically removes the old one, which will cause an error when we try to convert back from JSON. But I suspect the large majority of users are adjusting the current variant rather than creating a new one, and this saves us having to write proxy wrappers, so it seems like a reasonable compromise. One other change I made at the same time was to rename value->kind for the oneofs in our custom study protos, as 'value' was easily confused with the 'case/value' output that protobuf-es has. With protobuf.js codegen removed, touching a proto file and invoking ./run drops from about 8s to 6s. This closes #2043. * Allow tree-shaking on protobuf types * Display backend error messages in our ts alert() * Make sourcemap generation opt-in for ts-run Considerably slows down build, and not used most of the time.
2023-06-14 14:47:37 +02:00
def set_scheduling_states(self, request: SetSchedulingStatesRequest) -> None:
if request.key != self._state_mutation_key:
return
self._v3.states = request.states
def _run_state_mutation_hook(self) -> None:
def on_eval(result: Any) -> None:
if result is None:
# eval failed, usually a syntax error
self._states_mutated = True
if js := self._state_mutation_js:
self._states_mutated = False
self.web.evalWithCallback(
RUN_STATE_MUTATION.format(key=self._state_mutation_key, js=js),
on_eval,
)
# Audio
##########################################################################
def replayAudio(self) -> None:
if self.state == "question":
replay_audio(self.card, True)
elif self.state == "answer":
replay_audio(self.card, False)
gui_hooks.audio_will_replay(self.web, self.card, self.state == "question")
2020-01-21 05:47:03 +01:00
def _on_av_player_did_end_playing(self, *args) -> None:
def task() -> None:
if av_player.queue_is_empty():
if self._show_question_timer and not sip.isdeleted(
self._show_question_timer
):
self._on_show_question_timeout()
elif self._show_answer_timer and not sip.isdeleted(
self._show_answer_timer
):
self._on_show_answer_timeout()
# Allow time for audio queue to update
self.mw.taskman.run_on_main(lambda: self.mw.progress.single_shot(100, task))
# Initializing the webview
##########################################################################
2020-02-27 04:11:21 +01:00
def revHtml(self) -> str:
extra = self.mw.col.conf.get("reviewExtra", "")
2019-12-23 01:34:10 +01:00
fade = ""
if self.mw.pm.video_driver() == VideoDriver.Software:
2019-12-23 01:34:10 +01:00
fade = "<script>qFade=0;</script>"
return f"""
<div id="_mark" hidden>&#x2605;</div>
<div id="_flag" hidden>&#x2691;</div>
{fade}
<div id="qa"></div>
{extra}
"""
2020-02-27 04:11:21 +01:00
def _initWeb(self) -> None:
self._reps = 0
# main window
2019-12-23 01:34:10 +01:00
self.web.stdHtml(
self.revHtml(),
css=["css/reviewer.css"],
2019-12-23 01:34:10 +01:00
js=[
"js/mathjax.js",
"js/vendor/mathjax/tex-chtml-full.js",
"js/reviewer.js",
2019-12-23 01:34:10 +01:00
],
context=self,
2019-12-23 01:34:10 +01:00
)
# block default drag & drop behavior while allowing drop events to be received by JS handlers
self.web.allow_drops = True
self.web.eval("_blockDefaultDragDropBehavior();")
# show answer / ease buttons
self.bottom.web.stdHtml(
self._bottomHTML(),
css=["css/toolbar-bottom.css", "css/reviewer-bottom.css"],
js=["js/vendor/jquery.min.js", "js/reviewer-bottom.js"],
context=ReviewerBottomBar(self),
)
# Showing the question
##########################################################################
2020-02-27 04:11:21 +01:00
def _mungeQA(self, buf: str) -> str:
return self.typeAnsFilter(self.mw.prepare_card_text_for_display(buf))
def _showQuestion(self) -> None:
self._reps += 1
self.state = "question"
2020-02-27 04:11:21 +01:00
self.typedAnswer: str = None
c = self.card
# grab the question and play audio
2021-06-27 04:12:23 +02:00
q = c.question()
# play audio?
2020-04-13 01:04:30 +02:00
if c.autoplay():
self.web.setPlaybackRequiresGesture(False)
sounds = c.question_av_tags()
gui_hooks.reviewer_will_play_question_sounds(c, sounds)
else:
self.web.setPlaybackRequiresGesture(True)
sounds = []
gui_hooks.reviewer_will_play_question_sounds(c, sounds)
gui_hooks.av_player_will_play_tags(sounds, self.state, self)
av_player.play_tags(sounds)
# render & update bottom
q = self._mungeQA(q)
q = gui_hooks.card_will_show(q, c, "reviewQuestion")
self._run_state_mutation_hook()
bodyclass = theme_manager.body_classes_for_card_ord(c.ord)
a = self.mw.col.media.escape_media_filenames(c.answer())
self.web.eval(
f"_showQuestion({json.dumps(q)}, {json.dumps(a)}, '{bodyclass}');"
)
self._update_flag_icon()
self._update_mark_icon()
self._showAnswerButton()
self.mw.web.setFocus()
# user hook
gui_hooks.reviewer_did_show_question(c)
self._auto_advance_to_answer_if_enabled()
def _auto_advance_to_answer_if_enabled(self) -> None:
if self.auto_advance_enabled:
conf = self.mw.col.decks.config_dict_for_deck_id(
self.card.current_deck_id()
)
timer = None
if conf["secondsToShowQuestion"]:
timer = self._show_answer_timer = self.mw.progress.timer(
int(conf["secondsToShowQuestion"] * 1000),
lambda: self._on_show_answer_timeout(timer),
repeat=False,
parent=self.mw,
)
def _on_show_answer_timeout(self, timer: QTimer | None = None) -> None:
if self.card is None:
return
conf = self.mw.col.decks.config_dict_for_deck_id(self.card.current_deck_id())
if (conf["waitForAudio"] and av_player.current_player) or (
timer and self._show_answer_timer != timer
):
return
if self._show_answer_timer is not None:
self._show_answer_timer.deleteLater()
if not self.auto_advance_enabled:
return
self._showAnswer()
2020-02-27 04:11:21 +01:00
def autoplay(self, card: Card) -> bool:
2020-04-13 01:04:30 +02:00
print("use card.autoplay() instead of reviewer.autoplay(card)")
return card.autoplay()
def _update_flag_icon(self) -> None:
self.web.eval(f"_drawFlag({self.card.user_flag()});")
def _update_mark_icon(self) -> None:
2021-03-18 03:06:45 +01:00
self.web.eval(f"_drawMark({json.dumps(self.card.note().has_tag(MARKED_TAG))});")
_drawMark = _update_mark_icon
_drawFlag = _update_flag_icon
# Showing the answer
##########################################################################
def _showAnswer(self) -> None:
if self.mw.state != "review":
# showing resetRequired screen; ignore space
return
self.state = "answer"
c = self.card
2021-06-27 04:12:23 +02:00
a = c.answer()
# play audio?
2020-04-13 01:04:30 +02:00
if c.autoplay():
sounds = c.answer_av_tags()
gui_hooks.reviewer_will_play_answer_sounds(c, sounds)
else:
sounds = []
gui_hooks.reviewer_will_play_answer_sounds(c, sounds)
gui_hooks.av_player_will_play_tags(sounds, self.state, self)
av_player.play_tags(sounds)
2017-08-07 08:15:15 +02:00
a = self._mungeQA(a)
a = gui_hooks.card_will_show(a, c, "reviewAnswer")
# render and update bottom
self.web.eval(f"_showAnswer({json.dumps(a)});")
self._showEaseButtons()
self.mw.web.setFocus()
# user hook
gui_hooks.reviewer_did_show_answer(c)
self._auto_advance_to_question_if_enabled()
def _auto_advance_to_question_if_enabled(self) -> None:
if self.auto_advance_enabled:
conf = self.mw.col.decks.config_dict_for_deck_id(
self.card.current_deck_id()
)
timer = None
if conf["secondsToShowAnswer"]:
timer = self._show_question_timer = self.mw.progress.timer(
int(conf["secondsToShowAnswer"] * 1000),
lambda: self._on_show_question_timeout(timer),
repeat=False,
parent=self.mw,
)
def _on_show_question_timeout(self, timer: QTimer | None = None) -> None:
if self.card is None:
return
conf = self.mw.col.decks.config_dict_for_deck_id(self.card.current_deck_id())
if (conf["waitForAudio"] and av_player.current_player) or (
timer and self._show_question_timer != timer
):
return
if self._show_question_timer is not None:
self._show_question_timer.deleteLater()
if not self.auto_advance_enabled:
return
try:
answer_action = list(AnswerAction)[conf["answerAction"]]
except IndexError:
answer_action = AnswerAction.ANSWER_GOOD
if answer_action == AnswerAction.BURY_CARD:
self.bury_current_card()
elif answer_action == AnswerAction.ANSWER_AGAIN:
self._answerCard(1)
elif answer_action == AnswerAction.ANSWER_HARD:
self._answerCard(2)
elif answer_action == AnswerAction.SHOW_REMINDER:
tooltip(tr.studying_answer_time_elapsed())
else:
self._answerCard(3)
# Answering a card
############################################################
2021-05-19 08:05:12 +02:00
def _answerCard(self, ease: Literal[1, 2, 3, 4]) -> None:
"Reschedule card and show next."
if self.mw.state != "review":
# showing resetRequired screen; ignore key
return
if self.state != "answer":
return
proceed, ease = gui_hooks.reviewer_will_answer_card(
(True, ease), self, self.card
)
if not proceed:
return
sched = cast(V3Scheduler, self.mw.col.sched)
answer = sched.build_answer(
card=self.card,
states=self._v3.states,
rating=self._v3.rating_from_ease(ease),
)
def after_answer(changes: OpChanges) -> None:
if gui_hooks.reviewer_did_answer_card.count() > 0:
self.card.load()
self._after_answering(ease)
if sched.state_is_leech(answer.new_state):
self.onLeech()
self.state = "transition"
answer_card(parent=self.mw, answer=answer).success(
after_answer
).run_in_background(initiator=self)
2021-05-19 08:05:12 +02:00
def _after_answering(self, ease: Literal[1, 2, 3, 4]) -> None:
gui_hooks.reviewer_did_answer_card(self, self.card, ease)
self._answeredIds.append(self.card.id)
if not self.check_timebox():
self.nextCard()
# Handlers
############################################################
def korean_shortcuts(
self,
) -> Sequence[Union[tuple[str, Callable], tuple[Qt.Key, Callable]]]:
return [
("", self.mw.onEditCurrent),
("", self.showContextMenu),
("", self.replayAudio),
("Ctrl+Alt+ㅜ", self.forget_current_card),
# does not work
# ("Ctrl+Alt+ㄷ", self.on_create_copy),
# does not work
# ("Ctrl+Shift+ㅇ", self.on_set_due),
("", self.onReplayRecorded),
("Shift+ㅍ", self.onRecordVoice),
("", self.onOptions),
("", self.on_card_info),
("Ctrl+Alt+ㅑ", self.on_previous_card_info),
("", self.mw.undo),
]
2020-02-27 04:11:21 +01:00
def _shortcutKeys(
self,
) -> Sequence[Union[tuple[str, Callable], tuple[Qt.Key, Callable]]]:
return [
("e", self.mw.onEditCurrent),
(" ", self.onEnterKey),
(Qt.Key.Key_Return, self.onEnterKey),
(Qt.Key.Key_Enter, self.onEnterKey),
2020-08-23 16:46:19 +02:00
("m", self.showContextMenu),
("r", self.replayAudio),
(Qt.Key.Key_F5, self.replayAudio),
*(
(f"Ctrl+{flag.index}", self.set_flag_func(flag.index))
for flag in self.mw.flags.all()
),
("*", self.toggle_mark_on_current_note),
2021-03-04 12:40:59 +01:00
("=", self.bury_current_note),
("-", self.bury_current_card),
("!", self.suspend_current_note),
("@", self.suspend_current_card),
("Ctrl+Alt+N", self.forget_current_card),
("Ctrl+Alt+E", self.on_create_copy),
("Ctrl+Backspace" if is_mac else "Ctrl+Delete", self.delete_current_note),
("Ctrl+Shift+D", self.on_set_due),
("v", self.onReplayRecorded),
("Shift+v", self.onRecordVoice),
("o", self.onOptions),
("i", self.on_card_info),
("Ctrl+Alt+i", self.on_previous_card_info),
*(
(key, functools.partial(self._answerCard, ease))
for ease in aqt.mw.pm.default_answer_keys
if (key := aqt.mw.pm.get_answer_key(ease))
),
("u", self.mw.undo),
("5", self.on_pause_audio),
("6", self.on_seek_backward),
("7", self.on_seek_forward),
("Shift+A", self.toggle_auto_advance),
*self.korean_shortcuts(),
]
2020-02-27 04:11:21 +01:00
def on_pause_audio(self) -> None:
av_player.toggle_pause()
gui_hooks.audio_did_pause_or_unpause(self.web)
seek_secs = 5
2020-02-27 04:11:21 +01:00
def on_seek_backward(self) -> None:
av_player.seek_relative(-self.seek_secs)
gui_hooks.audio_did_seek_relative(self.web, -self.seek_secs)
2020-02-27 04:11:21 +01:00
def on_seek_forward(self) -> None:
av_player.seek_relative(self.seek_secs)
gui_hooks.audio_did_seek_relative(self.web, self.seek_secs)
2020-02-27 04:11:21 +01:00
def onEnterKey(self) -> None:
if self.state == "question":
self._getTypedAnswer()
elif self.state == "answer" and aqt.mw.pm.spacebar_rates_card():
2019-12-23 01:34:10 +01:00
self.bottom.web.evalWithCallback(
"selectedAnswerButton()", self._onAnswerButton
)
2020-02-27 04:11:21 +01:00
def _onAnswerButton(self, val: str) -> None:
# button selected?
if val and val in "1234":
2021-05-19 08:05:12 +02:00
val2: Literal[1, 2, 3, 4] = int(val) # type: ignore
self._answerCard(val2)
else:
self._answerCard(self._defaultEase())
2020-02-27 04:11:21 +01:00
def _linkHandler(self, url: str) -> None:
if url == "ans":
2016-07-05 05:14:45 +02:00
self._getTypedAnswer()
elif url.startswith("ease"):
2021-05-19 08:05:12 +02:00
val: Literal[1, 2, 3, 4] = int(url[4:]) # type: ignore
self._answerCard(val)
elif url == "edit":
self.mw.onEditCurrent()
elif url == "more":
self.showContextMenu()
2020-01-21 05:47:03 +01:00
elif url.startswith("play:"):
play_clicked_audio(url, self.card)
Auto-hide toolbar in Reviewer (#2262) * Give webviews a slide-in animation if reduced motion isn't set. * Auto-hide toolbar in review mode moving the mouse above the main webview expands the toolbar. When the mouse leaves the toolbar, it will collapse after a delay of 2s. * Save some space on bottom toolbars * Use props for all hard-coded transition durations and decrease most commonly used duration (200ms) to 150ms. * Move auto-hide logic into ToolbarWebView and handle auto-hide specific events in the respective webview subclasses. * Fix typing issues * Fix flickering issue * Add auto_hide_toolbar opt-in to preferences * Rename hide_toolbar to collapse_toolbar to better describe the dock-like behaviour. * Rename setting to minimize_distractions * Reduce calls to pm in eventFilter * Run formatter * Revert setting title to something more specific * Increase default animation time to 180ms * Inset toolbar in review mode when auto-hide is not enabled. * Use card background on toolbar and add glass effect * Use flatten/elevate over inset/outset * Use flatten/elevate over inset/outset * Update toolbar.py * Fix toolbar background delay * Tweak styles * Use "collapse" instead of "auto-hide" * Fix background misalignment in collapse mode * Do not collapse toolbar when pointer is outside MainWebView * Reduce hide_timer interval to 1000ms * Use CSS to hide toolbar instead of setting webview height * Add guard to prevent backdrop-filter: blur on Qt 5.14 * Apply transition to body instead of toolbar to not complicate things for #2301. * Fix Qt 5.14 and apply guard globally * Fix background image scaling difference * Tweak preference wording (dae)
2023-01-09 05:39:31 +01:00
elif url.startswith("updateToolbar"):
self.mw.toolbarWeb.update_background_image()
elif url == "statesMutated":
self._states_mutated = True
else:
print("unrecognized anki link:", url)
# Type in the answer
##########################################################################
2019-03-04 08:03:43 +01:00
typeAnsPat = r"\[\[type:(.+?)\]\]"
2020-02-27 04:11:21 +01:00
def typeAnsFilter(self, buf: str) -> str:
if self.state == "question":
return self.typeAnsQuestionFilter(buf)
else:
return self.typeAnsAnswerFilter(buf)
2020-02-27 04:11:21 +01:00
def typeAnsQuestionFilter(self, buf: str) -> str:
self.typeCorrect = None
clozeIdx = None
m = re.search(self.typeAnsPat, buf)
if not m:
return buf
fld = m.group(1)
# if it's a cloze, extract data
if fld.startswith("cloze:"):
# get field and cloze position
clozeIdx = self.card.ord + 1
fld = fld.split(":")[1]
# loop through fields for a match
2021-06-27 04:12:23 +02:00
for f in self.card.note_type()["flds"]:
2019-12-23 01:34:10 +01:00
if f["name"] == fld:
self.typeCorrect = self.card.note()[f["name"]]
if clozeIdx:
# narrow to cloze
2019-12-23 01:34:10 +01:00
self.typeCorrect = self._contentForCloze(self.typeCorrect, clozeIdx)
self.typeFont = f["font"]
self.typeSize = f["size"]
break
if not self.typeCorrect:
if self.typeCorrect is None:
if clozeIdx:
2021-03-26 04:48:26 +01:00
warn = tr.studying_please_run_toolsempty_cards()
else:
warn = tr.studying_type_answer_unknown_field(val=fld)
return re.sub(self.typeAnsPat, warn, buf)
else:
# empty field, remove type answer pattern
return re.sub(self.typeAnsPat, "", buf)
2019-12-23 01:34:10 +01:00
return re.sub(
self.typeAnsPat,
f"""
<center>
<input type=text id=typeans onkeypress="_typeAnsPress();"
style="font-family: '{self.typeFont}'; font-size: {self.typeSize}px;">
</center>
""",
2019-12-23 01:34:10 +01:00
buf,
)
2020-02-27 04:11:21 +01:00
def typeAnsAnswerFilter(self, buf: str) -> str:
if not self.typeCorrect:
return re.sub(self.typeAnsPat, "", buf)
origSize = len(buf)
buf = buf.replace("<hr id=answer>", "")
hadHR = len(buf) != origSize
expected = self.typeCorrect
provided = self.typedAnswer
output = self.mw.col.compare_answer(expected, provided)
# and update the type answer area
2021-02-01 14:28:21 +01:00
def repl(match: Match) -> str:
# can't pass a string in directly, and can't use re.escape as it
# escapes too much
s = """
<div style="font-family: '{}'; font-size: {}px">{}</div>""".format(
2019-12-23 01:34:10 +01:00
self.typeFont,
self.typeSize,
output,
2019-12-23 01:34:10 +01:00
)
if hadHR:
# a hack to ensure the q/a separator falls before the answer
# comparison when user is using {{FrontSide}}
s = f"<hr id=answer>{s}"
return s
2019-12-23 01:34:10 +01:00
return re.sub(self.typeAnsPat, repl, buf)
def _contentForCloze(self, txt: str, idx: int) -> str | None:
return self.mw.col.extract_cloze_for_typing(txt, idx) or None
2020-02-27 04:11:21 +01:00
def _getTypedAnswer(self) -> None:
2021-07-12 15:00:36 +02:00
self.web.evalWithCallback("getTypedAnswer();", self._onTypedAnswer)
2016-07-05 05:14:45 +02:00
2020-02-27 04:11:21 +01:00
def _onTypedAnswer(self, val: None) -> None:
self.typedAnswer = val or ""
2016-07-05 05:14:45 +02:00
self._showAnswer()
# Bottom bar
##########################################################################
2020-02-27 04:11:21 +01:00
def _bottomHTML(self) -> str:
return """
2016-06-07 06:27:33 +02:00
<center id=outer>
<table id=innertable width=100%% cellspacing=0 cellpadding=0>
<tr>
<td align=start valign=top class=stat>
<button title="%(editkey)s" onclick="pycmd('edit');">%(edit)s</button></td>
<td align=center valign=top id=middle>
</td>
<td align=end valign=top class=stat>
<button title="%(morekey)s" onclick="pycmd('more');">
%(more)s %(downArrow)s
<span id=time class=stattxt></span>
</button>
</td>
</tr>
</table>
2016-06-07 06:27:33 +02:00
</center>
<script>
time = %(time)d;
timerStopped = false;
</script>
2019-12-23 01:34:10 +01:00
""" % dict(
2021-03-26 04:48:26 +01:00
edit=tr.studying_edit(),
editkey=tr.actions_shortcut_key(val="E"),
2021-03-26 04:48:26 +01:00
more=tr.studying_more(),
morekey=tr.actions_shortcut_key(val="M"),
2019-12-23 01:34:10 +01:00
downArrow=downArrow(),
2021-06-27 04:12:23 +02:00
time=self.card.time_taken() // 1000,
2019-12-23 01:34:10 +01:00
)
2020-02-27 04:11:21 +01:00
def _showAnswerButton(self) -> None:
2019-12-23 01:34:10 +01:00
middle = """
<button title="{}" id="ansbut" onclick='pycmd("ans");'>{}<span class=stattxt>{}</span></button>""".format(
tr.actions_shortcut_key(val=tr.studying_space()),
2021-03-26 04:48:26 +01:00
tr.studying_show_answer(),
self._remaining(),
2019-12-23 01:34:10 +01:00
)
# wrap it in a table so it has the same top margin as the ease buttons
2019-12-23 01:34:10 +01:00
middle = (
"<table cellpadding=0><tr><td class=stat2 align=center>%s</td></tr></table>"
% middle
)
2021-06-27 04:12:23 +02:00
if self.card.should_show_timer():
maxTime = self.card.time_limit() / 1000
else:
maxTime = 0
2019-12-23 01:34:10 +01:00
self.bottom.web.eval("showQuestion(%s,%d);" % (json.dumps(middle), maxTime))
2020-02-27 04:11:21 +01:00
def _showEaseButtons(self) -> None:
if not self._states_mutated:
self.mw.progress.single_shot(50, self._showEaseButtons)
return
middle = self._answerButtons()
conf = self.mw.col.decks.config_dict_for_deck_id(self.card.current_deck_id())
self.bottom.web.eval(
f"showAnswer({json.dumps(middle)}, {json.dumps(conf['stopTimerOnAnswer'])});"
)
2020-02-27 04:11:21 +01:00
def _remaining(self) -> str:
2019-12-23 01:34:10 +01:00
if not self.mw.col.conf["dueCounts"]:
return ""
counts: list[Union[int, str]]
2023-09-24 06:19:25 +02:00
idx, counts_ = self._v3.counts()
counts = cast(list[Union[int, str]], counts_)
counts[idx] = f"<u>{counts[idx]}</u>"
return f"""
<span class=new-count>{counts[0]}</span> +
<span class=learn-count>{counts[1]}</span> +
<span class=review-count>{counts[2]}</span>
"""
2021-05-19 08:05:12 +02:00
def _defaultEase(self) -> Literal[2, 3]:
2023-09-24 06:19:25 +02:00
return 3
def _answerButtonList(self) -> tuple[tuple[int, str], ...]:
button_count = self.mw.col.sched.answerButtons(self.card)
if button_count == 2:
buttons_tuple: tuple[tuple[int, str], ...] = (
2021-03-26 04:48:26 +01:00
(1, tr.studying_again()),
(2, tr.studying_good()),
2020-08-21 04:34:44 +02:00
)
elif button_count == 3:
buttons_tuple = (
2021-03-26 04:48:26 +01:00
(1, tr.studying_again()),
(2, tr.studying_good()),
(3, tr.studying_easy()),
)
else:
2020-08-21 04:34:44 +02:00
buttons_tuple = (
2021-03-26 04:48:26 +01:00
(1, tr.studying_again()),
(2, tr.studying_hard()),
(3, tr.studying_good()),
(4, tr.studying_easy()),
2020-08-21 04:34:44 +02:00
)
buttons_tuple = gui_hooks.reviewer_will_init_answer_buttons(
buttons_tuple, self, self.card
)
return buttons_tuple
2020-02-27 04:11:21 +01:00
def _answerButtons(self) -> str:
default = self._defaultEase()
2019-12-23 01:34:10 +01:00
assert isinstance(self.mw.col.sched, V3Scheduler)
labels = self.mw.col.sched.describe_next_states(self._v3.states)
def but(i: int, label: str) -> str:
if i == default:
extra = """id="defease" """
else:
extra = ""
due = self._buttonTime(i, v3_labels=labels)
key = (
tr.actions_shortcut_key(val=aqt.mw.pm.get_answer_key(i))
if aqt.mw.pm.get_answer_key(i)
else ""
)
2019-12-23 01:34:10 +01:00
return """
<td align=center><button %s title="%s" data-ease="%s" onclick='pycmd("ease%d");'>\
%s%s</button></td>""" % (
2019-12-23 01:34:10 +01:00
extra,
key,
2019-12-23 01:34:10 +01:00
i,
i,
label,
due,
2019-12-23 01:34:10 +01:00
)
2022-11-24 11:18:57 +01:00
buf = "<center><table cellpadding=0 cellspacing=0><tr>"
for ease, label in self._answerButtonList():
buf += but(ease, label)
buf += "</tr></table>"
return buf
2023-09-24 06:19:25 +02:00
def _buttonTime(self, i: int, v3_labels: Sequence[str]) -> str:
2022-11-23 07:35:23 +01:00
if self.mw.col.conf["estTimes"]:
2023-09-24 06:19:25 +02:00
txt = v3_labels[i - 1]
2022-11-23 07:35:23 +01:00
return f"""<span class="nobold">{txt}</span>"""
else:
2022-11-23 07:35:23 +01:00
return ""
# Leeches
##########################################################################
def onLeech(self, card: Card | None = None) -> None:
# for now
2021-03-26 04:48:26 +01:00
s = tr.studying_card_was_a_leech()
# v3 scheduler doesn't report this
if card and card.queue < 0:
2021-03-26 04:48:26 +01:00
s += f" {tr.studying_it_has_been_suspended()}"
tooltip(s)
# Timebox
##########################################################################
def check_timebox(self) -> bool:
"True if answering should be aborted."
elapsed = self.mw.col.timeboxReached()
if elapsed:
assert not isinstance(elapsed, bool)
part1 = tr.studying_card_studied_in(count=elapsed[1])
mins = int(round(elapsed[0] / 60))
part2 = tr.studying_minute(count=mins)
fin = tr.studying_finish()
diag = askUserDialog(f"{part1} {part2}", [tr.studying_continue(), fin])
diag.setIcon(QMessageBox.Icon.Information)
if diag.run() == fin:
self.mw.moveToState("deckBrowser")
return True
self.mw.col.startTimebox()
return False
# Context menu
##########################################################################
# note the shortcuts listed here also need to be defined above
def _contextMenu(self) -> list[Any]:
currentFlag = self.card and self.card.user_flag()
opts = [
2019-12-23 01:34:10 +01:00
[
2021-03-26 04:48:26 +01:00
tr.studying_flag_card(),
2019-12-23 01:34:10 +01:00
[
[
2021-05-19 19:18:49 +02:00
flag.label,
f"Ctrl+{flag.index}",
self.set_flag_func(flag.index),
dict(checked=currentFlag == flag.index),
]
for flag in self.mw.flags.all()
2019-12-23 01:34:10 +01:00
],
],
2021-03-26 04:48:26 +01:00
[tr.studying_bury_card(), "-", self.bury_current_card],
[
tr.actions_with_ellipsis(action=tr.actions_forget_card()),
"Ctrl+Alt+N",
self.forget_current_card,
],
[
tr.actions_with_ellipsis(action=tr.actions_set_due_date()),
"Ctrl+Shift+D",
self.on_set_due,
],
2021-03-26 04:48:26 +01:00
[tr.actions_suspend_card(), "@", self.suspend_current_card],
[tr.actions_options(), "O", self.onOptions],
[tr.actions_card_info(), "I", self.on_card_info],
[tr.actions_previous_card_info(), "Ctrl+Alt+I", self.on_previous_card_info],
None,
[tr.studying_mark_note(), "*", self.toggle_mark_on_current_note],
[tr.studying_bury_note(), "=", self.bury_current_note],
2021-03-26 04:48:26 +01:00
[tr.studying_suspend_note(), "!", self.suspend_current_note],
[
tr.actions_with_ellipsis(action=tr.actions_create_copy()),
"Ctrl+Alt+E",
self.on_create_copy,
],
[
tr.studying_delete_note(),
"Ctrl+Backspace" if is_mac else "Ctrl+Delete",
self.delete_current_note,
],
None,
2021-03-26 04:48:26 +01:00
[tr.actions_replay_audio(), "R", self.replayAudio],
[tr.studying_pause_audio(), "5", self.on_pause_audio],
[tr.studying_audio_5s(), "6", self.on_seek_backward],
[tr.studying_audio_and5s(), "7", self.on_seek_forward],
[tr.studying_record_own_voice(), "Shift+V", self.onRecordVoice],
[tr.studying_replay_own_voice(), "V", self.onReplayRecorded],
[
tr.actions_auto_advance(),
"Shift+A",
self.toggle_auto_advance,
dict(checked=self.auto_advance_enabled),
],
]
return opts
2019-12-23 01:34:10 +01:00
def showContextMenu(self) -> None:
opts = self._contextMenu()
m = QMenu(self.mw)
self._addMenuItems(m, opts)
gui_hooks.reviewer_will_show_context_menu(self, m)
qtMenuShortcutWorkaround(m)
m.popup(QCursor.pos())
def _addMenuItems(self, m: QMenu, rows: Sequence) -> None:
for row in rows:
if not row:
m.addSeparator()
continue
if len(row) == 2:
subm = m.addMenu(row[0])
self._addMenuItems(subm, row[1])
qtMenuShortcutWorkaround(subm)
continue
if len(row) == 4:
label, scut, func, opts = row
else:
label, scut, func = row
opts = {}
a = m.addAction(label)
2017-01-10 09:39:31 +01:00
if scut:
a.setShortcut(QKeySequence(scut))
if opts.get("checked"):
a.setCheckable(True)
a.setChecked(True)
qconnect(a.triggered, func)
2020-02-27 04:11:21 +01:00
def onOptions(self) -> None:
confirm_deck_then_display_options(self.card)
2021-09-08 04:52:33 +02:00
def on_previous_card_info(self) -> None:
self._previous_card_info.toggle()
2021-09-08 04:52:33 +02:00
def on_card_info(self) -> None:
self._card_info.toggle()
2021-03-14 10:54:15 +01:00
def set_flag_on_current_card(self, desired_flag: int) -> None:
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
# need to toggle off?
if self.card.user_flag() == desired_flag:
flag = 0
else:
flag = desired_flag
2021-03-14 10:54:15 +01:00
2021-04-06 06:36:13 +02:00
set_card_flag(parent=self.mw, card_ids=[self.card.id], flag=flag).success(
lambda _: None
).run_in_background()
2021-05-19 19:18:49 +02:00
def set_flag_func(self, desired_flag: int) -> Callable:
return lambda: self.set_flag_on_current_card(desired_flag)
def toggle_mark_on_current_note(self) -> None:
def redraw_mark(out: OpChangesWithCount) -> None:
self.card.load()
self._update_mark_icon()
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
note = self.card.note()
2021-03-18 03:06:45 +01:00
if note.has_tag(MARKED_TAG):
remove_tags_from_notes(
parent=self.mw, note_ids=[note.id], space_separated_tags=MARKED_TAG
2021-04-06 06:36:13 +02:00
).success(redraw_mark).run_in_background(initiator=self)
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
else:
add_tags_to_notes(
parent=self.mw,
note_ids=[note.id],
space_separated_tags=MARKED_TAG,
2021-04-06 06:36:13 +02:00
).success(redraw_mark).run_in_background(initiator=self)
def on_set_due(self) -> None:
if self.mw.state != "review" or not self.card:
return
if op := set_due_date_dialog(
parent=self.mw,
card_ids=[self.card.id],
2021-03-12 05:50:31 +01:00
config_key=Config.String.SET_DUE_REVIEWER,
):
op.run_in_background()
2021-03-04 12:40:59 +01:00
def suspend_current_note(self) -> None:
gui_hooks.reviewer_will_suspend_note(self.card.nid)
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
suspend_note(
parent=self.mw,
note_ids=[self.card.nid],
).success(lambda _: tooltip(tr.studying_note_suspended())).run_in_background()
2013-01-29 01:46:17 +01:00
2021-03-04 12:40:59 +01:00
def suspend_current_card(self) -> None:
gui_hooks.reviewer_will_suspend_card(self.card.id)
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
suspend_cards(
parent=self.mw,
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
card_ids=[self.card.id],
).success(lambda _: tooltip(tr.studying_card_suspended())).run_in_background()
2021-03-04 12:40:59 +01:00
def bury_current_note(self) -> None:
gui_hooks.reviewer_will_bury_note(self.card.nid)
bury_notes(
parent=self.mw,
note_ids=[self.card.nid],
).success(
lambda res: tooltip(tr.studying_cards_buried(count=res.count))
).run_in_background()
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
def bury_current_card(self) -> None:
gui_hooks.reviewer_will_bury_card(self.card.id)
bury_cards(
parent=self.mw,
card_ids=[self.card.id],
).success(
lambda res: tooltip(tr.studying_cards_buried(count=res.count))
).run_in_background()
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
def forget_current_card(self) -> None:
if op := forget_cards(
parent=self.mw,
card_ids=[self.card.id],
context=ScheduleCardsAsNew.Context.REVIEWER,
):
op.run_in_background()
def on_create_copy(self) -> None:
if self.card:
aqt.dialogs.open("AddCards", self.mw).set_note(
self.card.note(), self.card.did
)
def delete_current_note(self) -> None:
# need to check state because the shortcut is global to the main
# window
if self.mw.state != "review" or not self.card:
return
undoable ops now return changes directly; add new *_ops.py files - Introduced a new transact() method that wraps the return value in a separate struct that describes the changes that were made. - Changes are now gathered from the undo log, so we don't need to guess at what was changed - eg if update_note() is called with identical note contents, no changes are returned. Card changes will only be set if cards were actually generated by the update_note() call, and tag will only be set if a new tag was added. - mw.perform_op() has been updated to expect the op to return the changes, or a structure with the changes in it, and it will use them to fire the change hook, instead of fetching the changes from undo_status(), so there is no risk of race conditions. - the various calls to mw.perform_op() have been split into separate files like card_ops.py. Aside from making the code cleaner, this works around a rather annoying issue with mypy. Because we run it with no_strict_optional, mypy is happy to accept an operation that returns None, despite the type signature saying it requires changes to be returned. Turning no_strict_optional on for the whole codebase is not practical at the moment, but we can enable it for individual files. Still todo: - The cursor keeps moving back to the start of a field when typing - we need to ignore the refresh hook when we are the initiator. - The busy cursor icon should probably be delayed a few hundreds ms. - Still need to think about a nicer way of handling saveNow() - op_made_changes(), op_affects_study_queue() might be better embedded as properties in the object instead
2021-03-16 05:26:42 +01:00
remove_notes(parent=self.mw, note_ids=[self.card.nid]).run_in_background()
2020-02-27 04:11:21 +01:00
def onRecordVoice(self) -> None:
2021-02-01 14:28:21 +01:00
def after_record(path: str) -> None:
self._recordedAudio = path
self.onReplayRecorded()
record_audio(self.mw, self.mw, False, after_record)
2020-02-27 04:11:21 +01:00
def onReplayRecorded(self) -> None:
self._recordedAudio = gui_hooks.reviewer_will_replay_recording(
self._recordedAudio
)
if not self._recordedAudio:
2021-03-26 04:48:26 +01:00
tooltip(tr.studying_you_havent_recorded_your_voice_yet())
2020-02-27 04:11:21 +01:00
return
2020-01-20 11:10:38 +01:00
av_player.play_file(self._recordedAudio)
2021-03-04 12:40:59 +01:00
def toggle_auto_advance(self) -> None:
self.auto_advance_enabled = not self.auto_advance_enabled
if self.auto_advance_enabled:
tooltip(tr.actions_auto_advance_activated())
else:
tooltip(tr.actions_auto_advance_deactivated())
self.auto_advance_if_enabled()
def auto_advance_if_enabled(self) -> None:
if self.state == "question":
self._auto_advance_to_answer_if_enabled()
elif self.state == "answer":
self._auto_advance_to_question_if_enabled()
2021-03-04 12:40:59 +01:00
# legacy
onBuryCard = bury_current_card
onBuryNote = bury_current_note
onSuspend = suspend_current_note
onSuspendCard = suspend_current_card
onDelete = delete_current_note
onMark = toggle_mark_on_current_note
setFlag = set_flag_on_current_card
RUN_STATE_MUTATION = """
anki.mutateNextCardStates('{key}', async (states, customData, ctx) => {{ {js} }})
.finally(() => bridgeCommand('statesMutated'));
"""