検証モジュール

このモジュールには、さまざまなタイプのパラメータを検証するための Validator クラスが含まれています。各メソッドは、パラメータ名、値、オプションのキーワード引数を取ります。パラメータ値が無効な場合、関数は ParameterValidationError エラーを発生させます。

検証関数は、検証された型で指定された値を返します。

例:

validator = ParameterValidator(siemplify) # siemplify SDK object 

validated_value = validator.validate_float(param_name='something', value='3.7') print(validated_value) # 3.7 as float

validated_value = validator.validate_int(param_name='something', validated_value) print(validated_value) # 3 as integer

クラス TIPCommon.validation.ParameterValidator

クラス TIPCommon.validation.ParameterValidator(siemplify)

ベース: オブジェクト

パラメータ検証関数を含むクラス。

validate_csv

validate_csv(param_name, csv_string, delimiter=', ', possible_values=None, default_value=<object object>, print_value=True, print_error=False)

カンマ区切り値(CSV)文字列を検証します。

パラメータ
param_name str

パラメータの名前。

csv_string str

検証する CSV 文字列。

delimiter str

CSV 文字列内の値を区切る文字。

possible_values list

有効な値のリスト。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - CSV 文字列が無効な場合。

戻り値

CSV 文字列内の値のリスト。

戻り値の型

list

validate_ddl

validate_ddl(param_name, value, ddl_values, case_sensitive=False, default_value=<object object>, print_value=True, print_error=False)

DDL 文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する DDL 文字列。

ddl_values list

有効な DDL 値のリスト。

case_sensitive bool

大文字と小文字を区別する検証を行うかどうかを定義します。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

戻り値

検証済みの DDL 文字列。

発生

ParameterValidationError - DDL 文字列が無効な場合。

validate_email

validate_email(param_name, email, default_value=<object object>, print_value=True, print_error=False)

メール文字列を検証します。

パラメータ
param_name str

パラメータの名前。

email str

検証するメールアドレス文字列。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - メールアドレス文字列が無効な場合。

戻り値

メールアドレスの文字列。

戻り値の型

str

validate_float

validate_float(param_name, value, default_value=<object object>, print_value=True, print_error=False)

浮動小数点文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が浮動小数点数でない場合。

戻り値

検証済みの値。

戻り値の型

float

validate_integer

validate_integer(param_name, value, default_value=<object object>, print_value=True, print_error=False)

整数文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が整数でない場合。

戻り値

検証済みの値。

戻り値の型

int

validate_json

validate_json(param_name, json_string, default_value=<object object>, print_value=True, print_error=False, **kwargs)

JSON 文字列を検証します。

パラメータ
param_name str

パラメータの名前。

json_string str

検証する JSON 文字列。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

**kwrags dict

json.loads() 関数のキーワード引数。

発生

ParameterValidationError - JSON 文字列が無効な場合。

戻り値

解析された JSON オブジェクト。

validate_lower_limit

validate_lower_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)

下限文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

limit int

下限。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が上限を下回っている場合。

戻り値

検証済みの値。

戻り値の型

int

validate_non_negative

validate_non_negative(param_name, value, default_value=<object object>, print_value=True, print_error=False)

非負の整数文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が負の場合。

戻り値

検証済みの値。

戻り値の型

int

validate_non_zero

validate_non_zero(param_name, value, default_value=<object object>, print_value=True, print_error=False)

ゼロ以外の整数文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値がゼロの場合。

戻り値

検証済みの値。

戻り値の型

int

validate_percentage

validate_percentage(param_name, value, default_value=<object object>, print_value=True, print_error=False)

パーセンテージ文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値がパーセンテージでない場合。

戻り値

検証済みの値。

戻り値の型

int

validate_positive

validate_positive(param_name, value, default_value=<object object>, print_value=True, print_error=False)

正の整数文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が正でない場合。

戻り値

検証済みの値。

戻り値の型

int

validate_range

validate_range(param_name, value, min_limit, max_limit, default_value=<object object>, print_value=True, print_error=False)

範囲文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

min_limit int

下限。

max_limit int

上限。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が範囲外の場合。

戻り値

検証済みの値。

戻り値の型

int

validate_severity

validate_severity(param_name, severity, min_limit=None, max_limit=None, possible_values=None, default_value=<object object>, print_value=True, print_error=False)

重大度文字列を検証します。

パラメータ
param_name str

パラメータの名前。

severity str

検証する重大度の値。

min_limit int

下限。

max_limit int

上限。

possible_values list

有効な値のリスト。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が無効な場合。

戻り値

検証済みの値。

戻り値の型

int

validate_upper_limit

validate_upper_limit(param_name, value, limit, default_value=<object object>, print_value=True, print_error=False)

上限文字列を検証します。

パラメータ
param_name str

パラメータの名前。

value str

検証する値。

limit int

上限。

default_value any

検証エラーが発生した場合に返すデフォルト値。

print_value bool

パラメータ値をメッセージの一部として出力するかどうかを定義します。

print_error bool

例外エラーをメッセージの一部として出力するかどうかを定義します。

発生

ParameterValidationError - 値が上限を超えた場合。

戻り値

検証済みの値。

戻り値の型

int

さらにサポートが必要な場合 コミュニティ メンバーや Google SecOps のプロフェッショナルから回答を得ることができます。