Módulo de validación

Este módulo contiene la clase Validator para validar varios tipos de parámetros. Cada método toma un nombre de parámetro, un valor y argumentos de palabras clave opcionales. Las funciones generan el error ParameterValidationError si el valor del parámetro no es válido.

Las funciones de validación devuelven el valor proporcionado en su tipo validado.

Ejemplo:

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

clase TIPCommon.validation.ParameterValidator(siemplify)

Bases: object

Clase que contiene funciones de validación de parámetros.

validate_csv

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

Valida una cadena de valores separados por comas (CSV).

Parámetros
param_name	str El nombre del parámetro.
csv_string	str Cadena CSV que se va a validar.
delimiter	str Carácter que separa los valores de la cadena CSV.
possible_values	list Lista de valores posibles.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError cuando la cadena CSV no es válida.

Devoluciones

Lista de valores de la cadena CSV.

Tipo de devolución

list

validate_ddl

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

Valida una cadena DDL.

Parámetros
param_name	str El nombre del parámetro.
value	str La cadena DDL que se va a validar.
ddl_values	list Lista de valores de DDL válidos.
case_sensitive	bool Define si se debe realizar una validación que distinga entre mayúsculas y minúsculas.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Devoluciones

Cadena DDL validada.

Aumentos

ParameterValidationError cuando la cadena DDL no es válida.

validate_email

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

Valida una cadena de correo electrónico.

Parámetros
param_name	str El nombre del parámetro.
email	str La cadena de la dirección de correo que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError cuando la cadena de la dirección de correo no es válida.

Devoluciones

Cadena de dirección de correo electrónico.

Tipo de devolución

str

validate_float

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

Valida una cadena de coma flotante.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError: cuando el valor no es un número de coma flotante.

Devoluciones

Valor validado.

Tipo de devolución

float

validate_integer

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

Valida una cadena de números enteros.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError cuando el valor no es un número entero.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_json

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

Valida una cadena JSON.

Parámetros
param_name	str El nombre del parámetro.
json_string	str La cadena JSON que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de que se produzca un error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.
**kwrags	dict Argumentos de palabras clave de la función json.loads().

Aumentos

ParameterValidationError: cuando la cadena JSON no es válida.

Devoluciones

El objeto JSON analizado.

validate_lower_limit

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

Valida una cadena de límite inferior.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
limit	int El límite inferior.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError: cuando el valor es inferior al límite.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_non_negative

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

Valida una cadena de números enteros no negativos.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError: cuando el valor es negativo.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_non_zero

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

Valida una cadena de números enteros distintos de cero.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError: cuando el valor es cero.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_percentage

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

Valida una cadena de porcentaje.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError cuando el valor no es un porcentaje.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_positive

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

Valida una cadena de número entero positivo.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError cuando el valor no es positivo.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_range

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

Valida una cadena de intervalo.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
min_limit	int El límite inferior.
max_limit	int El límite superior.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError: cuando el valor está fuera del intervalo.

Devoluciones

Valor validado.

Tipo de devolución

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)

Valida una cadena de gravedad.

Parámetros
param_name	str El nombre del parámetro.
severity	str Valor de gravedad que se va a validar.
min_limit	int El límite inferior.
max_limit	int El límite superior.
possible_values	list Lista de valores posibles.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError: cuando el valor no es válido.

Devoluciones

Valor validado.

Tipo de devolución

int

validate_upper_limit

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

Valida una cadena de límite superior.

Parámetros
param_name	str El nombre del parámetro.
value	str Valor que se va a validar.
limit	int El límite superior.
default_value	any Valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se debe imprimir el valor del parámetro como parte del mensaje.
print_error	bool Define si se debe imprimir el error de excepción como parte del mensaje.

Aumentos

ParameterValidationError cuando el valor supera el límite.

Devoluciones

Valor validado.

Tipo de devolución

int

¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.