dagster-dingtalk 0.1.4__py3-none-any.whl → 0.1.5b1__py3-none-any.whl

dagster_dingtalk/__init__.py

@@ -1,8 +1,9 @@
 # noinspection PyProtectedMember
 from dagster._core.libraries import DagsterLibraryRegistry
 
-from dagster_dingtalk.resources import DingTalkAPIResource, DingTalkWebhookResource
-from dagster_dingtalk.operations import DingTalkWebhookOp
+from dagster_dingtalk.resources import DingTalkResource, MultiDingTalkResource
+from dagster_dingtalk.resources import DingTalkWebhookResource, MultiDingTalkWebhookResource
+# from dagster_dingtalk.operations import DingTalkWebhookOp
 from dagster_dingtalk.version import __version__
 
 DagsterLibraryRegistry.register("dagster-dingtalk", __version__)

dagster_dingtalk/operations.py

@@ -1,22 +1,21 @@
 from dagster import In, OpExecutionContext, op
-from pydantic import Field
 
 
 class DingTalkWebhookOp:
     @staticmethod
     @op(description="使用钉钉 Webhook 发送文本消息",
-        config_schema={"dingtalk_webhook_key": str},
+        required_resource_keys={'dingtalk_webhook'},
         ins={"text": In(str)},
     )
     def send_simple_text(context: OpExecutionContext, text):
-        webhook = getattr(context.resources, context.op_config["dingtalk_webhook_key"])
+        webhook = context.resources.dingtalk_webhook
         webhook.send_text(text)
 
     @staticmethod
     @op(description="使用钉钉 Webhook 发送 Markdown 消息",
-        config_schema={"dingtalk_webhook_key": str},
+        required_resource_keys={'dingtalk_webhook'},
         ins={"text": In(str), "title": In(str, default_value='')},
     )
     def send_simple_markdown(context: OpExecutionContext, text, title):
-        webhook = getattr(context.resources, context.op_config["dingtalk_webhook_key"])
+        webhook = context.resources.dingtalk_webhook
         webhook.send_text(text, title)

dagster_dingtalk/resources.py

@@ -12,19 +12,19 @@ import httpx
 
 from dagster import (
     ConfigurableResource,
-    InitResourceContext,
+    InitResourceContext, ResourceDependency,
 )
 from httpx import Client
-from pydantic import Field, PrivateAttr
+from pydantic import Field, PrivateAttr, BaseModel
 
 
 class DingTalkWebhookResource(ConfigurableResource):
-    base_url: str = Field(default="https://oapi.dingtalk.com/robot/send", description="Webhook的通用地址，无需更改")
     access_token: str = Field(description="Webhook地址中的 access_token 部分")
     secret: Optional[str] = Field(default=None, description="如使用加签安全配置，需传签名密钥")
+    alias: Optional[str] = Field(default=None, description="如提供别名，将来可以使用别名进行选择")
+    base_url: str = Field(default="https://oapi.dingtalk.com/robot/send", description="Webhook的通用地址，无需更改")
 
     def _sign_webhook_url(self):
-
         if self.secret is None:
             return self.webhook_url
         else:
@@ -88,7 +88,60 @@ class DingTalkWebhookResource(ConfigurableResource):
         httpx.post(url=self.webhook_url, json={"msgtype": "feedCard", "feedCard": {"links": links_data}})
 
 
-class DingTalkMultiClient:
+# noinspection NonAsciiCharacters
+class MultiDingTalkWebhookResource(ConfigurableResource):
+    """
+    该资源提供了预先定义多个 webhook 资源，并在运行时动态选择的方法。
+
+    使用示例：
+
+    ```
+    from dagster_dingtalk import DingTalkResource, MultiDingTalkResource
+
+    app_apple = DingTalkResource(AppID="apple", ClientId="", ClientSecret="")
+    app_book = DingTalkResource(AppID="book", ClientId="", ClientSecret="")
+
+    @op(required_resource_keys={"dingtalk"}, ins={"app_id":In(str)})
+    def print_app_id(context:OpExecutionContext, app_id):
+        dingtalk:DingTalkResource = context.resources.dingtalk
+        select_app = dingtalk.select_app(app_id)
+        context.log.info(dingtalk_app.AppName)
+
+    @job
+    def print_app_id_job():
+        print_app_id()
+
+    defs = Definitions(
+        jobs=[print_app_id_job],
+        resources={
+            "dingtalk": MultiDingTalkResource(
+                Apps=[app_apple, app_book]
+            )
+        },
+    )
+    ```
+
+    """
+
+    Webhooks: ResourceDependency[List[DingTalkWebhookResource]] = Field(description="多个 Webhook 资源的列表")
+
+    _webhooks = PrivateAttr()
+
+    def setup_for_execution(self, context: InitResourceContext) -> None:
+        _webhooks_token_key = {webhook.access_token:webhook for webhook in self.Webhooks}
+        _webhooks_alias_key = {webhook.alias:webhook for webhook in self.Webhooks if webhook.alias}
+        self._webhooks = _webhooks_token_key | _webhooks_alias_key
+
+    def select(self, key:str = "_FIRST_"):
+        try:
+            if key == "_FIRST_":
+                return self.Webhooks[0]
+            return self._webhooks[key]
+        except KeyError:
+            raise f"该 AccessToken 或 别名 <{key}> 不存在于提供的 Webhooks 中。请使用 DingTalkWebhookResource 定义单个 Webhook 后，将其加入 Webhooks 。"
+
+
+class DingTalkClient:
     def __init__(self, access_token: str, app_id: str, agent_id: int, robot_code: str) -> None:
         self.access_token: str = access_token
         self.app_id: str = app_id
