Utils 模块
TIPCommon.utils.camel_to_snake_case
TIPCommon.utils.camel_to_snake_case(string)
将驼峰式大小写字符串转换为蛇形命名法。
| 参数 | |
|---|---|
string |
str要转换的字符串。 |
返回值
转换后的字符串。
返回类型
str
TIPCommon.utils.cast_keys_to_int
TIPCommon.utils.cast_keys_to_int(data)
将字典的键转换为整数。
| 参数 | |
|---|---|
data |
dict键被转换为整数的数据。 |
返回值
一个以整数为键的新字典。
返回类型
dict
TIPCommon.utils.clean_result
TIPCommon.utils.clean_result(value)
移除值前面或后面的不必要空格。
| 参数 | |
|---|---|
value |
str要移除空格的值。 |
返回值
原始值的纯文本版本。
返回类型
str
TIPCommon.utils.create_and_write_to_tempfile
TIPCommon.utils.create_and_write_to_tempfile(content: str | bytes)→ Path
创建临时文件并将内容写入该文件。
参数
| 参数 | |
|---|---|
content |
str | bytes要写入临时文件的内容。 |
返回值
所创建临时文件的路径。
返回类型
Path
TIPCommon.utils.get_entity_original_identifier
TIPCommon.utils.get_entity_original_identifier(entity)
用于获取实体的原始标识符的辅助函数。
| 参数 | |
|---|---|
entity |
Entity
函数从中获取原始标识符的实体。 |
返回值
原始标识符。
返回类型
str
TIPCommon.utils.get_function_arg_names
TIPCommon.utils.get_function_arg_names(func)
检索特定函数的所有实参名称。
| 参数 | |
|---|---|
func |
要分析的函数或方法。 |
返回值
指定函数中定义的所有实参键。
返回类型
list
TIPCommon.utils.get_unique_items_by_difference
TIPCommon.utils.get_unique_items_by_difference(item_pool: Iterable,
items_to_remove: Iterable) → list
从两个可迭代对象 (item_pool - items_to_remove) 中获取差集项。
| 参数 | |
|---|---|
item_pool |
iterable要从中过滤的商品池。 |
items_to_remove |
iterable
应移除的商品（如有）。 |
返回值
一个列表，其中包含 item_pool 中不属于 items_to_remove 的唯一项。
返回类型
list
TIPCommon.utils.is_empty_string_or_none
TIPCommon.utils.is_empty_string_or_none(data)
检查数据是否为空字符串或 None。
| 参数 | |
|---|---|
data |
str要检查的数据。 |
返回值
如果提供的数据为 None，或者仅包含空字符串 ""，则为 True。
返回类型
bool
TIPCommon.utils.is_first_run
TIPCommon.utils.is_first_run(sys_argv)
返回一个布尔值，指示操作是否正在异步执行。
参数
| 参数 | |
|---|---|
sys_argv |
来自 sys.argv 模块的命令行实参。 |
返回值
如果操作正在异步执行，则为 True；在任何其他情况下，则为 False。
TIPCommon.utils.is_overflowed
TIPCommon.utils.is_overflowed(siemplify, alert_info, is_test_run)
检查是否溢出。
| 参数 | |
|---|---|
siemplify |
obj
SDK |
alert_info |
AlertInfo提醒信息。 |
is_test_run |
bool
该形参用于指明当前运行是否为测试运行。 |
返回值
如果提醒溢出，则为 True；否则为 False。
TIPCommon.utils.is_python_37
TIPCommon.utils.is_python_37()
检查系统的 Python 版本是否为 3.7 或更高版本。
返回值
如果当前 Python 版本至少为 3.7，则为 True；否则为 False。
返回类型
bool
TIPCommon.utils.is_test_run
TIPCommon.utils.is_test_run(sys_argv)
返回一个布尔值，用于指示连接器的执行状态。
| 参数 | |
|---|---|
sys_argv |
_type_命令行实参。 |
返回值
如果当前运行是测试运行，则为 True；否则为 False。
返回类型
bool
TIPCommon.utils.is_valid_email
TIPCommon.utils.is_valid_email(email_addr: str)→ bool
检查提供的值是否为有效的电子邮件地址。
参数
| 参数 | |
|---|---|
email_addr |
str要检查的电子邮件地址。 |
返回值
如果电子邮件地址有效，则返回 True；否则，返回 False。
返回类型
bool
TIPCommon.utils.none_to_default_value
TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)
检查当前值是否为 None。
如果值为 None，则该函数会将其替换为另一个值。如果该值不是 None，则函数会返回原始值。
| 参数 | |
|---|---|
value_to_check |
dict/list/str要检查的值。 |
value_to_return_if_none |
dict/list/str
如果 |
返回值
如果提供了内容，则返回 value_to_check 的原始值。
如果未提供任何内容，则返回 value_to_return_if_none。
返回类型
dict/list/str
TIPCommon.utils.platform_supports_1p_api
TIPCommon.utils.platform_supports_1p_api()→ bool
检查平台是否为 1P。
参数
| 参数 |
|---|
返回值
如果平台为 1P，则返回 True；否则返回 False。
返回类型
bool
TIPCommon.utils.platform_supports_db
TIPCommon.utils.platform_supports_db(siemplify)
检查平台是否支持数据库使用情况。
| 参数 | |
|---|---|
siemplify |
objectSiemplify SDK 对象。 |
返回值
如果 Siemplify SDK 对象具有以下任一属性，则为 True：
set_connector_context_propertyset_job_context_property
否则，返回 False。
TIPCommon.utils.safe_cast_bool_value_from_str
TIPCommon.utils.safe_cast_bool_value_from_str(default_value)
检查默认值是否为包含布尔值的字符串。
如果默认值为包含布尔值的字符串，该函数会将该字符串转换为布尔值。否则，该函数会返回相应的值。
| 参数 | |
|---|---|
default_value |
如果转换失败，则返回的默认值。 |
返回值
强制转换后的值或默认值。
TIPCommon.utils.safe_cast_int_value_from_str
TIPCommon.utils.safe_cast_int_value_from_str(default_value)
检查默认值是否为包含整数值的字符串。
如果默认值是包含整数值的字符串，该函数会将该字符串转换为布尔值。否则，该函数会返回相应的值。
| 参数 | |
|---|---|
default_value |
如果转换失败，则返回的默认值。 |
返回值
强制转换后的值或默认值。
需要更多帮助？从社区成员和 Google SecOps 专业人士那里获得解答。