czech_plus.config

Module for config management.

Module Contents

Classes

LogLevel	Log level for the addon.
LogSettings	Settings for logs.
BaseCardFields	Base class for card fields.
NounCardFields	Additional fields in noun cards.
VerbCardFields	Additional fields in verb cards.
AdjectiveCardFields	Additional fields in adjective cards.
NounCardsSettings	Settings for noun cards.
VerbCardsSettings	Settings for verb cards.
AdjectivesCardsSettings	Settings for adjective cards.
CardsSettings	Settings for cards.
Config	Config for the addon.

Functions

_get_anki_config(→ _CONFIG_AS_DICT)

Get the config from Anki.

Attributes

BASE_DIR
_CONFIG_PATH
_ADDON_META_PATH
_CONFIG_AS_DICT

BASE_DIR

_CONFIG_PATH

_ADDON_META_PATH

_CONFIG_AS_DICT: typing_extensions.TypeAlias = 'dict[str, t.Union[str, _CONFIG_AS_DICT]]'

_get_anki_config() → _CONFIG_AS_DICT

Get the config from Anki.

class LogLevel

Bases: enum.IntEnum

Log level for the addon.

TRACE = 5

Use only for tracing error without a debugger.

DEBUG = 10

INFO = 20

SUCCESS = 25

WARNING = 30

ERROR = 40

CRITICAL = 50

class LogSettings

Settings for logs.

level: LogLevel

Log level for the app.

json: bool = False

Upload logs into JSON.

class BaseCardFields

Base class for card fields.

czech: str = 'Czech'

Name of the field, where czech word is.

processed: str = 'Processed'

Name of the field, where already processed card is.

class NounCardFields

Bases: BaseCardFields

Additional fields in noun cards.

gender: str = 'Gender'

Name of the field, where gender is.

class VerbCardFields

Bases: BaseCardFields

Additional fields in verb cards.

prepositions_and_cases: str = 'Prepositions and Cases'

Name of the field, where prepositions and cases is.

class AdjectiveCardFields

Bases: BaseCardFields

Additional fields in adjective cards.

completion_of_comparison_degrees: str = 'Completion of Comparison Degrees'

Name of the field, where completion of comparison degrees is.

class NounCardsSettings

Settings for noun cards.

note_type_name: str = 'Noun'

Name of the Note Type for nouns.

fields: NounCardFields

Settings for fields in noun cards.

class VerbCardsSettings

Settings for verb cards.

note_type_name: str = 'Verb'

Name of the Note Type for verbs.

fields: VerbCardFields

Settings for fields in verb cards.

class AdjectivesCardsSettings

Settings for adjective cards.

note_type_name: str = 'Adjective'

Name of the Note Type for adjectives.

fields: AdjectiveCardFields

Settings for fields in adjective cards.

class CardsSettings

Settings for cards.

nouns: NounCardsSettings

Settings for noun cards.

verbs: VerbCardsSettings

Settings for verb cards.

adjectives: AdjectivesCardsSettings

Settings for adjective cards.

class Config

Config for the addon.

logging: LogSettings

Settings for logs.

cards: CardsSettings

Settings for cards.

__post_init__() → None

Post init hook.

_setup() → None

Perform setup of the config.

_write_config() → None

Write config to the file.

_set_values(object_to_set: Any, config: _CONFIG_AS_DICT, /) → None

Set values from dict config to object.

We use this method of setting attributes because we use frozen dataclass. This was found on https://github.com/python/cpython/issues/82625.

Parameters:

• object_to_set – Object to set values to. To support recursion.

• config – Dict config to set values from.

classmethod _start_watching_for_changes() → None

Start watching for changes in config.

This ensures that we will never start two config watchers in one time.

_watch_for_changes() → None

Watch for changes in config file and update self based on changes.