A summary of the provided functions in the krdict module and the arguments they expect. With the exception of set_key and set_default, all of the functions listed below expect keyword arguments.

Performs an advanced search on the Korean Learner's Dictionary API.

def advanced_search(*,
    query: str,
    raise_api_errors: bool = False,
    key: str = None,
    start_index: int = None,
    num_results: int = None,
    sort: SortMethod = None,
    search_type: SearchType = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None,
    search_target: SearchTarget = None,
    target_language: TargetLanguage = None,
    search_method: SearchMethod = None,
    classification: Classification | List[Classification] = None,
    origin_type: OriginType | List[OriginType] = None,
    vocabulary_grade: VocabularyGrade | List[VocabularyGrade] = None,
    part_of_speech: PartOfSpeech | List[PartOfSpeech] = None,
    multimedia_info: MultimediaType | List[MultimediaType] = None,
    min_syllables: int = None,
    max_syllables: int = None,
    meaning_category: MeaningCategory | int = None,
    subject_category: SubjectCategory | int | List[SubjectCategory | int] = None,
    options: OptionsDict = None
) -> SearchResults | KRDictError: ...

Warning

Use of any value other than 'word' or None for the search_type parameter with advanced search is undefined behavior. It is likely that incomplete or empty results will be returned. The parameter is included for completeness, but is not recommended for usage.

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. This guarantees that the result is not an error object.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • start_index: The page at which the search should start [1, 1000] (default 1).
  • num_results: The maximum number of search results to return [10, 100] (default 10).
  • sort (SortMethod): The sort method which should be used (default 'alphabetical').
  • search_type (SearchType): The type of search to perform (default 'word').
  • translation_language (TranslationLanguage): A language to include translations for.
  • search_target (SearchTarget): The target field of the search query (default 'headword').
  • target_language (TargetLanguage): The original language to search by. If search_target is set to any value other than 'original_language', this parameter has no effect (default 'all').
  • search_method (SearchMethod): The method used to match against the query (default 'exact').
    • 'exact': Returns entries that are an exact match of the query.
    • 'include': Returns entries that include the query.
    • 'start': Returns entries that start with the query.
    • 'end': Returns entries that end with the query.
  • classification (Classification): An entry classification to filter by (default 'all').
  • origin_type (OriginType): A word origin type to filter by (default 'all').
  • vocabulary_grade (VocabularyGrade): A vocabulary level to filter by (default 'all').
  • part_of_speech (PartOfSpeech): A part of speech to filter by (default 'all').
  • multimedia_info (MultimediaType): A multimedia type to filter by (default 'all').
  • min_syllables: The minimum number of syllables in result words [1, 80] (default 1).
  • max_syllables: The maximum number of syllables in results words. A value of 0 denotes no maximum [0, 80] (default 0).
  • meaning_category (MeaningCategory): The meaning category to filter by (default 'all').
  • subject_category (SubjectCategory): A subject category to filter by (default 'all').
  • options (OptionsDict): Additional options to apply.

Returns:

Depending on the value of search_type and whether an error occurred, returns one of:

Performs a basic search on the Korean Learner's Dictionary API.

def search(*,
    query: str,
    raise_api_errors: bool = False,
    key: str = None,
    start_index: int = None,
    num_results: int = None,
    sort: SortMethod = None,
    search_type: SearchType = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None,
    options: OptionsDict = None
) -> SearchResults | KRDictError: ...

Note

If search_type is omitted, this function has the same behavior as search_words by default. For a more specific return type with static typing, use search_words.

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. A value of True guarantees that the result is not an error object.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • start_index: The page at which the search should start [1, 1000] (default 1).
  • num_results: The maximum number of search results to return [10, 100] (default 10).
  • sort (SortMethod): The sort method which should be used (default 'alphabetical').
  • search_type (SearchType): The type of search to perform (default 'word').
  • translation_language (TranslationLanguage): A language to include translations for.
  • options (OptionsDict): Additional options to apply.

Returns:

Depending on the value of search_type and whether an error occurred, returns one of:

search_definitions

Performs a search for definitions on the Korean Learner's Dictionary API.
This function is equivalent to using 'definition' as the argument to the search_type parameter in the search function, but returns a more specific type for static typing.

def search_definitions(*,
    query: str,
    raise_api_errors: bool = False,
    key: str = None,
    start_index: int = None,
    num_results: int = None,
    sort: SortMethod = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None
) -> DefinitionSearchResults | KRDictError: ...

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. A value of True guarantees that the result is not an error object.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • start_index: The page at which the search should start [1, 1000] (default 1).
  • num_results: The maximum number of search results to return [10, 100] (default 10).
  • sort (SortMethod): The sort method which should be used (default 'alphabetical').
  • translation_language (TranslationLanguage): A language to include translations for.

