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)

用於取得實體原始 ID 的輔助函式。

參數
entity	Entity 函式從中取得原始 ID 的實體。

傳回

原始 ID。

傳回類型

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 要檢查的資料。

傳回

True (如果提供的資料是 None，或只包含空字串 "")。

傳回類型

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 SiemplifyConnectorExecution 類別的執行個體。
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 為 None，則傳回此值。

傳回

如果提供值，則會傳回 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	object Siemplify SDK 物件。

傳回

True (如果 Siemplify SDK 物件具有下列任一屬性)：

• set_connector_context_property
• set_job_context_property

否則會傳回 False。

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

檢查預設值是否為包含布林值的字串。

如果預設值是含有布林值的字串，函式會將字串轉換為布林值。如未傳回錯誤，函式就會傳回 value。

參數
default_value	如果轉換失敗，要傳回的預設值。

傳回

轉換後的值或預設值。

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

檢查預設值是否為包含整數值的字串。

如果預設值是含有整數值的字串，函式會將字串轉換為布林值。如未傳回錯誤，函式就會傳回 value。

參數
default_value	如果轉換失敗，要傳回的預設值。

傳回

轉換後的值或預設值。

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求答案。