[resource.py] .netrcまたは環境変数から認証情報を読み込むメソッドを追加 (#191)

* [resource.py] netrcまたは環境変数から情報を取得するメソッドを追加

* version up

* メソッド名の変更

Author: yuji38kwmt

README.md

@@ -56,7 +56,7 @@ https://pypi.org/project/annofabapi/
 
 ## インスタンス生成
 
-### user_id, passwordをコンストラクタ引数に渡す
+### user_id, passwordをコンストラクタ引数に渡す場合
 
 ```python
 # APIアクセス用のインスタンスを生成
@@ -69,7 +69,7 @@ password = "YYYYYY"
 service = build(user_id, password)
 ```
 
-### `.netrc`に記載されたuser_id, passwordから生成
+### `.netrc`に認証情報を記載する場合
 `.netrc`ファイルに、AnnofabのユーザIDとパスワードを記載します。
 
 ```plain:.netrc
@@ -94,6 +94,24 @@ service = build_from_netrc()
 * パスは`%USERPROFILE%\.netrc`
 
 
+### 環境変数に認証情報を設定する場合
+環境変数`ANNOFAB_USER_ID`、`ANNOFAB_PASSWORD`にユーザIDとパスワードを設定します。
+
+```python
+from annofabapi import build_from_env
+service = build_from_env()
+```
+
+
+### `.netrc`または環境変数に認証情報を設定する場合
+`.netrc`、環境変数の順に認証情報を読み込みます。
+
+```python
+from annofabapi import build_from_netrc_or_env
+service = build_from_netrc_or_env()
+```
+
+
 ## `service.api`のサンプルコード
 
 * `service.api`には、Web APIに対応するメソッドが定義されています。

annofabapi/__init__.py

@@ -1,7 +1,7 @@
 from annofabapi.api import AnnofabApi
 from annofabapi.api2 import AnnofabApi2
 from annofabapi.wrapper import Wrapper
-from annofabapi.resource import build, build_from_netrc, build_from_env, Resource
+from annofabapi.resource import build, build_from_netrc, build_from_env, build_from_netrc_or_env, Resource
 
 from .__version__ import __version__
 
@@ -11,6 +11,7 @@
     "Wrapper",
     "build",
     "build_from_netrc",
+    "build_from_netrc_or_env",
     "build_from_env",
     "Resource",
     "__version__",

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = "0.38.1"
+__version__ = "0.38.2"

annofabapi/resource.py

@@ -97,3 +97,29 @@ def build_from_env(endpoint_url: str = DEFAULT_ENDPOINT_URL) -> Resource:
 
     logger.debug("環境変数からAnnoFab認証情報を読み込みました。")
     return Resource(login_user_id, login_password, endpoint_url=endpoint_url)
+
+
+def build_from_netrc_or_env(endpoint_url: str = DEFAULT_ENDPOINT_URL) -> Resource:
+    """
+    `.netrc`ファイルまたは環境変数からAnnoFab認証情報を取得し、annnofabapi.Resourceインスタンスを生成します。
+    netrc, 環境変数の順に認証情報を読み込みます。
+
+    Args:
+        endpoint_url:
+
+    Returns:
+
+    """
+    # '.netrc'ファイルから認証情報を取得する
+    try:
+        return build_from_netrc(endpoint_url)
+    except AnnofabApiException:
+        pass
+
+    # 環境変数から認証情報を取得する
+    try:
+        return build_from_env(endpoint_url)
+    except AnnofabApiException:
+        pass
+
+    raise AnnofabApiException("`.netrc`ファイルまたは環境変数にAnnoFab認証情報はありませんでした。")

pyproject.toml

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

tests/test_api.py

@@ -440,6 +440,7 @@ def test_put_webhook_and_delete_webhook(self):
 
         assert type(api.delete_webhook(project_id, test_webhook_id)[0]) == dict
 
+
 class TestLabor:
     def test_get_labor_control_worktime(self):
         wrapper.get_labor_control_worktime(project_id=project_id)

tests/test_local_resource.py

@@ -7,6 +7,7 @@
 
 import annofabapi
 import annofabapi.exceptions
+from annofabapi.resource import build_from_netrc_or_env
 
 # プロジェクトトップに移動する
 os.chdir(os.path.dirname(os.path.abspath(__file__)) + "/../")
@@ -32,6 +33,11 @@ def test_build_from_env(self):
         os.environ["ANNOFAB_PASSWORD"] = "BAR"
         assert isinstance(annofabapi.build_from_env(), annofabapi.Resource)
 
+    def test_build_from_netrc_or_env(self):
+        os.environ["ANNOFAB_USER_ID"] = "FOO"
+        os.environ["ANNOFAB_PASSWORD"] = "BAR"
+        assert isinstance(build_from_netrc_or_env(), annofabapi.Resource)
+
     def test_build_with_endpoint(self):
         resource = annofabapi.build("test_user", "password", "https://localhost:8080")
         assert resource.api.url_prefix == "https://localhost:8080/api/v1"