Source code for featuretools.primitives.standard.transform.datetime.diff_datetime

from woodwork.column_schema import ColumnSchema
from woodwork.logical_types import Datetime, Timedelta

from featuretools.primitives.standard.transform.numeric.diff import Diff


class DiffDatetime(Diff):
    """    计算列表中一个日期时间与前一个日期时间之间的时间差.

    Args:

        periods (int): 要移动索引行的周期数.默认值为0.周期对应于行.

    Description:
        给定一个日期时间列表,计算与列表中前一个元素的差值.列表的第一个元素的结果将始终为`NaT`.

    Examples:

        >>> from datetime import datetime
        >>> dt_values = [datetime(2019, 3, 1), datetime(2019, 6, 30), datetime(2019, 11, 17), datetime(2020, 1, 30), datetime(2020, 3, 11)]
        >>> diff_dt = DiffDatetime()
        >>> diff_dt(dt_values).tolist()
        [NaT, Timedelta('121 days 00:00:00'), Timedelta('140 days 00:00:00'), Timedelta('74 days 00:00:00'), Timedelta('41 days 00:00:00')]

        您可以指定要移动的周期数

        >>> diff_dt_periods = DiffDatetime(periods = 1)
        >>> diff_dt_periods(dt_values).tolist()
        [NaT, NaT, Timedelta('121 days 00:00:00'), Timedelta('140 days 00:00:00'), Timedelta('74 days 00:00:00')]"""

    name = "diff_datetime"
    input_types = [ColumnSchema(logical_type=Datetime)]
    return_type = ColumnSchema(logical_type=Timedelta)
    uses_full_dataframe = True
    description_template = "the difference from the previous value of {}"

    def __init__(self, periods=0):
        super().__init__(periods)