DatetimeOperations
Bases: ABC
Namespace for operations on datetimes, dates, and times.
This class cannot be instantiated directly. It can only be accessed using the dt attribute of a cell.
Examples:
>>> from datetime import date
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [date(2022, 1, 9), date(2024, 6, 12)])
>>> column.transform(lambda cell: cell.dt.year())
+------+
| a |
| --- |
| i32 |
+======+
| 2022 |
| 2024 |
+------+
Methods:
| Name | Description |
|---|---|
century |
Extract the century from a datetime or date. |
date |
Extract the date from a datetime. |
day |
Extract the day from a datetime or date. |
day_of_week |
Extract the day of the week from a datetime or date as defined by ISO 8601. |
day_of_year |
Extract the day of the year from a datetime or date. |
hour |
Extract the hour from a datetime or time. |
is_in_leap_year |
Check a datetime or date is in a leap year. |
microsecond |
Extract the microsecond from a datetime or time. |
millennium |
Extract the millennium from a datetime or date. |
millisecond |
Extract the millisecond from a datetime or time. |
minute |
Extract the minute from a datetime or time. |
month |
Extract the month from a datetime or date. |
quarter |
Extract the quarter from a datetime or date. |
replace |
Replace components of a datetime or date. |
second |
Extract the second from a datetime or time. |
time |
Extract the time from a datetime. |
to_string |
Convert a datetime, date, or time to a string. |
unix_timestamp |
Get the Unix timestamp from a datetime. |
week |
Extract the ISO 8601 week number from a datetime or date. |
year |
Extract the year from a datetime or date. |
Source code in src/safeds/data/tabular/query/_datetime_operations.py
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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 | |
century
¶
Extract the century from a datetime or date.
Note that since our calendar begins with year 1 the first century lasts from year 1 to year 100. Subsequent centuries begin with years ending in "01" and end with years ending in "00".
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The century. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), datetime(2001, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.century())
+------+
| a |
| --- |
| i32 |
+======+
| 20 |
| 20 |
| 21 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), date(2001, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.century())
+------+
| a |
| --- |
| i32 |
+======+
| 20 |
| 20 |
| 21 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
date
¶
Extract the date from a datetime.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[date | None]
|
The date. |
Examples:
>>> from datetime import datetime
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1, 12, 30, 0), None])
>>> column.transform(lambda cell: cell.dt.date())
+------------+
| a |
| --- |
| date |
+============+
| 1999-12-31 |
| 2000-01-01 |
| null |
+------------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
day
¶
Extract the day from a datetime or date.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The day. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.day())
+------+
| a |
| --- |
| i8 |
+======+
| 31 |
| 1 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.day())
+------+
| a |
| --- |
| i8 |
+======+
| 31 |
| 1 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
day_of_week
¶
Extract the day of the week from a datetime or date as defined by ISO 8601.
The day of the week is a number between 1 (Monday) and 7 (Sunday).
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The day of the week. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1), datetime(2000, 1, 2), None])
>>> column1.transform(lambda cell: cell.dt.day_of_week())
+------+
| a |
| --- |
| i8 |
+======+
| 6 |
| 7 |
| null |
+------+
>>> column2 = Column("a", [date(2000, 1, 1), date(2000, 1, 2), None])
>>> column2.transform(lambda cell: cell.dt.day_of_week())
+------+
| a |
| --- |
| i8 |
+======+
| 6 |
| 7 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
day_of_year
¶
Extract the day of the year from a datetime or date.
The day of the year is a number between 1 and 366. A 366th day only occurs in leap years.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The day of the year. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), datetime(2000, 12, 31), None])
>>> column1.transform(lambda cell: cell.dt.day_of_year())
+------+
| a |
| --- |
| i16 |
+======+
| 365 |
| 1 |
| 366 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), date(2000, 12, 31), None])
>>> column2.transform(lambda cell: cell.dt.day_of_year())
+------+
| a |
| --- |
| i16 |
+======+
| 365 |
| 1 |
| 366 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
hour
¶
Extract the hour from a datetime or time.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The hour. |
Examples:
>>> from datetime import datetime, time
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1, hour=0), datetime(2000, 1, 1, hour=12), None])
>>> column1.transform(lambda cell: cell.dt.hour())
+------+
| a |
| --- |
| i8 |
+======+
| 0 |
| 12 |
| null |
+------+
>>> column2 = Column("a", [time(hour=0), time(hour=12), None])
>>> column2.transform(lambda cell: cell.dt.hour())
+------+
| a |
| --- |
| i8 |
+======+
| 0 |
| 12 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
is_in_leap_year
¶
Check a datetime or date is in a leap year.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[bool | None]
|
Whether the year is a leap year. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1900, 1, 1), datetime(2000, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.is_in_leap_year())
+-------+
| a |
| --- |
| bool |
+=======+
| false |
| true |
| null |
+-------+
>>> column2 = Column("a", [date(1900, 1, 1), date(2000, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.is_in_leap_year())
+-------+
| a |
| --- |
| bool |
+=======+
| false |
| true |
| null |
+-------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
microsecond
¶
Extract the microsecond from a datetime or time.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The microsecond. |
Examples:
>>> from datetime import datetime, time
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1, microsecond=0), datetime(2000, 1, 1, microsecond=500), None])
>>> column1.transform(lambda cell: cell.dt.microsecond())
+------+
| a |
| --- |
| i32 |
+======+
| 0 |
| 500 |
| null |
+------+
>>> column2 = Column("a", [time(microsecond=0), time(microsecond=500), None])
>>> column2.transform(lambda cell: cell.dt.microsecond())
+------+
| a |
| --- |
| i32 |
+======+
| 0 |
| 500 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
millennium
¶
Extract the millennium from a datetime or date.
Note that since our calendar begins with year 1 the first millennium lasts from year 1 to year 1000. Subsequent centuries begin with years ending in "001" and end with years ending in "000".
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The millennium. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), datetime(2001, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.millennium())
+------+
| a |
| --- |
| i32 |
+======+
| 2 |
| 2 |
| 3 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), date(2001, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.millennium())
+------+
| a |
| --- |
| i32 |
+======+
| 2 |
| 2 |
| 3 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
millisecond
¶
Extract the millisecond from a datetime or time.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The millisecond. |
Examples:
>>> from datetime import datetime, time
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1, microsecond=0), datetime(2000, 1, 1, microsecond=500000), None])
>>> column1.transform(lambda cell: cell.dt.millisecond())
+------+
| a |
| --- |
| i32 |
+======+
| 0 |
| 500 |
| null |
+------+
>>> column2 = Column("a", [time(microsecond=0), time(microsecond=500000), None])
>>> column2.transform(lambda cell: cell.dt.millisecond())
+------+
| a |
| --- |
| i32 |
+======+
| 0 |
| 500 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
minute
¶
Extract the minute from a datetime or time.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The minute. |
Examples:
>>> from datetime import datetime, time
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1, minute=0), datetime(2000, 1, 1, minute=30), None])
>>> column1.transform(lambda cell: cell.dt.minute())
+------+
| a |
| --- |
| i8 |
+======+
| 0 |
| 30 |
| null |
+------+
>>> column2 = Column("a", [time(minute=0), time(minute=30), None])
>>> column2.transform(lambda cell: cell.dt.minute())
+------+
| a |
| --- |
| i8 |
+======+
| 0 |
| 30 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
month
¶
Extract the month from a datetime or date.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The month. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.month())
+------+
| a |
| --- |
| i8 |
+======+
| 12 |
| 1 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.month())
+------+
| a |
| --- |
| i8 |
+======+
| 12 |
| 1 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
quarter
¶
Extract the quarter from a datetime or date.
The quarter is a number between 1 and 4:
- 1: January to March
- 2: April to June
- 3: July to September
- 4: October to December
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The quarter. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), datetime(2000, 4, 1), None])
>>> column1.transform(lambda cell: cell.dt.quarter())
+------+
| a |
| --- |
| i8 |
+======+
| 4 |
| 1 |
| 2 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), date(2000, 4, 1), None])
>>> column2.transform(lambda cell: cell.dt.quarter())
+------+
| a |
| --- |
| i8 |
+======+
| 4 |
| 1 |
| 2 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
replace
¶
Replace components of a datetime or date.
If a component is not provided, it is not changed. Components that are not applicable to the object are ignored,
e.g. setting the hour of a date. Invalid results are converted to missing values (None).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
year
|
_ConvertibleToIntCell
|
The new year. |
None
|
month
|
_ConvertibleToIntCell
|
The new month. Must be between 1 and 12. |
None
|
day
|
_ConvertibleToIntCell
|
The new day. Must be between 1 and 31. |
None
|
hour
|
_ConvertibleToIntCell
|
The new hour. Must be between 0 and 23. |
None
|
minute
|
_ConvertibleToIntCell
|
The new minute. Must be between 0 and 59. |
None
|
second
|
_ConvertibleToIntCell
|
The new second. Must be between 0 and 59. |
None
|
microsecond
|
_ConvertibleToIntCell
|
The new microsecond. Must be between 0 and 999999. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell
|
The new datetime or date. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.replace(month=2, day=2, hour=2))
+---------------------+
| a |
| --- |
| datetime[μs] |
+=====================+
| 2000-02-02 02:00:00 |
| null |
+---------------------+
>>> column2 = Column("a", [date(2000, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.replace(month=2, day=2, hour=2))
+------------+
| a |
| --- |
| date |
+============+
| 2000-02-02 |
| null |
+------------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
second
¶
Extract the second from a datetime or time.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The second. |
Examples:
>>> from datetime import datetime, time
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(2000, 1, 1, second=0), datetime(2000, 1, 1, second=30), None])
>>> column1.transform(lambda cell: cell.dt.second())
+------+
| a |
| --- |
| i8 |
+======+
| 0 |
| 30 |
| null |
+------+
>>> column2 = Column("a", [time(second=0), time(second=30), None])
>>> column2.transform(lambda cell: cell.dt.second())
+------+
| a |
| --- |
| i8 |
+======+
| 0 |
| 30 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
time
¶
Extract the time from a datetime.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[time | None]
|
The time. |
Examples:
>>> from datetime import datetime
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1, 12, 30, 0), None])
>>> column.transform(lambda cell: cell.dt.time())
+----------+
| a |
| --- |
| time |
+==========+
| 00:00:00 |
| 12:30:00 |
| null |
+----------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
to_string
¶
Convert a datetime, date, or time to a string.
The format parameter controls the presentation. It can be "iso" to target ISO 8601 or a custom string. The
custom string can contain fixed specifiers (see below), which are replaced with the corresponding values. The
specifiers are case-sensitive and always enclosed in curly braces. Other text is included in the output
verbatim. To include a literal opening curly brace, use \{, and to include a literal backslash, use \\.
The following specifiers for date components are available for datetime and date:
{Y},{_Y},{^Y}: Year (zero-padded to four digits, space-padded to four digits, no padding).{Y99},{_Y99},{^Y99}: Year modulo 100 (zero-padded to two digits, space-padded to two digits, no padding).{M},{_M},{^M}: Month (zero-padded to two digits, space-padded to two digits, no padding).{M-full}: Full name of the month (e.g. "January").{M-short}: Abbreviated name of the month with three letters (e.g. "Jan").{W},{_W},{^W}: Week number as defined by ISO 8601 (zero-padded to two digits, space-padded to two digits, no padding).{D},{_D},{^D}: Day of the month (zero-padded to two digits, space-padded to two digits, no padding).{DOW}: Day of the week as defined by ISO 8601 (1 = Monday, 7 = Sunday).{DOW-full}: Full name of the day of the week (e.g. "Monday").{DOW-short}: Abbreviated name of the day of the week with three letters (e.g. "Mon").{DOY},{_DOY},{^DOY}: Day of the year, ranging from 1 to 366 (zero-padded to three digits, space-padded to three digits, no padding).
The following specifiers for time components are available for datetime and time:
{h},{_h},{^h}: Hour (zero-padded to two digits, space-padded to two digits, no padding).{h12},{_h12},{^h12}: Hour in 12-hour format (zero-padded to two digits, space-padded to two digits, no padding).{m},{_m},{^m}: Minute (zero-padded to two digits, space-padded to two digits, no padding).{s},{_s},{^s}: Second (zero-padded to two digits, space-padded to two digits, no padding).{.f}: Fractional seconds with a leading decimal point.{ms}: Millisecond (zero-padded to three digits).{us}: Microsecond (zero-padded to six digits).{ns}: Nanosecond (zero-padded to nine digits).{AM/PM}: AM or PM (uppercase).{am/pm}: am or pm (lowercase).
The following specifiers are available for datetime only:
{z}: Offset of the timezone from UTC without a colon (e.g. "+0000").{:z}: Offset of the timezone from UTC with a colon (e.g. "+00:00").{u}: The UNIX timestamp in seconds.
The specifiers follow certain conventions:
- Generally, date components use uppercase letters and time components use lowercase letters.
- If a component may be formatted in multiple ways, we use shorter specifiers for ISO 8601. Specifiers for other formats have a prefix (same value with different padding, see below) or suffix (other differences).
- By default, value are zero-padded, where applicable.
- A leading underscore (
_) means the value is space-padded. - A leading caret (
^) means the value has no padding (think of the caret in regular expressions).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
format
|
str
|
The format to use. |
'iso'
|
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[str | None]
|
The string representation. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the format is invalid. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1, 12, 30, 0), None])
>>> column1.transform(lambda cell: cell.dt.to_string())
+----------------------------+
| a |
| --- |
| str |
+============================+
| 1999-12-31T00:00:00.000000 |
| 2000-01-01T12:30:00.000000 |
| null |
+----------------------------+
>>> column1.transform(lambda cell: cell.dt.to_string(
... format="{DOW-short} {D}-{M-short}-{Y} {h12}:{m}:{s} {AM/PM}"
... ))
+-----------------------------+
| a |
| --- |
| str |
+=============================+
| Fri 31-Dec-1999 12:00:00 AM |
| Sat 01-Jan-2000 12:30:00 PM |
| null |
+-----------------------------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.to_string())
+------------+
| a |
| --- |
| str |
+============+
| 1999-12-31 |
| 2000-01-01 |
| null |
+------------+
>>> column2.transform(lambda cell: cell.dt.to_string(
... format="{M}/{D}/{Y}"
... ))
+------------+
| a |
| --- |
| str |
+============+
| 12/31/1999 |
| 01/01/2000 |
| null |
+------------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 | |
unix_timestamp
¶
Get the Unix timestamp from a datetime.
A Unix timestamp is the elapsed time since 00:00:00 UTC on 1 January 1970. By default, this method returns the
value in seconds, but that can be changed with the unit parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
unit
|
Literal['s', 'ms', 'us']
|
The unit of the timestamp. Can be "s" (seconds), "ms" (milliseconds), or "us" (microseconds). |
's'
|
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The Unix timestamp. |
Examples:
>>> from datetime import datetime
>>> from safeds.data.tabular.containers import Column
>>> column = Column("a", [datetime(1970, 1, 1), datetime(1970, 1, 2), None])
>>> column.transform(lambda cell: cell.dt.unix_timestamp())
+-------+
| a |
| --- |
| i64 |
+=======+
| 0 |
| 86400 |
| null |
+-------+
>>> column.transform(lambda cell: cell.dt.unix_timestamp(unit="ms"))
+----------+
| a |
| --- |
| i64 |
+==========+
| 0 |
| 86400000 |
| null |
+----------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
week
¶
Extract the ISO 8601 week number from a datetime or date.
The week is a number between 1 and 53. The first week of a year is the week that contains the first Thursday of the year. The last week of a year is the week that contains the last Thursday of the year. In other words, a week is associated with a year if it contains the majority of its days.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The week. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 2), datetime(2001, 12, 31), None])
>>> column1.transform(lambda cell: cell.dt.week())
+------+
| a |
| --- |
| i8 |
+======+
| 52 |
| 52 |
| 1 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 2), date(2001, 12, 31), None])
>>> column2.transform(lambda cell: cell.dt.week())
+------+
| a |
| --- |
| i8 |
+======+
| 52 |
| 52 |
| 1 |
| null |
+------+
Source code in src/safeds/data/tabular/query/_datetime_operations.py
year
¶
Extract the year from a datetime or date.
Returns:
| Name | Type | Description |
|---|---|---|
cell |
Cell[int | None]
|
The year. |
Examples:
>>> from datetime import date, datetime
>>> from safeds.data.tabular.containers import Column
>>> column1 = Column("a", [datetime(1999, 12, 31), datetime(2000, 1, 1), None])
>>> column1.transform(lambda cell: cell.dt.year())
+------+
| a |
| --- |
| i32 |
+======+
| 1999 |
| 2000 |
| null |
+------+
>>> column2 = Column("a", [date(1999, 12, 31), date(2000, 1, 1), None])
>>> column2.transform(lambda cell: cell.dt.year())
+------+
| a |
| --- |
| i32 |
+======+
| 1999 |
| 2000 |
| null |
+------+