Skip to content

DurationOperations

Bases: ABC

Namespace for operations on durations.

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

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(days=-1), timedelta(days=0), timedelta(days=1)])
>>> column.transform(lambda cell: cell.dur.abs())
+--------------+
| a            |
| ---          |
| duration[μs] |
+==============+
| 1d           |
| 0µs          |
| 1d           |
+--------------+

Methods:

Name Description
abs

Get the absolute value of the duration.
full_days

Get the number of full days in the duration. The result is rounded toward zero.
full_hours

Get the number of full hours in the duration. The result is rounded toward zero.
full_microseconds

Get the number of full microseconds in the duration. The result is rounded toward zero.
full_milliseconds

Get the number of full milliseconds in the duration. The result is rounded toward zero.
full_minutes

Get the number of full minutes in the duration. The result is rounded toward zero.
full_seconds

Get the number of full seconds in the duration. The result is rounded toward zero.
full_weeks

Get the number of full weeks in the duration. The result is rounded toward zero.
to_string

Convert the duration to a string.
Source code in src/safeds/data/tabular/query/_duration_operations.py 
 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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
class DurationOperations(ABC):
    """
    Namespace for operations on durations.

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

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(days=-1), timedelta(days=0), timedelta(days=1)])
    >>> column.transform(lambda cell: cell.dur.abs())
    +--------------+
    | a            |
    | ---          |
    | duration[μs] |
    +==============+
    | 1d           |
    | 0µs          |
    | 1d           |
    +--------------+
    """

    # ------------------------------------------------------------------------------------------------------------------
    # Dunder methods
    # ------------------------------------------------------------------------------------------------------------------

    @abstractmethod
    def __eq__(self, other: object) -> bool: ...

    @abstractmethod
    def __hash__(self) -> int: ...

    @abstractmethod
    def __repr__(self) -> str: ...

    @abstractmethod
    def __sizeof__(self) -> int: ...

    @abstractmethod
    def __str__(self) -> str: ...

    # ------------------------------------------------------------------------------------------------------------------
    # Duration operations
    # ------------------------------------------------------------------------------------------------------------------

    @abstractmethod
    def abs(self) -> Cell[timedelta | None]:
        """
        Get the absolute value of the duration.

        Returns
        -------
        cell:
            The absolute value.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(days=-1), timedelta(days=1), None])
        >>> column.transform(lambda cell: cell.dur.abs())
        +--------------+
        | a            |
        | ---          |
        | duration[μs] |
        +==============+
        | 1d           |
        | 1d           |
        | null         |
        +--------------+
        """

    @abstractmethod
    def full_weeks(self) -> Cell[int | None]:
        """
        Get the number of full weeks in the duration. The result is rounded toward zero.

        Returns
        -------
        cell:
            The number of full weeks.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(days=8), timedelta(days=6), None])
        >>> column.transform(lambda cell: cell.dur.full_weeks())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        |    1 |
        |    0 |
        | null |
        +------+
        """

    @abstractmethod
    def full_days(self) -> Cell[int | None]:
        """
        Get the number of full days in the duration. The result is rounded toward zero.

        Returns
        -------
        cell:
            The number of full days.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(hours=25), timedelta(hours=23), None])
        >>> column.transform(lambda cell: cell.dur.full_days())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        |    1 |
        |    0 |
        | null |
        +------+
        """

    @abstractmethod
    def full_hours(self) -> Cell[int | None]:
        """
        Get the number of full hours in the duration. The result is rounded toward zero.

        Returns
        -------
        cell:
            The number of full hours.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(minutes=61), timedelta(minutes=59), None])
        >>> column.transform(lambda cell: cell.dur.full_hours())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        |    1 |
        |    0 |
        | null |
        +------+
        """

    @abstractmethod
    def full_minutes(self) -> Cell[int | None]:
        """
        Get the number of full minutes in the duration. The result is rounded toward zero.

        Returns
        -------
        cell:
            The number of full minutes.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(seconds=61), timedelta(seconds=59), None])
        >>> column.transform(lambda cell: cell.dur.full_minutes())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        |    1 |
        |    0 |
        | null |
        +------+
        """

    @abstractmethod
    def full_seconds(self) -> Cell[int | None]:
        """
        Get the number of full seconds in the duration. The result is rounded toward zero.

        Returns
        -------
        cell:
            The number of full seconds.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(milliseconds=1001), timedelta(milliseconds=999), None])
        >>> column.transform(lambda cell: cell.dur.full_seconds())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        |    1 |
        |    0 |
        | null |
        +------+
        """

    @abstractmethod
    def full_milliseconds(self) -> Cell[int | None]:
        """
        Get the number of full milliseconds in the duration. The result is rounded toward zero.

        Returns
        -------
        cell:
            The number of full milliseconds.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(microseconds=1001), timedelta(microseconds=999), None])
        >>> column.transform(lambda cell: cell.dur.full_milliseconds())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        |    1 |
        |    0 |
        | null |
        +------+
        """

    @abstractmethod
    def full_microseconds(self) -> Cell[int | None]:
        """
        Get the number of full microseconds in the duration. The result is rounded toward zero.

        Since durations only have microsecond resolution at the moment, the rounding has no effect. This may change in
        the future.

        Returns
        -------
        cell:
            The number of full microseconds.

        Examples
        --------
        >>> from datetime import timedelta
        >>> from safeds.data.tabular.containers import Column
        >>> column = Column("a", [timedelta(microseconds=1001), timedelta(microseconds=999), None])
        >>> column.transform(lambda cell: cell.dur.full_microseconds())
        +------+
        |    a |
        |  --- |
        |  i64 |
        +======+
        | 1001 |
        |  999 |
        | null |
        +------+
        """

    @abstractmethod
    def to_string(
        self,
        *,
        format: Literal["iso", "pretty"] = "iso",
    ) -> Cell[str | None]:
        """
        Convert the duration to a string.

        The following formats are supported:

        - `"iso"`: The duration is represented in the ISO 8601 format. This is the default.
        - `"pretty"`: The duration is represented in a human-readable format.

        !!! warning "API Stability"

            Do not rely on the exact output of the `"pretty"` format. In future versions, we may change it without prior
            notice.

        Parameters
        ----------
        format:
            The format to use.

        Returns
        -------
        cell:
            The string representation.
        """

