Skip to content

TemporalCell

Bases: ABC

Namespace for operations on temporal data.

This class cannot be instantiated directly. It can only be accessed using the dt attribute of a cell.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 9)])
>>> column.transform(lambda cell: cell.dt.date_to_string("%Y/%m/%d"))
+------------+
| example    |
| ---        |
| str        |
+============+
| 2022/01/09 |
+------------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
class TemporalCell(ABC):
    """
    Namespace for operations on temporal data.

    This class cannot be instantiated directly. It can only be accessed using the `dt` attribute of a cell.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 9)])
    >>> column.transform(lambda cell: cell.dt.date_to_string("%Y/%m/%d"))
    +------------+
    | example    |
    | ---        |
    | str        |
    +============+
    | 2022/01/09 |
    +------------+
    """

    @abstractmethod
    def century(self) -> Cell[int]:
        """
        Get the century of the underlying date(time) data.

        Returns
        -------
            A cell containing the century as integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 1)])
        >>> column.transform(lambda cell: cell.dt.century())
        +---------+
        | example |
        |     --- |
        |     i32 |
        +=========+
        |      21 |
        +---------+
        """

    @abstractmethod
    def weekday(self) -> Cell[int]:
        """
        Get the weekday of the underlying date(time) data.

        Returns
        -------
            A cell containing the weekday as integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 1)])
        >>> column.transform(lambda cell: cell.dt.weekday())
        +---------+
        | example |
        |     --- |
        |      i8 |
        +=========+
        |       6 |
        +---------+
        """

    @abstractmethod
    def week(self) -> Cell[int]:
        """
        Get the week of the underlying date(time) data.

        Returns
        -------
            A cell containing the week as integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 1)])
        >>> column.transform(lambda cell: cell.dt.week())
        +---------+
        | example |
        |     --- |
        |      i8 |
        +=========+
        |      52 |
        +---------+
        """

    @abstractmethod
    def year(self) -> Cell[int]:
        """
        Get the year of the underlying date(time) data.

        Returns
        -------
            A cell containing the year as integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 9)])
        >>> column.transform(lambda cell: cell.dt.year())
        +---------+
        | example |
        |     --- |
        |     i32 |
        +=========+
        |    2022 |
        +---------+
        """

    @abstractmethod
    def month(self) -> Cell[int]:
        """
        Get the month of the underlying date(time) data.

        Returns
        -------
            A cell containing the month as integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 9)])
        >>> column.transform(lambda cell: cell.dt.month())
        +---------+
        | example |
        |     --- |
        |      i8 |
        +=========+
        |       1 |
        +---------+
        """

    @abstractmethod
    def day(self) -> Cell[int]:
        """
        Get the day of the underlying date(time) data.

        Returns
        -------
            A cell containing the day as integer.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 9)])
        >>> column.transform(lambda cell: cell.dt.day())
        +---------+
        | example |
        |     --- |
        |      i8 |
        +=========+
        |       9 |
        +---------+
        """

    @abstractmethod
    def datetime_to_string(self, format_string: str = "%Y/%m/%d %H:%M:%S") -> Cell[str]:
        """
        Convert the date value in the cell to a string.

        Parameters
        ----------
        format_string:
            The format string it will be used to convert the data into the string.

        Returns
        -------
        date:
            The string value.

        Raises
        ------
        ValueError
            If the formatstring is invalid.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [ datetime.datetime(2022, 1, 9, 23, 29, 1, tzinfo=datetime.UTC)])
        >>> column.transform(lambda cell: cell.dt.datetime_to_string())
        +---------------------+
        | example             |
        | ---                 |
        | str                 |
        +=====================+
        | 2022/01/09 23:29:01 |
        +---------------------+
        """

    @abstractmethod
    def date_to_string(self, format_string: str = "%F") -> Cell[str]:
        """
        Convert the date value in the cell to a string.

        Parameters
        ----------
        format_string:
            The format string it will be used to convert the data into the string.

        Returns
        -------
        date:
            The string value.


        ValueError
            If the formatstring is invalid.

        Examples
        --------
        >>> from safeds.data.tabular.containers import Column
        >>> import datetime
        >>> column = Column("example", [datetime.date(2022, 1, 9)])
        >>> column.transform(lambda cell: cell.dt.date_to_string())
        +------------+
        | example    |
        | ---        |
        | str        |
        +============+
        | 2022-01-09 |
        +------------+
        """

    # ------------------------------------------------------------------------------------------------------------------
    # Internal
    # ------------------------------------------------------------------------------------------------------------------

    @abstractmethod
    def _equals(self, other: object) -> bool:
        """
        Check if this cell is equal to another object.

        This method is needed because the `__eq__` method is used for element-wise comparisons.
        """

century

Get the century of the underlying date(time) data.

Returns:

Type Description
A cell containing the century as integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 1)])
>>> column.transform(lambda cell: cell.dt.century())
+---------+
| example |
|     --- |
|     i32 |
+=========+
|      21 |
+---------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@abstractmethod
def century(self) -> Cell[int]:
    """
    Get the century of the underlying date(time) data.

    Returns
    -------
        A cell containing the century as integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 1)])
    >>> column.transform(lambda cell: cell.dt.century())
    +---------+
    | example |
    |     --- |
    |     i32 |
    +=========+
    |      21 |
    +---------+
    """

date_to_string

Convert the date value in the cell to a string.

Parameters:

Name Type Description Default
format_string str

The format string it will be used to convert the data into the string.

 '%F'

Returns:

Name Type Description
date Cell[str]

The string value.
ValueError

