GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-24 16:56:36 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

python: add missing type annotations for None values (#3364)

Browse source 
* refactor: explicitly add NoneType to type hints

If variable can be `None`, don't be implicit. Be explicit.
This commit is contained in:
David Culley 2024-08-22 11:03:44 +02:00 committed by GitHub
parent 922958b0ae
commit a6d5c94997
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
18 changed files with 37 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pylib/anki/collection.py
View file

@ -897,7 +897,7 @@ class Collection(DeprecatedNamesMixin):
# Config
##########################################################################
def get_config(self, key: str, default: Any = None) -> Any:
def get_config(self, key: str, default: Any | None = None) -> Any:
try:
return self.conf.get_immutable(key)
except KeyError:
@ -939,7 +939,7 @@ class Collection(DeprecatedNamesMixin):
return self._backend.set_config_string(key=key, value=value, undoable=undoable)
def get_aux_notetype_config(
self, id: NotetypeId, key: str, default: Any = None
self, id: NotetypeId, key: str, default: Any | None = None
) -> Any:
key = self._backend.get_aux_notetype_config_key(id=id, key=key)
return self.get_config(key, default=default)
@ -951,7 +951,7 @@ class Collection(DeprecatedNamesMixin):
return self.set_config(key, value, undoable=undoable)
def get_aux_template_config(
self, id: NotetypeId, card_ordinal: int, key: str, default: Any = None
self, id: NotetypeId, card_ordinal: int, key: str, default: Any | None = None
) -> Any:
key = self._backend.get_aux_template_config_key(
notetype_id=id, card_ordinal=card_ordinal, key=key

2
pylib/anki/config.py
View file

@ -76,7 +76,7 @@ class ConfigManager:
def __setitem__(self, key: str, value: Any) -> None:
self.set(key, value)
def get(self, key: str, default: Any = None) -> Any:
def get(self, key: str, default: Any | None = None) -> Any:
try:
return self[key]
except KeyError:

2
pylib/anki/decks.py
View file

@ -85,7 +85,7 @@ class DeckManager(DeprecatedNamesMixin):
self.col = col.weakref()
self.decks = DecksDictProxy(col)
def save(self, deck_or_config: DeckDict | DeckConfigDict = None) -> None:
def save(self, deck_or_config: DeckDict | DeckConfigDict | None = None) -> None:
"Can be called with either a deck or a deck configuration."
if not deck_or_config:
print("col.decks.save() should be passed the changed deck")

2
pylib/anki/httpclient.py
View file

@ -57,7 +57,7 @@ class HttpClient(DeprecatedNamesMixin):
verify=self.verify,
) # pytype: disable=wrong-arg-types
def get(self, url: str, headers: dict[str, str] = None) -> Response:
def get(self, url: str, headers: dict[str, str] | None = None) -> Response:
if headers is None:
headers = {}
headers["User-Agent"] = self._agent_name()

2
pylib/anki/models.py
View file

@ -563,7 +563,7 @@ and notes.mid = ? and cards.ord = ?""",
self._mutate_after_write(notetype)
# @deprecated(replaced_by=update_dict)
def save(self, notetype: NotetypeDict = None, **legacy_kwargs: bool) -> None:
def save(self, notetype: NotetypeDict | None = None, **legacy_kwargs: bool) -> None:
"Save changes made to provided note type."
if not notetype:
print_deprecation_warning(

2
pylib/anki/template.py
View file

@ -147,7 +147,7 @@ class TemplateRenderContext:
card: anki.cards.Card,
note: anki.notes.Note,
browser: bool = False,
notetype: NotetypeDict = None,
notetype: NotetypeDict | None = None,
template: dict | None = None,
fill_empty: bool = False,
) -> None:

4
qt/aqt/addons.py
View file

@ -409,7 +409,9 @@ class AddonManager:
all_conflicts[other_dir].append(addon.dir_name)
return all_conflicts
def _disableConflicting(self, module: str, conflicts: list[str] = None) -> set[str]:
def _disableConflicting(
self, module: str, conflicts: list[str] | None = None
) -> set[str]:
if not self.isEnabled(module):
# disabled add-ons should not trigger conflict handling
return set()

2
qt/aqt/browser/sidebar/item.py
View file

@ -62,7 +62,7 @@ class SidebarItem:
name: str,
icon: str | ColoredIcon,
search_node: SearchNode | None = None,
on_expanded: Callable[[bool], None] = None,
on_expanded: Callable[[bool], None] | None = None,
expanded: bool = False,
item_type: SidebarItemType = SidebarItemType.CUSTOM,
id: int = 0,

2
qt/aqt/browser/sidebar/tree.py
View file

@ -159,7 +159,7 @@ class SidebarTreeView(QTreeView):
self.refresh()
self._refresh_needed = False
def refresh(self, new_current: SidebarItem = None) -> None:
def refresh(self, new_current: SidebarItem | None = None) -> None:
"Refresh list. No-op if sidebar is not visible."
if not self.isVisible():
return

4
qt/aqt/browser/table/table.py
View file

@ -600,7 +600,9 @@ class Table:
self._view.verticalScrollBar().setValue(vertical)
def _move_current(
self, direction: QAbstractItemView.CursorAction, index: QModelIndex = None
self,
direction: QAbstractItemView.CursorAction,
index: QModelIndex | None = None,
) -> None:
if not self.has_current():
return

4
qt/aqt/editor.py
View file

@ -233,9 +233,9 @@ require("anki/ui").loaded.then(() => require("anki/NoteEditor").instances[0].too
func: Callable[[Editor], None],
tip: str = "",
label: str = "",
id: str = None,
id: str | None = None,
toggleable: bool = False,
keys: str = None,
keys: str | None = None,
disables: bool = True,
rightside: bool = True,
) -> str:

2
qt/aqt/import_export/exporting.py
View file

@ -137,7 +137,7 @@ class ExportDialog(QDialog):
return path
def options(self, out_path: str) -> ExportOptions:
limit: ExportLimit = None
limit: ExportLimit | None = None
if self.nids:
limit = NoteIdsLimit(self.nids)
elif current_deck_id := self.current_deck_id():

2
qt/aqt/importing.py
View file

@ -120,7 +120,7 @@ class ImportDialog(QDialog):
)
self.deck = aqt.deckchooser.DeckChooser(self.mw, self.frm.deckArea, label=False)
def modelChanged(self, unused: Any = None) -> None:
def modelChanged(self, unused: Any | None = None) -> None:
self.importer.model = self.mw.col.models.current()
self.importer.initMapping()
self.showMapping()

4
qt/aqt/main.py
View file

@ -862,8 +862,8 @@ class AnkiQt(QMainWindow):
def requireReset(
self,
modal: bool = False,
reason: Any = None,
context: Any = None,
reason: Any | None = None,
context: Any | None = None,
) -> None:
traceback.print_stack(file=sys.stdout)
print("requireReset() is obsolete; please use CollectionOp()")

2
qt/aqt/progress.py
View file

@ -42,7 +42,7 @@ class ProgressManager:
repeat: bool,
requiresCollection: bool = True,
*,
parent: QObject = None,
parent: QObject | None = None,
) -> QTimer:
"""Create and start a standard Anki timer. For an alternative see `single_shot()`.

8
qt/aqt/reviewer.py
View file

@ -152,8 +152,8 @@ class Reviewer:
self.previous_card: Card | None = None
self._answeredIds: list[CardId] = []
self._recordedAudio: str | None = None
self.typeCorrect: str = None # web init happens before this is set
self.state: Literal["question", "answer", "transition", None] = None
self.typeCorrect: str | None = None # web init happens before this is set
self.state: Literal["question", "answer", "transition"] | None = None
self._refresh_needed: RefreshNeeded | None = None
self._v3: V3CardInfo | None = None
self._state_mutation_key = str(random.randint(0, 2**64 - 1))
@ -162,7 +162,7 @@ class Reviewer:
self._previous_card_info = PreviousReviewerCardInfo(self.mw)
self._states_mutated = True
self._state_mutation_js = None
self._reps: int = None
self._reps: int | None = None
self._show_question_timer: QTimer | None = None
self._show_answer_timer: QTimer | None = None
self.auto_advance_enabled = False
@ -369,7 +369,7 @@ class Reviewer:
def _showQuestion(self) -> None:
self._reps += 1
self.state = "question"
self.typedAnswer: str = None
self.typedAnswer: str | None = None
c = self.card
# grab the question and play audio
q = c.question()

4
qt/aqt/switch.py
View file

@ -1,5 +1,7 @@
# 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 cast
from aqt import colors, props
@ -21,7 +23,7 @@ class Switch(QAbstractButton):
right_label: str = "",
left_color: dict[str, str] = colors.ACCENT_CARD | {},
right_color: dict[str, str] = colors.ACCENT_NOTE | {},
parent: QWidget = None,
parent: QWidget | None = None,
) -> None:
super().__init__(parent=parent)
self.setCheckable(True)

