mirror of
https://github.com/ankitects/anki.git
synced 2025-09-18 22:12:21 -04:00
826cbb0108
Saves having to serialize the note fields and q/a templates, which is particularly a win when rendering question/answer in the browse screen. Also some work towards being able to preview notes without having to commit them to the database.
238 lines
7.4 KiB
Python
238 lines
7.4 KiB
Python
# Copyright: Ankitects Pty Ltd and contributors
|
|
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
"""
|
|
This file contains the Python portion of the template rendering code.
|
|
|
|
Templates can have filters applied to field replacements. The Rust template
|
|
rendering code will apply any built in filters, and stop at the first
|
|
unrecognized filter. The remaining filters are returned to Python,
|
|
and applied using the hook system. For example,
|
|
{{myfilter:hint:text:Field}} will apply the built in text and hint filters,
|
|
and then attempt to apply myfilter. If no add-ons have provided the filter,
|
|
the filter is skipped.
|
|
|
|
Add-ons can register a filter with the following code:
|
|
|
|
from anki import hooks
|
|
hooks.field_filter.append(myfunc)
|
|
|
|
This will call myfunc, passing the field text in as the first argument.
|
|
Your function should decide if it wants to modify the text by checking
|
|
the filter_name argument, and then return the text whether it has been
|
|
modified or not.
|
|
|
|
A Python implementation of the standard filters is currently available in the
|
|
template_legacy.py file, using the legacy addHook() system.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from typing import Any, Dict, List, Optional, Tuple
|
|
|
|
import anki
|
|
from anki import hooks
|
|
from anki.cards import Card
|
|
from anki.decks import DeckManager
|
|
from anki.models import NoteType
|
|
from anki.notes import Note
|
|
from anki.rsbackend import PartiallyRenderedCard, TemplateReplacementList
|
|
from anki.sound import AVTag
|
|
|
|
CARD_BLANK_HELP = (
|
|
"https://anki.tenderapp.com/kb/card-appearance/the-front-of-this-card-is-blank"
|
|
)
|
|
|
|
|
|
class TemplateRenderContext:
|
|
"""Holds information for the duration of one card render.
|
|
|
|
This may fetch information lazily in the future, so please avoid
|
|
using the _private fields directly."""
|
|
|
|
@staticmethod
|
|
def from_existing_card(card: Card, browser: bool) -> TemplateRenderContext:
|
|
return TemplateRenderContext(card.col, card, card.note(), browser)
|
|
|
|
@classmethod
|
|
def from_card_layout(cls, note: Note, card_ord: int) -> TemplateRenderContext:
|
|
card = cls.synthesized_card(note.col, card_ord)
|
|
return TemplateRenderContext(note.col, card, note)
|
|
|
|
@classmethod
|
|
def synthesized_card(cls, col: anki.storage._Collection, ord: int):
|
|
c = Card(col)
|
|
c.ord = ord
|
|
return c
|
|
|
|
def __init__(
|
|
self,
|
|
col: anki.storage._Collection,
|
|
card: Card,
|
|
note: Note,
|
|
browser: bool = False,
|
|
template: Optional[Any] = None,
|
|
) -> None:
|
|
self._col = col.weakref()
|
|
self._card = card
|
|
self._note = note
|
|
self._browser = browser
|
|
self._template = template
|
|
self._note_type = note.model()
|
|
|
|
# if you need to store extra state to share amongst rendering
|
|
# hooks, you can insert it into this dictionary
|
|
self.extra_state: Dict[str, Any] = {}
|
|
|
|
def col(self) -> anki.storage._Collection:
|
|
return self._col
|
|
|
|
# legacy
|
|
def fields(self) -> Dict[str, str]:
|
|
return fields_for_rendering(self.col(), self.card(), self.note())
|
|
|
|
def card(self) -> Card:
|
|
"""Returns the card being rendered.
|
|
|
|
Be careful not to call .q() or .a() on the card, or you'll create an
|
|
infinite loop."""
|
|
return self._card
|
|
|
|
def note(self) -> Note:
|
|
return self._note
|
|
|
|
def note_type(self) -> NoteType:
|
|
return self._note_type
|
|
|
|
# legacy
|
|
def qfmt(self) -> str:
|
|
return templates_for_card(self.card(), self._browser)[0]
|
|
|
|
# legacy
|
|
def afmt(self) -> str:
|
|
return templates_for_card(self.card(), self._browser)[1]
|
|
|
|
def render(self) -> TemplateRenderOutput:
|
|
try:
|
|
partial = self._partially_render()
|
|
except anki.rsbackend.TemplateError as e:
|
|
return TemplateRenderOutput(
|
|
question_text=str(e),
|
|
answer_text=str(e),
|
|
question_av_tags=[],
|
|
answer_av_tags=[],
|
|
)
|
|
|
|
qtext = apply_custom_filters(partial.qnodes, self, front_side=None)
|
|
qtext, q_avtags = self.col().backend.extract_av_tags(qtext, True)
|
|
|
|
atext = apply_custom_filters(partial.anodes, self, front_side=qtext)
|
|
atext, a_avtags = self.col().backend.extract_av_tags(atext, False)
|
|
|
|
output = TemplateRenderOutput(
|
|
question_text=qtext,
|
|
answer_text=atext,
|
|
question_av_tags=q_avtags,
|
|
answer_av_tags=a_avtags,
|
|
css=self.note_type()["css"],
|
|
)
|
|
|
|
if not self._browser:
|
|
hooks.card_did_render(output, self)
|
|
|
|
return output
|
|
|
|
def _partially_render(self) -> PartiallyRenderedCard:
|
|
if self._template:
|
|
# card layout screen
|
|
raise Exception("nyi")
|
|
else:
|
|
# existing card (eg study mode)
|
|
return self._col.backend.render_existing_card(self._card.id, self._browser)
|
|
|
|
|
|
@dataclass
|
|
class TemplateRenderOutput:
|
|
"Stores the rendered templates and extracted AV tags."
|
|
question_text: str
|
|
answer_text: str
|
|
question_av_tags: List[AVTag]
|
|
answer_av_tags: List[AVTag]
|
|
css: str = ""
|
|
|
|
def question_and_style(self) -> str:
|
|
return f"<style>{self.css}</style>{self.question_text}"
|
|
|
|
def answer_and_style(self) -> str:
|
|
return f"<style>{self.css}</style>{self.answer_text}"
|
|
|
|
|
|
# legacy
|
|
def templates_for_card(card: Card, browser: bool) -> Tuple[str, str]:
|
|
template = card.template()
|
|
if browser:
|
|
q, a = template.get("bqfmt"), template.get("bafmt")
|
|
else:
|
|
q, a = None, None
|
|
q = q or template.get("qfmt")
|
|
a = a or template.get("afmt")
|
|
return q, a # type: ignore
|
|
|
|
|
|
# legacy
|
|
def fields_for_rendering(
|
|
col: anki.storage._Collection, card: Card, note: Note
|
|
) -> Dict[str, str]:
|
|
# fields from note
|
|
fields = dict(note.items())
|
|
|
|
# add special fields
|
|
fields["Tags"] = note.stringTags().strip()
|
|
fields["Type"] = card.note_type()["name"]
|
|
fields["Deck"] = col.decks.name(card.odid or card.did)
|
|
fields["Subdeck"] = DeckManager.basename(fields["Deck"])
|
|
fields["Card"] = card.template()["name"]
|
|
flag = card.userFlag()
|
|
fields["CardFlag"] = flag and f"flag{flag}" or ""
|
|
fields["c%d" % (card.ord + 1)] = "1"
|
|
|
|
return fields
|
|
|
|
|
|
def apply_custom_filters(
|
|
rendered: TemplateReplacementList,
|
|
ctx: TemplateRenderContext,
|
|
front_side: Optional[str],
|
|
) -> str:
|
|
"Complete rendering by applying any pending custom filters."
|
|
# template already fully rendered?
|
|
if len(rendered) == 1 and isinstance(rendered[0], str):
|
|
return rendered[0]
|
|
|
|
res = ""
|
|
for node in rendered:
|
|
if isinstance(node, str):
|
|
res += node
|
|
else:
|
|
# do we need to inject in FrontSide?
|
|
if node.field_name == "FrontSide" and front_side is not None:
|
|
node.current_text = front_side
|
|
|
|
field_text = node.current_text
|
|
for filter_name in node.filters:
|
|
field_text = hooks.field_filter(
|
|
field_text, node.field_name, filter_name, ctx
|
|
)
|
|
# legacy hook - the second and fifth argument are no longer used.
|
|
field_text = anki.hooks.runFilter(
|
|
"fmod_" + filter_name,
|
|
field_text,
|
|
"",
|
|
ctx.fields(),
|
|
node.field_name,
|
|
"",
|
|
)
|
|
|
|
res += field_text
|
|
return res
|