Merge pull request #50 from kurusugawa-computer/fix/statistics-api

過去のアノテーション仕様を参照、統計APIの修正

Author: yuji38kwmt

Pipfile

@@ -22,8 +22,7 @@ twine = "*"
 # Match sphinx version at ReadTheDocs
 sphinx = "==1.8.5"
 autoflake = "*"
-# Specify version temporarily
-docutils = "<=0.15.0"
+docutils = "*"
 
 [pipenv]
 allow_prereleases = true

Pipfile.lock

@@ -1,6 +1,7 @@
 import functools
 import json
 import logging
+import warnings
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union  # pylint: disable=unused-import
 
 import backoff
@@ -177,6 +178,26 @@ def _request_wrapper(self, http_method: str, url_path: str, query_params: Option
         content = self._response_to_content(response)
         return content, response
 
+    def _get_signed_cookie(self, project_id):
+        """
+        アノテーション仕様の履歴情報を取得するために、非公開APIにアクセスする。
+        変更される可能性あり.
+
+        .. deprecated:: X
+
+        Args:
+            project_id: プロジェクトID
+
+        Returns:
+            Tuple[Content, Reponse)
+
+        """
+        warnings.warn("deprecated", DeprecationWarning)
+        url_path = f'/private/projects/{project_id}/sign-headers'
+        http_method = 'GET'
+        keyword_params: Dict[str, Any] = {}
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
     #########################################
     # Public Method : Login
     #########################################

annofabapi/api.py

@@ -5,6 +5,8 @@
 import urllib.parse
 from typing import Any, Callable, Dict, List, Optional, Tuple  # pylint: disable=unused-import
 
+import requests
+
 import annofabapi.utils
 from annofabapi import AnnofabApi
 from annofabapi.exceptions import AnnofabApiException
@@ -152,6 +154,22 @@ def get_all_annotation_list(self, project_id: str,
     #########################################
     # Public Method : AfAnnotationSpecsApi
     #########################################
+    def get_annotation_specs_from_url(self, project_id: str, url: str) -> AnnotationSpecs:
+        """
+        アノテーション仕様の履歴から取得したURLから、アノテーション仕様を取得する
+
+        Args:
+            project_id: プロジェクトID
+            url: アノテーション仕様の履歴から取得したURL
+
+        Returns:
+            put_annotation_specsのContent
+        """
+        cookies, _ = self.api._get_signed_cookie(project_id)
+        kwargs = self.api._create_kwargs()
+        kwargs.update({"cookies": cookies})
+        return requests.get(url, **kwargs).json()
+
     def copy_annotation_specs(self, src_project_id: str, dest_project_id: str,
                               comment: Optional[str] = None) -> AnnotationSpecs:
         """
@@ -262,6 +280,25 @@ def put_input_data_from_file(self, project_id: str, input_data_id: str, file_pat
 
         return self.api.put_input_data(project_id, input_data_id, request_body=copied_request_body)[0]
 
+    #########################################
+    # Public Method : AfStatisticsApi
+    #########################################
+    def get_worktime_statistics(self, project_id: str) -> Dict[str, Any]:
+        """
+        タスク作業時間集計取得.
+        Location Headerに記載されたURLのレスポンスをJSON形式で返す。
+
+        Args:
+            project_id:  プロジェクトID
+
+        Returns:
+            タスク作業時間集計
+
+        """
+        _, response = self.api.get_worktime_statistics(project_id)
+        url = response.headers['Location']
+        return requests.get(url).json()
+
     #########################################
     # Public Method : AfSupplementaryApi
     #########################################

annofabapi/wrapper.py

@@ -8,15 +8,14 @@
 """
 import configparser
 import datetime
-import logging
 import os
 import time
 import uuid
 from distutils.util import strtobool
 
 import annofabapi
 import annofabapi.utils
-from tests.utils_for_test import WrapperForTest, create_csv_for_task
+from tests.utils_for_test import WrapperForTest, create_csv_for_task, set_logging_from_inifile
 
 # プロジェクトトップに移動する
 os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
@@ -29,10 +28,7 @@
 test_dir = './tests/data'
 out_dir = './tests/out'
 
-if should_print_log_message:
-    logging_formatter = '%(levelname)s : %(asctime)s : %(name)s : %(funcName)s : %(message)s'
-    logging.basicConfig(format=logging_formatter)
-    logging.getLogger("annofabapi").setLevel(level=logging.DEBUG)
+set_logging_from_inifile(inifile)
 
 service = annofabapi.build_from_netrc()
 api = service.api
@@ -133,6 +129,10 @@ def test_annotation_specs():
     annotation_specs_histories = api.get_annotation_specs_histories(project_id)[0]
     assert type(annotation_specs_histories) == list
 
+    old_annotation_specs_url = annotation_specs_histories[0]["url"]
+    old_annotation_specs = wrapper.get_annotation_specs_from_url(project_id, old_annotation_specs_url)
+    assert type(old_annotation_specs) == dict
+
 
 def test_login():
     print(f"login")
@@ -314,7 +314,7 @@ def test_statistics():
     assert type(api.get_label_statistics(project_id)[0]) == list
 
     print("get_worktime_statistics")
-    assert type(api.get_worktime_statistics(project_id)[0]) == list
+    assert type(wrapper.get_worktime_statistics(project_id)) == list
 
 
 def test_task():

tests/test_api.py

@@ -3,29 +3,24 @@
 
 """
 import configparser
-import logging
 import os
 from distutils.util import strtobool
 
 import annofabapi
 import annofabapi.utils
-from tests.utils_for_test import WrapperForTest
+from tests.utils_for_test import WrapperForTest, set_logging_from_inifile
 
 # プロジェクトトップに移動する
 os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
 inifile = configparser.ConfigParser()
 inifile.read('./pytest.ini', 'UTF-8')
 project_id = inifile.get('annofab', 'project_id')
 should_execute_job_api: bool = strtobool(inifile.get('annofab', 'should_execute_job_api'))
-should_print_log_message: bool = strtobool(inifile.get('annofab', 'should_print_log_message'))
 
 test_dir = './tests/data'
 out_dir = './tests/out'
 
-if should_print_log_message:
-    logging_formatter = '%(levelname)s : %(asctime)s : %(name)s : %(funcName)s : %(message)s'
-    logging.basicConfig(format=logging_formatter)
-    logging.getLogger("annofabapi").setLevel(level=logging.DEBUG)
+set_logging_from_inifile(inifile)
 
 service = annofabapi.build_from_netrc()
 test_wrapper = WrapperForTest(service.api)

tests/test_api2.py

@@ -1,5 +1,4 @@
 import configparser
-import logging
 import os
 from distutils.util import strtobool
 from pathlib import Path
@@ -20,7 +19,7 @@
 from annofabapi.dataclass.supplementary import SupplementaryData
 from annofabapi.dataclass.task import Task, TaskHistory
 from annofabapi.dataclass.webhook import Webhook
-from tests.utils_for_test import WrapperForTest
+from tests.utils_for_test import WrapperForTest, set_logging_from_inifile
 
 # プロジェクトトップに移動する
 os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
@@ -30,14 +29,10 @@
 task_id = inifile.get('annofab', 'task_id')
 input_data_id = inifile.get('annofab', 'input_data_id')
 should_execute_job_api: bool = strtobool(inifile.get('annofab', 'should_execute_job_api'))
-should_print_log_message: bool = strtobool(inifile.get('annofab', 'should_print_log_message'))
 
-test_dir = Path('./tests/data')
+set_logging_from_inifile(inifile)
 
-if should_print_log_message:
-    logging_formatter = '%(levelname)s : %(asctime)s : %(name)s : %(funcName)s : %(message)s'
-    logging.basicConfig(format=logging_formatter)
-    logging.getLogger("annofabapi").setLevel(level=logging.DEBUG)
+test_dir = Path('./tests/data')
 
 service = annofabapi.build_from_netrc()
 test_wrapper = WrapperForTest(service.api)
@@ -141,7 +136,7 @@ def test_statistics_get_label_statistics():
 
 
 def test_statistics_get_worktime_statistics():
-    stat_list, _ = service.api.get_worktime_statistics(project_id)
+    stat_list = service.wrapper.get_worktime_statistics(project_id)
     stat = WorktimeStatistics.from_dict(stat_list[0])
     assert type(stat) == WorktimeStatistics
 

tests/test_dataclass.py

@@ -1,5 +1,8 @@
+import configparser
 import csv
+import logging
 import os
+from distutils.util import strtobool
 
 from annofabapi import AnnofabApi
 
@@ -17,6 +20,21 @@ def create_csv_for_task(file_path, first_input_data):
         writer.writerows(lines)
 
 
+def set_logging_from_inifile(inifile: configparser.ConfigParser):
+    """
+    読み込み済の inifile から、ロギングを設定する。
+
+    Args:
+        inifile: 読み込み済の inifile
+
+    """
+    should_print_log_message: bool = strtobool(inifile.get('annofab', 'should_print_log_message'))
+    if should_print_log_message:
+        logging_formatter = '%(levelname)s : %(asctime)s : %(name)s : %(funcName)s : %(message)s'
+        logging.basicConfig(format=logging_formatter)
+        logging.getLogger("annofabapi").setLevel(level=logging.DEBUG)
+
+
 class WrapperForTest:
     """
     テスト用のUtils