Method diff

src/pendulum/date.py:281–291

Returns the difference between two Date objects as an Interval. :param dt: The date to compare to (defaults to today) :param abs: Whether to return an absolute interval or not

(self, dt: date | None = None, abs: bool = True)

    # DIFFERENCES

    def diff(self, dt: date | None = None, abs: bool = True) -> Interval[Date]:
        """
        Returns the difference between two Date objects as an Interval.

        :param dt: The date to compare to (defaults to today)
        :param abs: Whether to return an absolute interval or not
        """
        if dt is None:
            dt = self.today()

        return Interval(self, Date(dt.year, dt.month, dt.day), absolute=abs)

    def diff_for_humans(
        self,