Engine

Engine

Bases: Generic[TOptions]

Abstract base class for KIF object producing engines.

debug property writable

The debug flag of engine (whether debugging is enabled).

default_debug property

The default value for :attr:Engine.debug.

default_limit property

The default value for :attr:Engine.limit.

default_lookahead property

The default value for :attr:Engine.lookahead.

default_page_size property

The default value for :attr:Engine.page_size.

default_timeout property

The default value for :attr:Engine.timeout.

limit property writable

The limit of engine (maximum number of responses).

lookahead property writable

The lookahead of engine.

max_limit property

The maximum value for :attr:Engine.limit.

max_page_size property

The maximum value for :attr:Engine.page_size.

max_timeout property

The maximum value for :attr:Engine.timeout.

options property

The options of engine.

page_size property writable

The page size of engine (size of response pages).

timeout property writable

The timeout of engine (in seconds).

Error

Bases: Error

Base class for engine errors.

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

Initializes :class:Engine.

Parameters:

• args (Any, default: () ) –

  Arguments.

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

  Whether to enable debugging mode.

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

  Context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

aclose() async

Async version of :meth:Engine.close.

close()

Closes engine.

get_context(context=None) classmethod

Gets the current KIF context.

If context is not None, returns context.

Parameters:

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

  Context.

Returns:

• Context –

  Context.

get_debug()

Gets the debug flag of engine.

Returns:

• bool –

  Debug flag.

get_default_debug()

Gets the default value for :attr:Engine.debug.

Returns:

• bool –

  Default debug flag.

get_default_limit()

Gets the default value for :attr:Engine.limit.

Returns:

• int | None –

  Default limit or None.

get_default_lookahead()

Gets the default value for :attr:Engine.lookahead.

Returns:

• int –

  Default lookahead value.

get_default_options(context=None) abstractmethod classmethod

Gets the default options of engine.

Parameters:

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

  Context.

Returns:

• TOptions –

  Engine options.

get_default_page_size()

Gets the default value for :attr:Engine.page_size.

Returns:

• int –

  Default page size.

get_default_timeout()

Gets the default value for :attr:Engine.timeout.

Returns:

• float | None –

  Timeout or None.

get_limit(default=None)

Gets the limit of engine.

If the limit is None, returns default.

If default is None, assumes :attr:Engine.default_limit.

Parameters:

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

  Default limit.

Returns:

• int | None –

  Limit or None.

get_lookahead()

Gets the lookahead of engine.

Returns:

• int –

  Lookahead.

get_max_limit()

Gets the maximum value for :attr:Engine.limit.

Returns:

• int –

  Maximum limit.

get_max_page_size()

Gets the maximum value for :attr:Engine.page_size.

Returns:

• int –

  Maximum page size.

get_max_timeout()

Gets the maximum value for :attr:Engine.timeout.

Returns:

• float –

  Maximum timeout (in seconds).

get_options()

Gets the options of engine.

Returns:

• TOptions –

  Engine options.

get_page_size()

Gets the page size of engine.

Returns:

• int –

  Page size.

get_timeout(default=None)

Gets the timeout of engine.

If the timeout is None, returns default.

If default is None, assumes :attr:Engine.default_timeout.

Parameters:

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

  Default timeout.

Returns:

• float | None –

  Timeout or None.

set_debug(debug=None)

Sets the debug flag of engine.

If debug is None, resets it to the default.

Parameters:

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

  Debug flag.

set_limit(limit=None)

Sets the limit of engine.

If limit is negative, assumes zero.

If limit is None, resets it to the default.

Parameters:

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

  Limit.

set_lookahead(lookahead=None)

Sets the lookhead of engine.

If lookahead is negative, assumes one.

If lookahead is None, resets it to the default.

Parameters:

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

  Lookahead.

set_page_size(page_size=None)

Sets the page size of engine.

If page_size is negative, assumes zero.

If page_size is None, resets it to the default.

Parameters:

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

  Page size.

set_timeout(timeout=None)

Sets the timeout of engine.

If timeout is negative, assumes zero.

If timeout is None, resets it to the default.

Parameters:

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

  Timeout.