アノテーション仕様のメッセージを取得するutil関数を追加 (#659)

* メッセージを取得する関数を作成

* 不要になった関数を削除

* 無視する

* エラー

* 不要なimportを削除

* ディレクトリを移動するコードを削除

Author: yuji38kwmt

annofabapi/api.py

@@ -492,7 +492,7 @@ def _request_wrapper(
         """
 
         # TODO 判定条件が不明
-        if url_path.startswith("/internal/"):  # noqa: SIM108
+        if url_path.startswith("/internal/"):
             url = f"{self.endpoint_url}/api{url_path}"
         else:
             url = f"{self.url_prefix}{url_path}"

annofabapi/api2.py

@@ -5,7 +5,7 @@
 import requests
 from requests.cookies import RequestsCookieJar
 
-import annofabapi.utils
+import annofabapi
 from annofabapi.api import (
     DEFAULT_WAITING_TIME_SECONDS_WITH_429_STATUS_CODE,
     AnnofabApi,

annofabapi/util/__init__.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from typing import Any, Literal, Optional, Union
+
+import more_itertools
+
+from annofabapi.models import Lang
+
+
+def get_english_message(internationalization_message: dict[str, Any]) -> str:
+    """
+    `InternalizationMessage`クラスの値から、英語メッセージを取得します。
+    英語メッセージが見つからない場合は ``ValueError`` をスローします。
+
+    Notes:
+        英語メッセージは必ず存在するはずなので、英語メッセージが見つからない場合は ``ValueError`` をスローするようにしました。
+
+    Args:
+        internationalization_message: 多言語化されたメッセージ。キー ``messages`` が存在している必要があります。
+
+    Returns:
+        指定した言語に対応するメッセージ。
+
+    Raises:
+        ValueError: 英語メッセージが見つからない場合
+    """
+    messages: list[dict[str, str]] = internationalization_message["messages"]
+    result = more_itertools.first_true(messages, pred=lambda e: e["lang"] == Lang.EN_US.value)
+    if result is not None:
+        return result["message"]
+    else:
+        raise ValueError(f"'{internationalization_message}'に英語のメッセージは存在しません。")
+
+
+STR_LANG = Literal["en-US", "ja-JP", "vi-VN"]
+"""
+対応している ``lang`` の文字列
+"""
+
+
+def get_message_with_lang(internationalization_message: dict[str, Any], lang: Union[Lang, STR_LANG]) -> Optional[str]:  # noqa: UP007
+    """
+    `InternalizationMessage`クラスの値から、指定した ``lang`` に対応するメッセージを取得します。
+
+    Args:
+        internationalization_message: 多言語化されたメッセージ。キー ``messages`` が存在している必要があります。
+        lang: 取得したいメッセージに対応する言語コード。
+
+    Returns:
+        指定した言語に対応するメッセージ。見つからない場合はNoneを返します。
+
+    """
+    messages: list[dict[str, str]] = internationalization_message["messages"]
+    if isinstance(lang, Lang):
+        str_lang = lang.value
+    else:
+        str_lang = str(lang)
+
+    result = more_itertools.first_true(messages, pred=lambda e: e["lang"] == str_lang)
+    if result is not None:
+        return result["message"]
+    return None

annofabapi/util/annotation_specs.py

@@ -1,10 +1,9 @@
 import datetime
 import logging
-from typing import Any, Dict, List, Optional
+from typing import List, Optional
 
 import dateutil
 import dateutil.tz
-import more_itertools
 
 from annofabapi.models import Task, TaskHistory, TaskHistoryShort, TaskPhase
 
@@ -160,25 +159,3 @@ def can_put_annotation(task: Task, my_account_id: str) -> bool:
     """
     # ログインユーザはプロジェクトオーナであること前提
     return len(task["histories_by_phase"]) == 0 or task["account_id"] == my_account_id
-
-
-def get_message_for_i18n(internationalization_message: Dict[str, Any], lang: str = "en-US") -> str:
-    """
-    アノテーション仕様で使われている`InternalizationMessage`クラスの値から、指定された言語のメッセージを取得する。
-
-    Args:
-        internationalization_message: 多言語化されたメッセージ
-        lang: 取得したいメッセージに対応する言語コード。`en-US`または`ja-JP`のみサポートしています。
-
-    Returns:
-        指定した言語に対応するメッセージ。
-
-    Raises:
-        ValueError: 引数langに対応するメッセージが見つからない場合
-    """
-    messages: List[Dict[str, str]] = internationalization_message["messages"]
-    result = more_itertools.first_true(messages, pred=lambda e: e["lang"] == lang)
-    if result is not None:
-        return result["message"]
-    else:
-        raise ValueError(f"lang='{lang}'であるメッセージは見つかりませんでした。")

annofabapi/utils.py

@@ -95,6 +95,7 @@ ignore = [
     "ERA", # : 役立つこともあるが、コメントアウトしていないコードも警告されるので無視する
     "TD", # flake8-todos
     "FIX", # flake8-fixme
+    "SIM108", # if-else-block-instead-of-if-exp, 三項演算子が読みにくい場合もあるので無視する
 
     # 以下のルールはコードに合っていないので無効化した
     "RSE", # flake8-raise

pyproject.toml

@@ -7,7 +7,6 @@
 
 import configparser
 import datetime
-import os
 import uuid
 from typing import Any
 
@@ -16,7 +15,6 @@
 from more_itertools import first_true
 
 import annofabapi
-import annofabapi.utils
 from annofabapi.dataclass.annotation import AnnotationV2Output, SimpleAnnotation, SingleAnnotationV2
 from annofabapi.dataclass.annotation_specs import AnnotationSpecsV3
 from annofabapi.dataclass.comment import Comment
@@ -32,8 +30,6 @@
 from annofabapi.wrapper import TaskFrameKey
 from tests.utils_for_test import WrapperForTest, create_csv_for_task
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
 inifile = configparser.ConfigParser()
 inifile.read("./pytest.ini", "UTF-8")
 

tests/test_api.py

@@ -4,14 +4,10 @@
 """
 
 import configparser
-import os
 
 import annofabapi
-import annofabapi.utils
 from tests.utils_for_test import WrapperForTest
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
 inifile = configparser.ConfigParser()
 inifile.read("./pytest.ini", "UTF-8")
 project_id = inifile["annofab"]["project_id"]

tests/test_api2.py

@@ -1,13 +1,11 @@
 import configparser
-import os
 import zipfile
 from pathlib import Path
 
 import pytest
 
 import annofabapi
 import annofabapi.parser
-import annofabapi.utils
 from annofabapi.dataclass.annotation import FullAnnotation, FullAnnotationDataPoints, SimpleAnnotation
 from annofabapi.exceptions import AnnotationOuterFileNotFoundError
 from annofabapi.parser import (
@@ -19,8 +17,6 @@
     SimpleAnnotationZipParserByTask,
 )
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
 inifile = configparser.ConfigParser()
 inifile.read("./pytest.ini", "UTF-8")
 

tests/test_local_parser.py

@@ -9,9 +9,6 @@
 import annofabapi.exceptions
 from annofabapi.resource import build, build_from_env
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
-
 
 class TestBuild:
     # def test_build_from_netrc(self):

tests/test_local_resource.py

@@ -2,11 +2,8 @@
 
 from typing import Any
 
-import pytest
-
 from annofabapi.models import TaskPhase
 from annofabapi.utils import (
-    get_message_for_i18n,
     get_number_of_rejections,
     get_task_history_index_skipped_acceptance,
     get_task_history_index_skipped_inspection,
@@ -617,20 +614,3 @@ def test_get_task_history_index_skipped_inspection_検査1回_教師付で提出
         actual = get_task_history_index_skipped_inspection(task_history_list)
         expected: list[int] = []
         assert all([a == b for a, b in zip(actual, expected)])  # noqa: C419
-
-
-def test_get_message_for_i18n():
-    i18n_message = {
-        "messages": [{"lang": "ja-JP", "message": "自動車"}, {"lang": "en-US", "message": "car"}],
-        "default_lang": "ja-JP",
-    }
-    assert get_message_for_i18n(i18n_message) == "car"
-    assert get_message_for_i18n(i18n_message, lang="ja-JP") == "自動車"
-
-    i18n_message2 = {
-        "messages": [{"lang": "ja-JP", "message": "自動車"}],
-        "default_lang": "ja-JP",
-    }
-
-    with pytest.raises(ValueError):
-        get_message_for_i18n(i18n_message2, lang="en-US")

tests/test_local_utils.py

@@ -1,11 +1,7 @@
-import os
 from pathlib import Path
 
 from annofabapi.wrapper import Wrapper
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
-
 data_dir = Path("./tests/data")
 
 

tests/test_local_wrapper.py

@@ -3,13 +3,9 @@
 """
 
 import configparser
-import os
 
 import annofabapi
-import annofabapi.utils
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
 inifile = configparser.ConfigParser()
 inifile.read("./pytest.ini", "UTF-8")
 

tests/test_sandbox.py

@@ -1,4 +1,3 @@
-import os
 import shutil
 import uuid
 from pathlib import Path
@@ -8,9 +7,6 @@
 
 from annofabapi.segmentation import read_binary_image, write_binary_image
 
-# プロジェクトトップに移動する
-os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
-
 data_dir = Path("./tests/data/segmentation")
 out_dir = Path("./tests/out/segmentation")
 

tests/test_segmentation.py

@@ -0,0 +1,39 @@
+import configparser
+from pathlib import Path
+
+import pytest
+
+from annofabapi.util.annotation_specs import Lang, get_english_message, get_message_with_lang
+
+inifile = configparser.ConfigParser()
+inifile.read("./pytest.ini", "UTF-8")
+
+test_dir = Path("./tests/data")
+
+
+class Test__get_english_message:
+    def test__get_english_message(self):
+        i18n_message = {
+            "messages": [{"lang": "ja-JP", "message": "自動車"}, {"lang": "en-US", "message": "car"}],
+            "default_lang": "ja-JP",
+        }
+        assert get_english_message(i18n_message) == "car"
+
+    def test__get_english_message__英語メッセージが存在しない場合はValueErrorをスローする(self):
+        i18n_message = {
+            "messages": [{"lang": "ja-JP", "message": "自動車"}],
+            "default_lang": "ja-JP",
+        }
+        with pytest.raises(ValueError):
+            get_english_message(i18n_message)
+
+
+class Test__get_message_with_lang:
+    def test__get_message_with_lang(self):
+        i18n_message = {
+            "messages": [{"lang": "ja-JP", "message": "自動車"}, {"lang": "en-US", "message": "car"}],
+            "default_lang": "ja-JP",
+        }
+        assert get_message_with_lang(i18n_message, Lang.JA_JP) == "自動車"
+        assert get_message_with_lang(i18n_message, "en-US") == "car"
+        assert get_message_with_lang(i18n_message, Lang.VI_VN) is None