card time client (#1310)

* card time client

* card time client fix queuenames split

* card time client fix cardtimeinfo class name

* card time client fix print

Author: hyx930

client/paddleflow/cli/statistics.py

@@ -1,9 +1,10 @@
+import json
 import sys
 import traceback
 
 import click
 from paddleflow.cli.output import print_output
-from paddleflow.statistics import StatisticsJobInfo, StatisticsJobDetailInfo
+from paddleflow.statistics import StatisticsJobInfo, StatisticsJobDetailInfo, CardTimeInfo, Detail
 
 
 # !/usr/bin/env python3
@@ -108,3 +109,63 @@ def _print_job_statistics_detail(job_statistics_detail_info: StatisticsJobDetail
         data.append(v)
 
     print_output(data, headers, output_format, table_format='grid')
+
+
+@statistics.command()
+@click.pass_context
+@click.option('-q', '--queue_names', help="queue names, split by ,", type=str)
+@click.option('-s', '--start_time', help="start time", type=str)
+@click.option('-e', '--end_time', help="end time", type=str)
+def card_time(ctx, queue_names, start_time, end_time):
+    """ get card time by queue name.\n
+    queue_name: the name of queues you want to get card time.
+    """
+    client = ctx.obj['client']
+    output_format = ctx.obj['output']
+    if not queue_names:
+        click.echo("queue name is required")
+        sys.exit(1)
+
+    if not start_time:
+        click.echo("start time is required")
+        sys.exit(1)
+
+    if not end_time:
+        click.echo("end time is required")
+        sys.exit(1)
+
+    queue_names = queue_names.split(",")
+    _get_cardtime_by_queue_name(client, output_format, queue_names, start_time, end_time)
+
+
+def _get_cardtime_by_queue_name(cli, output_format, queue_names, start_time, end_time):
+    valid, response = cli.get_cardtime_by_queue_name(queue_names, start_time, end_time)
+    if valid:
+        _print_card_time_info(response, output_format)
+    else:
+        click.echo("get queue statistics failed with message[%s]" % response)
+        sys.exit(1)
+
+
+def _print_card_time_info(info: CardTimeInfo, output_format):
+    """print card time info."""
+    if len(info.data) == 0:
+        click.echo("no data")
+        return
+
+    data_res = []
+    for data in info.data:
+        detail_res = []
+        for detail in data.detail:
+            detail = {
+                "userName": detail.user_name,
+                "jobInfo": [job_info.to_json() for job_info in detail.job_info_list],
+                "jobCount": detail.job_count,
+                "totalCardTime": detail.total_card_time,
+            }
+            detail_res.append(detail)
+        data_res.append([data.queue_name, data.card_time, data.device_type, detail_res])
+
+    headers = ['queueName', 'cardTime', 'deviceType', 'detail']
+
+    print_output(data_res, headers, output_format, table_format='json')

client/paddleflow/client.py

@@ -845,3 +845,12 @@ def get_statistics_detail(self, jobid: str, start: int = None, end: int = None,
         if not ret:
             return ret, res, False
         return ret, res, res.truncated
+
+    def get_cardtime_by_queue_name(self, queue_names: list, start_time: str, end_time: str):
+        """
+        get_card_time_by_queue_name
+        """
+        self.pre_check()
+        if queue_names is None or len(queue_names) == 0:
+            raise PaddleFlowSDKException("InvalidQueueName", "queue name should not be none or empty")
+        return StatisticsServiceApi.get_cardtime_by_queue_name(self.paddleflow_server, queue_names, start_time, end_time,header=self.header)

client/paddleflow/statistics/__init__.py

@@ -18,4 +18,4 @@
 # -*- coding:utf8 -*-
 
 from .statistics_api import StatisticsServiceApi
-from .statistics_info import StatisticsJobInfo, StatisticsJobDetailInfo
+from .statistics_info import StatisticsJobInfo, StatisticsJobDetailInfo, CardTimeInfo, Detail

client/paddleflow/statistics/statistics_api.py

@@ -23,7 +23,7 @@
 from paddleflow.common.exception.paddleflow_sdk_exception import PaddleFlowSDKException
 from paddleflow.utils import api_client
 from paddleflow.common import api
-from paddleflow.statistics.statistics_info import StatisticsJobInfo, StatisticsJobDetailInfo
+from paddleflow.statistics.statistics_info import StatisticsJobInfo, StatisticsJobDetailInfo, CardTimeInfo
 
 
 class StatisticsServiceApi(object):
@@ -113,3 +113,37 @@ def get_statistics_detail(cls, host, job_id: str, start=None, end=None,
             return False, data['message']
         statistics_job_detail_info = StatisticsJobDetailInfo.from_json(data)
         return True, statistics_job_detail_info
+
+    @classmethod
+    def get_cardtime_by_queue_name(cls, host, queue_names: list, start_time: str, end_time: str, header=None):
+        """
+        get statistics info, run_id is not supported yet
+        @param host: host url
+        @param queue_names: queue names list
+        @param start_time: start time
+        @param end_time: end time
+        @param header: request header
+        @return: success: bool, resp: StatisticsQueueInfo
+        """
+        if not header:
+            raise PaddleFlowSDKException("InvalidRequest", "paddleflow should login first")
+
+        body = {
+            "queueNames": queue_names,
+            "startTime": start_time,
+            "endTime": end_time,
+        }
+        resp = api_client.call_api(method="POST",
+                                   url=parse.urljoin(host, api.PADDLE_FLOW_STATISTIC + "/cardTime"),
+                                   headers=header,
+                                   json=body)
+        if not resp:
+            raise PaddleFlowSDKException("Connection Error", "status run failed due to HTTPError")
+        data = json.loads(resp.text)
+        # return error resp, return err
+        if 'message' in data:
+            return False, data['message']
+
+        statistics_queue_info = CardTimeInfo.from_json(data)
+
+        return True, statistics_queue_info

client/paddleflow/statistics/statistics_info.py

@@ -14,8 +14,9 @@
 limitations under the License.
 """
 
-#!/usr/bin/env python3
+# !/usr/bin/env python3
 # -*- coding:utf8 -*-
+import json
 from typing import List, Mapping
 
 
@@ -92,3 +93,122 @@ def from_json(metric_info):
                 result.task_info.append(task_info)
             statistics_job_detail_info.result.append(result)
         return statistics_job_detail_info
+
+
+class JobInfo:
+    job_id: str
+    card_time: float
+    create_time: str
+    start_time: str
+    finish_time: str
+    device_count: int
+
+    def __init__(self, job_id: str, card_time: float, create_time: str, start_time: str, finish_time: str,
+                 device_count: int) -> None:
+        self.job_id = job_id
+        self.card_time = card_time
+        self.create_time = create_time
+        self.start_time = start_time
+        self.finish_time = finish_time
+        self.device_count = device_count
+
+    def to_json(self):
+        job_info = {
+            "jobId": self.job_id,
+            "cardTime": self.card_time,
+            "createTime": self.create_time,
+            "startTime": self.start_time,
+            "finishTime": self.finish_time,
+            "deviceCount": self.device_count
+        }
+        return job_info
+
+
+class Detail:
+    user_name: str
+    job_info_list: List[JobInfo]
+    job_count: int
+    total_card_time: float
+
+    def __init__(self, user_name: str, job_info_list: List[JobInfo], job_count: int, total_card_time: float) -> None:
+        self.user_name = user_name
+        self.job_info_list = job_info_list
+        self.job_count = job_count
+        self.total_card_time = total_card_time
+
+    def __str__(self):
+        json.dumps(self.__dict__)
+
+    def to_str(self):
+        return "Detail: user name: {}, job info list: {}, job count: {}, total card time: {},". \
+            format(self.user_name, self.job_info_list, self.job_count, self.total_card_time)
+
+
+class CardTimeResult:
+    queue_name: str
+    card_time: float
+    device_type: str
+    detail: List[Detail]
+
+    def __init__(self, queue_name: str, card_time: float, device_type: str, detail: List[Detail]) -> None:
+        self.queue_name = queue_name
+        self.card_time = card_time
+        self.device_type = device_type
+        self.detail = detail
+
+    def __str__(self):
+        return "Detail: queue name: {}, card time: {}, device type: {}, detail: {},". \
+            format(self.queue_name, self.card_time, self.device_type, self.detail)
+
+
+class CardTimeInfo:
+    data: List[CardTimeResult]
+
+    def __init__(self, data: List[CardTimeResult]) -> None:
+        self.data = data
+
+    def __str__(self) -> str:
+        """ str """
+        return "CardTimeInfo: data: {}".format(self.data)
+
+    @staticmethod
+    def from_json(card_time_stat_info):
+        card_time_info = CardTimeInfo(
+            data=[],
+        )
+        try:
+            for result_json in card_time_stat_info['data']:
+                result = CardTimeResult(
+                    queue_name=result_json['queueName'],
+                    card_time=result_json['cardTime'],
+                    device_type=result_json['deviceType'],
+                    detail=[]
+                )
+                try:
+                    for detail_json in result_json['detail']:
+                        detail = Detail(
+                            user_name=detail_json['userName'],
+                            job_info_list=[],
+                            job_count=detail_json['jobCount'],
+                            total_card_time=detail_json['totalCardTime']
+                        )
+                        try:
+                            for job_info_json in detail_json['jobInfoList']:
+                                job_info = JobInfo(
+                                    job_id=job_info_json['jobId'],
+                                    card_time=job_info_json['cardTime'],
+                                    create_time=job_info_json['createTime'],
+                                    start_time=job_info_json['startTime'],
+                                    finish_time=job_info_json['finishTime'],
+                                    device_count=job_info_json['deviceCount'],
+                                )
+                                detail.job_info_list.append(job_info)
+                        except:
+                            pass
+                        result.detail.append(detail)
+                except:
+                    pass
+                card_time_info.data.append(result)
+        except:
+            pass
+        return card_time_info