apidocsの修正

kurusugawa-computer · Jul 1, 2019 · 3780eaa · 3780eaa
1 parent 1e5bf48
commit 3780eaa
Show file tree

Hide file tree

Showing 9 changed files with 84 additions and 68 deletions.
diff --git a/Makefile b/Makefile
@@ -31,5 +31,5 @@ publish:
 	rm -fr build/ dist/ annofabapi.egg-info
 
 docs:
-	cd docs && make html
+	cd docs && pipenv run make html
 	@echo "\033[95m\n\nBuild successful! View the docs homepage at docs/_build/html/index.html.\n\033[0m"
diff --git a/annofabapi/api.py b/annofabapi/api.py
@@ -201,6 +201,8 @@ def login(self) -> Tuple[Dict[str, Any], requests.Response]:
         """
         ログイン
 
+
+
         Returns:
             Tuple[Token, requests.Response]
 
@@ -225,6 +227,8 @@ def logout(self) -> Optional[Tuple[Dict[str, Any], requests.Response]]:
         ログアウト
         ログインしていないときはNoneを返す。
 
+
+
         Returns:
             Tuple[Token, requests.Response]. ログインしていないときはNone.
 
@@ -247,6 +251,8 @@ def refresh_token(self
         トークン リフレッシュ
         ログインしていないときはNoneを返す。
 
+
+
         Returns:
             Tuple[Token, requests.Response]. ログインしていないときはNone.
         """

diff --git a/annofabapi/api2.py b/annofabapi/api2.py
@@ -1,11 +1,7 @@
-import functools
-import json
 import logging
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union  # pylint: disable=unused-import
 
-import backoff
 import requests
-from requests.auth import AuthBase
 
 import annofabapi.utils
 from annofabapi.api import AnnofabApi
