Skip to content

warnings.warnのメッセージを分かりやすくする #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 18, 2021
Merged

warnings.warnのメッセージを分かりやすくする #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
106d032
warnings.warnのメッセージをわかりやすくする
yuji38kwmt Nov 18, 2021
2c84cf4
version up
yuji38kwmt Nov 18, 2021
758e1bf
Merge branch 'master' into modify-warning
yuji38kwmt Nov 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion annofabapi/__version__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.50.1"
__version__ = "0.50.2"
5 changes: 3 additions & 2 deletions annofabapi/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] = {
Expand Down
36 changes: 30 additions & 6 deletions annofabapi/generated_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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] = {}
Expand Down Expand Up @@ -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] = {}
Expand Down Expand Up @@ -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] = {}
Expand Down Expand Up @@ -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] = {}
Expand All @@ -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] = {}
Expand Down Expand Up @@ -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] = {}
Expand Down
46 changes: 38 additions & 8 deletions annofabapi/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion generate/template/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}'
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
Expand Down