Documentation

searchexe

# Search execution management

Classes

class

SearchExe

Attributes

NameTypeDescription
_msgCachelist[Any] | int—
apiApi—
goodbool—
levelint—
offsetint—
outerTemplatestr | None—
perfDefaultsdict[(str, int | float)]—
perfParamsdict[(str, int | float)]—
quKindstr | None—
searchTemplatestr—
setInfodict[(str, bool | None)]—
setsdict[(str, set[int])] | None—
shallowint—
showQuantifiersbool—
silentstr—

Methods

__init__(self, api: Api, searchTemplate: str, outerTemplate: str | None = None, quKind: str | None = None, offset: int = 0, level: int = 0, sets: dict[(str, set[int])] | None = None, shallow: bool | int = False, silent: str = {'cls': 'ExprName', 'member': None, 'name': 'DEEP'}, showQuantifiers: bool = False, _msgCache: bool | list[Any] = False, setInfo: dict[(str, bool | None)] | None = None) → None
Parameters
  • api: Api
  • searchTemplate: str
  • outerTemplate: str | None= None
  • quKind: str | None= None
  • offset: int= 0
  • level: int= 0
  • sets: dict[(str, set[int])] | None= None
  • shallow: bool | int= False
  • silent: str
  • showQuantifiers: bool= False
  • _msgCache: bool | list[Any]= False
  • setInfo: dict[(str, bool | None)] | None= None
count(self, progress: int | None = None, limit: int | None = None) → None
Parameters
  • progress: int | None= None
  • limit: int | None= None
fetch(self, limit: int | None = None) → tuple[(tuple[(int, ...)], ...)] | set[int] | set[tuple[(int, ...)]] | Generator[(tuple[(int, ...)], None, None)]
Parameters
  • limit: int | None= None
search(self, limit: int | None = None) → tuple[(tuple[(int, ...)], ...)] | set[int] | set[tuple[(int, ...)]] | Generator[(tuple[(int, ...)], None, None)]
Parameters
  • limit: int | None= None
setPerfParams(cls, params: dict[(str, int | float)]) → None
Parameters
  • cls
  • params: dict[(str, int | float)]
showOuterTemplate(self, _msgCache: list[Any] | int) → None
Parameters
  • _msgCache: list[Any] | int
showPlan(self, details: bool = False) → None
Parameters
  • details: bool= False
study(self, strategy: str | None = None) → None
Parameters
  • strategy: str | None= None