Returns:

Depending on whether an error occurred, returns DefinitionSearchResults or KRDictError.

search_examples

Performs a search for examples on the Korean Learner's Dictionary API.
This function is equivalent to using 'example' as the argument to the search_type parameter in the search function, but returns a more specific type for static typing.

def search_examples(*,
    query: str,
    raise_api_errors: bool = False,
    key: str = None,
    start_index: int = None,
    num_results: int = None,
    sort: SortMethod = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None
) -> ExampleSearchResults | KRDictError: ...

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. A value of True guarantees that the result is not an error object.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • start_index: The page at which the search should start [1, 1000] (default 1).
  • num_results: The maximum number of search results to return [10, 100] (default 10).
  • sort (SortMethod): The sort method which should be used (default 'alphabetical').
  • translation_language (TranslationLanguage): A language to include translations for.

Returns:

Depending on whether an error occurred, returns ExampleSearchResults or KRDictError.

search_idioms_proverbs

Performs a search for idioms and proverbs on the Korean Learner's Dictionary API.
This function is equivalent to using 'idiom_proverb' as the argument to the search_type parameter in the search function, but returns a more specific type for static typing.

def search_idioms_proverbs(*,
    query: str,
    raise_api_errors: bool = False,
    key: str = None,
    start_index: int = None,
    num_results: int = None,
    sort: SortMethod = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None
) -> IdiomProverbSearchResults | KRDictError: ...

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. A value of True guarantees that the result is not an error object.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • start_index: The page at which the search should start [1, 1000] (default 1).
  • num_results: The maximum number of search results to return [10, 100] (default 10).
  • sort (SortMethod): The sort method which should be used (default 'alphabetical').
  • translation_language (TranslationLanguage): A language to include translations for.

Returns:

Depending on whether an error occurred, returns IdiomProverbSearchResults or KRDictError.

search_words

Performs a search for definitions on the Korean Learner's Dictionary API.
This function is equivalent to using 'word' or None as the argument to the search_type parameter in the search function, but returns a more specific type for static typing.

def search_words(*,
    query: str,
    raise_api_errors: bool = False,
    key: str = None,
    start_index: int = None,
    num_results: int = None,
    sort: SortMethod = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None,
    options: OptionsDict = None
) -> WordSearchResults | KRDictError: ...

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. A value of True guarantees that the result is not an error object.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • start_index: The page at which the search should start. [1, 1000] (default 1).
  • num_results: The maximum number of search results to return. [10, 100] (default 10).
  • sort (SortMethod): The sort method which should be used (default 'alphabetical').
  • translation_language (TranslationLanguage): A language to include translations for.
  • options (OptionsDict): Additional options to apply.

Returns:

Depending on whether an error occurred, returns WordSearchResults or KRDictError.

set_default

Sets a default value for a library option.

def set_default(name: Option, value: bool) -> None: ...

Parameters:

  • name: The name of the option to set. Accepted values:
    • 'fetch_multimedia': Controls whether multimedia is scraped during view queries. No effect unless the 'use_scraper' option is True.
    • 'fetch_page_data': Controls whether pronunciation URLs and extended language information are scraped. No effect unless the 'use_scraper' option is True.
    • 'raise_scraper_errors': Controls whether errors which occur during scraping are raised. No effect unless the 'use_scraper' option is True.
    • 'use_scraper': Controls whether the scraper should be used to fetch more information.
  • value: The new default value of the option.

set_key

Sets a default API key to use, if one is not provided in a query.

def set_key(key: str | None) -> None: ...

Parameters:

  • key: The Korean Learner's Dictionary API key. To unset a key, use None.

view

Performs a view query, which retrieves information about a particular entry, on the Korean Learner's Dictionary API.

def view(*,
    query: str,
    raise_api_errors: bool = False,
    homograph_num: int = None,
    key: str = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None,
    options: OptionsDict = None
) -> ViewResult | KRDictError: ...

def view(*,
    target_code: int,
    raise_api_errors: bool = False,
    key: str = None,
    translation_language: TranslationLanguage | List[TranslationLanguage] = None,
    options: OptionsDict = None
) -> ViewResult | KRDictError: ...

Parameters:

  • query: The search query.
  • raise_api_errors: Sets whether a KRDictException will be raised if an API error occurs. A value of True guarantees that the result is not an error object.
  • homograph_num: The superscript number used to distinguish homographs (default 0).
  • target_code: The target code of the desired result.
  • key: The API key. If a key was set with set_key, this can be omitted.
  • translation_language (TranslationLanguage): A language or list of languages to include translations for.
  • options (OptionsDict): Additional options to apply.

Returns:

Depending on whether an error occurred, returns ViewResult or KRDictError.