@@ -81,9 +77,8 @@ def _request_wrapper(self,
             kwargs.update({"cookies": self.cookies})
 
             # HTTP Requestを投げる
-            response: requests.Response = getattr(self.api.session,
-                                                  http_method.lower())(
-                                                      url, **kwargs)
+            response = getattr(self.api.session, http_method.lower())(url,
+                                                                      **kwargs)
 
             # CloudFrontから403 Errorが発生したとき
             if response.status_code == requests.codes.forbidden and response.headers.get(
@@ -109,7 +104,8 @@ def _get_signed_access_v2(self, url_path: str):
     #########################################
     # Public Method : Cache
     #########################################
-    def get_signed_access_v2(self, query_params: Dict[str, Any]) -> Tuple[Dict[str, Any], requests.Response]:
+    def get_signed_access_v2(self, query_params: Dict[str, Any]
+                             ) -> Tuple[Dict[str, Any], requests.Response]:
         """
         Signed Cookieを取得して、インスタンスに保持する。
 

diff --git a/annofabapi/generated_api2.py b/annofabapi/generated_api2.py
@@ -1,13 +1,12 @@
 # flake8: noqa: W291
 # pylint: disable=too-many-lines,trailing-whitespace
-
 """
 AbstractAnnofabApi2のヘッダ部分
 注意：このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照
 """
 
 import abc
-import warnings
+import warnings  # pylint: disable=unused-import
 from typing import Any, Dict, List, Optional, Tuple, Union  # pylint: disable=unused-import
 
 import requests
@@ -27,12 +26,17 @@ def _request_wrapper(self,
                          request_body: Optional[Any] = None
                          ) -> Tuple[Any, requests.Response]:
         pass
+
     #########################################
     # Public Method : AfAnnotationSpecsV2Api
     # NOTE: This method is auto generated by OpenAPI Generator
     #########################################
 
-    def get_annotation_specs_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_annotation_specs_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """アノテーション仕様取得
 
 
@@ -54,12 +58,16 @@ def get_annotation_specs_v2(self, project_id: str, query_params: Optional[Dict[s
             'query_params': query_params,
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
+
     #########################################
     # Public Method : AfProjectV2Api
     # NOTE: This method is auto generated by OpenAPI Generator
     #########################################
 
-    def get_project_cache_v2(self, project_id: str, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_project_cache_v2(
+            self,
+            project_id: str,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """キャッシュレコード
 
 
@@ -75,15 +83,19 @@ def get_project_cache_v2(self, project_id: str, ) -> Tuple[Any, requests.Respons
         """
         url_path = f'/projects/{project_id}/cache'
         http_method = 'GET'
-        keyword_params: Dict[str, Any] = {
-        }
+        keyword_params: Dict[str, Any] = {}
         return self._request_wrapper(http_method, url_path, **keyword_params)
+
     #########################################
     # Public Method : AfStatisticsV2Api
     # NOTE: This method is auto generated by OpenAPI Generator
     #########################################
 
-    def get_account_statistics_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_account_statistics_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """ユーザー別タスク集計取得
 
 
@@ -106,7 +118,11 @@ def get_account_statistics_v2(self, project_id: str, query_params: Optional[Dict
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_inspection_statistics_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_inspection_statistics_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """検査コメント集計取得
 
 
@@ -129,7 +145,11 @@ def get_inspection_statistics_v2(self, project_id: str, query_params: Optional[D
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_label_statistics_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_label_statistics_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """ラベル別アノテーション数集計取得
 
 
@@ -152,7 +172,11 @@ def get_label_statistics_v2(self, project_id: str, query_params: Optional[Dict[s
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_task_phase_statistics_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_task_phase_statistics_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """フェーズ別タスク集計取得
 
 
@@ -175,7 +199,11 @@ def get_task_phase_statistics_v2(self, project_id: str, query_params: Optional[D
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_task_statistics_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_task_statistics_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """タスク集計取得
 
 
@@ -198,7 +226,11 @@ def get_task_statistics_v2(self, project_id: str, query_params: Optional[Dict[st
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_worktime_statistics_v2(self, project_id: str, query_params: Optional[Dict[str, Any]] = None, ) -> Tuple[Any, requests.Response]:  # noqa: E501
+    def get_worktime_statistics_v2(
+            self,
+            project_id: str,
+            query_params: Optional[Dict[str, Any]] = None,
+    ) -> Tuple[Any, requests.Response]:  # noqa: E501
         """タスク作業時間集計取得
 
 

diff --git a/annofabapi/resource.py b/annofabapi/resource.py
@@ -16,8 +16,14 @@ def __init__(self, login_user_id: str, login_password: str):
             login_password: AnnoFabにログインするときのパスワード
 
         """
+
+        #: AnnofabApi Instance
         self.api = AnnofabApi(login_user_id, login_password)
+
+        #: Wrapper Instance
         self.wrapper = Wrapper(self.api)
+
+        #: AnnofabApi2 Instance
         self.api2 = AnnofabApi2(self.api)
 
 

diff --git a/annofabapi/utils.py b/annofabapi/utils.py
@@ -16,9 +16,11 @@ def log_error_response(arg_logger: logging.Logger,
                        response: requests.Response):
     """
     HTTP Statusが400以上ならば、loggerにresponse/request情報を出力する
+
     Args:
         arg_logger: logger
         response: Response
+
     """
 
     if 400 <= response.status_code < 600:
@@ -34,9 +36,11 @@ def log_error_response(arg_logger: logging.Logger,
 def download(url: str, dest_path: str):
     """
     HTTP GETで取得した内容をファイルに保存する（ダウンロードする）
+
     Args:
         url: ダウンロード対象のURL
         dest_path: 保存先ファイルのパス
+
     """
     response = requests.get(url)
     response.raise_for_status()
@@ -50,8 +54,12 @@ def download(url: str, dest_path: str):
 def str_now() -> str:
     """
     現在日時をISO8601 formatで取得する。
+
+
+
     Returns:
         ISO 8601 formatの現在日時
+
     """
     d = datetime.datetime.now(dateutil.tz.tzlocal())
     return d.isoformat(timespec='milliseconds')
diff --git a/docs/annofabapi.rst b/docs/annofabapi.rst
@@ -1,70 +1,36 @@
 annofabapi package
 ==================
 
-Submodules
-----------
 
-annofabapi.api module
----------------------
+annofabapi.AnnofabApi class
+---------------------------
+.. autoclass:: annofabapi.AnnofabApi
+    :inherited-members:
 
-.. automodule:: annofabapi.api
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
-annofabapi.exceptions module
-----------------------------
+annofabapi.Wrapper class
+------------------------
+.. autoclass:: annofabapi.Wrapper
+    :inherited-members:
 
-.. automodule:: annofabapi.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
-annofabapi.generated\_api module
---------------------------------
+annofabapi.AnnofabApi2 class
+----------------------------
+.. autoclass:: annofabapi.AnnofabApi2
+    :inherited-members:
 
-.. automodule:: annofabapi.generated_api
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 annofabapi.resource module
 --------------------------
 
 .. automodule:: annofabapi.resource
     :members:
-    :undoc-members:
-    :show-inheritance:
-
-annofabapi.typing module
-------------------------
 
-.. automodule:: annofabapi.typing
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 annofabapi.utils module
 -----------------------
 
 .. automodule:: annofabapi.utils
     :members:
-    :undoc-members:
-    :show-inheritance:
 
-annofabapi.wrapper module
--------------------------
-
-.. automodule:: annofabapi.wrapper
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: annofabapi
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/tests/test_api2.py b/tests/test_api2.py
@@ -44,4 +44,3 @@
 
 def test_project():
     assert type(service.api2.get_project_cache_v2(project_id))
-
diff --git a/tox.ini b/tox.ini
@@ -57,6 +57,9 @@ disable =
     empty-docstring,
     redefined-builtin,
 
+# ===== Custom =====
+    protected-access,
+
 [aliases]
 test=pytest