ジョブ関係のクラスの名前変更 (#327)

* update pyproject.toml

* annofab v0.111.0

* devcontainer上でdockerが動かない問題の対応

* update dockerfile

* update dataclass

* update poetry

* Jobtype -> projectJobtype

* update swagger

* update poetry

* update wrapper

* dowgrade jedi.ipythonバグを避けるため

* JobInfoを追加

* get_all_project_jobのquery_paramsは必須でないので、デフォルト値をNoneにする

* JobInfoを追加

* stacklevelを追加

* update test

* 引数job_typeに対してProjectJobTypeとJobTypeの両方を利用できるようにする

* jobtypeをProjectJobTypeに変更

* generate.shを修正

* update

* version up

* update poetry

* 未使用のメソッドを削除

* poetry update

* update readthedocs requirements.txt

Author: yuji38kwmt

.devcontainer/Dockerfile

@@ -91,12 +91,13 @@ RUN set -x \
 # docker / docker-compose in devcontainer
 RUN set -x \
     && mkdir -p /usr/local/devcontainer-tool/bin \
-    && curl -fsSL -o /usr/local/devcontainer-tool/bin/docker https://raw.githubusercontent.com/thamaji/devcontainer-docker/main/docker \
+    && curl -fsSL -o /usr/local/devcontainer-tool/bin/docker https://github.com/thamaji/devcontainer-docker/releases/download/v1.0.1/docker \
     && chmod +x /usr/local/devcontainer-tool/bin/docker \
-    && curl -fsSL -o /usr/local/devcontainer-tool/bin/docker-compose https://github.com/thamaji/devcontainer-compose/releases/download/v1.0.0/docker-compose \
+    && curl -fsSL -o /usr/local/devcontainer-tool/bin/docker-compose https://github.com/thamaji/devcontainer-compose/releases/download/v1.0.2/docker-compose \
     && chmod +x /usr/local/devcontainer-tool/bin/docker-compose
 ENV PATH=/usr/local/devcontainer-tool/bin:${PATH}
 
+
 # python3.8, make
 RUN set -x \
     && apt-get update \

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = "0.45.2"
+__version__ = "0.46.0"

annofabapi/_utils.py

@@ -0,0 +1,55 @@
+import enum
+import warnings
+from functools import wraps
+from typing import Optional
+
+
+def _issue_deprecated_warning_with_class(
+    cls, stacklevel: int, deprecated_date: str, new_class_name: Optional[str] = None
+):
+    """非推奨なクラスに対する警告メッセージを出力する。"""
+    old_class_name = f"{cls.__module__}.{cls.__name__}"
+    message = f"deprecated: '{old_class_name}'は{deprecated_date}以降に廃止します。"
+    if new_class_name is not None:
+        message += f"替わりに'{new_class_name}'を使用してください。"
+    warnings.warn(message, FutureWarning, stacklevel=stacklevel)
+
+
+def _process_class(cls, deprecated_date: str, new_class_name: Optional[str] = None):
+    def decorator(function):
+        @wraps(function)
+        def wrapped(*args, **kwargs):
+            _issue_deprecated_warning_with_class(
+                cls, stacklevel=3, deprecated_date=deprecated_date, new_class_name=new_class_name
+            )
+            return function(*args, **kwargs)
+
+        return wrapped
+
+    cls.__init__ = decorator(cls.__init__)  # type: ignore
+    return cls
+
+
+def _process_enum_class(cls, deprecated_date: str, new_class_name: Optional[str] = None):
+    def getattribute(self, name):
+        _issue_deprecated_warning_with_class(
+            cls, stacklevel=4, deprecated_date=deprecated_date, new_class_name=new_class_name
+        )
+        return super(type(self), self).__getattribute__(name)
+
+    cls.__getattribute__ = getattribute
+    return cls
+
+
+def deprecated_class(_cls=None, *, deprecated_date: str, new_class_name: Optional[str] = None):
+    """クラスを非推奨にします。"""
+
+    def wrap(cls):
+        if issubclass(cls, enum.Enum):
+            return _process_enum_class(cls, deprecated_date=deprecated_date, new_class_name=new_class_name)
+        else:
+            return _process_class(cls, deprecated_date=deprecated_date, new_class_name=new_class_name)
+
+    if _cls is None:
+        return wrap
+    return wrap(_cls)

annofabapi/dataclass/inspection.py

@@ -50,6 +50,9 @@ class Inspection(DataClassJsonMixin):
     annotation_id: Optional[str]
     """アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
 
+    label_id: Optional[str]
+    """"""
+
     data: InspectionData
     """"""
 

annofabapi/dataclass/job.py

@@ -15,17 +15,52 @@
 
 from dataclasses_json import DataClassJsonMixin
 
-from annofabapi.models import JobStatus, JobType
+from annofabapi._utils import deprecated_class
+from annofabapi.models import JobStatus, ProjectJobType
 
 
 @dataclass
-class JobInfo(DataClassJsonMixin):
+class ProjectJobInfo(DataClassJsonMixin):
     """ """
 
     project_id: Optional[str]
     """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
-    job_type: Optional[JobType]
+    job_type: Optional[ProjectJobType]
+    """"""
+
+    job_id: Optional[str]
+    """"""
+
+    job_status: Optional[JobStatus]
+    """"""
+
+    job_execution: Optional[Dict[str, Any]]
+    """ジョブの内部情報"""
+
+    job_detail: Optional[Dict[str, Any]]
+    """ジョブ結果の内部情報"""
+
+    created_datetime: Optional[str]
+    """"""
+
+    updated_datetime: Optional[str]
+    """"""
+
+
+# 2021-09-01以降に削除する予定
+@deprecated_class(deprecated_date="2021-09-01", new_class_name=f"{ProjectJobInfo.__module__}.{ProjectJobInfo.__name__}")
+@dataclass
+class JobInfo(DataClassJsonMixin):
+    """プロジェクトのジョブ情報
+
+    .. deprecated:: 2021-09-01
+    """
+
+    project_id: Optional[str]
+    """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
+
+    job_type: Optional[ProjectJobType]
     """"""
 
     job_id: Optional[str]

annofabapi/dataclass/task.py

@@ -96,13 +96,13 @@ class Task(DataClassJsonMixin):
     account_id: Optional[str]
     """"""
 
-    histories_by_phase: Optional[List[TaskHistoryShort]]
+    histories_by_phase: List[TaskHistoryShort]
     """簡易的なタスク履歴（あるフェーズを誰が担当したか）"""
 
     work_time_span: int
     """累計実作業時間(ミリ秒)"""
 
-    number_of_rejections: Optional[int]
+    number_of_rejections: int
     """このタスクが差戻しされた回数（すべてのフェーズでの差戻し回数の合計  このフィールドは、どのフェーズで何回差戻されたかを区別できないため、廃止予定です。 `histories_by_phase` で各フェーズの回数を計算することで、差戻し回数が分かります。  例）`acceptance`フェーズが3回ある場合、`acceptance`フェーズで2回差し戻しされたことになります。 """
 
     started_datetime: Optional[str]

annofabapi/generated_api.py

@@ -1011,7 +1011,7 @@ def delete_project_job(
 
         Args:
             project_id (str):  プロジェクトID (required)
-            job_type (JobType):  ジョブの種別。[詳細はこちら](#section/JobType)。 (required)
+            job_type (ProjectJobType):  ジョブの種別。[詳細はこちら](#section/ProjectJobType)。 (required)
             job_id (str):  ジョブID (required)
 
         Returns:
@@ -1024,28 +1024,60 @@ def delete_project_job(
         keyword_params: Dict[str, Any] = {}
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
+    def get_organization_job(
+        self, organization_name: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
+    ) -> Tuple[Any, requests.Response]:
+        """組織のバックグラウンドジョブ情報取得
+        https://annofab.com/docs/api/#operation/getOrganizationJob
+
+
+        authorizations: AllOrganizationMember
+
+
+        組織のバックグラウンドジョブの情報を取得します。 取得されるジョブ情報は、作成日付の新しい順にソートされています。  バックグラウンドジョブ情報は、完了(失敗含む)から14日経過後に自動で削除されます。
+
+        Args:
+            organization_name (str):  組織名 (required)
+            query_params (Dict[str, Any]): Query Parameters
+                type (str):  取得するジョブの種別。[詳細はこちら](#section/OrganizationJobType)。
+                page (int):  検索結果のうち、取得したいページの番号(1始まり)  現在は未実装のパラメータです。(今後対応予定)
+                limit (int):  1ページあたりの取得するデータ件数。 未指定時は1件のみ取得。
+                exclusive_start_created_datetime (str):  取得するデータの直前の作成日時
+
+        Returns:
+            Tuple[OrganizationJobInfoContainer, requests.Response]
+
+
+        """
+        url_path = f"/organizations/{organization_name}/jobs"
+        http_method = "GET"
+        keyword_params: Dict[str, Any] = {
+            "query_params": query_params,
+        }
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
     def get_project_job(
         self, project_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """バックグラウンドジョブ情報取得
+        """プロジェクトのバックグラウンドジョブ情報取得
         https://annofab.com/docs/api/#operation/getProjectJob
 
 
         authorizations: AllProjectMember
 
 
-        バックグラウンドジョブの情報を取得します。 取得されるジョブ情報は、作成日付の新しい順にソートされています。  バックグラウンドジョブ情報は、完了(失敗含む)から14日経過後に自動で削除されます。
+        プロジェクトのバックグラウンドジョブの情報を取得します。 取得されるジョブ情報は、作成日付の新しい順にソートされています。  バックグラウンドジョブ情報は、完了(失敗含む)から14日経過後に自動で削除されます。
 
         Args:
             project_id (str):  プロジェクトID (required)
             query_params (Dict[str, Any]): Query Parameters
-                type (JobType):  取得するジョブの種別。[詳細はこちら](#section/JobType)。 (required)
+                type (ProjectJobType):  取得するジョブの種別。[詳細はこちら](#section/ProjectJobType)。
                 page (int):  検索結果のうち、取得したいページの番号(1始まり)  現在は未実装のパラメータです。(今後対応予定)
                 limit (int):  1ページあたりの取得するデータ件数。 未指定時は1件のみ取得。
                 exclusive_start_created_datetime (str):  取得するデータの直前の作成日時
 
         Returns:
-            Tuple[JobInfoContainer, requests.Response]
+            Tuple[ProjectJobInfoContainer, requests.Response]
 
 
         """
@@ -1410,6 +1442,7 @@ def get_projects_of_organization(
                 except_account_id (str):  指定したアカウントIDをメンバーに持たないプロジェクトで絞り込む。
                 title (str):  プロジェクトタイトルでの部分一致検索。1文字以上あれば使用します。利便性のため、大文字小文字は区別しません。
                 status (ProjectStatus):  指定した状態のプロジェクトで絞り込む。未指定時は全プロジェクト。
+                plugin_id (str):  指定したプラグインIDを使用しているプロジェクトで絞り込む。未指定時は指定なし。
                 input_data_type (InputDataType):  指定した入力データ種別でプロジェクトを絞り込む。未指定時は全プロジェクト。
                 sort_by (str):  `date` を指定することでプロジェクトの最新のタスク更新時間の順にソートして出力する。 未指定時はプロジェクト名でソートする。