abs

Get the absolute value of the duration.

Returns:

Name Type Description
cell Cell[timedelta | None]

The absolute value.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(days=-1), timedelta(days=1), None])
>>> column.transform(lambda cell: cell.dur.abs())
+--------------+
| a            |
| ---          |
| duration[μs] |
+==============+
| 1d           |
| 1d           |
| null         |
+--------------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
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
@abstractmethod
def abs(self) -> Cell[timedelta | None]:
    """
    Get the absolute value of the duration.

    Returns
    -------
    cell:
        The absolute value.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(days=-1), timedelta(days=1), None])
    >>> column.transform(lambda cell: cell.dur.abs())
    +--------------+
    | a            |
    | ---          |
    | duration[μs] |
    +==============+
    | 1d           |
    | 1d           |
    | null         |
    +--------------+
    """

full_days

Get the number of full days in the duration. The result is rounded toward zero.

Returns:

Name Type Description
cell Cell[int | None]

The number of full days.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(hours=25), timedelta(hours=23), None])
>>> column.transform(lambda cell: cell.dur.full_days())
+------+
|    a |
|  --- |
|  i64 |
+======+
|    1 |
|    0 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
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
@abstractmethod
def full_days(self) -> Cell[int | None]:
    """
    Get the number of full days in the duration. The result is rounded toward zero.

    Returns
    -------
    cell:
        The number of full days.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(hours=25), timedelta(hours=23), None])
    >>> column.transform(lambda cell: cell.dur.full_days())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    |    1 |
    |    0 |
    | null |
    +------+
    """

full_hours

Get the number of full hours in the duration. The result is rounded toward zero.

Returns:

Name Type Description
cell Cell[int | None]

The number of full hours.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(minutes=61), timedelta(minutes=59), None])
>>> column.transform(lambda cell: cell.dur.full_hours())
+------+
|    a |
|  --- |
|  i64 |
+======+
|    1 |
|    0 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
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
@abstractmethod
def full_hours(self) -> Cell[int | None]:
    """
    Get the number of full hours in the duration. The result is rounded toward zero.

    Returns
    -------
    cell:
        The number of full hours.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(minutes=61), timedelta(minutes=59), None])
    >>> column.transform(lambda cell: cell.dur.full_hours())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    |    1 |
    |    0 |
    | null |
    +------+
    """

full_microseconds

Get the number of full microseconds in the duration. The result is rounded toward zero.

Since durations only have microsecond resolution at the moment, the rounding has no effect. This may change in the future.

Returns:

Name Type Description
cell Cell[int | None]

The number of full microseconds.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(microseconds=1001), timedelta(microseconds=999), None])
>>> column.transform(lambda cell: cell.dur.full_microseconds())
+------+
|    a |
|  --- |
|  i64 |
+======+
| 1001 |
|  999 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
@abstractmethod
def full_microseconds(self) -> Cell[int | None]:
    """
    Get the number of full microseconds in the duration. The result is rounded toward zero.

    Since durations only have microsecond resolution at the moment, the rounding has no effect. This may change in
    the future.

    Returns
    -------
    cell:
        The number of full microseconds.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(microseconds=1001), timedelta(microseconds=999), None])
    >>> column.transform(lambda cell: cell.dur.full_microseconds())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    | 1001 |
    |  999 |
    | null |
    +------+
    """

