Changeset View
Changeset View
Standalone View
Standalone View
swh/scheduler/interface.py
| Show First 20 Lines • Show All 127 Lines • ▼ Show 20 Lines | class SchedulerInterface(Protocol): | ||||
| @remote_api_endpoint("task/get") | @remote_api_endpoint("task/get") | ||||
| def get_tasks(self, task_ids): | def get_tasks(self, task_ids): | ||||
| """Retrieve the info of tasks whose ids are listed.""" | """Retrieve the info of tasks whose ids are listed.""" | ||||
| ... | ... | ||||
| @remote_api_endpoint("task/peek_ready") | @remote_api_endpoint("task/peek_ready") | ||||
| def peek_ready_tasks( | def peek_ready_tasks( | ||||
| self, task_type, timestamp=None, num_tasks=None, num_tasks_priority=None, | self, | ||||
| ): | task_type: str, | ||||
| """Fetch the list of ready tasks | timestamp: Optional[datetime.datetime] = None, | ||||
| num_tasks: Optional[int] = None, | |||||
| ) -> List[Dict]: | |||||
| """Fetch the list of tasks (with no priority) to be scheduled. | |||||
| Args: | Args: | ||||
| task_type (str): filtering task per their type | task_type: filtering task per their type | ||||
| timestamp (datetime.datetime): peek tasks that need to be executed | timestamp: peek tasks that need to be executed | ||||
| before that timestamp | before that timestamp | ||||
| num_tasks (int): only peek at num_tasks tasks (with no priority) | num_tasks: only peek at num_tasks tasks (with no priority) | ||||
| num_tasks_priority (int): only peek at num_tasks_priority | |||||
| tasks (with priority) | |||||
| Returns: | Returns: | ||||
| a list of tasks | the list of tasks which would be scheduled | ||||
| """ | """ | ||||
| ... | ... | ||||
| @remote_api_endpoint("task/grab_ready") | @remote_api_endpoint("task/grab_ready") | ||||
| def grab_ready_tasks( | def grab_ready_tasks( | ||||
| self, task_type, timestamp=None, num_tasks=None, num_tasks_priority=None, | self, | ||||
| ): | task_type: str, | ||||
| """Fetch the list of ready tasks, and mark them as scheduled | timestamp: Optional[datetime.datetime] = None, | ||||
| num_tasks: Optional[int] = None, | |||||
| ) -> List[Dict]: | |||||
| """Fetch and schedule the list of tasks (with no priority) ready to be scheduled. | |||||
| Args: | Args: | ||||
| task_type (str): filtering task per their type | task_type: filtering task per their type | ||||
| timestamp (datetime.datetime): grab tasks that need to be executed | timestamp: grab tasks that need to be executed | ||||
| before that timestamp | before that timestamp | ||||
| num_tasks (int): only grab num_tasks tasks (with no priority) | num_tasks: only grab num_tasks tasks (with no priority) | ||||
| num_tasks_priority (int): only grab oneshot num_tasks tasks (with | |||||
| priorities) | |||||
| Returns: | Returns: | ||||
| a list of tasks | the list of scheduled tasks | ||||
| """ | """ | ||||
| ... | ... | ||||
| @remote_api_endpoint("task/peek_ready_with_priority") | @remote_api_endpoint("task/peek_ready_with_priority") | ||||
| def peek_ready_priority_tasks( | def peek_ready_priority_tasks( | ||||
| self, | self, | ||||
| task_type: str, | task_type: str, | ||||
| ▲ Show 20 Lines • Show All 220 Lines • ▼ Show 20 Lines | ) -> List[ListedOrigin]: | ||||
| visit_type: type of visits to schedule | visit_type: type of visits to schedule | ||||
| count: number of visits to schedule | count: number of visits to schedule | ||||
| policy: the scheduling policy used to select which visits to schedule | policy: the scheduling policy used to select which visits to schedule | ||||
| timestamp: the mocked timestamp at which we're recording that the visits are | timestamp: the mocked timestamp at which we're recording that the visits are | ||||
| being scheduled (defaults to the current time) | being scheduled (defaults to the current time) | ||||
| """ | """ | ||||
| ... | ... | ||||
| @remote_api_endpoint("priority_ratios/get") | |||||
| def get_priority_ratios(self): | |||||
| ... | |||||
| @remote_api_endpoint("visit_stats/upsert") | @remote_api_endpoint("visit_stats/upsert") | ||||
| def origin_visit_stats_upsert( | def origin_visit_stats_upsert( | ||||
| self, origin_visit_stats: Iterable[OriginVisitStats] | self, origin_visit_stats: Iterable[OriginVisitStats] | ||||
| ) -> None: | ) -> None: | ||||
| """Create a new origin visit stats | """Create a new origin visit stats | ||||
| """ | """ | ||||
| ... | ... | ||||
| Show All 40 Lines | |||||