mirror of
https://github.com/ankitects/anki.git
synced 2025-09-18 14:02:21 -04:00
add a helper so we can get semi-automatic camelCase conversion
This commit is contained in:
parent
f26384a82f
commit
0ddd316388
4 changed files with 49 additions and 0 deletions
|
@ -43,3 +43,6 @@ disable=
|
|||
global-statement,
|
||||
protected-access,
|
||||
arguments-differ,
|
||||
|
||||
[BASIC]
|
||||
good-names = id
|
|
@ -47,6 +47,7 @@ py_library(
|
|||
requirement("flask"),
|
||||
requirement("waitress"),
|
||||
requirement("markdown"),
|
||||
requirement("stringcase"),
|
||||
] + orjson_if_available(),
|
||||
)
|
||||
|
||||
|
|
43
pylib/anki/_legacy.py
Normal file
43
pylib/anki/_legacy.py
Normal file
|
@ -0,0 +1,43 @@
|
|||
# Copyright: Ankitects Pty Ltd and contributors
|
||||
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any, Callable, Dict, Tuple, Union
|
||||
|
||||
import stringcase
|
||||
|
||||
VariableTarget = Tuple[Any, str]
|
||||
DeprecatedAliasTarget = Union[Callable, VariableTarget]
|
||||
|
||||
|
||||
def _target_to_string(target: DeprecatedAliasTarget) -> str:
|
||||
if name := getattr(target, "__name__", None):
|
||||
return name
|
||||
else:
|
||||
return target[1] # type: ignore
|
||||
|
||||
|
||||
class DeprecatedNamesMixin:
|
||||
"Expose instance methods/vars as camelCase for legacy callers."
|
||||
|
||||
_deprecated_aliases: Dict[str, str] = {}
|
||||
|
||||
def __getattr__(self, name: str) -> Any:
|
||||
remapped = self._deprecated_aliases.get(name) or stringcase.snakecase(name)
|
||||
if remapped == name:
|
||||
raise AttributeError
|
||||
|
||||
out = getattr(self, remapped)
|
||||
print(f"please use {remapped} instead of {name} on {self}")
|
||||
return out
|
||||
|
||||
@classmethod
|
||||
def register_deprecated_aliases(cls, **kwargs: DeprecatedAliasTarget) -> None:
|
||||
"""Manually add aliases that are not a simple transform.
|
||||
|
||||
Either pass in a method, or a tuple of (variable, "variable"). The
|
||||
latter is required because we want to ensure the provided arguments
|
||||
are valid symbols, and we can't get a variable's name easily.
|
||||
"""
|
||||
cls._deprecated_aliases = {k: _target_to_string(v) for k, v in kwargs.items()}
|
|
@ -60,6 +60,8 @@ ignore_missing_imports = True
|
|||
ignore_missing_imports = True
|
||||
[mypy-socks]
|
||||
ignore_missing_imports = True
|
||||
[mypy-stringcase]
|
||||
ignore_missing_imports = True
|
||||
|
||||
[mypy-aqt.forms.*]
|
||||
disallow_untyped_defs=false
|
||||
|
|
Loading…
Reference in a new issue