Перейти к содержанию

InspectStats

InspectStats.

InspectStats

Bases: UtilsInspectStats

Класс для инспекции статистики.

Source code in src/qtasks/stats/inspect/inspect.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class InspectStats(UtilsInspectStats):
    """Класс для инспекции статистики."""

    def __init__(
        self,
        app: "QueueTasks"
    ):
        """Инициализация инспекции статистики.

        Args:
            app (QueueTasks): Экземпляр приложения.
        """
        self._app = app

    def app(self, json: bool = False):
        """Получение информации о приложении.

        Args:
            json (bool, optional): Флаг для возврата в формате JSON. По умолчанию: `False`.

        Returns:
            str: Информация о приложении.
        """
        return self._app_parser(self._app, json=json)

    def task(self, task_name: str, json: bool = False):
        """Получение информации о задаче.

        Args:
            task_name (str): Имя задачи.
            json (bool, optional): Флаг для возврата в формате JSON. По умолчанию: `False`.

        Returns:
            TaskExecSchema: Схема функции задачи.
        """
        if json:
            return self._parser_json(self._app.tasks[task_name])
        return self._tasks_parser((self._app.tasks[task_name], ))

    def tasks(self, *tasks: Tuple[str], json: bool = False):
        """Получение информации о задачах.

        Returns:
            List[TaskExecSchema]: Схемы функции задач.
            json (bool, optional): Флаг для возврата в формате JSON. По умолчанию: `False`.
        """
        if not tasks:
            result = self._app.tasks.values()
        else:
            result = [self._app.tasks[task] for task in tasks if task in self._app.tasks]

        if json:
            return self._parser_json(result)

        return self._tasks_parser(result)

__init__(app)

Инициализация инспекции статистики.

Parameters:

Name Type Description Default
app QueueTasks

Экземпляр приложения.

 required
Source code in src/qtasks/stats/inspect/inspect.py 
11
12
13
14
15
16
17
18
19
20
def __init__(
    self,
    app: "QueueTasks"
):
    """Инициализация инспекции статистики.

    Args:
        app (QueueTasks): Экземпляр приложения.
    """
    self._app = app

app(json=False)

Получение информации о приложении.

Parameters:

Name Type Description Default
json bool

Флаг для возврата в формате JSON. По умолчанию: False.

 False

Returns:

Name Type Description
str

Информация о приложении.
Source code in src/qtasks/stats/inspect/inspect.py 
22
23
24
25
26
27
28
29
30
31
def app(self, json: bool = False):
    """Получение информации о приложении.

    Args:
        json (bool, optional): Флаг для возврата в формате JSON. По умолчанию: `False`.

    Returns:
        str: Информация о приложении.
    """
    return self._app_parser(self._app, json=json)

task(task_name, json=False)

Получение информации о задаче.

Parameters:

Name Type Description Default
task_name str

Имя задачи.

 required
json bool

Флаг для возврата в формате JSON. По умолчанию: False.

 False

Returns:

Name Type Description
TaskExecSchema

Схема функции задачи.
Source code in src/qtasks/stats/inspect/inspect.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
def task(self, task_name: str, json: bool = False):
    """Получение информации о задаче.

    Args:
        task_name (str): Имя задачи.
        json (bool, optional): Флаг для возврата в формате JSON. По умолчанию: `False`.

    Returns:
        TaskExecSchema: Схема функции задачи.
    """
    if json:
        return self._parser_json(self._app.tasks[task_name])
    return self._tasks_parser((self._app.tasks[task_name], ))

tasks(*tasks, json=False)

Получение информации о задачах.

Returns:

Name Type Description

List[TaskExecSchema]: Схемы функции задач.
json (bool, optional)

Флаг для возврата в формате JSON. По умолчанию: False.
Source code in src/qtasks/stats/inspect/inspect.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def tasks(self, *tasks: Tuple[str], json: bool = False):
    """Получение информации о задачах.

    Returns:
        List[TaskExecSchema]: Схемы функции задач.
        json (bool, optional): Флаг для возврата в формате JSON. По умолчанию: `False`.
    """
    if not tasks:
        result = self._app.tasks.values()
    else:
        result = [self._app.tasks[task] for task in tasks if task in self._app.tasks]

    if json:
        return self._parser_json(result)

    return self._tasks_parser(result)