14
qt/aqt/utils.py
View file

@ -393,8 +393,8 @@ def showText(
def askUser(
text: str,
parent: QWidget = None,
help: HelpPageArgument = None,
parent: QWidget | None = None,
help: HelpPageArgument | None = None,
defaultno: bool = False,
msgfunc: Callable | None = None,
title: str = "Anki",
@ -426,7 +426,7 @@ class ButtonedDialog(QMessageBox):
text: str,
buttons: list[str],
parent: QWidget | None = None,
help: HelpPageArgument = None,
help: HelpPageArgument | None = None,
title: str = "Anki",
):
QMessageBox.__init__(self, parent)
@ -459,7 +459,7 @@ def askUserDialog(
text: str,
buttons: list[str],
parent: QWidget | None = None,
help: HelpPageArgument = None,
help: HelpPageArgument | None = None,
title: str = "Anki",
) -> ButtonedDialog:
if not parent:
@ -473,7 +473,7 @@ class GetTextDialog(QDialog):
self,
parent: QWidget | None,
question: str,
help: HelpPageArgument = None,
help: HelpPageArgument | None = None,
edit: QLineEdit | None = None,
default: str = "",
title: str = "Anki",
@ -525,7 +525,7 @@ class GetTextDialog(QDialog):
def getText(
prompt: str,
parent: QWidget | None = None,
help: HelpPageArgument = None,
help: HelpPageArgument | None = None,
edit: QLineEdit | None = None,
default: str = "",
title: str = "Anki",
@ -558,7 +558,7 @@ def getOnlyText(*args: Any, **kwargs: Any) -> str:
# fixme: these utilities could be combined into a single base class
# unused by Anki, but used by add-ons
def chooseList(
prompt: str, choices: list[str], startrow: int = 0, parent: Any = None
prompt: str, choices: list[str], startrow: int = 0, parent: Any | None = None
) -> int:
if not parent:
parent = aqt.mw.app.activeWindow()