@@ -99,7 +152,7 @@ class DingTalkMultiClient:
 
 
 # noinspection NonAsciiCharacters
-class DingTalkAPIResource(ConfigurableResource):
+class DingTalkResource(ConfigurableResource):
     """
     [钉钉服务端 API](https://open.dingtalk.com/document/orgapp/api-overview) 企业内部应用部分的第三方封装。
     通过此资源，可以调用部分钉钉服务端API。
@@ -112,15 +165,15 @@ class DingTalkAPIResource(ConfigurableResource):
     AppName: Optional[str] = Field(default=None, description="应用名。")
     ClientId: str = Field(description="应用的 Client ID (原 AppKey 和 SuiteKey)")
     ClientSecret: str = Field(description="应用的 Client Secret (原 AppSecret 和 SuiteSecret)")
-    RobotCode: Optional[str] = Field(default=None, description="应用的机器人 RobotCode")
+    RobotCode: Optional[str] = Field(default=None, description="应用的机器人 RobotCode，不传时使用 self.ClientId ")
 
-    _client: DingTalkMultiClient = PrivateAttr()
+    _client: DingTalkClient = PrivateAttr()
 
     @classmethod
     def _is_dagster_maintained(cls) -> bool:
         return False
 
-    def _get_access_token(self, context: InitResourceContext) -> str:
+    def _get_access_token(self) -> str:
         access_token_cache = Path("~/.dingtalk_cache")
 
         if access_token_cache.exists():
@@ -134,7 +187,7 @@ class DingTalkAPIResource(ConfigurableResource):
         if access_token and expire_in < int(time.time()):
             return access_token
         else:
-            context.log.info(f"应用{self.AppName}<{self.AppID}> 鉴权缓存过期或不存在，正在重新获取...")
+            print(f"应用{self.AppName}<{self.AppID}> 鉴权缓存过期或不存在，正在重新获取...")
             response = httpx.post(
                 url="https://api.dingtalk.com/v1.0/oauth2/accessToken",
                 json={"appKey": self.ClientId, "appSecret": self.ClientSecret},
@@ -147,30 +200,82 @@ class DingTalkAPIResource(ConfigurableResource):
             return access_token
 
     def setup_for_execution(self, context: InitResourceContext) -> None:
-        self._client = DingTalkMultiClient(
-            self._get_access_token(context),
-            self.AppID,
-            self.AgentID,
-            self.RobotCode,
-        )
+        self._client = DingTalkClient(self._get_access_token(), self.AppID, self.AgentID, self.RobotCode or self.ClientId)
 
     def teardown_after_execution(self, context: InitResourceContext) -> None:
         self._client.api.close()
         self._client.oapi.close()
 
     def 智能人事(self):
+        if not hasattr(self, '_client'):
+            self._client = DingTalkClient(self._get_access_token(), self.AppID, self.AgentID, self.RobotCode or self.ClientId)
         return API_智能人事(self._client)
 
     def 通讯录管理(self):
+        if not hasattr(self, '_client'):
+            self._client = DingTalkClient(self._get_access_token(), self.AppID, self.AgentID, self.RobotCode or self.ClientId)
         return API_通讯录管理(self._client)
 
     def 文档文件(self):
+        if not hasattr(self, '_client'):
+            self._client = DingTalkClient(self._get_access_token(), self.AppID, self.AgentID, self.RobotCode or self.ClientId)
         return API_文档文件(self._client)
 
 
+# noinspection NonAsciiCharacters
+class MultiDingTalkResource(ConfigurableResource):
+    """
+    该资源提供了预先定义多个应用资源，并在运行时动态选择的方法。
+
+    使用示例：
+
+    ```
+    from dagster_dingtalk import DingTalkResource, MultiDingTalkResource
+
+    app_apple = DingTalkResource(AppID="apple", ClientId="", ClientSecret="")
+    app_book = DingTalkResource(AppID="book", ClientId="", ClientSecret="")
+
+    @op(required_resource_keys={"dingtalk"}, ins={"app_id":In(str)})
+    def print_app_id(context:OpExecutionContext, app_id):
+        dingtalk:DingTalkResource = context.resources.dingtalk
+        select_app = dingtalk.select_app(app_id)
+        context.log.info(dingtalk_app.AppName)
+
+    @job
+    def print_app_id_job():
+        print_app_id()
+
+    defs = Definitions(
+        jobs=[print_app_id_job],
+        resources={
+            "dingtalk": MultiDingTalkResource(
+                Apps=[app_apple, app_book]
+            )
+        },
+    )
+    ```
+
+    """
+
+    Apps: ResourceDependency[List[DingTalkResource]] = Field(description="多个单应用资源的列表")
+
+    _apps = PrivateAttr()
+
+    def setup_for_execution(self, context: InitResourceContext) -> None:
+        self._apps = {app.AppID:app for app in self.Apps}
+
+    def select(self, app_id:str = "_FIRST_"):
+        try:
+            if app_id == "_FIRST_":
+                return self.Apps[0]
+            return self._apps[app_id]
+        except KeyError:
+            raise f"该 AppID <{app_id}> 不存在于提供的 AppLists 中。请使用 DingTalkResource 定义单个 App 后，将其加入 AppLists 。"
+
+
 # noinspection NonAsciiCharacters
 class API_智能人事:
-    def __init__(self, _client:DingTalkMultiClient):
+    def __init__(self, _client:DingTalkClient):
         self._client = _client
 
     def 花名册_获取花名册元数据(self):
@@ -228,7 +333,7 @@ class API_智能人事:
 
 # noinspection NonAsciiCharacters
 class API_通讯录管理:
-    def __init__(self, _client:DingTalkMultiClient):
+    def __init__(self, _client:DingTalkClient):
         self._client = _client
 
     def 查询用户详情(self, user_id:str, language:str = "zh_CN"):
@@ -245,7 +350,7 @@ class API_通讯录管理:
 
 # noinspection NonAsciiCharacters
 class API_文档文件:
-    def __init__(self, _client:DingTalkMultiClient):
+    def __init__(self, _client:DingTalkClient):
         self._client = _client
 
     def 媒体文件_上传媒体文件(self, file_path:Path|str, media_type:Literal['image', 'voice', 'video', 'file']):

{dagster_dingtalk-0.1.4.dist-info → dagster_dingtalk-0.1.5b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dagster-dingtalk
-Version: 0.1.4
+Version: 0.1.5b1
 Summary: A dagster plugin for the DingTalk
 Author: YiZixuan
 Author-email: sqkkyzx@qq.com

dagster_dingtalk-0.1.5b1.dist-info/RECORD

@@ -0,0 +1,7 @@
+dagster_dingtalk/__init__.py,sha256=ktvoURpkJwIzcyQfUvnel1KA4DukRgavAgLl7f0Cy_0,440
+dagster_dingtalk/operations.py,sha256=xJJlOVmFjpaDTMkHZXxj5LbXqRtIQwREl9ZJdXIMOyE,788
+dagster_dingtalk/resources.py,sha256=6S8pVSz0ZMumaibfsJ_ZTxJVUZOleotg1c4hzt_VPDk,15156
+dagster_dingtalk/version.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
+dagster_dingtalk-0.1.5b1.dist-info/METADATA,sha256=JeVAne_YvTbPe_Av_NPbuu5KpsKCsO0uJzNvarEfvLo,1661
+dagster_dingtalk-0.1.5b1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+dagster_dingtalk-0.1.5b1.dist-info/RECORD,,

dagster_dingtalk-0.1.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-dagster_dingtalk/__init__.py,sha256=o6bZAaJFfoQEphn9ZaxGBYwq45EsDEBCeTRNUDCWLz0,350
-dagster_dingtalk/operations.py,sha256=MOgt-a1k2OKxEaICm7-hq_JD2IpqxnI8-K9GUCfprTI,886
-dagster_dingtalk/resources.py,sha256=uZ-DV8_7RswiT9t0zv8IOiu5nkQcc1yPwNESRTlMDnY,11089
-dagster_dingtalk/version.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
-dagster_dingtalk-0.1.4.dist-info/METADATA,sha256=o1hdiDJpcjOzt9tFNat7zRuzbKNDKNSxbV4eLk6psWs,1659
-dagster_dingtalk-0.1.4.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-dagster_dingtalk-0.1.4.dist-info/RECORD,,