Search

Search

Bases: Engine[TOptions]

Abstract base class for search engines.

Error

Bases: Error

Base class for search errors.

__init__(search_name, *args, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Initializes :class:Search.

Parameters:

• search_name (str) –

  Name of the search plugin to instantiate.

• args (Any, default: () ) –

  Arguments.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  Context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

aitem(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.item.

aitem_data(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.item_data.

aitem_descriptor(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.item_descriptor.

alexeme(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.lexeme.

alexeme_data(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.lexeme_data.

alexeme_descriptor(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.lexeme_descriptor.

aproperty(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.property.

aproperty_data(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.property_data.

aproperty_descriptor(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Async version of :meth:Search.property_descriptor.

default_language()

The default value for :attr:Search.language.

get_default_language()

Gets the default value for :attr:Search.language.

Returns:

• str | None –

  Default Language.

get_language(default=None)

Gets the language of search.

If the language is None, returns default.

Parameters:

• default (str | None, default: None ) –

  Default language.

Returns:

• str | None –

  Language or None.

item(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for items matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[Item] –

  An iterator of items matching search.

item_data(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for item data matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[TData] –

  An iterator of item data matching search.

item_descriptor(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for item-descriptor pairs matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[tuple[Item, Descriptor]] –

  An iterator of "(item, descriptor)" pairs matching search.

lexeme(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for lexemes matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[Lexeme] –

  An iterator of lexemes matching search.

lexeme_data(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for lexeme data matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[TData] –

  An iterator of lexeme data matching search.

lexeme_descriptor(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for lexeme-descriptor pairs matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[tuple[Lexeme, Descriptor]] –

  An iterator of "(lexeme, descriptor)" pairs matching search.

property(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for properties matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[Property] –

  An iterator of properties matching search.

property_data(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for property data matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[TData] –

  An iterator of property data matching search.

property_descriptor(search, debug=None, language=None, limit=None, lookahead=None, page_size=None, timeout=None, context=None, **kwargs)

Searches for property-descriptor pairs matching search.

Parameters:

• search (str) –

  Search string.

• debug (bool | None, default: None ) –

  Whether to enable debugging mode.

• language (TTextLanguage | None, default: None ) –

  Language of search.

• limit (int | None, default: None ) –

  Limit (maximum number) of responses.

• lookahead (int | None, default: None ) –

  Number of pages to lookahead asynchronously.

• page_size (int | None, default: None ) –

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  KIF context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[tuple[Property, Descriptor]] –

  An iterator of "(property, descriptor)" pairs matching search.

set_language(language=None)

Sets the language of search.

If language is None, resets it to the default.

Parameters:

• language (TTextLanguage | None, default: None ) –

  Language.

to_item(data)

Parses item data.

Parameters:

• data (TData) –

  Item data.

Returns:

• Item –

  Item.

to_item_descriptor(data)

Parses item descriptor data.

Parameters:

• data (TData) –

  Item data.

Returns:

• tuple[Item, Descriptor] –

  Item-descriptor pair.

to_lexeme(data)

Parses lexeme data.

Parameters:

• data (TData) –

  Lexeme data.

Returns:

• Lexeme –

  Lexeme.

to_lexeme_descriptor(data)

Parses lexeme descriptor data.

Parameters:

• data (TData) –

  Lexeme data.

Returns:

• tuple[Lexeme, Descriptor] –

  Lexeme-descriptor pair.

to_property(data)

Parses property data.

Parameters:

• data (TData) –

  Property data.

Returns:

• Property –

  Property.

to_property_descriptor(data)

Parses property descriptor data.

Parameters:

• data (TData) –

  Property data.

Returns:

• tuple[Property, Descriptor] –

  Property-descriptor pair.