full_milliseconds

Get the number of full milliseconds in the duration. The result is rounded toward zero.

Returns:

Name Type Description
cell Cell[int | None]

The number of full milliseconds.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(microseconds=1001), timedelta(microseconds=999), None])
>>> column.transform(lambda cell: cell.dur.full_milliseconds())
+------+
|    a |
|  --- |
|  i64 |
+======+
|    1 |
|    0 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
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
@abstractmethod
def full_milliseconds(self) -> Cell[int | None]:
    """
    Get the number of full milliseconds in the duration. The result is rounded toward zero.

    Returns
    -------
    cell:
        The number of full milliseconds.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(microseconds=1001), timedelta(microseconds=999), None])
    >>> column.transform(lambda cell: cell.dur.full_milliseconds())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    |    1 |
    |    0 |
    | null |
    +------+
    """

full_minutes

Get the number of full minutes in the duration. The result is rounded toward zero.

Returns:

Name Type Description
cell Cell[int | None]

The number of full minutes.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(seconds=61), timedelta(seconds=59), None])
>>> column.transform(lambda cell: cell.dur.full_minutes())
+------+
|    a |
|  --- |
|  i64 |
+======+
|    1 |
|    0 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
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
@abstractmethod
def full_minutes(self) -> Cell[int | None]:
    """
    Get the number of full minutes in the duration. The result is rounded toward zero.

    Returns
    -------
    cell:
        The number of full minutes.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(seconds=61), timedelta(seconds=59), None])
    >>> column.transform(lambda cell: cell.dur.full_minutes())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    |    1 |
    |    0 |
    | null |
    +------+
    """

full_seconds

Get the number of full seconds in the duration. The result is rounded toward zero.

Returns:

Name Type Description
cell Cell[int | None]

The number of full seconds.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(milliseconds=1001), timedelta(milliseconds=999), None])
>>> column.transform(lambda cell: cell.dur.full_seconds())
+------+
|    a |
|  --- |
|  i64 |
+======+
|    1 |
|    0 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
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
@abstractmethod
def full_seconds(self) -> Cell[int | None]:
    """
    Get the number of full seconds in the duration. The result is rounded toward zero.

    Returns
    -------
    cell:
        The number of full seconds.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(milliseconds=1001), timedelta(milliseconds=999), None])
    >>> column.transform(lambda cell: cell.dur.full_seconds())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    |    1 |
    |    0 |
    | null |
    +------+
    """

full_weeks

Get the number of full weeks in the duration. The result is rounded toward zero.

Returns:

Name Type Description
cell Cell[int | None]

The number of full weeks.

Examples:

>>> from datetime import timedelta
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [timedelta(days=8), timedelta(days=6), None])
>>> column.transform(lambda cell: cell.dur.full_weeks())
+------+
|    a |
|  --- |
|  i64 |
+======+
|    1 |
|    0 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_duration_operations.py 
 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
@abstractmethod
def full_weeks(self) -> Cell[int | None]:
    """
    Get the number of full weeks in the duration. The result is rounded toward zero.

    Returns
    -------
    cell:
        The number of full weeks.

    Examples
    --------
    >>> from datetime import timedelta
    >>> from safeds.data.tabular.containers import Column
    >>> column = Column("a", [timedelta(days=8), timedelta(days=6), None])
    >>> column.transform(lambda cell: cell.dur.full_weeks())
    +------+
    |    a |
    |  --- |
    |  i64 |
    +======+
    |    1 |
    |    0 |
    | null |
    +------+
    """

to_string

Convert the duration to a string.

The following formats are supported:

  • "iso": The duration is represented in the ISO 8601 format. This is the default.
  • "pretty": The duration is represented in a human-readable format.

API Stability

Do not rely on the exact output of the "pretty" format. In future versions, we may change it without prior notice.

Parameters:

Name Type Description Default
format Literal['iso', 'pretty']

The format to use.

 'iso'

Returns:

Name Type Description
cell Cell[str | None]

The string representation.
Source code in src/safeds/data/tabular/query/_duration_operations.py 
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
@abstractmethod
def to_string(
    self,
    *,
    format: Literal["iso", "pretty"] = "iso",
) -> Cell[str | None]:
    """
    Convert the duration to a string.

    The following formats are supported:

    - `"iso"`: The duration is represented in the ISO 8601 format. This is the default.
    - `"pretty"`: The duration is represented in a human-readable format.

    !!! warning "API Stability"

        Do not rely on the exact output of the `"pretty"` format. In future versions, we may change it without prior
        notice.

    Parameters
    ----------
    format:
        The format to use.

    Returns
    -------
    cell:
        The string representation.
    """