Source code for snow.resource.fields.numeric

from .base import BaseField

from ..query import NumericOperator


[docs]class Numeric(BaseField):
[docs]    def equals(self, value):
        """
        Example: reassignment_count.equals(0)

        All records in which the Reassignment count is nothing else but 0.
        """

        return self._segment(NumericOperator.EQUALS, value, field_operator=NumericOperator.SAME)

[docs]    def not_equals(self, value):
        """
        Example: reassignment_count.not_equals(0)

        All records in which the value for the Reassignment count is any number but 0.
        """

        return self._segment(NumericOperator.NOT_EQUALS, value, field_operator=NumericOperator.DIFFERENT)

[docs]    def less_than(self, value):
        """
        Example: impact.less_than(2)

        All records in which the Impact field has a value of 1 - High.
        """

        return self._segment(NumericOperator.LESS, value, field_operator=NumericOperator.Related.LESS)

[docs]    def greater_than(self, value):
        """
        Example: impact.greater_than(2)

        All records in which the Impact field has a value of 3 - Low
        """

        return self._segment(NumericOperator.LESS, value, field_operator=NumericOperator.Related.GREATER)

[docs]    def less_or_equals(self, value):
        """
        Example: impact.less_or_equals(2)

        All records in which the Impact field has a value of 1 - High or 2 - Medium.
        """

        return self._segment(NumericOperator.LESS, value, field_operator=NumericOperator.Related.LESS_EQUALS)

[docs]    def greater_or_equals(self, value):
        """
        Example: impact.greater_or_equals(2)

        All records in which the Impact field has a value of 2 - Medium or 3 - Low.
        """

        return self._segment(
            NumericOperator.GREATER_EQUALS,
            value,
            field_operator=NumericOperator.Related.GREATER_EQUALS
        )

[docs]    def between(self, value1, value2):
        """
        Example: impact.between([1, 3])

        All records in which the Impact field has one of the following values:
        1 - High
        2 - Medium
        3 - Low
        """

        value = f"{value1}@{value2}"
        return self._segment(NumericOperator.BETWEEN, value)