GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-12-16 00:00:59 -05:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

move generated methods into separate, gitignored file

Browse source
This commit is contained in:
Damien Elmes 2020-05-24 20:34:17 +10:00
parent c8d13209cd
commit 015de0c51f
5 changed files with 41 additions and 510 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
pylib/.gitignore vendored
View file

@ -12,6 +12,7 @@ __pycache__
anki.egg-info
anki/backend_pb2.*
anki/fluent_pb2.*
anki/rsbackend_gen.py
anki/buildhash.py
build
dist

2
pylib/.isort.cfg
View file

@ -1,5 +1,5 @@
[settings]
skip=aqt/forms,backend_pb2.py,backend_pb2.pyi,fluent_pb2.py,fluent_pb2.pyi
skip=aqt/forms,backend_pb2.py,backend_pb2.pyi,fluent_pb2.py,fluent_pb2.pyi,rsbackend_gen.py
multi_line_output=3
include_trailing_comma=True
force_grid_wrap=0

4
pylib/Makefile
View file

@ -23,7 +23,7 @@ endif
.DELETE_ON_ERROR:
.SUFFIXES:
BLACKARGS := -t py36 anki tests setup.py tools/*.py --exclude='_pb2|buildinfo'
BLACKARGS := -t py36 anki tests setup.py tools/*.py --exclude='_pb2|buildinfo|_gen'
ISORTARGS := anki tests setup.py
$(shell mkdir -p .build ../dist)
@ -46,7 +46,7 @@ PROTODEPS := ../proto/backend.proto ../proto/fluent.proto
perl -i'' -pe 's/from fluent_pb2/from anki.fluent_pb2/' anki/backend_pb2.pyi
perl -i'' -pe 's/import fluent_pb2/import anki.fluent_pb2/' anki/backend_pb2.py
python tools/genbackend.py
python -m black -t py36 anki/rsbackend.py
python -m black -t py36 anki/rsbackend_gen.py
@touch $@
.build/hooks: tools/genhooks.py tools/hookslib.py

505
pylib/anki/rsbackend.py
View file

@ -27,6 +27,14 @@ from anki.dbproxy import ValueForDB
from anki.fluent_pb2 import FluentString as TR
from anki.types import assert_impossible_literal
try:
from anki.rsbackend_gen import RustBackendGenerated
except ImportError:
# will fail during initial setup
class RustBackendGenerated: # type: ignore
pass
assert ankirspy.buildhash() == anki.buildinfo.buildhash
SchedTimingToday = pb.SchedTimingTodayOut
@ -164,7 +172,7 @@ def _on_progress(progress_bytes: bytes) -> bool:
return hooks.bg_thread_progress_callback(True, native_progress)
class RustBackend:
class RustBackend(RustBackendGenerated):
def __init__(
self,
ftl_folder: Optional[str] = None,
@ -228,501 +236,6 @@ class RustBackend:
err.ParseFromString(err_bytes)
raise proto_exception_to_native(err)
# The code in this section is automatically generated - any edits you make
# will be lost.
# @@AUTOGEN@@
def extract_av_tags(self, *, text: str, question_side: bool) -> pb.ExtractAVTagsOut:
input = pb.ExtractAVTagsIn(text=text, question_side=question_side)
output = pb.ExtractAVTagsOut()
output.ParseFromString(self._run_command(1, input))
return output
def extract_latex(
self, *, text: str, svg: bool, expand_clozes: bool
) -> pb.ExtractLatexOut:
input = pb.ExtractLatexIn(text=text, svg=svg, expand_clozes=expand_clozes)
output = pb.ExtractLatexOut()
output.ParseFromString(self._run_command(2, input))
return output
def get_empty_cards(self) -> pb.EmptyCardsReport:
input = pb.Empty()
output = pb.EmptyCardsReport()
output.ParseFromString(self._run_command(3, input))
return output
def render_existing_card(self, *, card_id: int, browser: bool) -> pb.RenderCardOut:
input = pb.RenderExistingCardIn(card_id=card_id, browser=browser)
output = pb.RenderCardOut()
output.ParseFromString(self._run_command(4, input))
return output
def render_uncommitted_card(
self, *, note: pb.Note, card_ord: int, template: bytes, fill_empty: bool
) -> pb.RenderCardOut:
input = pb.RenderUncommittedCardIn(
note=note, card_ord=card_ord, template=template, fill_empty=fill_empty
)
output = pb.RenderCardOut()
output.ParseFromString(self._run_command(5, input))
return output
def strip_av_tags(self, val: str) -> str:
input = pb.String(val=val)
output = pb.String()
output.ParseFromString(self._run_command(6, input))
return output.val
def search_cards(self, *, search: str, order: pb.SortOrder) -> Sequence[int]:
input = pb.SearchCardsIn(search=search, order=order)
output = pb.SearchCardsOut()
output.ParseFromString(self._run_command(7, input))
return output.card_ids
def search_notes(self, search: str) -> Sequence[int]:
input = pb.SearchNotesIn(search=search)
output = pb.SearchNotesOut()
output.ParseFromString(self._run_command(8, input))
return output.note_ids
def find_and_replace(
self,
*,
nids: Sequence[int],
search: str,
replacement: str,
regex: bool,
match_case: bool,
field_name: str,
) -> int:
input = pb.FindAndReplaceIn(
nids=nids,
search=search,
replacement=replacement,
regex=regex,
match_case=match_case,
field_name=field_name,
)
output = pb.UInt32()
output.ParseFromString(self._run_command(9, input))
return output.val
def local_minutes_west(self, val: int) -> int:
input = pb.Int64(val=val)
output = pb.Int32()
output.ParseFromString(self._run_command(10, input))
return output.val
def set_local_minutes_west(self, val: int) -> pb.Empty:
input = pb.Int32(val=val)
output = pb.Empty()
output.ParseFromString(self._run_command(11, input))
return output
def sched_timing_today(self) -> pb.SchedTimingTodayOut:
input = pb.Empty()
output = pb.SchedTimingTodayOut()
output.ParseFromString(self._run_command(12, input))
return output
def studied_today(self, *, cards: int, seconds: float) -> str:
input = pb.StudiedTodayIn(cards=cards, seconds=seconds)
output = pb.String()
output.ParseFromString(self._run_command(13, input))
return output.val
def congrats_learn_message(self, *, next_due: float, remaining: int) -> str:
input = pb.CongratsLearnMessageIn(next_due=next_due, remaining=remaining)
output = pb.String()
output.ParseFromString(self._run_command(14, input))
return output.val
def check_media(self) -> pb.CheckMediaOut:
input = pb.Empty()
output = pb.CheckMediaOut()
output.ParseFromString(self._run_command(15, input))
return output
def trash_media_files(self, fnames: Sequence[str]) -> pb.Empty:
input = pb.TrashMediaFilesIn(fnames=fnames)
output = pb.Empty()
output.ParseFromString(self._run_command(16, input))
return output
def add_media_file(self, *, desired_name: str, data: bytes) -> str:
input = pb.AddMediaFileIn(desired_name=desired_name, data=data)
output = pb.String()
output.ParseFromString(self._run_command(17, input))
return output.val
def empty_trash(self) -> pb.Empty:
input = pb.Empty()
output = pb.Empty()
output.ParseFromString(self._run_command(18, input))
return output
def restore_trash(self) -> pb.Empty:
input = pb.Empty()
output = pb.Empty()
output.ParseFromString(self._run_command(19, input))
return output
def add_or_update_deck_legacy(
self, *, deck: bytes, preserve_usn_and_mtime: bool
) -> int:
input = pb.AddOrUpdateDeckLegacyIn(
deck=deck, preserve_usn_and_mtime=preserve_usn_and_mtime
)
output = pb.DeckID()
output.ParseFromString(self._run_command(20, input))
return output.did
def deck_tree(self, *, include_counts: bool, top_deck_id: int) -> pb.DeckTreeNode:
input = pb.DeckTreeIn(include_counts=include_counts, top_deck_id=top_deck_id)
output = pb.DeckTreeNode()
output.ParseFromString(self._run_command(21, input))
return output
def deck_tree_legacy(self) -> bytes:
input = pb.Empty()
output = pb.Json()
output.ParseFromString(self._run_command(22, input))
return output.json
def get_all_decks_legacy(self) -> bytes:
input = pb.Empty()
output = pb.Json()
output.ParseFromString(self._run_command(23, input))
return output.json
def get_deck_id_by_name(self, val: str) -> int:
input = pb.String(val=val)
output = pb.DeckID()
output.ParseFromString(self._run_command(24, input))
return output.did
def get_deck_legacy(self, did: int) -> bytes:
input = pb.DeckID(did=did)
output = pb.Json()
output.ParseFromString(self._run_command(25, input))
return output.json
def get_deck_names(
self, *, skip_empty_default: bool, include_filtered: bool
) -> Sequence[pb.DeckNameID]:
input = pb.GetDeckNamesIn(
skip_empty_default=skip_empty_default, include_filtered=include_filtered
)
output = pb.DeckNames()
output.ParseFromString(self._run_command(26, input))
return output.entries
def new_deck_legacy(self, val: bool) -> bytes:
input = pb.Bool(val=val)
output = pb.Json()
output.ParseFromString(self._run_command(27, input))
return output.json
def remove_deck(self, did: int) -> pb.Empty:
input = pb.DeckID(did=did)
output = pb.Empty()
output.ParseFromString(self._run_command(28, input))
return output
def add_or_update_deck_config_legacy(
self, *, config: bytes, preserve_usn_and_mtime: bool
) -> int:
input = pb.AddOrUpdateDeckConfigLegacyIn(
config=config, preserve_usn_and_mtime=preserve_usn_and_mtime
)
output = pb.DeckConfigID()
output.ParseFromString(self._run_command(29, input))
return output.dcid
def all_deck_config_legacy(self) -> bytes:
input = pb.Empty()
output = pb.Json()
output.ParseFromString(self._run_command(30, input))
return output.json
def get_deck_config_legacy(self, dcid: int) -> bytes:
input = pb.DeckConfigID(dcid=dcid)
output = pb.Json()
output.ParseFromString(self._run_command(31, input))
return output.json
def new_deck_config_legacy(self) -> bytes:
input = pb.Empty()
output = pb.Json()
output.ParseFromString(self._run_command(32, input))
return output.json
def remove_deck_config(self, dcid: int) -> pb.Empty:
input = pb.DeckConfigID(dcid=dcid)
output = pb.Empty()
output.ParseFromString(self._run_command(33, input))
return output
def get_card(self, cid: int) -> pb.Card:
input = pb.CardID(cid=cid)
output = pb.Card()
output.ParseFromString(self._run_command(34, input))
return output
def update_card(self, input: pb.Card) -> pb.Empty:
output = pb.Empty()
output.ParseFromString(self._run_command(35, input))
return output
def add_card(self, input: pb.Card) -> int:
output = pb.CardID()
output.ParseFromString(self._run_command(36, input))
return output.cid
def new_note(self, ntid: int) -> pb.Note:
input = pb.NoteTypeID(ntid=ntid)
output = pb.Note()
output.ParseFromString(self._run_command(37, input))
return output
def add_note(self, *, note: pb.Note, deck_id: int) -> int:
input = pb.AddNoteIn(note=note, deck_id=deck_id)
output = pb.NoteID()
output.ParseFromString(self._run_command(38, input))
return output.nid
def update_note(self, input: pb.Note) -> pb.Empty:
output = pb.Empty()
output.ParseFromString(self._run_command(39, input))
return output
def get_note(self, nid: int) -> pb.Note:
input = pb.NoteID(nid=nid)
output = pb.Note()
output.ParseFromString(self._run_command(40, input))
return output
def add_note_tags(self, *, nids: Sequence[int], tags: str) -> int:
input = pb.AddNoteTagsIn(nids=nids, tags=tags)
output = pb.UInt32()
output.ParseFromString(self._run_command(41, input))
return output.val
def update_note_tags(
self, *, nids: Sequence[int], tags: str, replacement: str, regex: bool
) -> int:
input = pb.UpdateNoteTagsIn(
nids=nids, tags=tags, replacement=replacement, regex=regex
)
output = pb.UInt32()
output.ParseFromString(self._run_command(42, input))
return output.val
def cloze_numbers_in_note(self, input: pb.Note) -> Sequence[int]:
output = pb.ClozeNumbersInNoteOut()
output.ParseFromString(self._run_command(43, input))
return output.numbers
def after_note_updates(
self, *, nids: Sequence[int], mark_notes_modified: bool, generate_cards: bool
) -> pb.Empty:
input = pb.AfterNoteUpdatesIn(
nids=nids,
mark_notes_modified=mark_notes_modified,
generate_cards=generate_cards,
)
output = pb.Empty()
output.ParseFromString(self._run_command(44, input))
return output
def field_names_for_notes(self, nids: Sequence[int]) -> Sequence[str]:
input = pb.FieldNamesForNotesIn(nids=nids)
output = pb.FieldNamesForNotesOut()
output.ParseFromString(self._run_command(45, input))
return output.fields
def note_is_duplicate_or_empty(
self, input: pb.Note
) -> pb.NoteIsDuplicateOrEmptyOut.State:
output = pb.NoteIsDuplicateOrEmptyOut()
output.ParseFromString(self._run_command(46, input))
return output.state
def add_or_update_notetype(
self, *, json: bytes, preserve_usn_and_mtime: bool
) -> int:
input = pb.AddOrUpdateNotetypeIn(
json=json, preserve_usn_and_mtime=preserve_usn_and_mtime
)
output = pb.NoteTypeID()
output.ParseFromString(self._run_command(47, input))
return output.ntid
def get_stock_notetype_legacy(self, kind: pb.StockNoteType) -> bytes:
input = pb.GetStockNotetypeIn(kind=kind)
output = pb.Json()
output.ParseFromString(self._run_command(48, input))
return output.json
def get_notetype_legacy(self, ntid: int) -> bytes:
input = pb.NoteTypeID(ntid=ntid)
output = pb.Json()
output.ParseFromString(self._run_command(49, input))
return output.json
def get_notetype_names(self) -> Sequence[pb.NoteTypeNameID]:
input = pb.Empty()
output = pb.NoteTypeNames()
output.ParseFromString(self._run_command(50, input))
return output.entries
def get_notetype_names_and_counts(self) -> Sequence[pb.NoteTypeNameIDUseCount]:
input = pb.Empty()
output = pb.NoteTypeUseCounts()
output.ParseFromString(self._run_command(51, input))
return output.entries
def get_notetype_id_by_name(self, val: str) -> int:
input = pb.String(val=val)
output = pb.NoteTypeID()
output.ParseFromString(self._run_command(52, input))
return output.ntid
def remove_notetype(self, ntid: int) -> pb.Empty:
input = pb.NoteTypeID(ntid=ntid)
output = pb.Empty()
output.ParseFromString(self._run_command(53, input))
return output
def open_collection(
self,
*,
collection_path: str,
media_folder_path: str,
media_db_path: str,
log_path: str,
) -> pb.Empty:
input = pb.OpenCollectionIn(
collection_path=collection_path,
media_folder_path=media_folder_path,
media_db_path=media_db_path,
log_path=log_path,
)
output = pb.Empty()
output.ParseFromString(self._run_command(54, input))
return output
def close_collection(self, downgrade_to_schema11: bool) -> pb.Empty:
input = pb.CloseCollectionIn(downgrade_to_schema11=downgrade_to_schema11)
output = pb.Empty()
output.ParseFromString(self._run_command(55, input))
return output
def check_database(self) -> Sequence[str]:
input = pb.Empty()
output = pb.CheckDatabaseOut()
output.ParseFromString(self._run_command(56, input))
return output.problems
def sync_media(self, *, hkey: str, endpoint: str) -> pb.Empty:
input = pb.SyncMediaIn(hkey=hkey, endpoint=endpoint)
output = pb.Empty()
output.ParseFromString(self._run_command(57, input))
return output
def abort_media_sync(self) -> pb.Empty:
input = pb.Empty()
output = pb.Empty()
output.ParseFromString(self._run_command(58, input))
return output
def before_upload(self) -> pb.Empty:
input = pb.Empty()
output = pb.Empty()
output.ParseFromString(self._run_command(59, input))
return output
def translate_string(self, input: pb.TranslateStringIn) -> str:
output = pb.String()
output.ParseFromString(self._run_command(60, input))
return output.val
def format_timespan(
self, *, seconds: float, context: pb.FormatTimespanIn.Context
) -> str:
input = pb.FormatTimespanIn(seconds=seconds, context=context)
output = pb.String()
output.ParseFromString(self._run_command(61, input))
return output.val
def register_tags(
self, *, tags: str, preserve_usn: bool, usn: int, clear_first: bool
) -> bool:
input = pb.RegisterTagsIn(
tags=tags, preserve_usn=preserve_usn, usn=usn, clear_first=clear_first
)
output = pb.Bool()
output.ParseFromString(self._run_command(62, input))
return output.val
def all_tags(self) -> Sequence[pb.TagUsnTuple]:
input = pb.Empty()
output = pb.AllTagsOut()
output.ParseFromString(self._run_command(63, input))
return output.tags
def get_changed_tags(self, val: int) -> Sequence[str]:
input = pb.Int32(val=val)
output = pb.GetChangedTagsOut()
output.ParseFromString(self._run_command(64, input))
return output.tags
def get_config_json(self, val: str) -> bytes:
input = pb.String(val=val)
output = pb.Json()
output.ParseFromString(self._run_command(65, input))
return output.json
def set_config_json(self, *, key: str, value_json: bytes) -> pb.Empty:
input = pb.SetConfigJsonIn(key=key, value_json=value_json)
output = pb.Empty()
output.ParseFromString(self._run_command(66, input))
return output
def remove_config(self, val: str) -> pb.Empty:
input = pb.String(val=val)
output = pb.Empty()
output.ParseFromString(self._run_command(67, input))
return output
def set_all_config(self, json: bytes) -> pb.Empty:
input = pb.Json(json=json)
output = pb.Empty()
output.ParseFromString(self._run_command(68, input))
return output
def get_all_config(self) -> bytes:
input = pb.Empty()
output = pb.Json()
output.ParseFromString(self._run_command(69, input))
return output.json
def get_preferences(self) -> pb.CollectionSchedulingSettings:
input = pb.Empty()
output = pb.Preferences()
output.ParseFromString(self._run_command(70, input))
return output.sched
def set_preferences(self, sched: pb.CollectionSchedulingSettings) -> pb.Empty:
input = pb.Preferences(sched=sched)
output = pb.Empty()
output.ParseFromString(self._run_command(71, input))
return output
# @@AUTOGEN@@
def translate_string_in(
key: TR, **kwargs: Union[str, int, float]

39
pylib/tools/genbackend.py
View file

@ -129,16 +129,33 @@ for idx, method in enumerate(pb._BACKENDSERVICE.methods):
out = "\n".join(out)
path = "anki/rsbackend.py"
with open(path) as file:
orig = file.read()
new = re.sub(
"(?s)# @@AUTOGEN@@.*?# @@AUTOGEN@@\n",
f"# @@AUTOGEN@@\n\n{out}\n # @@AUTOGEN@@\n",
orig,
)
path = "anki/rsbackend_gen.py"
with open(path, "wb") as file:
file.write(new.encode("utf8"))
file.write(
(
'''# Copyright: Ankitects Pty Ltd and contributors
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
# pylint: skip-file
"""
THIS FILE IS AUTOMATICALLY GENERATED - DO NOT EDIT.
Please do not access methods on the backend directly - they may be changed
or removed at any time. Instead, please use the methods on the collection
instead. Eg, don't use col.backend.all_deck_config(), instead use
col.decks.all_config()
"""
from typing import *
import anki.backend_pb2 as pb
class RustBackendGenerated:
def _run_command(self, method: int, input: Any) -> bytes:
raise Exception("not implemented")
'''
+ out
).encode("utf8")
)