anki.errors

anki.errors#

Attributes#

`DeckRenameError`
`AnkiError`

Exceptions#

`AnkiException`	General Anki exception that all custom exceptions raised by Anki should
`BackendError`	An error originating from Anki's backend.
`Interrupted`	An error originating from Anki's backend.
`NetworkError`	An error originating from Anki's backend.
`SyncError`	An error originating from Anki's backend.
`BackendIOError`	An error originating from Anki's backend.
`CustomStudyError`	An error originating from Anki's backend.
`DBError`	An error originating from Anki's backend.
`CardTypeError`	An error originating from Anki's backend.
`TemplateError`	An error originating from Anki's backend.
`NotFoundError`	An error originating from Anki's backend.
`DeletedError`	An error originating from Anki's backend.
`ExistsError`	An error originating from Anki's backend.
`UndoEmpty`	An error originating from Anki's backend.
`FilteredDeckError`	An error originating from Anki's backend.
`InvalidInput`	An error originating from Anki's backend.
`SearchError`	An error originating from Anki's backend.
`SchedulerUpgradeRequired`	An error originating from Anki's backend.
`AbortSchemaModification`	General Anki exception that all custom exceptions raised by Anki should

Classes#

SyncErrorKind

Create a collection of name/value pairs.

Module Contents#

exception anki.errors.AnkiException#

Bases: Exception

General Anki exception that all custom exceptions raised by Anki should inherit from. Allows add-ons to easily identify Anki-native exceptions.

When inheriting from a Python built-in exception other than Exception, please supply AnkiException as an additional inheritance:

``` class MyNewAnkiException(ValueError, AnkiException):

pass

exception anki.errors.BackendError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: AnkiException

An error originating from Anki’s backend.

help_page#

context#

backtrace#

exception anki.errors.Interrupted(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.NetworkError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

class anki.errors.SyncErrorKind(*args, **kwds)#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

AUTH = 1#

OTHER = 2#

exception anki.errors.SyncError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None, kind: SyncErrorKind)#

Bases: BackendError

An error originating from Anki’s backend.

kind#

exception anki.errors.BackendIOError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.CustomStudyError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.DBError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.CardTypeError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.TemplateError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.NotFoundError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.DeletedError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.ExistsError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.UndoEmpty(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.FilteredDeckError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.InvalidInput(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.SearchError(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.SchedulerUpgradeRequired(message: str, help_page: anki.collection.HelpPage.V | None, context: str | None, backtrace: str | None)#

Bases: BackendError

An error originating from Anki’s backend.

exception anki.errors.AbortSchemaModification#

Bases: AnkiException

General Anki exception that all custom exceptions raised by Anki should inherit from. Allows add-ons to easily identify Anki-native exceptions.

When inheriting from a Python built-in exception other than Exception, please supply AnkiException as an additional inheritance:

``` class MyNewAnkiException(ValueError, AnkiException):

pass

anki.errors.DeckRenameError#

anki.errors.AnkiError#