Module `grpc_argument_validator.validation_result`

Expand source code

import typing
from dataclasses import dataclass


@dataclass
class ValidationResult:
    """
    Contains results for validation check.
    """

    valid: bool
    """Whether the argument was valid."""

    invalid_reason: typing.Optional[str] = None
    """Reason for invalidity of the argument. Will be ``None`` if valid."""

Classes

class ValidationResult (valid: bool, invalid_reason: Optional[str] = None)

Contains results for validation check.

Expand source code

class ValidationResult:
    """
    Contains results for validation check.
    """

    valid: bool
    """Whether the argument was valid."""

    invalid_reason: typing.Optional[str] = None
    """Reason for invalidity of the argument. Will be ``None`` if valid."""

Class variables

var invalid_reason : Optional[str]: Reason for invalidity of the argument. Will be None if valid.
var valid : bool: Whether the argument was valid.