dagster-dingtalk 0.1.8__py3-none-any.whl → 0.1.10__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 DingTalkResource, MultiDingTalkResource
-from dagster_dingtalk.resources import DingTalkWebhookResource, MultiDingTalkWebhookResource
+from dagster_dingtalk.resources import DingTalkAppResource
+from dagster_dingtalk.resources import DingTalkWebhookResource
+from dagster_dingtalk.app_client import DingTalkClient as DingTalkAppClient
 # from dagster_dingtalk.operations import DingTalkWebhookOp
 from dagster_dingtalk.version import __version__
 

dagster_dingtalk/app_client.py

@@ -0,0 +1,154 @@
+import logging
+import pickle
+import time
+from datetime import datetime
+from enum import Enum
+from pathlib import Path
+from typing import List, Literal, Dict, Tuple
+from httpx import Client
+
+
+# noinspection NonAsciiCharacters
+class DingTalkClient:
+    def __init__(self, app_id: str, client_id: str, client_secret: str, app_name: str|None = None, agent_id: int|None = None):
+        self.app_id: str = app_id
+        self.app_name: str|None = app_name
+        self.agent_id: int|None = agent_id
+        self.client_id: str = client_id
+        self.__client_secret: str = client_secret
+        self.robot_code: str = client_id
+
+        access_token: str = self._get_access_token()
+        self.api: Client = Client(base_url="https://api.dingtalk.com/", headers={"x-acs-dingtalk-access-token": access_token})
+        self.oapi: Client = Client(base_url="https://oapi.dingtalk.com/", params={"access_token": access_token})
+
+        self.智能人事 = 智能人事_API(self)
+        self.通讯录管理 = 通讯录管理_API(self)
+        self.文档文件 = 文档文件_API(self)
+
+    def _get_access_token(self) -> str:
+        access_token_cache = Path("/tmp/.dingtalk_cache")
+
+        try:
+            with open(access_token_cache, 'rb') as f:
+                all_access_token: Dict[str, Tuple[str, int]] = pickle.loads(f.read())
+                access_token, expire_in = all_access_token.get(self.app_id, ('', 0))
+        except Exception as e:
+            print(e)
+            all_access_token = {}
+            access_token, expire_in = all_access_token.get(self.app_id, ('', 0))
+
+        if access_token and expire_in < int(time.time()):
+            return access_token
+        else:
+            logging.warning(f"应用{self.app_name}<{self.app_id}> 鉴权缓存过期或不存在，正在重新获取...")
+            response = Client().post(
+                url="https://api.dingtalk.com/v1.0/oauth2/accessToken",
+                json={"appKey": self.client_id, "appSecret": self.__client_secret},
+            )
+            access_token:str = response.json().get("accessToken")
+            expire_in:int = response.json().get("expireIn") + int(time.time()) - 60
+            with open(access_token_cache, 'wb') as f:
+                all_access_token[self.app_id] = (access_token, expire_in)
+                f.write(pickle.dumps(all_access_token))
+            return access_token
+
+# noinspection NonAsciiCharacters
+class 智能人事_API:
+    def __init__(self, _client:DingTalkClient):
+        self.花名册 = 智能人事_花名册_API(_client)
+        self.员工管理 = 智能人事_员工管理_API(_client)
+
+# noinspection NonAsciiCharacters
+class 智能人事_花名册_API:
+    def __init__(self, _client:DingTalkClient):
+        self.__client:DingTalkClient = _client
+
+    def 获取花名册元数据(self) -> dict:
+        response = self.__client.oapi.post(
+            url="/topapi/smartwork/hrm/roster/meta/get",
+            json={"agentid": self.__client.agent_id},
+        )
+        return response.json()
+
+    def 获取员工花名册字段信息(self, user_id_list:List[str], field_filter_list:List[str]|None = None, text_to_select_convert:bool|None = None) -> dict:
+        body_dict = {"userIdList": user_id_list, "appAgentId": self.__client.agent_id}
+        if field_filter_list is not None:
+            body_dict["fieldFilterList"] = field_filter_list
+        if text_to_select_convert is not None:
+            body_dict["text2SelectConvert"] = text_to_select_convert
+
+        response = self.__client.api.post(url="/topapi/smartwork/hrm/roster/meta/get", json=body_dict, )
+        return response.json()
+
+# noinspection NonAsciiCharacters
+class 智能人事_员工管理_API:
+
+    def __init__(self, _client:DingTalkClient):
+        self.__client:DingTalkClient = _client
+
+    # noinspection NonAsciiCharacters
+    class 在职员工状态(Enum):
+        试用期: '2'
+        正式: '3'
+        待离职: '5'
+        无状态: '-1'
+
+    def 获取待入职员工列表(self, offset:int, size:int) -> dict:
+        response = self.__client.oapi.post(
+            "/topapi/smartwork/hrm/employee/querypreentry",
+            json={"offset": offset, "size": size},
+        )
+        return response.json()
+
+    def 获取在职员工列表(self, status_list:List[在职员工状态], offset:int, size:int) -> dict:
+        response = self.__client.oapi.post(
+            "/topapi/smartwork/hrm/employee/querypreentry",
+            json={"status_list": status_list, "offset": offset, "size": size},
+        )
+        return response.json()
+
+    def 获取离职员工列表(self, next_token:int, max_results:int) -> dict:
+        response = self.__client.api.get(
+            "/v1.0/hrm/employees/dismissions",
+            params={"nextToken": next_token, "maxResults": max_results},
+        )
+        return response.json()
+
+    def 批量获取员工离职信息(self, user_id_list:List[str]) -> dict:
+        response = self.__client.api.get(
+            "/v1.0/hrm/employees/dimissionInfo",
+            params={"userIdList": user_id_list},
+        )
+        return response.json()
+
+# noinspection NonAsciiCharacters
+class 通讯录管理_API:
+    def __init__(self, _client:DingTalkClient):
+        self.__client = _client
+
+    def 查询用户详情(self, user_id:str, language:str = "zh_CN") -> dict:
+        response = self.__client.oapi.post(url="/topapi/v2/user/get", json={"language": language, "userid": user_id})
+        return response.json()
+
+    def 查询离职记录列表(self, start_time:datetime, end_time:datetime|None, next_token:str, max_results:int) -> dict:
+        params = {"startTime": start_time.strftime("%Y-%m-%dT%H:%M:%SZ"), "nextToken": next_token, "maxResults": max_results}
+        if end_time is not None:
+            params["endTime"] = end_time.strftime("%Y-%m-%dT%H:%M:%SZ")
+        response = self.__client.api.get(url="/v1.0/contact/empLeaveRecords", params=params)
+        return response.json()
+
+# noinspection NonAsciiCharacters
+class 文档文件_API:
+    def __init__(self, _client:DingTalkClient):
+        self.媒体文件 = 文档文件_媒体文件_API(_client)
+
+# noinspection NonAsciiCharacters
+class 文档文件_媒体文件_API:
+    def __init__(self, _client:DingTalkClient):
+        self.__client = _client
+
+    def 上传媒体文件(self, file_path:Path|str, media_type:Literal['image', 'voice', 'video', 'file']) -> dict:
+        with open(file_path, 'rb') as f:
+            response = self.__client.oapi.post(url=f"/media/upload?type={media_type}", files={'media': f})
+        return response.json()