If the formatstring is invalid.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 9)])
>>> column.transform(lambda cell: cell.dt.date_to_string())
+------------+
| example    |
| ---        |
| str        |
+============+
| 2022-01-09 |
+------------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
@abstractmethod
def date_to_string(self, format_string: str = "%F") -> Cell[str]:
    """
    Convert the date value in the cell to a string.

    Parameters
    ----------
    format_string:
        The format string it will be used to convert the data into the string.

    Returns
    -------
    date:
        The string value.


    ValueError
        If the formatstring is invalid.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 9)])
    >>> column.transform(lambda cell: cell.dt.date_to_string())
    +------------+
    | example    |
    | ---        |
    | str        |
    +============+
    | 2022-01-09 |
    +------------+
    """

datetime_to_string

Convert the date value in the cell to a string.

Parameters:

Name Type Description Default
format_string str

The format string it will be used to convert the data into the string.

 '%Y/%m/%d %H:%M:%S'

Returns:

Name Type Description
date Cell[str]

The string value.

Raises:

Type Description
ValueError

If the formatstring is invalid.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [ datetime.datetime(2022, 1, 9, 23, 29, 1, tzinfo=datetime.UTC)])
>>> column.transform(lambda cell: cell.dt.datetime_to_string())
+---------------------+
| example             |
| ---                 |
| str                 |
+=====================+
| 2022/01/09 23:29:01 |
+---------------------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
@abstractmethod
def datetime_to_string(self, format_string: str = "%Y/%m/%d %H:%M:%S") -> Cell[str]:
    """
    Convert the date value in the cell to a string.

    Parameters
    ----------
    format_string:
        The format string it will be used to convert the data into the string.

    Returns
    -------
    date:
        The string value.

    Raises
    ------
    ValueError
        If the formatstring is invalid.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [ datetime.datetime(2022, 1, 9, 23, 29, 1, tzinfo=datetime.UTC)])
    >>> column.transform(lambda cell: cell.dt.datetime_to_string())
    +---------------------+
    | example             |
    | ---                 |
    | str                 |
    +=====================+
    | 2022/01/09 23:29:01 |
    +---------------------+
    """

day

Get the day of the underlying date(time) data.

Returns:

Type Description
A cell containing the day as integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 9)])
>>> column.transform(lambda cell: cell.dt.day())
+---------+
| example |
|     --- |
|      i8 |
+=========+
|       9 |
+---------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
@abstractmethod
def day(self) -> Cell[int]:
    """
    Get the day of the underlying date(time) data.

    Returns
    -------
        A cell containing the day as integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 9)])
    >>> column.transform(lambda cell: cell.dt.day())
    +---------+
    | example |
    |     --- |
    |      i8 |
    +=========+
    |       9 |
    +---------+
    """

month

Get the month of the underlying date(time) data.

Returns:

Type Description
A cell containing the month as integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 9)])
>>> column.transform(lambda cell: cell.dt.month())
+---------+
| example |
|     --- |
|      i8 |
+=========+
|       1 |
+---------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
@abstractmethod
def month(self) -> Cell[int]:
    """
    Get the month of the underlying date(time) data.

    Returns
    -------
        A cell containing the month as integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 9)])
    >>> column.transform(lambda cell: cell.dt.month())
    +---------+
    | example |
    |     --- |
    |      i8 |
    +=========+
    |       1 |
    +---------+
    """

week

Get the week of the underlying date(time) data.

Returns:

Type Description
A cell containing the week as integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 1)])
>>> column.transform(lambda cell: cell.dt.week())
+---------+
| example |
|     --- |
|      i8 |
+=========+
|      52 |
+---------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@abstractmethod
def week(self) -> Cell[int]:
    """
    Get the week of the underlying date(time) data.

    Returns
    -------
        A cell containing the week as integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 1)])
    >>> column.transform(lambda cell: cell.dt.week())
    +---------+
    | example |
    |     --- |
    |      i8 |
    +=========+
    |      52 |
    +---------+
    """

weekday

Get the weekday of the underlying date(time) data.

Returns:

Type Description
A cell containing the weekday as integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 1)])
>>> column.transform(lambda cell: cell.dt.weekday())
+---------+
| example |
|     --- |
|      i8 |
+=========+
|       6 |
+---------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
@abstractmethod
def weekday(self) -> Cell[int]:
    """
    Get the weekday of the underlying date(time) data.

    Returns
    -------
        A cell containing the weekday as integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 1)])
    >>> column.transform(lambda cell: cell.dt.weekday())
    +---------+
    | example |
    |     --- |
    |      i8 |
    +=========+
    |       6 |
    +---------+
    """

year

Get the year of the underlying date(time) data.

Returns:

Type Description
A cell containing the year as integer.

Examples:

>>> from safeds.data.tabular.containers import Column
>>> import datetime
>>> column = Column("example", [datetime.date(2022, 1, 9)])
>>> column.transform(lambda cell: cell.dt.year())
+---------+
| example |
|     --- |
|     i32 |
+=========+
|    2022 |
+---------+
Source code in src/safeds/data/tabular/containers/_temporal_cell.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
@abstractmethod
def year(self) -> Cell[int]:
    """
    Get the year of the underlying date(time) data.

    Returns
    -------
        A cell containing the year as integer.

    Examples
    --------
    >>> from safeds.data.tabular.containers import Column
    >>> import datetime
    >>> column = Column("example", [datetime.date(2022, 1, 9)])
    >>> column.transform(lambda cell: cell.dt.year())
    +---------+
    | example |
    |     --- |
    |     i32 |
    +=========+
    |    2022 |
    +---------+
    """