Skip to content

Commit bec40ab

Browse files
authored
v1.1.0で削除したdataclassを一時的に元に戻す (#703)
* 削除したdataclassを元に戻す * format
1 parent fcdcb17 commit bec40ab

File tree

2 files changed

+161
-0
lines changed

2 files changed

+161
-0
lines changed

annofabapi/dataclass/job.py

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# ruff: noqa: E501
2+
# pylint: disable=too-many-lines,trailing-whitespace
3+
4+
"""
5+
Deprecated: 2025-02-01 以降に廃止します
6+
"""
7+
8+
from dataclasses import dataclass
9+
from typing import Any, Optional # pylint: disable=unused-import
10+
11+
from dataclasses_json import DataClassJsonMixin
12+
13+
from annofabapi.models import Errors, JobStatus, ProjectJobType
14+
15+
16+
@dataclass
17+
class ProjectJobInfo(DataClassJsonMixin):
18+
""" """
19+
20+
project_id: str
21+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
22+
23+
job_type: ProjectJobType
24+
""""""
25+
26+
job_id: str
27+
"""ジョブID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
28+
29+
job_status: JobStatus
30+
""""""
31+
32+
job_execution: Optional[dict[str, Any]]
33+
"""ジョブの内部情報"""
34+
35+
job_detail: Optional[dict[str, Any]]
36+
"""ジョブ結果の内部情報"""
37+
38+
errors: Errors
39+
""""""
40+
41+
created_datetime: str
42+
"""作成日時"""
43+
44+
updated_datetime: str
45+
"""更新日時"""

annofabapi/dataclass/project.py

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# ruff: noqa: E501
2+
# pylint: disable=too-many-lines,trailing-whitespace
3+
4+
"""
5+
Deprecated: 2025-02-01 以降に廃止します
6+
"""
7+
8+
from dataclasses import dataclass
9+
from typing import Optional # pylint: disable=unused-import
10+
11+
from dataclasses_json import DataClassJsonMixin
12+
13+
from annofabapi.models import AssigneeRuleOfResubmittedTask, InputDataType, ProjectStatus, TaskAssignmentProperty, TaskAssignmentType
14+
15+
16+
@dataclass
17+
class ProjectSummary(DataClassJsonMixin):
18+
"""
19+
プロジェクトのサマリー情報
20+
"""
21+
22+
last_tasks_updated_datetime: Optional[str]
23+
"""タスクの最終更新日時"""
24+
25+
26+
@dataclass
27+
class ProjectConfiguration(DataClassJsonMixin):
28+
"""
29+
プロジェクトの設定情報
30+
"""
31+
32+
number_of_inspections: Optional[int]
33+
"""検査回数。 * 0回:教師付け -> 受入 * 1回:教師付け -> 検査 -> 受入 * n回(n >= 2):教師付け -> 検査1 -> ... -> 検査n -> 受入 """
34+
35+
assignee_rule_of_resubmitted_task: Optional[AssigneeRuleOfResubmittedTask]
36+
""""""
37+
38+
task_assignment_type: Optional[TaskAssignmentType]
39+
""""""
40+
41+
task_assignment_property: Optional[TaskAssignmentProperty]
42+
""""""
43+
44+
max_tasks_per_member: Optional[int]
45+
"""保留中のタスクを除き、1人(オーナー以外)に割り当てられるタスク数の上限。 """
46+
47+
max_tasks_per_member_including_hold: Optional[int]
48+
"""保留中のタスクを含めて、1人(オーナー以外)に割り当てられるタスク数上限の保留分。 割り当て時の上限チェックは、max_tasks_per_memberとこの数字の合計で行われます。 例えばmax_tasks_per_memberが10、max_tasks_per_member_including_holdが20の場合、保留中を含むタスク数の割り当て上限は30になります。 """
49+
50+
input_data_set_id_list: Optional[list[str]]
51+
"""システム内部用のプロパティ。 [putProject](#operation/putProject) APIでプロジェクトを更新する際は、[getProject](#operation/getProject) APIで取得した値を指定してください。 """
52+
53+
input_data_max_long_side_length: Optional[int]
54+
"""入力データ画像の長辺の最大値(未指定時は4096px)。 画像をアップロードすると、長辺がこの値になるように画像が自動で圧縮されます。 アノテーションの座標は、もとの解像度の画像でつけたものに復元されます。 大きな数値を設定すると入力データ画像のサイズが大きくなり、生産性低下やブラウザで画像を表示できない懸念があります。注意して設定してください。 """
55+
56+
sampling_inspection_rate: Optional[int]
57+
"""抜取検査率[%]。未指定の場合は100%として扱う。"""
58+
59+
sampling_acceptance_rate: Optional[int]
60+
"""抜取受入率[%]。未指定の場合は100%として扱う。"""
61+
62+
private_storage_aws_iam_role_arn: Optional[str]
63+
"""AWS IAMロール。S3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。 """
64+
65+
plugin_id: Optional[str]
66+
"""プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
67+
68+
custom_task_assignment_plugin_id: Optional[str]
69+
"""プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
70+
71+
custom_specs_plugin_id: Optional[str]
72+
"""プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
73+
74+
extended_specs_plugin_id: Optional[str]
75+
"""プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
76+
77+
editor_version: Optional[str]
78+
"""標準アノテーションエディタのバージョン。 * `stable` * 安定版。通常はこちらを利用してください。 * `preview` * 最新版。新機能やUI変更の先行リリース版。 プロジェクト更新時に未指定の場合は `stable` が指定されたものとみなします。 """
79+
80+
use_beginner_navigation: Optional[bool]
81+
"""true の場合、プロジェクトの画面でナビゲーションUIを表示します(ログインユーザーがプロジェクトオーナーの場合のみ)。 """
82+
83+
84+
@dataclass
85+
class Project(DataClassJsonMixin):
86+
""" """
87+
88+
project_id: str
89+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
90+
91+
organization_id: str
92+
"""組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
93+
94+
title: str
95+
"""プロジェクトのタイトル"""
96+
97+
overview: Optional[str]
98+
"""プロジェクトの概要"""
99+
100+
project_status: ProjectStatus
101+
""""""
102+
103+
input_data_type: InputDataType
104+
""""""
105+
106+
configuration: ProjectConfiguration
107+
""""""
108+
109+
created_datetime: str
110+
"""作成日時"""
111+
112+
updated_datetime: str
113+
"""更新日時"""
114+
115+
summary: ProjectSummary
116+
""""""

0 commit comments

Comments
 (0)