Module grpc_argument_validator.argument_validators

Expand source code 
import abc
import re
import typing
import uuid

from google.protobuf.descriptor import FieldDescriptor

from .validation_context import ValidationContext
from .validation_result import ValidationResult


class AbstractArgumentValidator(abc.ABC):
    """
    An abstract class that is the base for all argument validators
    """

    @abc.abstractmethod
    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        """
        Returns a validation bool of the given value and field_descriptor

            Parameters:
                name (str): Name for the field to be used in invalid reason messages.
                value (typing.Any): The value to be validated
                field_descriptor (FieldDescriptor): The protobuf field descriptor of the given value
                validation_context (ValidationContext): The validation context containing more information about the request that is being validated

            Returns:
                result (ValidationResult): validation bool for the given value
        """
        pass  # pragma: no cover


class UUIDBytesValidator(AbstractArgumentValidator):
    """Class that ensures the provided value is a valid UUID"""

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        try:
            uuid.UUID(bytes=value)
        except (ValueError, TypeError):
            return ValidationResult(False, f"'{name}' must be a valid UUID")
        return ValidationResult(True)


class NonDefaultValidator(AbstractArgumentValidator):
    """Ensures the provided value is not the default value for this field type"""

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        if value != field_descriptor.default_value:
            return ValidationResult(True)
        return ValidationResult(False, f"'{name}' must have non-default value")


class NonEmptyValidator(AbstractArgumentValidator):
    """Ensures the provided value is non-empty"""

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        if len(value) > 0:
            return ValidationResult(True)
        return ValidationResult(False, f"'{name}' must be non-empty")


class RegexpValidator(AbstractArgumentValidator):
    """
    Matches the input value against the provided regex.

    Parameters:
        pattern (str): Regexp pattern to match.
    """

    def __init__(self, pattern: str):
        self._pattern = pattern

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        if re.match(self._pattern, value) is not None:
            return ValidationResult(True)
        return ValidationResult(False, f"'{name}' must match regexp pattern: {self._pattern}")

Classes

class AbstractArgumentValidator

An abstract class that is the base for all argument validators

Expand source code 
class AbstractArgumentValidator(abc.ABC):
    """
    An abstract class that is the base for all argument validators
    """

    @abc.abstractmethod
    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        """
        Returns a validation bool of the given value and field_descriptor

            Parameters:
                name (str): Name for the field to be used in invalid reason messages.
                value (typing.Any): The value to be validated
                field_descriptor (FieldDescriptor): The protobuf field descriptor of the given value
                validation_context (ValidationContext): The validation context containing more information about the request that is being validated

            Returns:
                result (ValidationResult): validation bool for the given value
        """
        pass  # pragma: no cover

Ancestors

  • abc.ABC

Subclasses

Methods

def check(self, name: str, value: Any, field_descriptor: google.protobuf.descriptor.FieldDescriptor, validation_context: ValidationContext) ‑> ValidationResult

Returns a validation bool of the given value and field_descriptor

Parameters:
    name (str): Name for the field to be used in invalid reason messages.
    value (typing.Any): The value to be validated
    field_descriptor (FieldDescriptor): The protobuf field descriptor of the given value
    validation_context (ValidationContext): The validation context containing more information about the request that is being validated

Returns:
    result (ValidationResult): validation bool for the given value
Expand source code 
@abc.abstractmethod
def check(
    self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
) -> ValidationResult:
    """
    Returns a validation bool of the given value and field_descriptor

        Parameters:
            name (str): Name for the field to be used in invalid reason messages.
            value (typing.Any): The value to be validated
            field_descriptor (FieldDescriptor): The protobuf field descriptor of the given value
            validation_context (ValidationContext): The validation context containing more information about the request that is being validated

        Returns:
            result (ValidationResult): validation bool for the given value
    """
    pass  # pragma: no cover
class NonDefaultValidator

Ensures the provided value is not the default value for this field type

Expand source code 
class NonDefaultValidator(AbstractArgumentValidator):
    """Ensures the provided value is not the default value for this field type"""

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        if value != field_descriptor.default_value:
            return ValidationResult(True)
        return ValidationResult(False, f"'{name}' must have non-default value")

Ancestors

Inherited members

class NonEmptyValidator

Ensures the provided value is non-empty

Expand source code 
class NonEmptyValidator(AbstractArgumentValidator):
    """Ensures the provided value is non-empty"""

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        if len(value) > 0:
            return ValidationResult(True)
        return ValidationResult(False, f"'{name}' must be non-empty")

Ancestors

Inherited members

class RegexpValidator (pattern: str)

Matches the input value against the provided regex.

Parameters

pattern (str): Regexp pattern to match.

Expand source code 
class RegexpValidator(AbstractArgumentValidator):
    """
    Matches the input value against the provided regex.

    Parameters:
        pattern (str): Regexp pattern to match.
    """

    def __init__(self, pattern: str):
        self._pattern = pattern

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        if re.match(self._pattern, value) is not None:
            return ValidationResult(True)
        return ValidationResult(False, f"'{name}' must match regexp pattern: {self._pattern}")

Ancestors

Inherited members

class UUIDBytesValidator

Class that ensures the provided value is a valid UUID

Expand source code 
class UUIDBytesValidator(AbstractArgumentValidator):
    """Class that ensures the provided value is a valid UUID"""

    def check(
        self, name: str, value: typing.Any, field_descriptor: FieldDescriptor, validation_context: ValidationContext
    ) -> ValidationResult:
        try:
            uuid.UUID(bytes=value)
        except (ValueError, TypeError):
            return ValidationResult(False, f"'{name}' must be a valid UUID")
        return ValidationResult(True)

Ancestors

Inherited members