xmes-dingtalk-connectflow-sdk 1.0.0__tar.gz → 1.0.1__tar.gz

{xmes_dingtalk_connectflow_sdk-1.0.0 → xmes_dingtalk_connectflow_sdk-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xmes-dingtalk-connectflow-sdk
-Version: 1.0.0
+Version: 1.0.1
 Summary: DingTalk Connection Platform Connection Flow SDK
 License: MIT
 Author: leslieliang
@@ -16,7 +16,7 @@ Requires-Dist: requests (>=2.32.3,<3.0.0)
 Description-Content-Type: text/markdown
 
 ## 概述
-![Version](https://img.shields.io/badge/Version-v1.0.0-green)
+![Version](https://img.shields.io/badge/Version-v1.0.1-green)
 ![Python Version](https://img.shields.io/badge/Python-%E2%89%A53.9-blue)
 
 `xmes-dingtalk-connectflow-sdk` 是钉钉连接平台自建连接流SDK（向美而生），通过该工具可以方便快捷的调用钉钉的连接流。

{xmes_dingtalk_connectflow_sdk-1.0.0 → xmes_dingtalk_connectflow_sdk-1.0.1}/README.md

@@ -1,5 +1,5 @@
 ## 概述
-![Version](https://img.shields.io/badge/Version-v1.0.0-green)
+![Version](https://img.shields.io/badge/Version-v1.0.1-green)
 ![Python Version](https://img.shields.io/badge/Python-%E2%89%A53.9-blue)
 
 `xmes-dingtalk-connectflow-sdk` 是钉钉连接平台自建连接流SDK（向美而生），通过该工具可以方便快捷的调用钉钉的连接流。

{xmes_dingtalk_connectflow_sdk-1.0.0 → xmes_dingtalk_connectflow_sdk-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "xmes-dingtalk-connectflow-sdk"
-version = "1.0.0"
+version = "1.0.1"
 description = "DingTalk Connection Platform Connection Flow SDK"
 authors = ["leslieliang <zwliang98@163.com>"]
 license = "MIT"

{xmes_dingtalk_connectflow_sdk-1.0.0 → xmes_dingtalk_connectflow_sdk-1.0.1}/src/DingtalkConnectflowSDk/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '1.0.0'
+__version__ = '1.0.1'
 
 from .complex_table import *  # noqa: F403

xmes_dingtalk_connectflow_sdk-1.0.1/src/DingtalkConnectflowSDk/_types.py

@@ -0,0 +1,10 @@
+from dataclasses import fields
+
+
+class FilteredDataclass(type):
+    """过滤kwargs中多余的键"""
+
+    def __call__(cls, *args, **kwargs):
+        valid_fields = {f.name for f in fields(cls)}
+        kwargs = {k: v for k, v in kwargs.items() if k in valid_fields}
+        return super().__call__(*args, **kwargs)

{xmes_dingtalk_connectflow_sdk-1.0.0 → xmes_dingtalk_connectflow_sdk-1.0.1}/src/DingtalkConnectflowSDk/complex_table.py

@@ -5,14 +5,20 @@ Author: LeslieLiang
 Description: 多维表连接流SDK
 """
 
+import json
+from copy import deepcopy
 from dataclasses import dataclass
 from typing import Literal
 
 from requests import post
 
+from ._types import FilteredDataclass
+
 
 @dataclass
 class GetterFilter:
+    """记录筛选器"""
+
     field: str
     operator: Literal[
         'equal', 'notEqual', 'incontain', 'notContain', 'empty', 'notEmpty'
@@ -22,10 +28,63 @@ class GetterFilter:
 
 @dataclass
 class Updater:
+    """记录更新器"""
+
     record_id: str
     fields: dict[str, any]
 
 
+@dataclass
+class GetterResult(metaclass=FilteredDataclass):
+    """获取器结果"""
+
+    nextCursor: str = None
+    records: list[dict] = None
+    hasMore: bool = False
+
+    def __post_init__(self):
+        if self.records and isinstance(self.records, list):
+            self.records = self.__records_handle()
+
+    def __records_handle(self):
+        records: list[dict] = []
+        for record in self.records:
+            record_temp = {'id': record.get('id'), 'fields': {}}
+            fields: dict = record.get('fields')
+
+            for field_name, field_value in fields.items():
+                _value = deepcopy(field_value)
+                if isinstance(field_value, dict):
+                    if 'link' in field_value:
+                        _value = field_value.get('link')
+                    elif 'name' in field_value:
+                        _value = field_value.get('name')
+
+                record_temp['fields'][field_name] = _value
+
+            records.append(record_temp)
+
+        return records
+
+    def to_file(self, file_path: str):
+        """
+        将数据写出到本地
+
+        Args:
+            file_path: 用于存储数据的文件路径, 不需要文件后缀
+        Returns:
+            数据文件路径
+        """
+
+        if not self.records:
+            raise ValueError('数据记录为空, 无法写出')
+
+        with open(f'{file_path}.json', 'w', encoding='utf-8') as f:
+            f.write(json.dumps(self.records, ensure_ascii=False, indent=2))
+
+        return file_path
+
+
 class Table:
     __HEADERS = {
         'Content-Type': 'application/json',
@@ -46,7 +105,7 @@ class Table:
         cursor: str = '',
         combination: Literal['and', 'or'] = 'and',
         filters: list[GetterFilter] | None = None,
-    ) -> dict:
+    ):
         """
         获取表格数据
         Args:
@@ -78,7 +137,11 @@ class Table:
             reqdata['handle_get']['filter'] = filter_field
 
         resp = post(self.flow_url, json=reqdata, headers=self.__HEADERS)
-        return resp.json().get('GET_RESULT')
+        result: dict = resp.json().get('GET_RESULT')
+
+        getter_result = GetterResult(**result)
+
+        return getter_result
 
     def add(self, records: list[dict]):
         """