dagster_dingtalk/operations.py

@@ -1,21 +1,20 @@
 from dagster import In, OpExecutionContext, op
 
+# noinspection PyProtectedMember
+from dagster._annotations import experimental
 
-class DingTalkWebhookOp:
-    @staticmethod
-    @op(description="使用钉钉 Webhook 发送文本消息",
-        required_resource_keys={'dingtalk_webhook'},
-        ins={"text": In(str)},
-    )
-    def send_simple_text(context: OpExecutionContext, text):
-        webhook = context.resources.dingtalk_webhook
-        webhook.send_text(text)
 
-    @staticmethod
-    @op(description="使用钉钉 Webhook 发送 Markdown 消息",
-        required_resource_keys={'dingtalk_webhook'},
-        ins={"text": In(str), "title": In(str, default_value='')},
-    )
-    def send_simple_markdown(context: OpExecutionContext, text, title):
-        webhook = context.resources.dingtalk_webhook
-        webhook.send_text(text, title)
+@experimental
+@op(description="使用钉钉 Webhook 发送文本消息",
+    required_resource_keys={'dingtalk_webhook'},
+    ins={"text": In(str)})
+def op_send_simple_text(context: OpExecutionContext, text):
+    webhook = context.resources.dingtalk_webhook
+    webhook.send_text(text)
+
+@op(description="使用钉钉 Webhook 发送 Markdown 消息",
+    required_resource_keys={'dingtalk_webhook'},
+    ins={"text": In(str), "title": In(str, default_value='')})
+def op_simple_markdown(context: OpExecutionContext, text, title):
+    webhook = context.resources.dingtalk_webhook
+    webhook.send_text(text, title)

dagster_dingtalk/resources.py

@@ -1,30 +1,45 @@
 import base64
 import hashlib
 import hmac
+import re
 import time
 import urllib.parse
-from datetime import datetime
-from enum import Enum
-from pathlib import Path
-from typing import Optional, Dict, Tuple, List, Literal
-import pickle
+from typing import Optional, Tuple, List, Literal
 import httpx
-
-from dagster import (
-    ConfigurableResource,
-    InitResourceContext, ResourceDependency,
-)
-from httpx import Client
-from pydantic import Field, PrivateAttr
+from pydantic import Field
+from .app_client import DingTalkClient
+from dagster import ConfigurableResource, InitResourceContext
 
 
 class DingTalkWebhookResource(ConfigurableResource):
+    """
+    定义一个钉钉群 Webhook 机器人资源，可以用来发送各类通知。
+
+    钉钉API文档：
+    https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type
+
+    Args:
+        access_token (str): 机器人 Webhook 地址中的 access_token 值。
+        secret (str, optional): 如使用加签安全配置，则需传签名密钥。默认值为 None。
+        alias (str, optional): 如提供别名，可以在使用 `MultiDingTalkWebhookResource` 中使用别名进行 webhook 选择。默认值为 None。
+        base_url (str, optional): 通用地址，一般无需更改。默认值为 “https://oapi.dingtalk.com/robot/send”。
+
+    """
     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 webhook_url(self):
+        """
+        实时生成加签或未加签的 Webhook URL。
+
+        钉钉API文档：
+        https://open.dingtalk.com/document/robots/custom-robot-access
+
+        Returns:
+            str: Webhook URL
+        """
         if self.secret is None:
             return f"{self.base_url}?access_token={self.access_token}"
         else:
@@ -37,10 +52,31 @@ class DingTalkWebhookResource(ConfigurableResource):
 
     @staticmethod
     def _gen_title(text):
-        return text[:12].replace("\n", "").replace("#", "").replace(">", "").replace("*", "")
+        """
+        从文本截取前12个字符作为标题，并清理其中的 Markdown 格式字符。
+
+        Args:
+            text: 原文
+
+        Returns:
+            str: 标题
+        """
+        return re.sub(r'[\n#>* ]', '', text[:12])
 
     def send_text(self, text: str,
                   at_mobiles:List[str]|None = None, at_user_ids:List[str]|None = None, at_all:bool = False):
+        """
+        发送文本消息。
+
+        钉钉API文档：
+        https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type
+
+        Args:
+            text (str): 待发送文本
+            at_mobiles (List[str], optional): 需要 @ 的用户手机号。默认值为 None
+            at_user_ids (List[str], optional): 需要 @ 的用户 UserID。默认值为 None
+            at_all (bool, optional): 是否 @ 所有人。默认值为 False
+        """
         at = {"isAtAll": at_all}
         if at_user_ids:
             at["atUserIds"] = at_user_ids
@@ -49,6 +85,18 @@ class DingTalkWebhookResource(ConfigurableResource):
         httpx.post(url=self.webhook_url(), json={"msgtype": "text", "text": {"content": text}, "at": at})
 
     def send_link(self, text: str, message_url:str, title:str|None = None, pic_url:str = ""):
+        """
+        发送 Link 消息。
+
+        钉钉API文档：
+        https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type
+
+        Args:
+            text (str): 待发送文本
+            message_url (str): 链接的 Url
+            title (str, optional): 标题，在通知和被引用时显示的简短信息。默认从文本中生成。
+            pic_url (str, optional): 图片的 Url，默认为 None
+        """
         title = title or self._gen_title(text)
         httpx.post(
             url=self.webhook_url(),
@@ -57,6 +105,32 @@ class DingTalkWebhookResource(ConfigurableResource):
 
     def send_markdown(self, text: List[str]|str, title:str|None = None,
                       at_mobiles:List[str]|None = None, at_user_ids:List[str]|None = None, at_all:bool = False):
+        """
+        发送 Markdown 消息。支持的语法有：
+            # 一级标题
+            ## 二级标题
+            ### 三级标题
+            #### 四级标题
+            ##### 五级标题
+            ###### 六级标题
+            > 引用
+            **加粗**
+            *斜体*
+            [链接跳转](https://example.com/doc.html)
+            ![图片预览](https://example.com/pic.jpg)
+            - 无序列表
+            1. 有序列表
+
+        钉钉API文档：
+        https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type
+
+        Args:
+            text (str): 待发送文本
+            title (str, optional): 标题，在通知和被引用时显示的简短信息。默认从文本中生成。
+            at_mobiles (List[str], optional): 需要 @ 的用户手机号。默认值为 None
+            at_user_ids (List[str], optional): 需要 @ 的用户 UserID。默认值为 None
+            at_all (bool, optional): 是否 @ 所有人。默认值为 False
+        """
         text = text if isinstance(text, str) else "\n\n".join(text)
         title = title or self._gen_title(text)
         at = {"isAtAll": at_all}
@@ -68,99 +142,63 @@ class DingTalkWebhookResource(ConfigurableResource):
 
     def send_action_card(self, text: List[str]|str, title:str|None = None, btn_orientation:Literal["0","1"] = "0",
                          single_jump:Tuple[str,str]|None = None, btns_jump:List[Tuple[str,str]]|None = None):
+        """
+        发送跳转 ActionCard 消息。
+
+        Args:
+            text (str): 待发送文本，支持 Markdown 部分语法。
+            title (str, optional): 标题，在通知和被引用时显示的简短信息。默认从文本中生成。
+            btn_orientation (str, optional):  按钮排列方式，0-按钮竖直排列，1-按钮横向排列。默认值为 "0"
+            single_jump(Tuple[str,str], optional): 传此参数为单个按钮，元组内第一项为按钮的标题，第二项为按钮链接。
+            btns_jump(Tuple[str,str], optional): 传此参数为多个按钮，元组内第一项为按钮的标题，第二项为按钮链接。
+
+        Notes:
+            同时传 single_jump 和 btns_jump，仅 single_jump 生效。
+
+        """
         text = text if isinstance(text, str) else "\n\n".join(text)
         title = title or self._gen_title(text)
-        action_card = {"title": title, "text": text, "btnOrientation": btn_orientation}
-        if btns_jump:
-            action_card["btns"] = [{"title": action_title, "actionURL": action_url} for action_title, action_url in btns_jump]
-            httpx.post(url=self.webhook_url(), json={"msgtype": "actionCard", "actionCard": action_card})
-        elif single_jump:
+        action_card = {"title": title, "text": text, "btnOrientation": str(btn_orientation)}
+        if single_jump:
             action_card["singleTitle"], action_card["singleURL"] = single_jump
             httpx.post(url=self.webhook_url(), json={"msgtype": "actionCard", "actionCard": action_card})
+        elif btns_jump:
+            action_card["btns"] = [{"title": action_title, "actionURL": action_url} for action_title, action_url in btns_jump]
+            httpx.post(url=self.webhook_url(), json={"msgtype": "actionCard", "actionCard": action_card})
         else:
             pass
 
-    def send_feed_card(self, links: List[Tuple[str,str,str]]):
+    def send_feed_card(self, *args:Tuple[str,str,str]):
+        """
+        发送 FeedCard 消息。
+
+        Args:
+            args (Tuple[str,str,str]): 可以传入任意个具有三个元素的元组，分别为 (标题, 跳转链接, 缩略图链接)
+
+        """
+        for a in args:
+            print(a)
         links_data = [
             {"title": title, "messageURL": message_url, "picURL": pic_url}
-            for title, message_url, pic_url in links
+            for title, message_url, pic_url in args
         ]
         httpx.post(url=self.webhook_url(), json={"msgtype": "feedCard", "feedCard": {"links": links_data}})
 
 
-# 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_" or key is None:
-                webhook = self.Webhooks[0]
-            else:
-                webhook = self._webhooks[key]
-            webhook.init_webhook_url()
-            return webhook
-        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
-        self.agent_id: int = agent_id
-        self.robot_code: str = robot_code
-        self.api: Client = httpx.Client(base_url="https://api.dingtalk.com/", headers={"x-acs-dingtalk-access-token": self.access_token})
-        self.oapi: Client = httpx.Client(base_url="https://oapi.dingtalk.com/", params={"access_token": self.access_token})
-
-
-# noinspection NonAsciiCharacters
-class DingTalkResource(ConfigurableResource):
+class DingTalkAppResource(ConfigurableResource):
     """
     [钉钉服务端 API](https://open.dingtalk.com/document/orgapp/api-overview) 企业内部应用部分的第三方封装。
     通过此资源，可以调用部分钉钉服务端API。
 
-    注意：不包含全部的API端点。
+    Notes:
+        不包含全部的API端点。
+
+    Args:
+        AppID (str): 应用应用唯一标识 AppID，作为缓存标识符使用。不传入则不缓存鉴权。
+        AgentID (int, optional): 原企业内部应用 AgentId ，部分 API 会使用到。默认值为 None
+        AppName (str, optional): 应用名。
+        ClientId (str): 应用的 Client ID ，原 AppKey 和 SuiteKey
+        ClientSecret (str): 应用的 Client Secret ，原 AppSecret 和 SuiteSecret
     """
 
     AppID: str = Field(description="应用应用唯一标识 AppID，作为缓存标识符使用。不传入则不缓存鉴权。")
@@ -168,203 +206,16 @@ class DingTalkResource(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，不传时使用 self.ClientId ")
-
-    _client: DingTalkClient = PrivateAttr()
 
     @classmethod
     def _is_dagster_maintained(cls) -> bool:
         return False
 
-    def _get_access_token(self) -> str:
-        access_token_cache = Path("/tmp/.dingtalk_cache")
-
-        try:
-            with open(access_token_cache, 'rb') as f:
-                all_access_token: Dict[str, Tuple[str, int]] = pickle.loads(f.read())
-                access_token, expire_in = all_access_token.get(self.AppID, ('', 0))
-        except Exception as e:
-            print(e)
-            all_access_token = {}
-            access_token, expire_in = all_access_token.get(self.AppID, ('', 0))
-
-        if access_token and expire_in < int(time.time()):
-            return access_token
-        else:
-            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},
-            )
-            access_token:str = response.json().get("accessToken")
-            expire_in:int = response.json().get("expireIn") + int(time.time()) - 60
-            with open(access_token_cache, 'wb') as f:
-                all_access_token[self.AppID] = (access_token, expire_in)
-                f.write(pickle.dumps(all_access_token))
-            return access_token
-
-    def init_client(self):
-        if not hasattr(self, '_client'):
-            self._client = DingTalkClient(
-                self._get_access_token(),
-                self.AppID,
-                self.AgentID,
-                self.RobotCode or self.ClientId
-            )
-
-    def setup_for_execution(self, context: InitResourceContext) -> None:
-        self.init_client()
-
-    def teardown_after_execution(self, context: InitResourceContext) -> None:
-        self._client.api.close()
-        self._client.oapi.close()
-
-    def 智能人事(self):
-        return API_智能人事(self._client)
-
-    def 通讯录管理(self):
-        return API_通讯录管理(self._client)
-
-    def 文档文件(self):
-        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_" or app_id is None:
-                app = self.Apps[0]
-            else:
-                app = self._apps[app_id]
-            app.init_client()
-            return app
-        except KeyError:
-            raise f"该 AppID <{app_id}> 不存在于提供的 AppLists 中。请使用 DingTalkResource 定义单个 App 后，将其加入 AppLists 。"
-
-
-# noinspection NonAsciiCharacters
-class API_智能人事:
-    def __init__(self, _client:DingTalkClient):
-        self._client = _client
-
-    def 花名册_获取花名册元数据(self) -> dict:
-        response = self._client.oapi.post(
-            url="/topapi/smartwork/hrm/roster/meta/get",
-            json={"agentid": self._client.agent_id},
-        )
-        return response.json()
-
-    def 花名册_获取员工花名册字段信息(self, user_id_list:List[str], field_filter_list:List[str]|None = None, text_to_select_convert:bool|None = None) -> dict:
-        body_dict = {"userIdList": user_id_list, "appAgentId": self._client.agent_id}
-        if field_filter_list is not None:
-            body_dict["fieldFilterList"] = field_filter_list
-        if text_to_select_convert is not None:
-            body_dict["text2SelectConvert"] = text_to_select_convert
-
-        response = self._client.api.post(url="/topapi/smartwork/hrm/roster/meta/get", json=body_dict,)
-        return response.json()
-
-    # noinspection NonAsciiCharacters
-    class 在职员工状态(Enum):
-        试用期: '2'
-        正式: '3'
-        待离职: '5'
-        无状态: '-1'
-
-    def 员工管理_获取待入职员工列表(self, offset:int, size:int) -> dict:
-        response = self._client.oapi.post(
-            "/topapi/smartwork/hrm/employee/querypreentry",
-            json={"offset": offset, "size": size},
-        )
-        return response.json()
-
-    def 员工管理_获取在职员工列表(self, status_list:List[在职员工状态], offset:int, size:int) -> dict:
-        response = self._client.oapi.post(
-            "/topapi/smartwork/hrm/employee/querypreentry",
-            json={"status_list": status_list, "offset": offset, "size": size},
-        )
-        return response.json()
-
-    def 员工管理_获取离职员工列表(self, next_token:int, max_results:int) -> dict:
-        response = self._client.api.get(
-            "/v1.0/hrm/employees/dismissions",
-            params={"nextToken": next_token, "maxResults": max_results},
-        )
-        return response.json()
-
-    def 员工管理_批量获取员工离职信息(self, user_id_list:List[str]) -> dict:
-        response = self._client.api.get(
-            "/v1.0/hrm/employees/dimissionInfo",
-            params={"userIdList": user_id_list},
+    def create_resource(self, context: InitResourceContext) -> DingTalkClient:
+        return DingTalkClient(
+            app_id=self.AppID,
+            agent_id=self.AgentID,
+            app_name=self.AppName,
+            client_id=self.ClientId,
+            client_secret=self.ClientSecret
         )
-        return response.json()
-
-
-# noinspection NonAsciiCharacters
-class API_通讯录管理:
-    def __init__(self, _client:DingTalkClient):
-        self._client = _client
-
-    def 查询用户详情(self, user_id:str, language:str = "zh_CN") -> dict:
-        response = self._client.oapi.post(url="/topapi/v2/user/get", json={"language": language, "userid": user_id})
-        return response.json()
-
-    def 查询离职记录列表(self, start_time:datetime, end_time:datetime|None, next_token:str, max_results:int) -> dict:
-        params = {"startTime": start_time.strftime("%Y-%m-%dT%H:%M:%SZ"), "nextToken": next_token, "maxResults": max_results}
-        if end_time is not None:
-            params["endTime"] = end_time.strftime("%Y-%m-%dT%H:%M:%SZ")
-        response = self._client.api.get(url="/v1.0/contact/empLeaveRecords", params=params)
-        return response.json()
-
-
-# noinspection NonAsciiCharacters
-class API_文档文件:
-    def __init__(self, _client:DingTalkClient):
-        self._client = _client
-
-    def 媒体文件_上传媒体文件(self, file_path:Path|str, media_type:Literal['image', 'voice', 'video', 'file']) -> dict:
-        with open(file_path, 'rb') as f:
-            response = self._client.oapi.post(url=f"/media/upload?type={media_type}", files={'media': f})
-        return response.json()
-

dagster_dingtalk/version.py

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.1.10"

{dagster_dingtalk-0.1.8.dist-info → dagster_dingtalk-0.1.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dagster-dingtalk
-Version: 0.1.8
+Version: 0.1.10
 Summary: A dagster plugin for the DingTalk
 Author: YiZixuan
 Author-email: sqkkyzx@qq.com
@@ -20,28 +20,19 @@ Description-Content-Type: text/markdown
 
 ## 介绍
 
-该 Dagster 集成是为了更便捷的调用钉钉（DingTalk）的API，集成提供了两个 Dagster
-Resource 和若干 Dagster Op 的封装。
+该 Dagster 集成是为了更便捷的调用钉钉（DingTalk）的API，集成提供了两个 Dagster Resource。
+
+
+## Webhook 资源
 
 ### DingTalkWebhookResource
 
-该 Dagster 资源允许定义一个钉钉自定义机器人的 Webhook 端点，发送文本、Markdown
+该资源允许定义单个钉钉自定义机器人的 Webhook 端点，以便于发送文本、Markdown
 、Link、 ActionCard、FeedCard 消息，消息具体样式可参考 
 [钉钉开放平台 | 自定义机器人发送消息的消息类型](https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type) 。
 
 
-### DingTalkAPIResource
-
-该 Dagster 资源允许定义一个钉钉的 API Client，更加便捷地调用钉钉服务端 API (
-仅企业内部应用)
-
-
-### DingTalkWebhookOp
-
-该类提供一些预定义的 Dagster Op ，以便于快速调用。
+### DingTalkAppResource
 
-需要注意的是，这些 Op 都没有静态声明 `required_resource_keys`，而是需要根据
-上下文配置 `context.op_config` 中的 `dingtalk_webhook_key` 键来动态查找
-资源。在使用时，必须在 Job 中提供 `resource_defs` ，或在 `User Code` 全局
-定义会使用到的 `dingtalk_webhook_key`。
+该 Dagster 资源允许定义一个钉钉的 API Client，更加便捷地调用钉钉服务端企业内部应用 API
 

dagster_dingtalk-0.1.10.dist-info/RECORD

@@ -0,0 +1,8 @@
+dagster_dingtalk/__init__.py,sha256=X7r8JoydXOsT9Sis4rBpVSKQeKJnnZ_t_qFae-ASF7E,466
+dagster_dingtalk/app_client.py,sha256=U4rEmfpG9J0rqoksWCZxQg6QkdHICwLtBzQL64MjvUY,6749
+dagster_dingtalk/operations.py,sha256=3cCZCxh-dAdzzb75WCTKVdzeMV8yu_JJpIeULS7XaNg,761
+dagster_dingtalk/resources.py,sha256=Z7TtBjliXrU9hglzohymYmg_Itd6PnogpvJE9xO7IjQ,9781
+dagster_dingtalk/version.py,sha256=z0zCHFTcKSR0tJ6h5qrpNmRVP21QIPP8N0p7quCnnm0,23
+dagster_dingtalk-0.1.10.dist-info/METADATA,sha256=4fjDXlG6sooFgoxCnbFOXlY0x2hBiEiBaMHRA4ojn_A,1221
+dagster_dingtalk-0.1.10.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+dagster_dingtalk-0.1.10.dist-info/RECORD,,

dagster_dingtalk-0.1.8.dist-info/RECORD

@@ -1,7 +0,0 @@
-dagster_dingtalk/__init__.py,sha256=ktvoURpkJwIzcyQfUvnel1KA4DukRgavAgLl7f0Cy_0,440
-dagster_dingtalk/operations.py,sha256=xJJlOVmFjpaDTMkHZXxj5LbXqRtIQwREl9ZJdXIMOyE,788
-dagster_dingtalk/resources.py,sha256=iWhVHtct5DDKk3-ejlT1t_N0pFtfD_nb1h6xr4rVSSQ,15231
-dagster_dingtalk/version.py,sha256=sXLh7g3KC4QCFxcZGBTpG2scR7hmmBsMjq6LqRptkRg,22
-dagster_dingtalk-0.1.8.dist-info/METADATA,sha256=KlhB2moaofe0iHmVOFCgxtJ5AqEItCkbqFVkjaQKS2A,1659
-dagster_dingtalk-0.1.8.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-dagster_dingtalk-0.1.8.dist-info/RECORD,,