-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
note_model_template.py
196 lines (163 loc) · 8.43 KB
/
note_model_template.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
import os
from dataclasses import dataclass, field
from typing import Optional, Union, Set
from brain_brew.configuration.anki_field import AnkiField
from brain_brew.configuration.representation_base import RepresentationBase
from brain_brew.interfaces.yamale_verifyable import YamlRepr
from brain_brew.representation.generic.html_file import HTMLFile
from brain_brew.representation.yaml.yaml_object import YamlObject
from brain_brew.utils import find_media_in_field, split_by_regex
NAME = AnkiField("name")
ORDINAL = AnkiField("ord", "ordinal")
QUESTION_FORMAT = AnkiField("qfmt", "question_format")
ANSWER_FORMAT = AnkiField("afmt", "answer_format")
BROWSER_ANSWER_FORMAT = AnkiField("bafmt", "browser_answer_format", default_value="")
BROWSER_QUESTION_FORMAT = AnkiField("bqfmt", "browser_question_format", default_value="")
DECK_OVERRIDE_ID = AnkiField("did", "deck_override_id", default_value=None)
BROWSER_FONT = AnkiField("bfont", "browser_font", default_value="")
BROWSER_FONT_SIZE = AnkiField("bsize", "browser_font_size", default_value=0)
SCRATCH_PAD = AnkiField("scratchPad", "scratch_pad", default_value=0)
HTML_FILE = AnkiField("html_file")
BROWSER_HTML_FILE = AnkiField("browser_html_file", default_value=None)
html_separator_regex = r'[\n]{1,}[-]{1,}[\n]{1,}'
@dataclass
class Template(RepresentationBase, YamlObject, YamlRepr):
@classmethod
def task_name(cls) -> str:
return r'note_model_template_from_html'
@classmethod
def yamale_schema(cls) -> str:
return f"""\
name: str()
html_file: str()
browser_html_file: str(required=False)
deck_override_id: int(required=False)
"""
@dataclass
class HTML(RepresentationBase):
name: str
html_file: str
browser_html_file: Optional[str] = field(default=None)
browser_font: str = field(default=BROWSER_FONT.default_value)
browser_font_size: int = field(default=BROWSER_FONT_SIZE.default_value)
deck_override_id: Optional[int] = field(default=DECK_OVERRIDE_ID.default_value)
scratch_pad: int = field(default=SCRATCH_PAD.default_value)
@classmethod
def from_repr(cls, data: Union[HTML, dict]):
rep: cls.HTML = data if isinstance(data, cls.HTML) else cls.HTML.from_dict(data)
return cls.from_html_files(rep)
@classmethod
def from_yaml_file(cls, filename: str) -> 'Template':
return cls.from_dict(cls.read_to_dict(filename))
@dataclass
class CrowdAnki(RepresentationBase):
name: str
qfmt: str
afmt: str
bqfmt: str = field(default=BROWSER_QUESTION_FORMAT.default_value)
bafmt: str = field(default=BROWSER_ANSWER_FORMAT.default_value)
bfont: str = field(default=BROWSER_FONT.default_value)
bsize: int = field(default=BROWSER_FONT_SIZE.default_value)
ord: int = field(default=None)
did: Optional[int] = field(default=None)
scratchPad: int = field(default=SCRATCH_PAD.default_value)
name: str
question_format: str
answer_format: str
question_format_in_browser: str = field(default=BROWSER_QUESTION_FORMAT.default_value)
answer_format_in_browser: str = field(default=BROWSER_ANSWER_FORMAT.default_value)
browser_font: str = field(default=BROWSER_FONT.default_value)
browser_font_size: int = field(default=BROWSER_FONT_SIZE.default_value)
deck_override_id: Optional[int] = field(default=DECK_OVERRIDE_ID.default_value)
scratch_pad: int = field(default=SCRATCH_PAD.default_value)
html_file: Optional[str] = field(default="")
browser_html_file: Optional[str] = field(default="")
@classmethod
def from_html_files(cls, data: Union[HTML, dict]):
html_rep: cls.HTML = data if isinstance(data, cls.HTML) else cls.HTML.from_dict(data)
html_file = HTMLFile.create_or_get(html_rep.html_file)
browser_html_file = HTMLFile.create_or_get(html_rep.browser_html_file) if html_rep.browser_html_file else None
main_data = html_file.get_data(deep_copy=True)
browser_data = browser_html_file.get_data(deep_copy=True) if browser_html_file else None
def split_template(the_data, file):
split = split_by_regex(the_data, html_separator_regex)
if len(split) != 2:
raise ValueError(f"Cannot find" if len(split) < 2 else "More than one"
f" separator '---' in html file '{file.file_location}'")
return split[0], split[1]
front, back = split_template(main_data, html_file)
browser_front, browser_back = split_template(browser_data, browser_html_file) if browser_data else ("", "")
return cls(
name=html_rep.name,
question_format=front,
answer_format=back,
question_format_in_browser=browser_front,
answer_format_in_browser=browser_back,
deck_override_id=html_rep.deck_override_id,
html_file=html_rep.html_file,
browser_html_file=html_rep.browser_html_file,
browser_font=html_rep.browser_font,
browser_font_size=html_rep.browser_font_size,
scratch_pad=html_rep.scratch_pad,
)
@classmethod
def from_crowdanki(cls, data: Union[CrowdAnki, dict]):
ca: cls.CrowdAnki = data if isinstance(data, cls.CrowdAnki) else cls.CrowdAnki.from_dict(data)
return cls(
name=ca.name, question_format=ca.qfmt, answer_format=ca.afmt,
question_format_in_browser=ca.bqfmt, answer_format_in_browser=ca.bafmt,
deck_override_id=ca.did, browser_font=ca.bfont, browser_font_size=ca.bsize, scratch_pad=ca.scratchPad,
)
def encode_as_part(self):
data_dict = {
NAME.name: self.name,
HTML_FILE.name: ""
}
if self.has_browser_template():
data_dict.setdefault(BROWSER_HTML_FILE.name, "")
DECK_OVERRIDE_ID.append_name_if_differs(data_dict, self.deck_override_id)
BROWSER_FONT.append_name_if_differs(data_dict, self.browser_font)
BROWSER_FONT_SIZE.append_name_if_differs(data_dict, self.browser_font_size)
SCRATCH_PAD.append_name_if_differs(data_dict, self.scratch_pad)
return data_dict
def encode_as_crowdanki(self, ordinal: int) -> dict:
data_dict = {
ANSWER_FORMAT.anki_name: self.answer_format,
BROWSER_ANSWER_FORMAT.anki_name: self.answer_format_in_browser,
BROWSER_FONT.anki_name: self.browser_font,
BROWSER_QUESTION_FORMAT.anki_name: self.question_format_in_browser,
BROWSER_FONT_SIZE.anki_name: self.browser_font_size,
DECK_OVERRIDE_ID.anki_name: self.deck_override_id,
NAME.anki_name: self.name,
ORDINAL.anki_name: ordinal,
QUESTION_FORMAT.anki_name: self.question_format,
SCRATCH_PAD.anki_name: self.scratch_pad,
}
return data_dict
def encode(self) -> dict:
data_dict = {
NAME.name: self.name,
QUESTION_FORMAT.name: self.question_format,
ANSWER_FORMAT.name: self.answer_format
}
BROWSER_QUESTION_FORMAT.append_name_if_differs(data_dict, self.question_format_in_browser)
BROWSER_ANSWER_FORMAT.append_name_if_differs(data_dict, self.answer_format_in_browser)
DECK_OVERRIDE_ID.append_name_if_differs(data_dict, self.deck_override_id)
BROWSER_FONT.append_name_if_differs(data_dict, self.browser_font)
BROWSER_FONT_SIZE.append_name_if_differs(data_dict, self.browser_font_size)
SCRATCH_PAD.append_name_if_differs(data_dict, self.scratch_pad)
return data_dict
def get_all_media_references(self) -> Set[str]:
all_media = set() \
.union(find_media_in_field(self.question_format)) \
.union(find_media_in_field(self.answer_format)) \
.union(find_media_in_field(self.question_format_in_browser)) \
.union(find_media_in_field(self.answer_format_in_browser))
return all_media
def has_browser_template(self):
return BROWSER_QUESTION_FORMAT.does_differ(self.question_format_in_browser) \
or BROWSER_ANSWER_FORMAT.does_differ(self.answer_format_in_browser)
def get_template_files_data(self):
template = f"{self.question_format}\n\n--\n\n{self.answer_format}"
browser_template = f"{self.question_format}\n\n--\n\n{self.answer_format}" if self.has_browser_template() else None
return template, browser_template