UserRestrictionCursor

toloka.streaming.cursor.UserRestrictionCursor | Source code

UserRestrictionCursor(
self,
toloka_client: Union[TolokaClient, AsyncTolokaClient],
time_lag: timedelta = ...,
scope: Optional[UserRestriction.Scope] = None,
user_id: Optional[str] = None,
project_id: Optional[str] = None,
pool_id: Optional[str] = None,
id_lt: Optional[str] = None,
id_lte: Optional[str] = None,
id_gt: Optional[str] = None,
id_gte: Optional[str] = None,
created_lt: Optional[datetime] = None,
created_lte: Optional[datetime] = None,
created_gt: Optional[datetime] = None,
created_gte: Optional[datetime] = None
)

Iterator over Toloker restrictions by create time.

Parameters description

ParametersTypeDescription
toloka_clientUnion[TolokaClient, AsyncTolokaClient]

TolokaClient object that is being used to search Toloker restrictions.

requestUserRestrictionSearchRequest

Base request to search Toloker restrictions.

_time_lag-

Time lag between cursor time field upper bound and real time. Default is 1 minute. This lag is required to keep cursor consistent. Lowering this value will make cursor process events faster, but raises probability of missing some events in case of concurrent operations.

Examples:

Iterate over Toloker restrictions in a project.

it = UserRestrictionCursor(toloka_client=toloka_client, project_id=my_proj_id)
current_restrictions = list(it)
# ... new restrictions could appear ...
new_restrictions = list(it) # Contains only new restrictions, appeared since the previous call.

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming