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

2 つのイテラブル（item_pool - items_to_remove）から差集合のアイテムを取得します。

パラメータ
item_pool iterable

フィルタリングするアイテム プール。
items_to_remove iterable

削除するアイテム（ある場合）。

戻り値

items_to_remove に含まれていない item_pool の一意の項目を含むリスト。

戻り値の型

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 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 オブジェクト。

戻り値

Siemplify SDK オブジェクトに次のいずれかの属性がある場合は True。

  • 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 のプロフェッショナルから回答を得ることができます。