Módulo de validação

Este módulo contém a classe Validator para validar vários tipos de parâmetros. Cada método recebe um nome de parâmetro, um valor e argumentos de palavras-chave opcionais. As funções geram o erro ParameterValidationError se o valor do parâmetro for inválido.

As funções de validação devolvem o valor fornecido no respetivo tipo validado.

Exemplo:

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

classe TIPCommon.validation.ParameterValidator(siemplify)

Bases: object

Uma classe que contém funções de validação 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 uma string de valores separados por vírgulas (CSV).

Parâmetros
param_name	str O nome do parâmetro.
csv_string	str A string CSV a validar.
delimiter	str O caráter que separa os valores na string CSV.
possible_values	list Uma lista de valores possíveis.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se quer imprimir o erro de exceção como parte da mensagem.

Aumenta

ParameterValidationError: quando a string CSV é inválida.

Devoluções

A lista de valores na string CSV.

Tipo devolvido

list

validate_ddl

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

Valida uma string DDL.

Parâmetros
param_name	str O nome do parâmetro.
value	str A string DDL a validar.
ddl_values	list Uma lista de valores DDL válidos.
case_sensitive	bool Defina se deve ser realizada uma validação sensível a maiúsculas e minúsculas.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se quer imprimir o erro de exceção como parte da mensagem.

Devoluções

A string DDL validada.

Aumenta

ParameterValidationError: quando a string DDL é inválida.

validate_email

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

Valida uma string de email.

Parâmetros
param_name	str O nome do parâmetro.
email	str A string do endereço de email a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se quer imprimir o erro de exceção como parte da mensagem.

Aumenta

ParameterValidationError: quando a string do endereço de email é inválida.

Devoluções

A string do endereço de email.

Tipo devolvido

str

validate_float

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

Valida uma string de número de ponto flutuante.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se quer imprimir o erro de exceção como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor não é um número de vírgula flutuante.

Devoluções

O valor validado.

Tipo devolvido

float

validate_integer

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

Valida uma string de número inteiro.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se quer imprimir o erro de exceção como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor não é um número inteiro.

Devoluções

O valor validado.

Tipo devolvido

int

validate_json

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

Valida uma string JSON.

Parâmetros
param_name	str O nome do parâmetro.
json_string	str A string JSON a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se quer imprimir o erro de exceção como parte da mensagem.
**kwrags	dict Argumentos de palavras-chave para a função json.loads().

Aumenta

ParameterValidationError: quando a string JSON é inválida.

Devoluções

O objeto JSON analisado.

validate_lower_limit

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

Valida uma string de limite inferior.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
limit	int O limite inferior.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor é inferior ao limite.

Devoluções

O valor validado.

Tipo devolvido

int

validate_non_negative

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

Valida uma string de número inteiro não negativo.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor é negativo.

Devoluções

O valor validado.

Tipo devolvido

int

validate_non_zero

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

Valida uma string de número inteiro diferente de zero.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor é zero.

Devoluções

O valor validado.

Tipo devolvido

int

validate_percentage

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

Valida uma string de percentagem.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor não é uma percentagem.

Devoluções

O valor validado.

Tipo devolvido

int

validate_positive

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

Valida uma string de número inteiro positivo.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor não é positivo.

Devoluções

O valor validado.

Tipo devolvido

int

validate_range

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

Valida uma string de intervalo.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
min_limit	int O limite inferior.
max_limit	int O limite superior.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor está fora do intervalo.

Devoluções

O valor validado.

Tipo devolvido

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 uma string de gravidade.

Parâmetros
param_name	str O nome do parâmetro.
severity	str O valor de gravidade a validar.
min_limit	int O limite inferior.
max_limit	int O limite superior.
possible_values	list Uma lista de valores possíveis.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor é inválido.

Devoluções

O valor validado.

Tipo devolvido

int

validate_upper_limit

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

Valida uma string de limite superior.

Parâmetros
param_name	str O nome do parâmetro.
value	str O valor a validar.
limit	int O limite superior.
default_value	any O valor predefinido a devolver em caso de erro de validação.
print_value	bool Defina se o valor do parâmetro deve ser impresso como parte da mensagem.
print_error	bool Defina se o erro de exceção deve ser impresso como parte da mensagem.

Aumenta

ParameterValidationError: quando o valor excede o limite.

Devoluções

O valor validado.

Tipo devolvido

int

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais da Google SecOps.