Esta página foi traduzida pela API Cloud Translation.

Módulo de validação

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

As funções de validação retornam o valor fornecido no 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

class 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írgula (CSV).

Parâmetros
`param_name`	`str` O nome do parâmetro.
`csv_string`	`str` A string CSV a ser validada.
`delimiter`	`str` O caractere que separa os valores na string CSV.
`possible_values`	`list` Uma lista de valores possíveis.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Define se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Defina se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando a string CSV é inválida.

Retorna

A lista de valores na string CSV.

Tipo de retorno

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 ser validada.
`ddl_values`	`list` Uma lista de valores DDL válidos.
`case_sensitive`	`bool` Defina se uma validação que diferencia maiúsculas e minúsculas deve ser realizada ou não.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Define se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Defina se o erro de exceção será impresso como parte da mensagem.

Retorna

A string DDL validada.

Gera

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 e-mail.

Parâmetros
`param_name`	`str` O nome do parâmetro.
`email`	`str` A string do endereço de e-mail a ser validada.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Define se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Defina se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando a string do endereço de e-mail é inválida.

Retorna

A string do endereço de e-mail.

Tipo de retorno

str

validate_float

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

Valida uma string de ponto flutuante.

Parâmetros
`param_name`	`str` O nome do parâmetro.
`value`	`str` O valor a ser validado.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Define se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Defina se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor não é um ponto flutuante.

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Define se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Defina se o erro de exceção será impresso como parte da mensagem.

Gera

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

Retorna

O valor validado.

Tipo de retorno

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 ser validada.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Define se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Defina se o erro de exceção será impresso como parte da mensagem.
`**kwrags`	`dict` Argumentos de palavra-chave para a função `json.loads()`.

Gera

ParameterValidationError: quando a string JSON é inválida.

Retorna

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 ser validado.
`limit`	`int` O limite inferior.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor é menor que o limite.

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor é negativo.

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor é zero.

Retorna

O valor validado.

Tipo de retorno

int

validate_percentage

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

Valida uma string de porcentagem.

Parâmetros
`param_name`	`str` O nome do parâmetro.
`value`	`str` O valor a ser validado.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

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

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor não é positivo.

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`min_limit`	`int` O limite inferior.
`max_limit`	`int` O limite máximo.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor está fora do intervalo.

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`min_limit`	`int` O limite inferior.
`max_limit`	`int` O limite máximo.
`possible_values`	`list` Uma lista de valores possíveis.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor é inválido.

Retorna

O valor validado.

Tipo de retorno

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 ser validado.
`limit`	`int` O limite máximo.
`default_value`	`any` O valor padrão a ser retornado em caso de um erro de validação.
`print_value`	`bool` Defina se o valor do parâmetro será impresso como parte da mensagem.
`print_error`	`bool` Define se o erro de exceção será impresso como parte da mensagem.

Gera

ParameterValidationError: quando o valor excede o limite.

Retorna

O valor validado.

Tipo de retorno

int

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