Variable¶

class deepfos.element.variable.Variable(element_name: str, folder_id: str = None, path: str = None, server_name: str = None)¶

变量

为了防止将变量元素本身与变量元素保存的变量值混淆。在本节文档中，将变量元素称为 “变量” ，各变量值称为 “变量成员” 或简称为 “成员”。

参数

提示

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

方法

`add_custom_list`(name, custom_list[, value, …])	新增单个自定义列表变量成员
`add_date`(name[, date_format, value, …])	新增单个日期变量成员
`add_dimension`(name, dim, dim_expression[, …])	新增单个维度变量成员
`add_number`(name[, value, description, …])	新增单个数字变量成员
`add_smartlist`(name, smart_list[, value, …])	新增单个值列表变量成员
`add_text`(name[, value, description, …])	新增单个文本变量成员
`async_check_exist`(ele_name[, ele_type, …])	异步查询元素是否存在
`check_exist`(ele_name[, ele_type, folder, …])	查询元素是否存在
`delete_variables`(*name[, silent])	删除变量成员
`get`(name[, default])	根据变量成员名获取成员值
`get_value`(name[, is_customize_value, …])	根据变量成员名获取成员值
`get_variable`(name)	根据变量成员名获取成员
`save`()	保存变量
`update_description`(name[, en_description, …])	根据变量成员名称，更新变量成员的描述
`update_value`(name, update_value[, …])	更新变量成员的值
`wait_for`(attr)	异步等待成员变量

属性