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 Es el nombre del parámetro.
csv_string	str Es la cadena de CSV que se validará.
delimiter	str Es el carácter que separa los valores en la cadena CSV.
possible_values	list Es una lista de valores posibles.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Se produce cuando la cadena CSV no es válida.

Devoluciones

Es la lista de valores en la cadena CSV.

Tipo de datos que se muestra

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 de DDL.

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

Devoluciones

Es la cadena DDL validada.

Se genera el error

ParameterValidationError: Cuando la cadena de 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 Es el nombre del parámetro.
email	str Es la cadena de dirección de correo electrónico que se validará.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Se produce cuando la cadena de dirección de correo electrónico no es válida.

Devoluciones

Es la cadena de dirección de correo electrónico.

Tipo de datos que se muestra

str

validate_float

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

Valida una cadena de número de punto flotante.

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

Se genera el error

ParameterValidationError: Cuando el valor no es un número de punto flotante.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 Es el nombre del parámetro.
value	str Es el valor que se validará.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Cuando el valor no es un número entero.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 Es el nombre del parámetro.
json_string	str Es la cadena JSON que se validará.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.
**kwrags	dict Argumentos de palabra clave para la función json.loads().

Se genera el error

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

Devoluciones

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 Es el nombre del parámetro.
value	str Es el valor que se validará.
limit	int Es el límite inferior.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

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

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 Es el nombre del parámetro.
value	str Es el valor que se validará.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Se produce cuando el valor es negativo.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 distinta de cero.

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

Se genera el error

ParameterValidationError: Cuando el valor es cero.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 Es el nombre del parámetro.
value	str Es el valor que se validará.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Cuando el valor no es un porcentaje.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

int

validate_positive

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

Valida una cadena de números enteros positivos.

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

Se genera el error

ParameterValidationError: Se produce cuando el valor no es positivo.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 rango.

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

Se genera el error

ParameterValidationError: Cuando el valor está fuera del rango.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 Es el nombre del parámetro.
severity	str Es el valor de gravedad que se validará.
min_limit	int Es el límite inferior.
max_limit	int Es el límite superior.
possible_values	list Es una lista de valores posibles.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Se produce cuando el valor no es válido.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

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 Es el nombre del parámetro.
value	str Es el valor que se validará.
limit	int Es el límite superior.
default_value	any Es el valor predeterminado que se devuelve en caso de error de validación.
print_value	bool Define si se imprimirá el valor del parámetro como parte del mensaje.
print_error	bool Define si se imprimirá el error de excepción como parte del mensaje.

Se genera el error

ParameterValidationError: Cuando el valor supera el límite.

Devoluciones

Es el valor validado.

Tipo de datos que se muestra

int

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.