anki/qt/aqt/legacy.py

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

"""
Legacy support
"""

from __future__ import annotations

from typing import Any

import anki
import anki.sound
import anki.utils
import aqt
from aqt.theme import theme_manager

# Routines removed from pylib/
##########################################################################


def bodyClass(col, card) -> str:  # type: ignore
    print("bodyClass() deprecated")
    return theme_manager.body_classes_for_card_ord(card.ord)


def allSounds(text) -> list:  # type: ignore
    print("allSounds() deprecated")
    return aqt.mw.col.media._extract_filenames(text)


def stripSounds(text) -> str:  # type: ignore
    print("stripSounds() deprecated")
    return aqt.mw.col.media.strip_av_tags(text)


def fmtTimeSpan(
    time: Any,
    pad: Any = 0,
    point: Any = 0,
    short: Any = False,
    inTime: Any = False,
    unit: Any = 99,
) -> Any:
    print("fmtTimeSpan() has become col.format_timespan()")
    return aqt.mw.col.format_timespan(time)


def install_pylib_legacy() -> None:
    anki.utils.bodyClass = bodyClass  # type: ignore
    anki.utils.fmtTimeSpan = fmtTimeSpan  # type: ignore
    anki.sound._soundReg = r"\[sound:(.+?)\]"  # type: ignore
    anki.sound.allSounds = allSounds  # type: ignore
    anki.sound.stripSounds = stripSounds  # type: ignore
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00			`# Copyright: Ankitects Pty Ltd and contributors`
			`# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html`

			`"""`
			`Legacy support`
			`"""`

run pyupgrade over codebase [python upgrade required] This adds Python 3.9 and 3.10 typing syntax to files that import attributions from __future___. Python 3.9 should be able to cope with the 3.10 syntax, but Python 3.8 will no longer work. On Windows/Mac, install the latest Python 3.9 version from python.org. There are currently no orjson wheels for Python 3.10 on Windows/Mac, which will break the build unless you have Rust installed separately. On Linux, modern distros should have Python 3.9 available already. If you're on an older distro, you'll need to build Python from source first. 2021-10-03 10:59:42 +02:00			`from __future__ import annotations`

			`from typing import Any`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00
			`import anki`
Import submodules directly (#1662) * Use submodule imports in aqt * Use submodule imports in pylib * More submodule imports in pylib These required removing some direct imports to get rid of import cycles. 2022-02-13 04:40:47 +01:00			`import anki.sound`
			`import anki.utils`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00			`import aqt`
			`from aqt.theme import theme_manager`

			`# Routines removed from pylib/`
			`##########################################################################`


add remaining types and disable missing types on (almost) all aqt 2021-02-02 15:00:29 +01:00			`def bodyClass(col, card) -> str: # type: ignore`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00			`print("bodyClass() deprecated")`
			`return theme_manager.body_classes_for_card_ord(card.ord)`


run pyupgrade over codebase [python upgrade required] This adds Python 3.9 and 3.10 typing syntax to files that import attributions from __future___. Python 3.9 should be able to cope with the 3.10 syntax, but Python 3.8 will no longer work. On Windows/Mac, install the latest Python 3.9 version from python.org. There are currently no orjson wheels for Python 3.10 on Windows/Mac, which will break the build unless you have Rust installed separately. On Linux, modern distros should have Python 3.9 available already. If you're on an older distro, you'll need to build Python from source first. 2021-10-03 10:59:42 +02:00			`def allSounds(text) -> list: # type: ignore`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00			`print("allSounds() deprecated")`
add public wrappers for remaining backend functions 2021-01-31 09:46:43 +01:00			`return aqt.mw.col.media._extract_filenames(text)`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00

add remaining types and disable missing types on (almost) all aqt 2021-02-02 15:00:29 +01:00			`def stripSounds(text) -> str: # type: ignore`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00			`print("stripSounds() deprecated")`
add public wrappers for remaining backend functions 2021-01-31 09:46:43 +01:00			`return aqt.mw.col.media.strip_av_tags(text)`
inject legacy funcs referencing aqt in GUI load 2020-01-23 09:19:54 +01:00

add a bunch of return types 2021-02-01 14:28:21 +01:00			`def fmtTimeSpan(`
			`time: Any,`
			`pad: Any = 0,`
			`point: Any = 0,`
			`short: Any = False,`
			`inTime: Any = False,`
			`unit: Any = 99,`
			`) -> Any:`
add public wrappers for remaining backend functions 2021-01-31 09:46:43 +01:00			`print("fmtTimeSpan() has become col.format_timespan()")`
migrate the remaining methods 2020-05-24 00:36:50 +02:00			`return aqt.mw.col.format_timespan(time)`
remove old fmtTimeSpan() and associated strings 2020-02-23 09:47:16 +01:00

use qconnect everywhere, and fix some typing issues a step towards check_untyped_defs in aqt, but there's still 100+ issues to resolve 2020-05-04 05:23:08 +02:00			`def install_pylib_legacy() -> None:`
			`anki.utils.bodyClass = bodyClass # type: ignore`
			`anki.utils.fmtTimeSpan = fmtTimeSpan # type: ignore`
Also fix legacy.py::anki.sound._soundReg accepting empty tags 2020-05-12 17:43:35 +02:00			`anki.sound._soundReg = r"\[sound:(.+?)\]" # type: ignore`
use qconnect everywhere, and fix some typing issues a step towards check_untyped_defs in aqt, but there's still 100+ issues to resolve 2020-05-04 05:23:08 +02:00			`anki.sound.allSounds = allSounds # type: ignore`
			`anki.sound.stripSounds = stripSounds # type: ignore`