アノテーション仕様の標準プラグインに関するEnumを追加しました。 (#520)

* プラグイン関係のEnumを定義 * type hintの修正 * ドキュメント更新 * readthedocsのpip更新 * version up * format * version up * エディタプラグインの定義 * version up
kurusugawa-computer · Nov 14, 2022 · 6db5d1c · 6db5d1c
1 parent d5ea566
commit 6db5d1c
Show file tree

Hide file tree

Showing 13 changed files with 76 additions and 20 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,6 +5,7 @@ python:
   - "3.8"
   - "3.9"
   - "3.10"
+  - "3.11-dev"
 install:
   - pip install pip --upgrade
   - pip install "poetry<1.2"

diff --git a/annofabapi/__version__.py b/annofabapi/__version__.py
@@ -1 +1 @@
-__version__ = "0.65.0"
+__version__ = "0.67.1"
diff --git a/annofabapi/plugin.py b/annofabapi/plugin.py
@@ -0,0 +1,42 @@
+"""プラグイン関係"""
+
+from enum import Enum
+
+
+class EditorPluginId(Enum):
+    """
+    アノテーションエディタの標準（ビルトイン）プラグインのID
+    """
+
+    THREE_DIMENSION = "bdc16348-107e-4fbc-af4a-e482bc84a60f"
+    """
+    3次元アノテーションエディタの標準プラグインのID
+    "af-default-annotation-editor-plugin-for-3d-editor"
+    （Annofab本番環境/開発環境でIDは同じ）
+    """
+
+
+class ExtendSpecsPluginId(Enum):
+    """
+    アノテーション仕様の拡張プラグインのID
+    """
+
+    THREE_DIMENSION = "703ababa-96ac-4920-8afb-d4f2bddac7e3"
+    """
+    3次元プロジェクトのアノテーション仕様を定義した標準プラグインのID
+    "af-default-extended-spec-plugin-for-3d-editor"
+    （Annofab本番環境/開発環境でIDは同じ）
+    """
+
+
+class ThreeDimensionAnnotationType(Enum):
+    """
+    3次元アノテーションの種類（アノテーション種類の標準プラグインで定義されている）
+    """
+
+    BOUNDING_BOX = "user_bounding_box"
+    """バウンディングボックス"""
+    INSTANCE_SEGMENT = "user_instance_segment"
+    """インスタンスセグメント"""
+    SEMANTIC_SEGMENT = "user_semantic_segment"
+    """セマンティックセグメント"""
diff --git a/annofabapi/wrapper.py b/annofabapi/wrapper.py
@@ -2226,7 +2226,9 @@ def delete_all_succeeded_job(self, project_id: str, job_type: ProjectJobType) ->
 
         return deleted_jobs
 
-    def get_all_project_job(self, project_id: str, query_params: Dict[str, Any] = None) -> List[ProjectJobInfo]:
+    def get_all_project_job(
+        self, project_id: str, query_params: Optional[Dict[str, Any]] = None
+    ) -> List[ProjectJobInfo]:
         """
         すべてのバックグランドジョブを取得する。
 

diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst
@@ -10,6 +10,7 @@ API reference
    resource
    utils
    parser
+   plugin
    models
    dataclass
    exceptions

diff --git a/docs/api_reference/plugin.rst b/docs/api_reference/plugin.rst
@@ -0,0 +1,8 @@
+annofabapi.plugin module
+==========================
+
+
+
+.. automodule:: annofabapi.plugin
+    :members:
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -54,6 +54,7 @@
 html_theme_options = {
     "github_url": "https://github.com/kurusugawa-computer/annofab-api-python-client",
     "use_edit_page_button": True,
+    "footer_items": [],  # footerを空にする
 }
 
 html_logo = "img/logo_landscape.png"

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
-sphinx==4.0.2
-pydata-sphinx-theme==0.6.3
+sphinx==5.3.0
+pydata-sphinx-theme==0.11.0
+
 
diff --git a/docs/user_guide/basic_usage.rst b/docs/user_guide/basic_usage.rst
@@ -6,7 +6,7 @@ WebAPIにリクエストを投げる方法
 --------------------------------------------------
 
 ``service.api`` には、Web APIに対応するメソッドが定義されています。
-メソッド名は、AnnoFab Web APIのOpenAPI specificationに記載されている ``operationId`` を、スネークケース"input1","input2"に変換したものです。
+メソッド名は、Annofab Web APIのOpenAPI specificationに記載されている ``operationId`` を、スネークケース"input1","input2"に変換したものです。
 各メソッドの戻り値の型は ``Tupple[Content, Response]`` です。 ``Response`` はrequestsモジュールの ``Reponse`` オブジェクトです。
 ``Content`` は ``Reponse`` の中身です。
 
@@ -120,7 +120,7 @@ annofabapiは、pythonのloggingモジュールを利用してログメッセー
 
     from annofabapi import build
     servcie = build()
-    # DEBUG    : 2020-12-09 21:09:04,728 : resource.py : annofabapi.resource : build_from_netrc : .netrcファイルからAnnoFab認証情報を読み込みました。
+    # DEBUG    : 2020-12-09 21:09:04,728 : resource.py : annofabapi.resource : build_from_netrc : .netrcファイルからAnnofab認証情報を読み込みました。
 
 
 
diff --git a/docs/user_guide/for_developer.rst b/docs/user_guide/for_developer.rst
@@ -4,7 +4,7 @@
 
 
 
-ローカルのAnnoFab環境にアクセスする方法
+ローカルのAnnofab環境にアクセスする方法
 --------------------------------------------------
 
 .. code-block:: python

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "annofabapi"
-version = "0.65.0"
+version = "0.67.1"
 description = "Python Clinet Library of Annofab WebAPI (https://annofab.com/docs/api/)"
 authors = ["yuji38kwmt"]
 license = "MIT"

diff --git a/tests/test_api.py b/tests/test_api.py
@@ -74,7 +74,9 @@ def test_get_annotation(self):
         SimpleAnnotation.from_dict(annotation)
 
     def test_get_editor_annotation(self):
-        editor_annotation, _ = api.get_editor_annotation(project_id, task_id, self.input_data_id, query_params={"v":"2"})
+        editor_annotation, _ = api.get_editor_annotation(
+            project_id, task_id, self.input_data_id, query_params={"v": "2"}
+        )
         assert type(editor_annotation) == dict
         # dataclassに変換できることの確認
         AnnotationV2Output.from_dict(editor_annotation)