Modul Utils

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Mengonversi string camel case menjadi snake case.

Parameter
string str

String yang akan dikonversi.

Hasil

String yang dikonversi.

Jenis hasil yang ditampilkan

str

TIPCommon.utils.cast_keys_to_int

TIPCommon.utils.cast_keys_to_int(data)

Mengubah kunci kamus menjadi bilangan bulat.

Parameter
data dict

Data yang kuncinya dikonversi menjadi bilangan bulat.

Hasil

Dict baru dengan kuncinya sebagai bilangan bulat.

Jenis hasil yang ditampilkan

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Menghapus spasi yang tidak perlu sebelum atau sesudah nilai.

Parameter
value str

Nilai yang akan dihapus spasinya.

Hasil

Versi biasa dari nilai asli.

Jenis hasil yang ditampilkan

str

TIPCommon.utils.create_and_write_to_tempfile

TIPCommon.utils.create_and_write_to_tempfile(content: str | bytes)→ Path

Membuat file sementara dan menulis konten ke dalamnya.

Parameter

Parameter
content str | bytes

Konten yang akan ditulis ke file sementara.

Hasil

Jalur ke file sementara yang dibuat.

Jenis hasil yang ditampilkan

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Fungsi bantuan untuk mendapatkan ID asli entitas.

Parameter
entity Entity

Entitas tempat fungsi mendapatkan ID asli.

Hasil

ID asli.

Jenis hasil yang ditampilkan

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

Mengambil semua nama argumen fungsi tertentu.

Parameter
func Fungsi atau metode yang akan dianalisis.

Hasil

Semua kunci argumen yang ditentukan dalam fungsi tertentu.

Jenis hasil yang ditampilkan

list

TIPCommon.utils.get_unique_items_by_difference

TIPCommon.utils.get_unique_items_by_difference(item_pool: Iterable, items_to_remove: Iterable) → list

Mendapatkan item perbedaan set dari dua iterable (item_pool - items_to_remove).

Parameter
item_pool iterable

Kumpulan item yang akan difilter.
items_to_remove iterable

Item yang harus dihapus, jika ada.

Hasil

Daftar yang berisi item unik dari item_pool yang bukan bagian dari items_to_remove.

Jenis hasil yang ditampilkan

list

TIPCommon.utils.is_empty_string_or_none

TIPCommon.utils.is_empty_string_or_none(data)

Memeriksa apakah data adalah string kosong atau None.

Parameter
data str

Data yang akan diperiksa.

Hasil

True jika data yang diberikan adalah None, atau jika hanya berisi string kosong "".

Jenis hasil yang ditampilkan

bool

TIPCommon.utils.is_first_run

TIPCommon.utils.is_first_run(sys_argv)

Menampilkan nilai boolean yang menunjukkan apakah tindakan sedang dieksekusi secara asinkron.

Parameter

Parameter
sys_argv Argumen command line dari modul sys.argv.

Hasil

True jika tindakan sedang dieksekusi secara asinkron dan False dalam kasus lainnya.

TIPCommon.utils.is_overflowed

TIPCommon.utils.is_overflowed(siemplify, alert_info, is_test_run)

Memeriksa apakah meluap.

Parameter
siemplify obj

Instance class SiemplifyConnectorExecution SDK.

alert_info AlertInfo

Informasi pemberitahuan.
is_test_run bool

Parameter menunjukkan apakah proses saat ini adalah uji coba atau tidak.

Hasil

True jika notifikasi meluap dan False dalam kasus lainnya.

TIPCommon.utils.is_python_37

TIPCommon.utils.is_python_37()

Memeriksa apakah versi Python sistem adalah 3.7 atau yang lebih baru.

Hasil

True jika versi Python saat ini minimal 3.7; jika tidak, False.

Jenis hasil yang ditampilkan

bool

TIPCommon.utils.is_test_run

TIPCommon.utils.is_test_run(sys_argv)

Menampilkan nilai boolean yang menunjukkan status eksekusi konektor.

Parameter
sys_argv _type_

Argumen command line.

Hasil

True jika run saat ini adalah run pengujian; jika tidak, False.

Jenis hasil yang ditampilkan

bool

TIPCommon.utils.is_valid_email

TIPCommon.utils.is_valid_email(email_addr: str)→ bool

Memeriksa apakah nilai yang diberikan adalah alamat email yang valid.

Parameter

Parameter
email_addr str

Alamat email yang akan diperiksa.

Hasil

Menampilkan True jika email valid; jika tidak, False.

Jenis hasil yang ditampilkan

bool

TIPCommon.utils.none_to_default_value

TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)

Memeriksa apakah nilai saat ini adalah None.

Jika nilainya None, fungsi akan menggantinya dengan nilai lain. Jika nilai bukan None, fungsi akan menampilkan nilai asli.

Parameter
value_to_check dict/list/str

Nilai yang akan diperiksa.
value_to_return_if_none dict/list/str

Nilai yang akan ditampilkan jika value_to_check adalah None.

Hasil

Jika sesuatu disediakan, nilai asli value_to_check akan ditampilkan.

Jika tidak ada yang diberikan, value_to_return_if_none akan ditampilkan.

Jenis hasil yang ditampilkan

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Memeriksa apakah platform adalah 1P atau tidak.

Parameter

Parameter

Hasil

Menampilkan True jika platformnya adalah 1P; jika tidak, False.

Jenis hasil yang ditampilkan

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

Memeriksa apakah platform mendukung penggunaan database.

Parameter
siemplify object

Objek Siemplify SDK.

Hasil

True jika objek Siemplify SDK memiliki salah satu atribut berikut:

  • set_connector_context_property
  • set_job_context_property

Jika tidak, False akan ditampilkan.

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

Memeriksa apakah nilai default adalah string yang berisi nilai boolean.

Jika nilai default adalah string yang berisi nilai boolean, fungsi akan mengonversi string menjadi boolean. Jika tidak, fungsi tersebut akan menampilkan nilai sebenarnya.

Parameter
default_value Nilai default yang akan ditampilkan jika transmisi gagal.

Hasil

Nilai yang di-cast atau nilai default.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

Memeriksa apakah nilai default adalah string yang berisi nilai bilangan bulat.

Jika nilai default adalah string yang berisi nilai bilangan bulat, fungsi akan mengonversi string menjadi boolean. Jika tidak, fungsi tersebut akan menampilkan nilai sebenarnya.

Parameter
default_value Nilai default yang akan ditampilkan jika transmisi gagal.

Hasil

Nilai yang di-cast atau nilai default.

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.