מודול אימות

המודול הזה מכיל את המחלקה 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

‫class TIPCommon.validation.ParameterValidator

class TIPCommon.validation.ParameterValidator(siemplify)

בסיסים: object

מחלקת על שמכילה פונקציות לאימות פרמטרים.

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 הגדרת אימות רגיש לאותיות רישיות (case-sensitive) או לא.
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.