מודול 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 הנתונים לבדיקה.

מחזירה

‫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 ואילך.

מחזירה

‫True אם גרסת Python הנוכחית היא 3.7 לפחות, אחרת 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

בודקת אם הפלטפורמה היא צד ראשון או לא.

פרמטרים

פרמטרים

מחזירה

הפונקציה מחזירה True אם הפלטפורמה היא 1P, אחרת היא מחזירה 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)

בודקת אם ערך ברירת המחדל הוא מחרוזת שמכילה ערך בוליאני.

אם ערך ברירת המחדל הוא מחרוזת שמכילה ערך בוליאני, הפונקציה ממירה את המחרוזת לערך בוליאני. אחרת, הפונקציה מחזירה את הערך.

פרמטרים
default_value	ערך ברירת המחדל שיוחזר אם ההמרה תיכשל.

מחזירה

הערך שהומר או ערך ברירת המחדל.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

בודקת אם ערך ברירת המחדל הוא מחרוזת שמכילה את הערך השלם.

אם ערך ברירת המחדל הוא מחרוזת שמכילה ערך של מספר שלם, הפונקציה ממירה את המחרוזת לערך בוליאני. אחרת, הפונקציה מחזירה את הערך.

פרמטרים
default_value	ערך ברירת המחדל שיוחזר אם ההמרה תיכשל.

מחזירה

הערך שהומר או ערך ברירת המחדל.

הבעיה עדיין לא נפתרה? קבלת תשובות מחברי הקהילה וממומחי Google SecOps.