From 106d032ecb2250d1ea4d7ce757727e5957ed08b7 Mon Sep 17 00:00:00 2001 From: yuji38kwmt Date: Thu, 18 Nov 2021 13:51:44 +0900 Subject: [PATCH 1/2] =?UTF-8?q?warnings.warn=E3=81=AE=E3=83=A1=E3=83=83?= =?UTF-8?q?=E3=82=BB=E3=83=BC=E3=82=B8=E3=82=92=E3=82=8F=E3=81=8B=E3=82=8A?= =?UTF-8?q?=E3=82=84=E3=81=99=E3=81=8F=E3=81=99=E3=82=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- annofabapi/api.py | 5 ++-- annofabapi/generated_api.py | 36 +++++++++++++++++++++----- annofabapi/wrapper.py | 46 ++++++++++++++++++++++++++++------ generate/template/api.mustache | 2 +- 4 files changed, 72 insertions(+), 17 deletions(-) diff --git a/annofabapi/api.py b/annofabapi/api.py index f41b7a8c..c647753b 100644 --- a/annofabapi/api.py +++ b/annofabapi/api.py @@ -325,8 +325,9 @@ def get_labor_control(self, query_params: Optional[Dict[str, Any]] = None) -> Tu """ - warnings.warn("deprecated", FutureWarning) - + warnings.warn( + "annofabapi.AnnofabApi.get_labor_control() is deprecated and will be removed.", FutureWarning, stacklevel=2 + ) url_path = "/labor-control" http_method = "GET" keyword_params: Dict[str, Any] = { diff --git a/annofabapi/generated_api.py b/annofabapi/generated_api.py index 47b3771f..bb519a03 100644 --- a/annofabapi/generated_api.py +++ b/annofabapi/generated_api.py @@ -2137,7 +2137,11 @@ def get_project_task_history_events_url(self, project_id: str, **kwargs) -> Tupl """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.AnnofabApi.get_project_task_history_events_url() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) url_path = f"/projects/{project_id}/rawdata/task_history_events" http_method = "GET" keyword_params: Dict[str, Any] = {} @@ -2419,7 +2423,11 @@ def get_account_statistics(self, project_id: str, **kwargs) -> Tuple[Any, reques """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.AnnofabApi.get_account_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) url_path = f"/projects/{project_id}/statistics/accounts" http_method = "GET" keyword_params: Dict[str, Any] = {} @@ -2474,7 +2482,11 @@ def get_inspection_statistics(self, project_id: str, **kwargs) -> Tuple[Any, req """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.AnnofabApi.get_inspection_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) url_path = f"/projects/{project_id}/statistics/inspections" http_method = "GET" keyword_params: Dict[str, Any] = {} @@ -2605,7 +2617,11 @@ def get_task_phase_statistics(self, project_id: str, **kwargs) -> Tuple[Any, req """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.AnnofabApi.get_task_phase_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) url_path = f"/projects/{project_id}/statistics/task-phases" http_method = "GET" keyword_params: Dict[str, Any] = {} @@ -2630,7 +2646,11 @@ def get_task_statistics(self, project_id: str, **kwargs) -> Tuple[Any, requests. """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.AnnofabApi.get_task_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) url_path = f"/projects/{project_id}/statistics/tasks" http_method = "GET" keyword_params: Dict[str, Any] = {} @@ -2716,7 +2736,11 @@ def get_worktime_statistics(self, project_id: str, **kwargs) -> Tuple[Any, reque """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.AnnofabApi.get_worktime_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) url_path = f"/projects/{project_id}/statistics/worktimes" http_method = "GET" keyword_params: Dict[str, Any] = {} diff --git a/annofabapi/wrapper.py b/annofabapi/wrapper.py index b716343c..40109f71 100644 --- a/annofabapi/wrapper.py +++ b/annofabapi/wrapper.py @@ -265,7 +265,11 @@ def download_full_annotation_archive(self, project_id: str, dest_path: str) -> s ダウンロード元のURL """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.download_full_annotation_archive() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) _, response = self.api.get_archive_full_with_pro_id(project_id) url = response.headers["Location"] response2 = _download(url, dest_path) @@ -1014,7 +1018,9 @@ def get_task_statistics(self, project_id: str) -> List[Any]: """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_task_statistics() is deprecated and will be removed.", FutureWarning, stacklevel=2 + ) _, response = self.api.get_task_statistics(project_id) result = self._request_location_header_url(response) if result is not None: @@ -1034,7 +1040,11 @@ def get_account_statistics(self, project_id: str) -> List[Any]: Returns: """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_account_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) _, response = self.api.get_account_statistics(project_id) result = self._request_location_header_url(response) if result is not None: @@ -1054,7 +1064,11 @@ def get_inspection_statistics(self, project_id: str) -> List[Any]: Returns: """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_inspection_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) _, response = self.api.get_inspection_statistics(project_id) result = self._request_location_header_url(response) if result is not None: @@ -1074,7 +1088,11 @@ def get_task_phase_statistics(self, project_id: str) -> List[Any]: Returns: """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_task_phase_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) _, response = self.api.get_task_phase_statistics(project_id) result = self._request_location_header_url(response) if result is not None: @@ -1113,7 +1131,11 @@ def get_worktime_statistics(self, project_id: str) -> List[Any]: タスク作業時間集計 """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_worktime_statistics() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) _, response = self.api.get_worktime_statistics(project_id) result = self._request_location_header_url(response) if result is not None: @@ -2394,7 +2416,11 @@ def get_labor_control_worktime( * plan_worktime：予定作業時間[hour] * working_description：実績に関するコメント(optional) """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_labor_control_worktime() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) def _to_new_data(labor: Dict[str, Any]) -> Dict[str, Any]: labor["actual_worktime"] = self._get_actual_worktime_hour_from_labor(labor) @@ -2474,7 +2500,11 @@ def get_labor_control_availability( * date * availability：予定稼働時間[hour] """ - warnings.warn("deprecated", FutureWarning) + warnings.warn( + "annofabapi.Wrapper.get_labor_control_availability() is deprecated and will be removed.", + FutureWarning, + stacklevel=2, + ) def _to_new_data(labor: Dict[str, Any]) -> Dict[str, Any]: labor["availability"] = self._get_plan_worktime_hour_from_labor(labor) diff --git a/generate/template/api.mustache b/generate/template/api.mustache index c9ada5f7..9b3e6a51 100644 --- a/generate/template/api.mustache +++ b/generate/template/api.mustache @@ -52,7 +52,7 @@ """ {{#isDeprecated}} - warnings.warn("deprecated", FutureWarning) + warnings.warn("annofabapi.AnnofabApi.{{operationId}}() is deprecated and will be removed.", FutureWarning, stacklevel=2) {{/isDeprecated}} url_path = f'{{{path}}}' http_method = '{{httpMethod}}' From 2c84cf4054b5137cb703ef0012b68a7cc6356489 Mon Sep 17 00:00:00 2001 From: yuji38kwmt Date: Thu, 18 Nov 2021 13:51:51 +0900 Subject: [PATCH 2/2] version up --- annofabapi/__version__.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/annofabapi/__version__.py b/annofabapi/__version__.py index 83417866..079baa70 100644 --- a/annofabapi/__version__.py +++ b/annofabapi/__version__.py @@ -1 +1 @@ -__version__ = "0.50.1" +__version__ = "0.50.2" diff --git a/pyproject.toml b/pyproject.toml index 0f674879..041fe846 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "annofabapi" -version = "0.50.1" +version = "0.50.2" description = "Python Clinet Library of AnnoFab WebAPI (https://annofab.com/docs/api/)" authors = ["yuji38kwmt"] license = "MIT"