danoan.word_def.core.api module

Public API.

class danoan.word_def.core.api.PluginRegister(plugin_register: _PluginRegister)

Bases: object

Public proxy to _PluginRegister.

Parameters:

plugin_register (_PluginRegister) –

get_language_plugins(language_code: str) → List[Plugin]

Return a list of registered adapters for the requested language.

Parameters:

language_code (str) –

Return type:

List[Plugin]

get_languages_available() → List[str]

Return type:

List[str]

danoan.word_def.core.api.api_version() → str

Get the version of the word-def package and its protocols.

Version is expected to follow the semantic versioning scheme.

Return type:

str

danoan.word_def.core.api.get_definition(word: str, language_code: str, plugin_name: str | None = None, configuration_stream: TextIO | None = None) → List[str]

Get a list of definitions for the given word.

Parameters:

• word (str) –

• language_code (str) –

• plugin_name (str | None) –

• configuration_stream (TextIO | None) –

Return type:

List[str]

danoan.word_def.core.api.get_pos_tag(word: str, language_code: str, plugin_name: str | None = None, configuration_stream: TextIO | None = None)

Get a list of part-of-speech tags for the given word.

Parameters:

• word (str) –

• language_code (str) –

• plugin_name (str | None) –

• configuration_stream (TextIO | None) –

danoan.word_def.core.api.get_register()

danoan.word_def.core.api.get_synonym(word: str, language_code: str, plugin_name: str | None = None, configuration_stream: TextIO | None = None)

Get a list of synonyms to the given word.

Parameters:

• word (str) –

• language_code (str) –

• plugin_name (str | None) –

• configuration_stream (TextIO | None) –

danoan.word_def.core.api.get_usage_example(word: str, language_code: str, plugin_name: str | None = None, configuration_stream: TextIO | None = None)

Get a list of examples in which the given word is employed.

Parameters:

• word (str) –

• language_code (str) –

• plugin_name (str | None) –

• configuration_stream (TextIO | None) –

danoan.word_def.core.api.is_plugin_compatible(plugin: PluginFactory) → str

Check if word_def and plugin version are compatible.

Versions are compatible if major version components are equal. (see https://semver.org/)

Parameters:

plugin (PluginFactory) –

Return type:

str