librelingo-utils 2.6.2

Utilities to be used in LibreLingo-related-packages

librelingo_utils

librelingo-utils contains utility functions that are meant to make it easier to create Python software that works with LibreLingo courses.

librelingo_utils.utils

calculate_number_of_levels

calculate_number_of_levels(nwords: int, nphrases: int) -> int

Calculates how many levels a skill should have

get_words_from_phrase

get_words_from_phrase(phrase)

Splits a phrase into its component words/terms. Note that this respects grouping with curly braces, i.e. sets of words surrounded by curly braces will not be split from each other.

remove_control_characters_for_display

remove_control_characters_for_display(phrase)

Removes characters with special LibreLingo functions from a phrase before it is displayed to the user. At the moment, this only applies to curly brackets used to group several words into a single mini-dictionary term.

clean_word

@lru_cache(maxsize=None)
clean_word(word: Word)

Remove punctuation and other special characters from a word.

get_dumb_opaque_id

get_dumb_opaque_id(name: str, id_, salt: str = "") -> str

Generate a unique, opaque ID based on a name, and id_ and a salt id

get_opaque_id

get_opaque_id(obj, salt: str = "") -> str

Generate a unique, opaque ID based on a salt and the type of the object id

audio_id

audio_id(language: Language, text: str) -> str

Generate the ID that will identify the audio file of a sentence.

iterate_phrases

iterate_phrases(course: Course)

"Flatten" a course into a sequence of phrases

iterate_words

iterate_words(course: Course)

"Flatten" a course into a sequence of words