Spaces:
Paused
Paused
File size: 33,389 Bytes
5b7ed07 | 1 2 3 4 5 6 7 8 9 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 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 | # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import re
from datetime import date, datetime, timedelta
from typing import Optional
from unittest.mock import Mock, patch
import freezegun
import pytest
from dateutil.relativedelta import relativedelta
from superset.commands.chart.exceptions import (
TimeRangeAmbiguousError,
TimeRangeParseFailError,
)
from superset.utils.date_parser import (
DateRangeMigration,
datetime_eval,
get_past_or_future,
get_since_until,
is_constant_human_timedelta,
is_parseable_human_timedelta,
normalize_time_delta,
parse_human_datetime,
parse_human_timedelta,
parse_past_timedelta,
TimeDeltaAmbiguousError,
)
from tests.unit_tests.conftest import with_feature_flags
def mock_parse_human_datetime(s: str) -> Optional[datetime]: # noqa: C901
if s == "now":
return datetime(2016, 11, 7, 9, 30, 10)
elif s == "2018":
return datetime(2018, 1, 1)
elif s == "2018-9":
return datetime(2018, 9, 1)
elif s == "today":
return datetime(2016, 11, 7)
elif s == "yesterday":
return datetime(2016, 11, 6)
elif s == "tomorrow":
return datetime(2016, 11, 8)
elif s == "Last year":
return datetime(2015, 11, 7)
elif s == "Last week":
return datetime(2015, 10, 31)
elif s == "Last 5 months":
return datetime(2016, 6, 7)
elif s == "Next 5 months":
return datetime(2017, 4, 7)
elif s in ["5 days", "5 days ago"]:
return datetime(2016, 11, 2)
elif s == "2000-01-01T00:00:00":
return datetime(2000, 1, 1)
elif s == "2018-01-01T00:00:00":
return datetime(2018, 1, 1)
elif s == "2018-01-10T00:00:00":
return datetime(2018, 1, 10)
elif s == "2018-12-31T23:59:59":
return datetime(2018, 12, 31, 23, 59, 59)
elif s == "2022-01-01T00:00:00":
return datetime(2022, 1, 1)
else:
return None
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_get_since_until() -> None:
result: tuple[Optional[datetime], Optional[datetime]]
expected: tuple[Optional[datetime], Optional[datetime]]
result = get_since_until()
expected = None, datetime(2016, 11, 7)
assert result == expected
result = get_since_until(" : now")
expected = None, datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = get_since_until("yesterday : tomorrow")
expected = datetime(2016, 11, 6), datetime(2016, 11, 8)
assert result == expected
result = get_since_until(" : now")
expected = None, datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = get_since_until(" : last 2 minutes")
expected = None, datetime(2016, 11, 7, 9, 28, 10)
assert result == expected
result = get_since_until(" : prior 2 minutes")
expected = None, datetime(2016, 11, 7, 9, 28, 10)
assert result == expected
result = get_since_until(" : next 2 minutes")
expected = None, datetime(2016, 11, 7, 9, 32, 10)
assert result == expected
result = get_since_until("start of this month : ")
expected = datetime(2016, 11, 1), None
assert result == expected
result = get_since_until("start of next month : ")
expected = datetime(2016, 12, 1), None
assert result == expected
result = get_since_until("end of this month : ")
expected = datetime(2016, 11, 30), None
assert result == expected
result = get_since_until("end of next month : ")
expected = datetime(2016, 12, 31), None
assert result == expected
result = get_since_until("beginning of next year : ")
expected = datetime(2017, 1, 1), None
assert result == expected
result = get_since_until("beginning of last year : ")
expected = datetime(2015, 1, 1), None
assert result == expected
result = get_since_until("2018-01-01T00:00:00 : 2018-12-31T23:59:59")
expected = datetime(2018, 1, 1), datetime(2018, 12, 31, 23, 59, 59)
assert result == expected
result = get_since_until("Last year")
expected = datetime(2015, 11, 7), datetime(2016, 11, 7)
assert result == expected
result = get_since_until("Last quarter")
expected = datetime(2016, 8, 7), datetime(2016, 11, 7)
assert result == expected
result = get_since_until("Last 5 months")
expected = datetime(2016, 6, 7), datetime(2016, 11, 7)
assert result == expected
result = get_since_until("Last 1 month")
expected = datetime(2016, 10, 7), datetime(2016, 11, 7)
assert result == expected
result = get_since_until("Next 5 months")
expected = datetime(2016, 11, 7), datetime(2017, 4, 7)
assert result == expected
result = get_since_until("Next 1 month")
expected = datetime(2016, 11, 7), datetime(2016, 12, 7)
assert result == expected
result = get_since_until(since="5 days")
expected = datetime(2016, 11, 2), datetime(2016, 11, 7)
assert result == expected
result = get_since_until(since="5 days ago", until="tomorrow")
expected = datetime(2016, 11, 2), datetime(2016, 11, 8)
assert result == expected
result = get_since_until(time_range="yesterday : tomorrow", time_shift="1 day")
expected = datetime(2016, 11, 5), datetime(2016, 11, 7)
assert result == expected
result = get_since_until(time_range="5 days : now")
expected = datetime(2016, 11, 2), datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = get_since_until("Last week", relative_end="now")
expected = datetime(2016, 10, 31), datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = get_since_until("Last week", relative_start="now")
expected = datetime(2016, 10, 31, 9, 30, 10), datetime(2016, 11, 7)
assert result == expected
result = get_since_until("Last week", relative_start="now", relative_end="now")
expected = datetime(2016, 10, 31, 9, 30, 10), datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = get_since_until("previous calendar week")
expected = datetime(2016, 10, 31, 0, 0, 0), datetime(2016, 11, 7, 0, 0, 0)
assert result == expected
result = get_since_until("previous calendar month")
expected = datetime(2016, 10, 1, 0, 0, 0), datetime(2016, 11, 1, 0, 0, 0)
assert result == expected
result = get_since_until("previous calendar year")
expected = datetime(2015, 1, 1, 0, 0, 0), datetime(2016, 1, 1, 0, 0, 0)
assert result == expected
result = get_since_until("Current day")
expected = datetime(2016, 11, 7, 0, 0, 0), datetime(2016, 11, 8, 0, 0, 0)
assert result == expected
result = get_since_until("Current week")
expected = datetime(2016, 11, 7, 0, 0, 0), datetime(2016, 11, 14, 0, 0, 0)
assert result == expected
result = get_since_until("Current month")
expected = datetime(2016, 11, 1, 0, 0, 0), datetime(2016, 12, 1, 0, 0, 0)
assert result == expected
result = get_since_until("Current quarter")
expected = datetime(2016, 10, 1, 0, 0, 0), datetime(2017, 1, 1, 0, 0, 0)
assert result == expected
result = get_since_until("Current year")
expected = expected = datetime(2016, 1, 1, 0, 0, 0), datetime(2017, 1, 1, 0, 0, 0)
assert result == expected
# Tests for our new instant_time_comparison logic and Feature Flag off
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="y",
)
expected = datetime(2000, 1, 1), datetime(2018, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="m",
)
expected = datetime(2000, 1, 1), datetime(2018, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="w",
)
expected = datetime(2000, 1, 1), datetime(2018, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="r",
)
expected = datetime(2000, 1, 1), datetime(2018, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
time_shift="1 year ago",
)
expected = datetime(1999, 1, 1), datetime(2017, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
time_shift="1 month ago",
)
expected = datetime(1999, 12, 1), datetime(2017, 12, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
time_shift="1 week ago",
)
expected = datetime(1999, 12, 25), datetime(2017, 12, 25)
assert result == expected
# Test time_shift with date range format (contains ' : ')
result = get_since_until(
time_range="today : tomorrow",
time_shift="yesterday : today",
)
# When time_shift contains ' : ', it should be parsed as a new time range
expected = datetime(2016, 11, 6), datetime(2016, 11, 7)
assert result == expected
with pytest.raises(ValueError): # noqa: PT011
get_since_until(time_range="tomorrow : yesterday")
@with_feature_flags(CHART_PLUGINS_EXPERIMENTAL=True)
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_get_since_until_instant_time_comparison_enabled() -> None:
result: tuple[Optional[datetime], Optional[datetime]]
expected: tuple[Optional[datetime], Optional[datetime]]
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="y",
)
expected = datetime(1999, 1, 1), datetime(2017, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="m",
)
expected = datetime(1999, 12, 1), datetime(2017, 12, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="w",
)
expected = datetime(1999, 12, 25), datetime(2017, 12, 25)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="r",
)
expected = datetime(1981, 12, 31), datetime(2000, 1, 1)
assert result == expected
result = get_since_until(
time_range="2000-01-01T00:00:00 : 2018-01-01T00:00:00",
instant_time_comparison_range="unknown",
)
expected = datetime(2000, 1, 1), datetime(2018, 1, 1)
assert result == expected
def test_previous_calendar_quarter():
with freezegun.freeze_time("2023-01-15"):
result = get_since_until("previous calendar quarter")
expected = (datetime(2022, 10, 1), datetime(2023, 1, 1))
assert result == expected
with freezegun.freeze_time("2023, 4, 15"):
result = get_since_until("previous calendar quarter")
expected = (datetime(2023, 1, 1), datetime(2023, 4, 1))
assert result == expected
with freezegun.freeze_time("2023, 8, 15"):
result = get_since_until("previous calendar quarter")
expected = (datetime(2023, 4, 1), datetime(2023, 7, 1))
assert result == expected
with freezegun.freeze_time("2023, 10, 15"):
result = get_since_until("previous calendar quarter")
expected = (datetime(2023, 7, 1), datetime(2023, 10, 1))
assert result == expected
with freezegun.freeze_time("2024, 1, 1"):
result = get_since_until("previous calendar quarter")
expected = (datetime(2023, 10, 1), datetime(2024, 1, 1))
assert result == expected
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_datetime_eval() -> None:
result = datetime_eval("datetime('now')")
expected = datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = datetime_eval("datetime('today')")
expected = datetime(2016, 11, 7)
assert result == expected
result = datetime_eval("datetime('2018')")
expected = datetime(2018, 1, 1)
assert result == expected
result = datetime_eval("datetime('2018-9')")
expected = datetime(2018, 9, 1)
assert result == expected
# Parse compact arguments spelling
result = datetime_eval("dateadd(datetime('today'),1,year,)")
expected = datetime(2017, 11, 7)
assert result == expected
result = datetime_eval("dateadd(datetime('today'), -2, year)")
expected = datetime(2014, 11, 7)
assert result == expected
result = datetime_eval("dateadd(datetime('today'), 2, quarter)")
expected = datetime(2017, 5, 7)
assert result == expected
result = datetime_eval("dateadd(datetime('today'), 3, month)")
expected = datetime(2017, 2, 7)
assert result == expected
result = datetime_eval("dateadd(datetime('today'), -3, week)")
expected = datetime(2016, 10, 17)
assert result == expected
result = datetime_eval("dateadd(datetime('today'), 3, day)")
expected = datetime(2016, 11, 10)
assert result == expected
result = datetime_eval("dateadd(datetime('now'), 3, hour)")
expected = datetime(2016, 11, 7, 12, 30, 10)
assert result == expected
result = datetime_eval("dateadd(datetime('now'), 40, minute)")
expected = datetime(2016, 11, 7, 10, 10, 10)
assert result == expected
result = datetime_eval("dateadd(datetime('now'), -11, second)")
expected = datetime(2016, 11, 7, 9, 29, 59)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), year)")
expected = datetime(2016, 1, 1, 0, 0, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), quarter)")
expected = datetime(2016, 10, 1, 0, 0, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), month)")
expected = datetime(2016, 11, 1, 0, 0, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), day)")
expected = datetime(2016, 11, 7, 0, 0, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), week)")
expected = datetime(2016, 11, 7, 0, 0, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), hour)")
expected = datetime(2016, 11, 7, 9, 0, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), minute)")
expected = datetime(2016, 11, 7, 9, 30, 0)
assert result == expected
result = datetime_eval("datetrunc(datetime('now'), second)")
expected = datetime(2016, 11, 7, 9, 30, 10)
assert result == expected
result = datetime_eval("lastday(datetime('now'), year)")
expected = datetime(2016, 12, 31, 0, 0, 0)
assert result == expected
result = datetime_eval("lastday(datetime('today'), month)")
expected = datetime(2016, 11, 30, 0, 0, 0)
assert result == expected
result = datetime_eval("holiday('Christmas')")
expected = datetime(2016, 12, 25, 0, 0, 0)
assert result == expected
result = datetime_eval("holiday('Labor day', datetime('2018-01-01T00:00:00'))")
expected = datetime(2018, 9, 3, 0, 0, 0)
assert result == expected
# Saudi Arabia holidays - try both English and Arabic names as the default
# language varies by environment (ar in some envs, en_US in CI)
sa_holiday_test_passed = False
for holiday_name in ["Eid al-Fitr", "عطلة عيد الفطر"]:
try:
result = datetime_eval(
f"holiday('{holiday_name}', datetime('2000-01-01T00:00:00'), 'SA')"
)
expected = datetime(2000, 1, 8, 0, 0, 0)
assert result == expected
sa_holiday_test_passed = True
break
except ValueError:
continue
assert sa_holiday_test_passed
result = datetime_eval(
"holiday('Boxing day', datetime('2018-01-01T00:00:00'), 'UK')"
)
expected = datetime(2018, 12, 26, 0, 0, 0)
assert result == expected
result = datetime_eval(
"holiday('Juneteenth', datetime('2022-01-01T00:00:00'), 'US')"
)
expected = datetime(2022, 6, 19, 0, 0, 0)
assert result == expected
result = datetime_eval(
"holiday('Independence Day', datetime('2022-01-01T00:00:00'), 'US')"
)
expected = datetime(2022, 7, 4, 0, 0, 0)
assert result == expected
result = datetime_eval(
"lastday(dateadd(datetime('2018-01-01T00:00:00'), 1, month), month)"
)
expected = datetime(2018, 2, 28, 0, 0, 0)
assert result == expected
result = datetime_eval(
"datediff(datetime('2018-01-01T00:00:00'), datetime('2018-01-10T00:00:00'))" # pylint: disable=line-too-long,useless-suppression
)
assert result == 9
result = datetime_eval(
"datediff(datetime('2018-01-10T00:00:00'), datetime('2018-01-01T00:00:00'))" # pylint: disable=line-too-long,useless-suppression
)
assert result == -9
result = datetime_eval(
"datediff(datetime('2018-01-01T00:00:00'), datetime('2018-01-10T00:00:00'), day)" # pylint: disable=line-too-long,useless-suppression # noqa: E501
)
assert result == 9
result = datetime_eval(
"datediff(datetime('2018-01-01T00:00:00'), datetime('2018-01-10T00:00:00'), year)" # pylint: disable=line-too-long,useless-suppression # noqa: E501
)
assert result == 0
result = datetime_eval(
"dateadd("
"datetime('2018-01-01T00:00:00'), "
"datediff(datetime('2018-01-10T00:00:00'), datetime('2018-01-01T00:00:00')), " # pylint: disable=line-too-long,useless-suppression
"day,"
"),"
)
expected = datetime(2017, 12, 23, 0, 0, 0)
assert result == expected
@patch("superset.utils.date_parser.datetime")
def test_parse_human_timedelta(mock_datetime: Mock) -> None:
mock_datetime.now.return_value = datetime(2019, 4, 1)
mock_datetime.side_effect = lambda *args, **kw: datetime(*args, **kw)
assert parse_human_timedelta("now") == timedelta(0)
assert parse_human_timedelta("1 year") == timedelta(366)
assert parse_human_timedelta("-1 year") == timedelta(-365)
assert parse_human_timedelta(None) == timedelta(0)
assert parse_human_timedelta("1 month", datetime(2019, 4, 1)) == timedelta(30)
assert parse_human_timedelta("1 month", datetime(2019, 5, 1)) == timedelta(31)
assert parse_human_timedelta("1 month", datetime(2019, 2, 1)) == timedelta(28)
assert parse_human_timedelta("-1 month", datetime(2019, 2, 1)) == timedelta(-31)
@patch("superset.utils.date_parser.datetime")
def test_parse_past_timedelta(mock_datetime: Mock) -> None:
mock_datetime.now.return_value = datetime(2019, 4, 1)
mock_datetime.side_effect = lambda *args, **kw: datetime(*args, **kw)
assert parse_past_timedelta("1 year") == timedelta(365)
assert parse_past_timedelta("-1 year") == timedelta(365)
assert parse_past_timedelta("52 weeks") == timedelta(364)
assert parse_past_timedelta("1 month") == timedelta(31)
def test_get_past_or_future() -> None:
# 2020 is a leap year
dttm = datetime(2020, 2, 29)
assert get_past_or_future("1 year", dttm) == datetime(2021, 2, 28)
assert get_past_or_future("-1 year", dttm) == datetime(2019, 2, 28)
assert get_past_or_future("1 month", dttm) == datetime(2020, 3, 29)
assert get_past_or_future("3 month", dttm) == datetime(2020, 5, 29)
def test_get_past_or_future_quarters() -> None:
# parsedatetime has no notion of quarters (it would leave the source time
# unchanged); quarter phrases are rewritten to months before parsing
dttm = datetime(2024, 5, 15, 10, 30, 45)
assert get_past_or_future("1 quarter ago", dttm) == datetime(
2024, 2, 15, 10, 30, 45
)
assert get_past_or_future("2 quarters ago", dttm) == datetime(
2023, 11, 15, 10, 30, 45
)
assert get_past_or_future("1 quarter later", dttm) == datetime(
2024, 8, 15, 10, 30, 45
)
assert get_past_or_future("1 QUARTER ago", dttm) == datetime(
2024, 2, 15, 10, 30, 45
)
# absurdly long digit runs are not rewritten (bounded to keep matching
# linear and the month count small); they parse like any other
# unintelligible phrase, i.e. the source time comes back unchanged
assert get_past_or_future("0" * 100_000 + " quarters ago", dttm) == dttm
def test_parse_human_timedelta_unparseable_is_zero() -> None:
# the parser leaves unparseable phrases as the source time, so their
# delta is zero; a zero delta alone cannot distinguish them from
# legitimate zero-shift phrases (see is_parseable_human_timedelta)
dttm = datetime(2024, 5, 15)
assert parse_human_timedelta("not a real offset", dttm) == timedelta(0)
def test_is_parseable_human_timedelta() -> None:
assert is_parseable_human_timedelta("1 week ago")
assert is_parseable_human_timedelta("one year ago")
assert is_parseable_human_timedelta("1 quarter ago")
# zero-shift phrases parse successfully even though their delta is zero
assert is_parseable_human_timedelta("0 days ago")
assert not is_parseable_human_timedelta("not a real offset")
assert not is_parseable_human_timedelta("invalid-date-range")
assert not is_parseable_human_timedelta("")
assert not is_parseable_human_timedelta(None)
# absurdly long digit runs are not rewritten to months; they are
# unparseable like any other unintelligible phrase
assert not is_parseable_human_timedelta("9" * 100_000 + " quarters ago")
def test_is_constant_human_timedelta() -> None:
# phrases that shift every source time by the same amount
assert is_constant_human_timedelta("1 week ago")
assert is_constant_human_timedelta("1 month ago")
assert is_constant_human_timedelta("52 weeks ago")
assert is_constant_human_timedelta("1 year ago")
assert is_constant_human_timedelta("one year ago")
assert is_constant_human_timedelta("1 quarter ago")
assert is_constant_human_timedelta("2 days later")
# a zero shift is still a constant one
assert is_constant_human_timedelta("0 days ago")
# anchors resolve to a fixed point instead: how far they move a source
# time depends on where in the day that source time falls
assert not is_constant_human_timedelta("yesterday")
assert not is_constant_human_timedelta("last month")
assert not is_constant_human_timedelta("noon")
assert not is_constant_human_timedelta("friday")
assert not is_constant_human_timedelta("june")
# a phrase nothing can parse is not a delta either
assert not is_constant_human_timedelta("not a real offset")
assert not is_constant_human_timedelta("")
assert not is_constant_human_timedelta(None)
def test_is_constant_human_timedelta_matches_applied_shift() -> None:
"""
The probes stand in for real source timestamps, so the verdict has to hold
for source times they never looked at: an accepted phrase shifts arbitrary
timestamps equally, a rejected one does not.
"""
sources = [
datetime(2021, 3, 14, 2, 30),
datetime(2021, 11, 7, 1, 30),
datetime(2024, 2, 29, 23, 59, 59),
datetime(2020, 1, 1, 0, 0),
]
deltas = {get_past_or_future("1 week ago", src) - src for src in sources}
assert deltas == {timedelta(days=-7)}
anchored = {get_past_or_future("yesterday", src) - src for src in sources}
assert len(anchored) > 1
def test_normalize_time_delta() -> None:
assert normalize_time_delta("30 seconds ago") == {"seconds": -30}
assert normalize_time_delta("5 minutes later") == {"minutes": 5}
assert normalize_time_delta("12 hours ago") == {"hours": -12}
assert normalize_time_delta("2 weeks ago") == {"weeks": -2}
assert normalize_time_delta("28 days ago") == {"days": -28}
assert normalize_time_delta("2 months later") == {"months": 2}
assert normalize_time_delta("1 year ago") == {"years": -1}
# quarters are converted to months (pd.DateOffset has no quarters argument)
assert normalize_time_delta("1 quarter ago") == {"months": -3}
assert normalize_time_delta("2 quarters later") == {"months": 6}
# matching is case-insensitive and the result uses lowercase keys
assert normalize_time_delta("1 QUARTER ago") == {"months": -3}
assert normalize_time_delta("1 Year AGO") == {"years": -1}
with pytest.raises(TimeDeltaAmbiguousError):
normalize_time_delta("one year ago")
def test_parse_human_datetime() -> None:
with pytest.raises(TimeRangeAmbiguousError):
parse_human_datetime("2 days")
with pytest.raises(TimeRangeAmbiguousError):
parse_human_datetime("2 day")
with pytest.raises(TimeRangeParseFailError):
parse_human_datetime("xxxxxxx")
assert parse_human_datetime("2015-04-03") == datetime(2015, 4, 3, 0, 0)
assert parse_human_datetime("2/3/1969") == datetime(1969, 2, 3, 0, 0)
assert parse_human_datetime("now") <= datetime.now()
assert parse_human_datetime("yesterday") < datetime.now()
assert date.today() - timedelta(1) == parse_human_datetime("yesterday").date()
assert (
parse_human_datetime("one year ago").date()
== (datetime.now() - relativedelta(years=1)).date()
)
assert (
parse_human_datetime("2 years after").date()
== (datetime.now() + relativedelta(years=2)).date()
)
def test_date_range_migration() -> None:
params = '{"time_range": " 8 days : 2020-03-10T00:00:00"}'
assert re.search(DateRangeMigration.x_dateunit_in_since, params)
params = '{"time_range": "2020-03-10T00:00:00 : 8 days "}'
assert re.search(DateRangeMigration.x_dateunit_in_until, params)
params = '{"time_range": " 2 weeks : 8 days "}'
assert re.search(DateRangeMigration.x_dateunit_in_since, params)
assert re.search(DateRangeMigration.x_dateunit_in_until, params)
params = '{"time_range": "2 weeks ago : 8 days later"}'
assert not re.search(DateRangeMigration.x_dateunit_in_since, params)
assert not re.search(DateRangeMigration.x_dateunit_in_until, params)
field = " 8 days "
assert re.search(DateRangeMigration.x_dateunit, field)
field = "last week"
assert not re.search(DateRangeMigration.x_dateunit, field)
field = "10 years ago"
assert not re.search(DateRangeMigration.x_dateunit, field)
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_first_of_with_explicit_scope() -> None:
"""Test 'first of [scope] [unit]' expressions that return a single date."""
result = get_since_until("first of this month : ")
assert result == (datetime(2016, 11, 1), None)
result = get_since_until("first of last month : ")
assert result == (datetime(2016, 10, 1), None)
result = get_since_until("first of next month : ")
assert result == (datetime(2016, 12, 1), None)
result = get_since_until("first of prior month : ")
assert result == (datetime(2016, 10, 1), None)
result = get_since_until("first day of this year : ")
assert result == (datetime(2016, 1, 1), None)
result = get_since_until("first day of last year : ")
assert result == (datetime(2015, 1, 1), None)
result = get_since_until("first day of this week : ")
assert result == (datetime(2016, 11, 7), None)
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_first_of_with_default_scope() -> None:
"""Test 'first of the [unit]' expressions that default to 'this'."""
result = get_since_until("first of the month : ")
assert result == (datetime(2016, 11, 1), None)
result = get_since_until("first of the year : ")
assert result == (datetime(2016, 1, 1), None)
result = get_since_until("first day of the month : ")
assert result == (datetime(2016, 11, 1), None)
result = get_since_until("first day of the week : ")
assert result == (datetime(2016, 11, 7), None)
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_first_subunit_of_with_explicit_scope() -> None:
"""Test 'first [subunit] of [scope] [unit]' expressions that return a range."""
result = get_since_until("first week of this year")
assert result == (datetime(2016, 1, 1), datetime(2016, 1, 8))
result = get_since_until("first month of this quarter")
assert result == (datetime(2016, 10, 1), datetime(2016, 11, 1))
result = get_since_until("first week of last month")
assert result == (datetime(2016, 10, 1), datetime(2016, 10, 8))
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_first_subunit_of_with_default_scope() -> None:
"""Test 'first [subunit] of the [unit]' expressions that default to 'this'."""
result = get_since_until("first week of the year")
assert result == (datetime(2016, 1, 1), datetime(2016, 1, 8))
result = get_since_until("first month of the quarter")
assert result == (datetime(2016, 10, 1), datetime(2016, 11, 1))
# Tests for bounded whitespace regex patterns in time_range_lookup
@pytest.mark.parametrize(
"time_range",
[
"last 7 days : ",
"this week : ",
"start of next month : ",
"prior quarter : ",
"last 7 days : ",
"last 7 days : ",
"last 7 days : ",
"last 7 days : ",
"start of next month : ", # 5 spaces - valid
"last week : ",
"last week : ",
"last week : ",
"next 12 months : ",
"next 12 months : ",
"next 12 months : ",
"last 7days : ", # \s{0,5} allows 0 spaces after number - valid
],
)
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_time_range_bounded_whitespace_regex_valid(time_range: str) -> None:
"""Match expressions with 1-5 spaces between tokens."""
result = get_since_until(time_range)
assert result[0] is not None, f"Expected '{time_range}' to parse successfully"
@pytest.mark.parametrize(
"time_range",
[
"last 7 days : ",
"last7days : ",
"lastweek : ",
"last : ",
"start of : ",
"last 7 days extra : ",
],
)
@patch("superset.utils.date_parser.parse_human_datetime", mock_parse_human_datetime)
def test_time_range_bounded_whitespace_regex_invalid(time_range: str) -> None:
"""Reject expressions with 0 or 6+ spaces (fall back to DATETIME wrapping)."""
result = get_since_until(time_range)
assert result[0] is None, f"Expected '{time_range}' to NOT match bounded regex"
def test_datetime_eval_does_not_emit_parsedatetime_debug_logs(
caplog: pytest.LogCaptureFixture,
) -> None:
"""
Regression for #33365: ``parsedatetime`` emits a noisy DEBUG record
(``parsedatetime:eval now with context - False, False``) every time
``datetime_eval`` runs against a relative expression. In production
deployments running at DEBUG level this floods the logs — the user
report notes "this appears frequently" and a search of the issue
tracker turns up "dozens of places where people have posted a log
with that in it."
The fix is to silence the ``parsedatetime`` logger at module load
in ``superset/utils/date_parser.py`` (e.g.
``logging.getLogger("parsedatetime").setLevel(logging.WARNING)``).
Their own DEBUG output is internal library chatter that Superset
does not surface to operators in any actionable way.
This test captures all log records at DEBUG level during a single
``datetime_eval`` call and asserts that none of them come from the
``parsedatetime`` logger. If the suppression is removed or bypassed,
the test fails immediately.
"""
import logging
with caplog.at_level(logging.DEBUG):
datetime_eval("datetime('now')")
parsedatetime_records = [
r for r in caplog.records if r.name.startswith("parsedatetime")
]
assert not parsedatetime_records, (
"parsedatetime emitted DEBUG records during datetime_eval — these "
"flood production logs. Records: "
+ repr([(r.levelname, r.getMessage()) for r in parsedatetime_records])
)
|