Utils-Modul

TIPCommon.utils.camel_to_snake_case

TIPCommon.utils.camel_to_snake_case(string)

Konvertiert einen String im CamelCase-Format in einen String im SnakeCase-Format.

Parameter
string	str Der zu konvertierende String.

Gibt Folgendes zurück:

Der konvertierte String.

Rückgabetyp

str

TIPCommon.utils.cast_keys_to_int

TIPCommon.utils.cast_keys_to_int(data)

Wandelt die Schlüssel eines Dictionary in Ganzzahlen um.

Parameter
data	dict Die Daten, deren Schlüssel in Ganzzahlen umgewandelt werden.

Gibt Folgendes zurück:

Ein neues Dictionary mit seinen Schlüsseln als Ganzzahlen.

Rückgabetyp

dict

TIPCommon.utils.clean_result

TIPCommon.utils.clean_result(value)

Entfernt unnötige Leerzeichen vor oder nach dem Wert.

Parameter
value	str Der Wert, aus dem die Leerzeichen entfernt werden sollen.

Gibt Folgendes zurück:

Eine einfache Version des ursprünglichen Werts.

Rückgabetyp

str

TIPCommon.utils.create_and_write_to_tempfile

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

Erstellt eine temporäre Datei und schreibt Inhalte hinein.

Parameter

Parameter
content	str | bytes Der Inhalt, der in die temporäre Datei geschrieben werden soll.

Gibt Folgendes zurück:

Der Pfad zur erstellten temporären Datei.

Rückgabetyp

Path

TIPCommon.utils.get_entity_original_identifier

TIPCommon.utils.get_entity_original_identifier(entity)

Eine Hilfsfunktion zum Abrufen der ursprünglichen Kennung für die Entität.

Parameter
entity	Entity Die Entität, aus der die Funktion die ursprüngliche Kennung abruft.

Gibt Folgendes zurück:

Die ursprüngliche ID.

Rückgabetyp

str

TIPCommon.utils.get_function_arg_names

TIPCommon.utils.get_function_arg_names(func)

Ruft alle Argumentnamen einer bestimmten Funktion ab.

Parameter
func	Die zu analysierende Funktion oder Methode.

Gibt Folgendes zurück:

Alle in der angegebenen Funktion definierten Argumentschlüssel.

Rückgabetyp

list

TIPCommon.utils.get_unique_items_by_difference

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

Ruft die Elemente der Differenzmenge aus zwei iterierbaren Objekten ab (item_pool – items_to_remove).

Parameter
item_pool	iterable Der Elementpool, aus dem gefiltert werden soll.
items_to_remove	iterable Die Elemente, die entfernt werden sollen (falls zutreffend).

Gibt Folgendes zurück:

Eine Liste mit eindeutigen Elementen aus item_pool, die nicht Teil von items_to_remove waren.

Rückgabetyp

list

TIPCommon.utils.is_empty_string_or_none

TIPCommon.utils.is_empty_string_or_none(data)

Prüft, ob die Daten ein leerer String oder None sind.

Parameter
data	str Die zu prüfenden Daten.

Gibt Folgendes zurück:

True, wenn die bereitgestellten Daten None sind oder nur einen leeren String "" enthalten.

Rückgabetyp

bool

TIPCommon.utils.is_first_run

TIPCommon.utils.is_first_run(sys_argv)

Gibt einen booleschen Wert zurück, der angibt, ob die Aktion asynchron ausgeführt wird.

Parameter

Parameter
sys_argv	Die Befehlszeilenargumente aus dem sys.argv-Modul.

Gibt Folgendes zurück:

True, wenn die Aktion asynchron ausgeführt wird, andernfalls False.

TIPCommon.utils.is_overflowed

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

Prüft, ob ein Überlauf stattgefunden hat.

Parameter
siemplify	obj Eine Instanz der SDK-Klasse SiemplifyConnectorExecution.
alert_info	AlertInfo Benachrichtigungsinformationen.
is_test_run	bool Der Parameter gibt an, ob der aktuelle Lauf ein Testlauf ist.

Gibt Folgendes zurück:

True, wenn die Benachrichtigung überläuft, und False in allen anderen Fällen.

TIPCommon.utils.is_python_37

TIPCommon.utils.is_python_37()

Prüft, ob die Python-Version des Systems 3.7 oder höher ist.

Gibt Folgendes zurück:

True, wenn die aktuelle Python-Version mindestens 3.7 ist, andernfalls False.

Rückgabetyp

bool

TIPCommon.utils.is_test_run

TIPCommon.utils.is_test_run(sys_argv)

Gibt einen booleschen Wert zurück, der den Ausführungsstatus des Connectors angibt.

Parameter
sys_argv	_type_ Die Befehlszeilenargumente.

Gibt Folgendes zurück:

True, wenn der aktuelle Lauf ein Testlauf ist, andernfalls False.

Rückgabetyp

bool

TIPCommon.utils.is_valid_email

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

Prüft, ob ein angegebener Wert eine gültige E‑Mail-Adresse ist.

Parameter

Parameter
email_addr	str Die zu überprüfende E-Mail-Adresse.

Gibt Folgendes zurück:

Gibt True zurück, wenn die E-Mail-Adresse gültig ist. Andernfalls wird False zurückgegeben.

Rückgabetyp

bool

TIPCommon.utils.none_to_default_value

TIPCommon.utils.none_to_default_value(value_to_check, value_to_return_if_none)

Prüft, ob der aktuelle Wert None ist.

Wenn der Wert None ist, wird er durch einen anderen Wert ersetzt. Wenn der Wert nicht None ist, gibt die Funktion den ursprünglichen Wert zurück.

Parameter
value_to_check	dict/list/str Der zu prüfende Wert.
value_to_return_if_none	dict/list/str Der Wert, der zurückgegeben werden soll, wenn value_to_check gleich None ist.

Gibt Folgendes zurück:

Wenn etwas angegeben wird, wird der ursprüngliche Wert von value_to_check zurückgegeben.

Wenn nichts angegeben ist, wird value_to_return_if_none zurückgegeben.

Rückgabetyp

dict/list/str

TIPCommon.utils.platform_supports_1p_api

TIPCommon.utils.platform_supports_1p_api()→ bool

Prüft, ob es sich bei der Plattform um eine 1P-Plattform handelt.

Parameter

Parameter

Gibt Folgendes zurück:

Gibt True zurück, wenn die Plattform 1P ist, andernfalls False.

Rückgabetyp

bool

TIPCommon.utils.platform_supports_db

TIPCommon.utils.platform_supports_db(siemplify)

Prüft, ob die Plattform die Datenbanknutzung unterstützt.

Parameter
siemplify	object Das Siemplify SDK-Objekt.

Gibt Folgendes zurück:

True, wenn das Siemplify SDK-Objekt eines der folgenden Attribute hat:

• set_connector_context_property
• set_job_context_property

Andernfalls wird False zurückgegeben.

TIPCommon.utils.safe_cast_bool_value_from_str

TIPCommon.utils.safe_cast_bool_value_from_str(default_value)

Prüft, ob ein Standardwert ein String mit einem booleschen Wert ist.

Wenn der Standardwert ein String mit einem booleschen Wert ist, wird der String von der Funktion in einen booleschen Wert konvertiert. Andernfalls gibt die Funktion den Wert zurück.

Parameter
default_value	Der Standardwert, der zurückgegeben wird, wenn die Umwandlung fehlschlägt.

Gibt Folgendes zurück:

Der umgewandelte Wert oder der Standardwert.

TIPCommon.utils.safe_cast_int_value_from_str

TIPCommon.utils.safe_cast_int_value_from_str(default_value)

Prüft, ob ein Standardwert ein String ist, der den Ganzzahlwert enthält.

Wenn der Standardwert ein String mit einem Ganzzahlwert ist, wird der String von der Funktion in einen booleschen Wert konvertiert. Andernfalls gibt die Funktion den Wert zurück.

Parameter
default_value	Der Standardwert, der zurückgegeben wird, wenn die Umwandlung fehlschlägt.

Gibt Folgendes zurück:

Der umgewandelte Wert oder der Standardwert.

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten