SmartList

class deepfos.element.smartlist.SmartList(element_name: str, folder_id: str = None, path: str = None, server_name: str = None)

值列表元素

提供值列表成员的增删改查与批量保存能力，适合脚本中维护小型枚举数据。

快速开始

from deepfos.element.smartlist import SmartList

sml = SmartList('my_sml')

# 读取所有成员
for item in sml.items:
    print(item.subjectValue, item.description)

# 新增成员并保存
sml.add('ITEM_001', desc_zh='项目一', desc_en='Item 1')
sml.save()

# 从 DataFrame 批量覆盖成员
import pandas as pd
df = pd.DataFrame({'subjectValue': ['A', 'B'], 'zh-cn': ['选项A', '选项B']})
sml.load_dataframe(df, strategy='full_replace')

注解

add、remove、load_dataframe 等写入操作只在内存中修改，必须调用 save() 才会提交到系统。

参数

• element_name – 元素名

• folder_id – 元素所在的文件夹id

• path – 元素所在的文件夹绝对路径

提示

如果不提供folder_id和path，将会使用元素名和元素类型进行全局搜索。 如果找到 唯一匹配 的元素，那么一切正常，否则将会报错。

方法

add(value[, desc_zh, desc_en, on_duplicate])	增加成员
add_item(*items[, on_duplicate])	增加成员对象
async_check_exist(ele_name[, ele_type, …])	异步查询元素是否存在
check_exist(ele_name[, ele_type, folder, …])	查询元素是否存在
delete(*item_values[, silent])	删除成员
load_dataframe(dataframe[, strategy])	保存 DataFrame 数据至值列表
save()	保存值列表
set_ud(ud_num[, desc_zh, desc_en, active])	设置ud
update(value[, on_absent])	更新成员
update_item(*items[, on_absent])	使用成员对象更新
wait_for(attr)	异步等待成员变量

属性

api	同步 API 对象
async_api	异步 API 对象
element_info	元素信息
element_type	元素类型
items	值列表成员
meta	值列表的元数据信息