deepfos 1.1.7__tar.gz → 1.1.8__tar.gz

{deepfos-1.1.7 → deepfos-1.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deepfos
-Version: 1.1.7
+Version: 1.1.8
 Summary: Collecions of useful and handy tools for deepfos platform
 Home-page: http://py.deepfos.com
 Author: deepfos-python-team

{deepfos-1.1.7 → deepfos-1.1.8}/deepfos/lib/deepux.py

@@ -1,12 +1,13 @@
 """DeepUX组件数据源"""
 import asyncio
 import functools
-from typing import Dict, Type
+from typing import Dict, Type, List
 
 import pandas as pd
 
 from deepfos import OPTION
 from deepfos.api.models import BaseModel
+from deepfos.api.models.dimension import DimensionMemberBean
 
 __all__ = [
     'BaseField',
@@ -19,6 +20,7 @@ __all__ = [
     'UUID',
     'as_datasource',
     'Struct',
+    'to_desc'
 ]
 
 FLAG_FOR_META = 'describe'
@@ -26,6 +28,7 @@ FIELDS = "fields"
 STRUCT_FIELD = "objectInfos"
 ELE_INFO_FIELD = "elementInfo"
 DATA_FIELD = "json"
+DESC_FIELD = "description"
 
 
 class BaseField(BaseModel):
@@ -130,12 +133,50 @@ class Struct(metaclass=StructMeta):
         }
 
 
+def to_desc(data: List[DimensionMemberBean]):
+    desc = {}
+    for dim in data:
+        desc[dim.name] = dim.multilingual.get(OPTION.api.header.get('language', 'en'), dim.name)
+    return desc
+
+
 def _resolve_param(args: tuple):
     if len(args) == 2:
         return args[1]
     if len(args) == 1:
         return args[0]
-    raise ValueError("Bad signature for main function.")
+    raise ValueError("main函数入参数非法")
+
+
+def _check_str_dict(data: Dict[str, Dict], value_type):
+    if any(not isinstance(k, str) for k in data):
+        raise ValueError("字段描述格式非法")
+
+    if any(not isinstance(v, value_type) for v in data.values()):
+        raise ValueError("字段描述格式非法")
+
+    if value_type == str:
+        return
+
+    for v in data.values():
+        _check_str_dict(v, str)
+
+
+def _resolve_return_value(return_value):
+    if isinstance(return_value, tuple) and len(return_value) == 2:
+        df, desc = return_value
+        if not isinstance(desc, dict):
+            raise TypeError("预期字段描述为字典")
+
+        _check_str_dict(desc, dict)
+
+    elif isinstance(return_value, pd.DataFrame):
+        df = return_value
+        desc = {}
+    else:
+        raise ValueError("预期main函数返回值为pandas DataFrame或pandas DataFrame与字段描述的元组")
+
+    return df, desc
 
 
 def as_datasource(
@@ -145,7 +186,7 @@ def as_datasource(
     """用作DeepUX数据源的main函数装饰器
 
     Args:
-        func: 返回pandas DataFrame的main方法
+        func: 返回pandas DataFrame和字段描述（可选）的main方法
         struct: 定义字段及其字段类型的类名称，必填
 
     .. admonition:: 用法示例
@@ -182,11 +223,13 @@ def as_datasource(
             if param == FLAG_FOR_META:
                 return struct.to_dict()
 
-            df = await func(*args)
+            maybe_df_desc = await func(*args)
+
+            df, desc = _resolve_return_value(maybe_df_desc)
 
             assert isinstance(df, pd.DataFrame), '预期main函数返回值为pandas DataFrame'
 
-            return {DATA_FIELD: df.to_dict('records')}
+            return {DATA_FIELD: df.to_dict('records'), DESC_FIELD: desc}
     else:
         def wrapper(*args):
             param = _resolve_param(args)
@@ -194,10 +237,12 @@ def as_datasource(
             if param == FLAG_FOR_META:
                 return struct.to_dict()
 
-            df = func(*args)
+            maybe_df_desc = func(*args)
+
+            df, desc = _resolve_return_value(maybe_df_desc)
 
             assert isinstance(df, pd.DataFrame), '预期main函数返回值为pandas DataFrame'
 
-            return {DATA_FIELD: df.to_dict('records')}
+            return {DATA_FIELD: df.to_dict('records'), DESC_FIELD: desc}
 
     return functools.wraps(func)(wrapper)

{deepfos-1.1.7 → deepfos-1.1.8}/deepfos.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: deepfos
-Version: 1.1.7
+Version: 1.1.8
 Summary: Collecions of useful and handy tools for deepfos platform
 Home-page: http://py.deepfos.com
 Author: deepfos-python-team

{deepfos-1.1.7 → deepfos-1.1.8}/setup.py

@@ -52,7 +52,7 @@ def resolve_extensions():
 
 
 setup(
-    version="1.1.7",
+    version="1.1.8",
     # cmdclass=versioneer.get_cmdclass(),
     ext_modules=resolve_extensions()
 )