dve.core_engine.functions.implementations ¶

def check_correct_numeric_signage(
    val: Union[float, int, Decimal], expected_sign: str = "+/-"
) -> Optional[bool]:
    """Check the expected sign of a numeric type."""
    if val is None:
        return None
    if expected_sign not in ("+/-", "+", "-"):
        return None

    if expected_sign == "+/-":
        return True
    if expected_sign == "+":
        return val >= 0
    if expected_sign == "-":
        return val <= 0
    return None

def date_in_current_financial_year(test_date: datetime.date) -> bool:
    """Checks the date is in the current financial year"""
    current_fiscal_year_start: datetime.date = datetime.date(datetime.date.today().year, 4, 1)
    return test_date >= current_fiscal_year_start

def nhsno_mod11_check(nhs_no: str) -> bool:
    """Check that a given nhs number passes mod11 checks."""
    return NHSNumber.check_validates(nhs_no)

def number_matches_within_percentage(
    comparator: Decimal, number: Decimal, percentage: Decimal
) -> Optional[bool]:
    """Check that `number` matches `comparator` to within a percentage of the value of `comparator`.

    `tolerance` should be a decimal representaion of the percentage (e.g. 0.01 for 1%).

    """
    if percentage is None or comparator is None:
        return None

    tolerance = comparator * percentage
    return number_matches_within_tolerance(comparator, number, tolerance)

def number_matches_within_tolerance(
    comparator: Decimal, number: Decimal, tolerance: Decimal
) -> Optional[bool]:
    """Check that `number` matches `comparator` to within a fixed tolerance."""
    if comparator is None or number is None or tolerance is None:
        return None

    return abs(number - comparator) <= abs(tolerance)