Annofab v0.90.2 (#181)

* AnnoFan v0.90.2 (delete_project_job)

* format

* update version

Author: yuji38kwmt

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = "0.35.0"
+__version__ = "0.36.0"

annofabapi/generated_api.py

@@ -1000,7 +1000,9 @@ def put_instruction(
     # NOTE: This method is auto generated by OpenAPI Generator
     #########################################
 
-    def delete_project_job(self, project_id: str, job_id: str, **kwargs) -> Tuple[Any, requests.Response]:
+    def delete_project_job(
+        self, project_id: str, job_type: str, job_id: str, **kwargs
+    ) -> Tuple[Any, requests.Response]:
         """バックグラウンドジョブ情報削除
 
 
@@ -1011,14 +1013,15 @@ def delete_project_job(self, project_id: str, job_id: str, **kwargs) -> Tuple[An
 
         Args:
             project_id (str):  プロジェクトID (required)
+            job_type (JobType):  ジョブの種別。[詳細はこちら](#section/JobType)。 (required)
             job_id (str):  ジョブID (required)
 
         Returns:
             Tuple[, requests.Response]
 
 
         """
-        url_path = f"/projects/{project_id}/jobs/gen-inputs/{job_id}"
+        url_path = f"/projects/{project_id}/jobs/{job_type}/{job_id}"
         http_method = "DELETE"
         keyword_params: Dict[str, Any] = {}
         return self._request_wrapper(http_method, url_path, **keyword_params)

annofabapi/models.py

@@ -1236,6 +1236,8 @@ class AssigneeRuleOfResubmittedTask(Enum):
     複数の集約を区別するための名前です。  `(フィールド名)_(集約内容)` のように命名されます。例えば `account_id` フィールドを `count` する場合、`account_id_count` となります。 
 * field: str
     集約に使われたリソースのフィールド名です。  リソースの属性のさらに属性を参照するときは、`foo.bar.buz` のようにドット区切りになります。 
+* doc_count: int
+    集約の件数です。 
 * items: List[Count]
     集約結果の値です。 
 
@@ -2685,6 +2687,21 @@ class OrganizationMemberStatus(Enum):
 
 """
 
+OverlappedRangeAnnotation = Dict[str, Any]
+"""
+区間が重複しているアノテーションが存在している場合に発生するエラー
+
+Kyes of Dict
+
+* label_id: str
+    
+* annotation_id: str
+    
+* type: str
+    OverlappedRangeAnnotation
+
+"""
+
 PasswordResetRequest = Dict[str, Any]
 """
 

annofabapi/wrapper.py

@@ -1257,7 +1257,7 @@ def delete_all_succeeded_job(self, project_id: str, job_type: JobType) -> List[J
         for job in jobs:
             if job["job_status"] == "succeeded":
                 logger.debug("job_id=%s のジョブを削除します。", job["job_id"])
-                self.api.delete_project_job(project_id, job["job_id"])
+                self.api.delete_project_job(project_id, job_type=job_type.value, job_id=job["job_id"])
                 deleted_jobs.append(job)
 
         return deleted_jobs

generate/generate.sh

@@ -65,6 +65,9 @@ docker run --rm   -u `id -u`:`id -g`  -v ${PWD}:/local -w /local  -e JAVA_OPTS=$
     --ignore-file-override=/local/.openapi-generator-ignore_v1
 
 cat partial-header/generated_api_partial_header_v1.py out/openapi_client/api/*_api.py > ../annofabapi/generated_api.py
+# job_typeの型がJobTypeだとEnumのため都合が悪いので、型をstrに変換する
+sed  -e "s/job_type: JobType/job_type: str/g"  ../annofabapi/generated_api.py  --in-place
+
 rm -Rf out/openapi_client
 
 # v2 apiを生成
@@ -231,6 +234,7 @@ sed  -e "s/__DictStrKeyAnyValue__/Dict[str,Any]/g"  ../annofabapi/dataclass/*.py
 sed -E -e "s/dict\((.*)\)/Dict\[\1\]/g"  ../annofabapi/dataclass/*.py  --in-place
 
 
+
 rm -Rf out/openapi_client
 
 

generate/swagger/swagger-api-components.yaml

@@ -3941,6 +3941,10 @@ components:
             集約に使われたリソースのフィールド名です。
 
             リソースの属性のさらに属性を参照するときは、`foo.bar.buz` のようにドット区切りになります。
+        doc_count:
+          type: integer
+          description: |
+            集約の件数です。
         items:
           type: array
           items:
@@ -4029,6 +4033,7 @@ components:
         - $ref: "#/components/schemas/Duplicated"
         - $ref: "#/components/schemas/UnknownAdditionalData"
         - $ref: "#/components/schemas/OutOfImageBounds"
+        - $ref: "#/components/schemas/OverlappedRangeAnnotation"
         - $ref: "#/components/schemas/UnknownLabel"
       discriminator:
         propertyName: "_type"
@@ -4042,6 +4047,7 @@ components:
           Duplicated: "#/components/schemas/Duplicated"
           UnknownAdditionalData: "#/components/schemas/UnknownAdditionalData"
           OutOfImageBounds: "#/components/schemas/OutOfImageBounds"
+          OverlappedRangeAnnotation: "#/components/schemas/OverlappedRangeAnnotation"
           UnknownLabel: "#/components/schemas/UnknownLabel"
     InvalidAnnotationData:
       type: object
@@ -4167,6 +4173,18 @@ components:
           type: string
           description: OutOfImageBounds
           example: "OutOfImageBounds"
+    OverlappedRangeAnnotation:
+      type: object
+      description: 区間が重複しているアノテーションが存在している場合に発生するエラー
+      properties:
+        labelId:
+          type: string
+        annotationId:
+          type: string
+        _type:
+          type: string
+          description: OverlappedRangeAnnotation
+          example: "OverlappedRangeAnnotation"
     UnknownLabel:
       type: object
       description: 何らかの原因で、アノテーション仕様にないラベルがついているエラー

generate/swagger/swagger.v2.yaml

@@ -115,7 +115,7 @@ info:
 
     上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。
 
-  version: 0.90.0
+  version: 0.90.2
   title: AnnoFab Web API
   x-logo:
     url: "https://annofab.com/images/logo_landscape.png"

generate/swagger/swagger.yaml

@@ -102,6 +102,7 @@ info:
           "_type": "CountResult",
           "name": "account_id_count",
           "field": "account_id",
+          "docCount": 15,
           "items": [
             {"key":"c5eee002", "count":9, "aggregations":[], "_type":"..."},
             {"key":"9f110e48", "count":5, "aggregations":[], "_type":"..."},
@@ -113,8 +114,9 @@ info:
     ```
 
     上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。
+    また、AggregationResultの集約の件数は、合計で10000件以下に制限されており、それを超える件数がある場合は上位10000件が取得されます。もし、省略された部分を取得したい場合は、検索条件を縛って結果に上る集約の数を減らしてください。
 
-  version: 0.90.0
+  version: 0.90.2
   title: AnnoFab Web API
   x-logo:
     url: "https://annofab.com/images/logo_landscape.png"
@@ -2592,7 +2594,7 @@ paths:
           $ref: "swagger-api-components.yaml#/components/responses/ErrorMissingResource"
         "503":
           $ref: "swagger-api-components.yaml#/components/responses/ErrorUnderMaintenance"
-  /projects/{project_id}/jobs/gen-inputs/{job_id}:
+  /projects/{project_id}/jobs/{job_type}/{job_id}:
     delete:
       tags:
       - af-job
@@ -2611,6 +2613,12 @@ paths:
         required: true
         schema:
           $ref: "swagger-api-components.yaml#/components/schemas/ProjectId"
+      - name: job_type
+        in: path
+        description: ジョブの種別。[詳細はこちら](#section/JobType)。
+        required: true
+        schema:
+          $ref: "swagger-api-components.yaml#/components/schemas/JobType"
       - name: job_id
         in: path
         description: ジョブID

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "annofabapi"
-version = "0.35.0"
+version = "0.36.0"
 description = "Python Clinet Library of AnnoFab WebAPI (https://annofab.com/docs/api/)"
 authors = ["yuji38kwmt <[email protected]>"]
 maintainers = ["yuji38kwmt <[email protected]>"]

tests/conftest.py

@@ -5,20 +5,26 @@
 
 def pytest_addoption(parser):
     parser.addoption("--run_submitting_job", action="store_true", default=False, help="ジョブを投げるテストを実行する。")
+    parser.addoption("--run_side_effect", action="store_true", default=False, help="副作用のあるテストを実行する。")
     parser.addoption("--print_log_annofabapi", action="store_true", default=False, help="annofabapiモジュールのログを表示する。")
 
 
 def pytest_configure(config):
     config.addinivalue_line("markers", "submitting_job: mark test with submitting job")
+    config.addinivalue_line("markers", "side_effect: mark test with side effect")
 
 
 def pytest_collection_modifyitems(config, items):
-    if config.getoption("--run_submitting_job"):
-        return
-    skip_slow = pytest.mark.skip(reason="need --sun_submitting_job option to run")
+    run_submitting_job = config.getoption("--run_submitting_job")
+    run_side_effect = config.getoption("--run_side_effect")
+
+    skip_slow_submitting_job = pytest.mark.skip(reason="need --run_submitting_job option to run")
+    skip_slow_side_effect = pytest.mark.skip(reason="need --run_side_effect option to run")
     for item in items:
-        if "submitting_job" in item.keywords:
-            item.add_marker(skip_slow)
+        if not run_submitting_job and "submitting_job" in item.keywords:
+            item.add_marker(skip_slow_submitting_job)
+        if not run_side_effect and "side_effect" in item.keywords:
+            item.add_marker(skip_slow_side_effect)
 
 
 def pytest_cmdline_main(config):

tests/test_api.py

@@ -13,6 +13,7 @@
 
 import pytest
 import requests
+from more_itertools import first_true
 
 import annofabapi
 import annofabapi.utils
@@ -178,6 +179,18 @@ def test_delete_all_succeeded_job(self):
     def test_job_in_progress(self):
         assert type(wrapper.job_in_progress(project_id, JobType.GEN_TASKS)) == bool
 
+    @pytest.mark.submitting_job
+    def test_delete_project_job(self):
+        content, _ = api.post_project_tasks_update(project_id, {"v": "2"})
+        job = content["job"]
+        job_type = job["job_type"]
+        job_id = job["job_id"]
+        job_list = wrapper.get_all_project_job(project_id, {"type": job_type})
+        assert first_true(job_list, pred=lambda e: e["job_id"] == job_id) is not None
+        api.delete_project_job(project_id, job_type=job["job_type"], job_id=job["job_id"])
+        job_list = wrapper.get_all_project_job(project_id, {"type": job_type})
+        assert first_true(job_list, pred=lambda e: e["job_id"] == job_id) is None
+
 
 class TestLogin:
     def test_login(self):
@@ -367,6 +380,7 @@ def test_put_task_and_delete_task(self):
 
         assert type(api.delete_task(project_id, test_task_id)[0]) == dict
 
+    @pytest.mark.side_effect
     def test_assign_task(self):
         request_body = {"request_type": {"phase": "annotation", "_type": "Random"}}
         assert type(api.assign_tasks(project_id, request_body=request_body)[0]) == list