forked from dbader/schedule
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_schedule.py
899 lines (769 loc) · 34.2 KB
/
test_schedule.py
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
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
"""Unit tests for schedule.py"""
import datetime
import functools
import mock
import unittest
import os
import time
# Silence "missing docstring", "method could be a function",
# "class already defined", and "too many public methods" messages:
# pylint: disable-msg=R0201,C0111,E0102,R0904,R0901
import schedule
from schedule import (
every,
repeat,
ScheduleError,
ScheduleValueError,
IntervalError,
)
# Set timezone to Europe/Berlin (CEST) to ensure global reproducibility
os.environ["TZ"] = "CET-1CEST,M3.5.0,M10.5.0"
time.tzset()
def make_mock_job(name=None):
job = mock.Mock()
job.__name__ = name or "job"
return job
class mock_datetime(object):
"""
Monkey-patch datetime for predictable results
"""
def __init__(self, year, month, day, hour, minute, second=0):
self.year = year
self.month = month
self.day = day
self.hour = hour
self.minute = minute
self.second = second
self.original_datetime = None
def __enter__(self):
class MockDate(datetime.datetime):
@classmethod
def today(cls):
return cls(self.year, self.month, self.day)
@classmethod
def now(cls):
return cls(
self.year,
self.month,
self.day,
self.hour,
self.minute,
self.second,
)
self.original_datetime = datetime.datetime
datetime.datetime = MockDate
return MockDate(
self.year, self.month, self.day, self.hour, self.minute, self.second
)
def __exit__(self, *args, **kwargs):
datetime.datetime = self.original_datetime
class SchedulerTests(unittest.TestCase):
def setUp(self):
schedule.clear()
def test_time_units(self):
assert every().seconds.unit == "seconds"
assert every().minutes.unit == "minutes"
assert every().hours.unit == "hours"
assert every().days.unit == "days"
assert every().weeks.unit == "weeks"
job_instance = schedule.Job(interval=2)
# without a context manager, it incorrectly raises an error because
# it is not callable
with self.assertRaises(IntervalError):
job_instance.minute
with self.assertRaises(IntervalError):
job_instance.hour
with self.assertRaises(IntervalError):
job_instance.day
with self.assertRaises(IntervalError):
job_instance.week
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.monday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.monday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.monday
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.tuesday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.tuesday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.tuesday
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.wednesday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.wednesday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.wednesday
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.thursday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.thursday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.thursday
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.friday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.friday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.friday
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.saturday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.saturday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.saturday
with self.assertRaisesRegex(
IntervalError,
(
r"Scheduling \.sunday\(\) jobs is only allowed for weekly jobs\. "
r"Using \.sunday\(\) on a job scheduled to run every 2 or more "
r"weeks is not supported\."
),
):
job_instance.sunday
# test an invalid unit
job_instance.unit = "foo"
self.assertRaises(ScheduleValueError, job_instance.at, "1:0:0")
self.assertRaises(ScheduleValueError, job_instance._schedule_next_run)
# test start day exists but unit is not 'weeks'
job_instance.unit = "days"
job_instance.start_day = 1
self.assertRaises(ScheduleValueError, job_instance._schedule_next_run)
# test weeks with an invalid start day
job_instance.unit = "weeks"
job_instance.start_day = "bar"
self.assertRaises(ScheduleValueError, job_instance._schedule_next_run)
# test a valid unit with invalid hours/minutes/seconds
job_instance.unit = "days"
self.assertRaises(ScheduleValueError, job_instance.at, "25:00:00")
self.assertRaises(ScheduleValueError, job_instance.at, "00:61:00")
self.assertRaises(ScheduleValueError, job_instance.at, "00:00:61")
# test invalid time format
self.assertRaises(ScheduleValueError, job_instance.at, "25:0:0")
self.assertRaises(ScheduleValueError, job_instance.at, "0:61:0")
self.assertRaises(ScheduleValueError, job_instance.at, "0:0:61")
# test (very specific) seconds with unspecified start_day
job_instance.unit = "seconds"
job_instance.at_time = datetime.datetime.now()
job_instance.start_day = None
self.assertRaises(ScheduleValueError, job_instance._schedule_next_run)
# test self.latest >= self.interval
job_instance.latest = 1
self.assertRaises(ScheduleError, job_instance._schedule_next_run)
job_instance.latest = 3
self.assertRaises(ScheduleError, job_instance._schedule_next_run)
def test_next_run_with_tag(self):
with mock_datetime(2014, 6, 28, 12, 0):
job1 = every(5).seconds.do(make_mock_job(name="job1")).tag("tag1")
job2 = every(2).hours.do(make_mock_job(name="job2")).tag("tag1", "tag2")
job3 = (
every(1)
.minutes.do(make_mock_job(name="job3"))
.tag("tag1", "tag3", "tag2")
)
assert schedule.next_run("tag1") == job1.next_run
assert schedule.default_scheduler.get_next_run("tag2") == job3.next_run
assert schedule.next_run("tag3") == job3.next_run
assert schedule.next_run("tag4") is None
def test_singular_time_units_match_plural_units(self):
assert every().second.unit == every().seconds.unit
assert every().minute.unit == every().minutes.unit
assert every().hour.unit == every().hours.unit
assert every().day.unit == every().days.unit
assert every().week.unit == every().weeks.unit
def test_time_range(self):
with mock_datetime(2014, 6, 28, 12, 0):
mock_job = make_mock_job()
# Choose a sample size large enough that it's unlikely the
# same value will be chosen each time.
minutes = set(
[
every(5).to(30).minutes.do(mock_job).next_run.minute
for i in range(100)
]
)
assert len(minutes) > 1
assert min(minutes) >= 5
assert max(minutes) <= 30
def test_time_range_repr(self):
mock_job = make_mock_job()
with mock_datetime(2014, 6, 28, 12, 0):
job_repr = repr(every(5).to(30).minutes.do(mock_job))
assert job_repr.startswith("Every 5 to 30 minutes do job()")
def test_at_time(self):
mock_job = make_mock_job()
assert every().day.at("10:30").do(mock_job).next_run.hour == 10
assert every().day.at("10:30").do(mock_job).next_run.minute == 30
assert every().day.at("20:59").do(mock_job).next_run.minute == 59
assert every().day.at("10:30:50").do(mock_job).next_run.second == 50
self.assertRaises(ScheduleValueError, every().day.at, "2:30:000001")
self.assertRaises(ScheduleValueError, every().day.at, "::2")
self.assertRaises(ScheduleValueError, every().day.at, ".2")
self.assertRaises(ScheduleValueError, every().day.at, "2")
self.assertRaises(ScheduleValueError, every().day.at, ":2")
self.assertRaises(ScheduleValueError, every().day.at, " 2:30:00")
self.assertRaises(ScheduleValueError, every().day.at, "59:59")
self.assertRaises(ScheduleValueError, every().do, lambda: 0)
self.assertRaises(TypeError, every().day.at, 2)
# without a context manager, it incorrectly raises an error because
# it is not callable
with self.assertRaises(IntervalError):
every(interval=2).second
with self.assertRaises(IntervalError):
every(interval=2).minute
with self.assertRaises(IntervalError):
every(interval=2).hour
with self.assertRaises(IntervalError):
every(interval=2).day
with self.assertRaises(IntervalError):
every(interval=2).week
with self.assertRaises(IntervalError):
every(interval=2).monday
with self.assertRaises(IntervalError):
every(interval=2).tuesday
with self.assertRaises(IntervalError):
every(interval=2).wednesday
with self.assertRaises(IntervalError):
every(interval=2).thursday
with self.assertRaises(IntervalError):
every(interval=2).friday
with self.assertRaises(IntervalError):
every(interval=2).saturday
with self.assertRaises(IntervalError):
every(interval=2).sunday
def test_until_time(self):
mock_job = make_mock_job()
# Check argument parsing
with mock_datetime(2020, 1, 1, 10, 0, 0) as m:
assert every().day.until(datetime.datetime(3000, 1, 1, 20, 30)).do(
mock_job
).cancel_after == datetime.datetime(3000, 1, 1, 20, 30, 0)
assert every().day.until(datetime.datetime(3000, 1, 1, 20, 30, 50)).do(
mock_job
).cancel_after == datetime.datetime(3000, 1, 1, 20, 30, 50)
assert every().day.until(datetime.time(12, 30)).do(
mock_job
).cancel_after == m.replace(hour=12, minute=30, second=0, microsecond=0)
assert every().day.until(datetime.time(12, 30, 50)).do(
mock_job
).cancel_after == m.replace(hour=12, minute=30, second=50, microsecond=0)
assert every().day.until(
datetime.timedelta(days=40, hours=5, minutes=12, seconds=42)
).do(mock_job).cancel_after == datetime.datetime(2020, 2, 10, 15, 12, 42)
assert every().day.until("10:30").do(mock_job).cancel_after == m.replace(
hour=10, minute=30, second=0, microsecond=0
)
assert every().day.until("10:30:50").do(mock_job).cancel_after == m.replace(
hour=10, minute=30, second=50, microsecond=0
)
assert every().day.until("3000-01-01 10:30").do(
mock_job
).cancel_after == datetime.datetime(3000, 1, 1, 10, 30, 0)
assert every().day.until("3000-01-01 10:30:50").do(
mock_job
).cancel_after == datetime.datetime(3000, 1, 1, 10, 30, 50)
assert every().day.until(datetime.datetime(3000, 1, 1, 10, 30, 50)).do(
mock_job
).cancel_after == datetime.datetime(3000, 1, 1, 10, 30, 50)
# Invalid argument types
self.assertRaises(TypeError, every().day.until, 123)
self.assertRaises(ScheduleValueError, every().day.until, "123")
self.assertRaises(ScheduleValueError, every().day.until, "01-01-3000")
# Using .until() with moments in the passed
self.assertRaises(
ScheduleValueError,
every().day.until,
datetime.datetime(2019, 12, 31, 23, 59),
)
self.assertRaises(
ScheduleValueError, every().day.until, datetime.timedelta(minutes=-1)
)
self.assertRaises(ScheduleValueError, every().day.until, datetime.time(hour=5))
# Unschedule job after next_run passes the deadline
schedule.clear()
with mock_datetime(2020, 1, 1, 11, 35, 10):
mock_job.reset_mock()
every(5).seconds.until(datetime.time(11, 35, 20)).do(mock_job)
with mock_datetime(2020, 1, 1, 11, 35, 15):
schedule.run_pending()
assert mock_job.call_count == 1
assert len(schedule.jobs) == 1
with mock_datetime(2020, 1, 1, 11, 35, 20):
schedule.run_all()
assert mock_job.call_count == 2
assert len(schedule.jobs) == 0
# Unschedule job because current execution time has passed deadline
schedule.clear()
with mock_datetime(2020, 1, 1, 11, 35, 10):
mock_job.reset_mock()
every(5).seconds.until(datetime.time(11, 35, 20)).do(mock_job)
with mock_datetime(2020, 1, 1, 11, 35, 50):
schedule.run_pending()
assert mock_job.call_count == 0
assert len(schedule.jobs) == 0
def test_weekday_at_todady(self):
mock_job = make_mock_job()
# This date is a wednesday
with mock_datetime(2020, 11, 25, 22, 38, 5):
job = every().wednesday.at("22:38:10").do(mock_job)
assert job.next_run.hour == 22
assert job.next_run.minute == 38
assert job.next_run.second == 10
assert job.next_run.year == 2020
assert job.next_run.month == 11
assert job.next_run.day == 25
job = every().wednesday.at("22:39").do(mock_job)
assert job.next_run.hour == 22
assert job.next_run.minute == 39
assert job.next_run.second == 00
assert job.next_run.year == 2020
assert job.next_run.month == 11
assert job.next_run.day == 25
def test_at_time_hour(self):
with mock_datetime(2010, 1, 6, 12, 20):
mock_job = make_mock_job()
assert every().hour.at(":30").do(mock_job).next_run.hour == 12
assert every().hour.at(":30").do(mock_job).next_run.minute == 30
assert every().hour.at(":30").do(mock_job).next_run.second == 0
assert every().hour.at(":10").do(mock_job).next_run.hour == 13
assert every().hour.at(":10").do(mock_job).next_run.minute == 10
assert every().hour.at(":10").do(mock_job).next_run.second == 0
assert every().hour.at(":00").do(mock_job).next_run.hour == 13
assert every().hour.at(":00").do(mock_job).next_run.minute == 0
assert every().hour.at(":00").do(mock_job).next_run.second == 0
self.assertRaises(ScheduleValueError, every().hour.at, "2:30:00")
self.assertRaises(ScheduleValueError, every().hour.at, "::2")
self.assertRaises(ScheduleValueError, every().hour.at, ".2")
self.assertRaises(ScheduleValueError, every().hour.at, "2")
self.assertRaises(ScheduleValueError, every().hour.at, " 2:30")
self.assertRaises(ScheduleValueError, every().hour.at, "61:00")
self.assertRaises(ScheduleValueError, every().hour.at, "00:61")
self.assertRaises(ScheduleValueError, every().hour.at, "01:61")
self.assertRaises(TypeError, every().hour.at, 2)
# test the 'MM:SS' format
assert every().hour.at("30:05").do(mock_job).next_run.hour == 12
assert every().hour.at("30:05").do(mock_job).next_run.minute == 30
assert every().hour.at("30:05").do(mock_job).next_run.second == 5
assert every().hour.at("10:25").do(mock_job).next_run.hour == 13
assert every().hour.at("10:25").do(mock_job).next_run.minute == 10
assert every().hour.at("10:25").do(mock_job).next_run.second == 25
assert every().hour.at("00:40").do(mock_job).next_run.hour == 13
assert every().hour.at("00:40").do(mock_job).next_run.minute == 0
assert every().hour.at("00:40").do(mock_job).next_run.second == 40
def test_at_time_minute(self):
with mock_datetime(2010, 1, 6, 12, 20, 30):
mock_job = make_mock_job()
assert every().minute.at(":40").do(mock_job).next_run.hour == 12
assert every().minute.at(":40").do(mock_job).next_run.minute == 20
assert every().minute.at(":40").do(mock_job).next_run.second == 40
assert every().minute.at(":10").do(mock_job).next_run.hour == 12
assert every().minute.at(":10").do(mock_job).next_run.minute == 21
assert every().minute.at(":10").do(mock_job).next_run.second == 10
self.assertRaises(ScheduleValueError, every().minute.at, "::2")
self.assertRaises(ScheduleValueError, every().minute.at, ".2")
self.assertRaises(ScheduleValueError, every().minute.at, "2")
self.assertRaises(ScheduleValueError, every().minute.at, "2:30:00")
self.assertRaises(ScheduleValueError, every().minute.at, "2:30")
self.assertRaises(ScheduleValueError, every().minute.at, " :30")
self.assertRaises(TypeError, every().minute.at, 2)
def test_next_run_time(self):
with mock_datetime(2010, 1, 6, 12, 15):
mock_job = make_mock_job()
assert schedule.next_run() is None
assert every().minute.do(mock_job).next_run.minute == 16
assert every(5).minutes.do(mock_job).next_run.minute == 20
assert every().hour.do(mock_job).next_run.hour == 13
assert every().day.do(mock_job).next_run.day == 7
assert every().day.at("09:00").do(mock_job).next_run.day == 7
assert every().day.at("12:30").do(mock_job).next_run.day == 6
assert every().week.do(mock_job).next_run.day == 13
assert every().monday.do(mock_job).next_run.day == 11
assert every().tuesday.do(mock_job).next_run.day == 12
assert every().wednesday.do(mock_job).next_run.day == 13
assert every().thursday.do(mock_job).next_run.day == 7
assert every().friday.do(mock_job).next_run.day == 8
assert every().saturday.do(mock_job).next_run.day == 9
assert every().sunday.do(mock_job).next_run.day == 10
assert (
every().minute.until(datetime.time(12, 17)).do(mock_job).next_run.minute
== 16
)
def test_next_run_time_day_end(self):
mock_job = make_mock_job()
# At day 1, schedule job to run at daily 23:30
with mock_datetime(2010, 12, 1, 23, 0, 0):
job = every().day.at("23:30").do(mock_job)
# first occurrence same day
assert job.next_run.day == 1
assert job.next_run.hour == 23
# Running the job 01:00 on day 2, afterwards the job should be
# scheduled at 23:30 the same day. This simulates a job that started
# on day 1 at 23:30 and took 1,5 hours to finish
with mock_datetime(2010, 12, 2, 1, 0, 0):
job.run()
assert job.next_run.day == 2
assert job.next_run.hour == 23
# Run the job at 23:30 on day 2, afterwards the job should be
# scheduled at 23:30 the next day
with mock_datetime(2010, 12, 2, 23, 30, 0):
job.run()
assert job.next_run.day == 3
assert job.next_run.hour == 23
def test_next_run_time_hour_end(self):
mock_job = make_mock_job()
with mock_datetime(2010, 10, 10, 12, 0, 0):
job = every().hour.at(":10").do(mock_job)
assert job.next_run.hour == 12
assert job.next_run.minute == 10
with mock_datetime(2010, 10, 10, 13, 0, 0):
job.run()
assert job.next_run.hour == 13
assert job.next_run.minute == 10
with mock_datetime(2010, 10, 10, 13, 15, 0):
job.run()
assert job.next_run.hour == 14
assert job.next_run.minute == 10
def test_next_run_time_minute_end(self):
mock_job = make_mock_job()
with mock_datetime(2010, 10, 10, 10, 10, 0):
job = every().minute.at(":15").do(mock_job)
assert job.next_run.minute == 10
assert job.next_run.second == 15
with mock_datetime(2010, 10, 10, 10, 10, 59):
job.run()
assert job.next_run.minute == 11
assert job.next_run.second == 15
with mock_datetime(2010, 10, 10, 10, 12, 14):
job.run()
assert job.next_run.minute == 12
assert job.next_run.second == 15
with mock_datetime(2010, 10, 10, 10, 12, 16):
job.run()
assert job.next_run.minute == 13
assert job.next_run.second == 15
def test_at_timezone(self):
mock_job = make_mock_job()
try:
import pytz
except ModuleNotFoundError:
self.skipTest("pytz unavailable")
return
with mock_datetime(2022, 2, 1, 23, 15):
# Current Berlin time: feb-1 23:15 (local)
# Current India time: feb-2 03:45
# Expected to run India time: feb-2 06:30
# Next run Berlin time: feb-2 02:00
next = every().day.at("06:30", "Asia/Kolkata").do(mock_job).next_run
assert next.hour == 2
assert next.minute == 0
with mock_datetime(2022, 4, 8, 10, 0):
# Current Berlin time: 10:00 (local) (during daylight saving)
# Current NY time: 04:00
# Expected to run NY time: 10:30
# Next run Berlin time: 16:30
next = every().day.at("10:30", "America/New_York").do(mock_job).next_run
assert next.hour == 16
assert next.minute == 30
with mock_datetime(2022, 3, 20, 10, 0):
# Current Berlin time: 10:00 (local) (NOT during daylight saving)
# Current NY time: 04:00 (during daylight saving)
# Expected to run NY time: 10:30
# Next run Berlin time: 15:30
tz = pytz.timezone("America/New_York")
next = every().day.at("10:30", tz).do(mock_job).next_run
assert next.hour == 15
assert next.minute == 30
with self.assertRaises(pytz.exceptions.UnknownTimeZoneError):
every().day.at("10:30", "FakeZone").do(mock_job)
with self.assertRaises(ScheduleValueError):
every().day.at("10:30", 43).do(mock_job)
def test_daylight_saving_time(self):
mock_job = make_mock_job()
# 27 March 2022, 02:00:00 clocks were turned forward 1 hour
with mock_datetime(2022, 3, 27, 0, 0):
assert every(4).hours.do(mock_job).next_run.hour == 4
# Sunday, 30 October 2022, 03:00:00 clocks were turned backward 1 hour
with mock_datetime(2022, 10, 30, 0, 0):
assert every(4).hours.do(mock_job).next_run.hour == 4
def test_run_all(self):
mock_job = make_mock_job()
every().minute.do(mock_job)
every().hour.do(mock_job)
every().day.at("11:00").do(mock_job)
schedule.run_all()
assert mock_job.call_count == 3
def test_run_all_with_decorator(self):
mock_job = make_mock_job()
@repeat(every().minute)
def job1():
mock_job()
@repeat(every().hour)
def job2():
mock_job()
@repeat(every().day.at("11:00"))
def job3():
mock_job()
schedule.run_all()
assert mock_job.call_count == 3
def test_run_all_with_decorator_args(self):
mock_job = make_mock_job()
@repeat(every().minute, 1, 2, "three", foo=23, bar={})
def job(*args, **kwargs):
mock_job(*args, **kwargs)
schedule.run_all()
mock_job.assert_called_once_with(1, 2, "three", foo=23, bar={})
def test_run_all_with_decorator_defaultargs(self):
mock_job = make_mock_job()
@repeat(every().minute)
def job(nothing=None):
mock_job(nothing)
schedule.run_all()
mock_job.assert_called_once_with(None)
def test_job_func_args_are_passed_on(self):
mock_job = make_mock_job()
every().second.do(mock_job, 1, 2, "three", foo=23, bar={})
schedule.run_all()
mock_job.assert_called_once_with(1, 2, "three", foo=23, bar={})
def test_to_string(self):
def job_fun():
pass
s = str(every().minute.do(job_fun, "foo", bar=23))
assert s == (
"Job(interval=1, unit=minutes, do=job_fun, "
"args=('foo',), kwargs={'bar': 23})"
)
assert "job_fun" in s
assert "foo" in s
assert "{'bar': 23}" in s
def test_to_repr(self):
def job_fun():
pass
s = repr(every().minute.do(job_fun, "foo", bar=23))
assert s.startswith(
"Every 1 minute do job_fun('foo', bar=23) (last run: [never], next run: "
)
assert "job_fun" in s
assert "foo" in s
assert "bar=23" in s
# test repr when at_time is not None
s2 = repr(every().day.at("00:00").do(job_fun, "foo", bar=23))
assert s2.startswith(
(
"Every 1 day at 00:00:00 do job_fun('foo', "
"bar=23) (last run: [never], next run: "
)
)
def test_to_string_lambda_job_func(self):
assert len(str(every().minute.do(lambda: 1))) > 1
assert len(str(every().day.at("10:30").do(lambda: 1))) > 1
def test_repr_functools_partial_job_func(self):
def job_fun(arg):
pass
job_fun = functools.partial(job_fun, "foo")
job_repr = repr(every().minute.do(job_fun, bar=True, somekey=23))
assert "functools.partial" in job_repr
assert "bar=True" in job_repr
assert "somekey=23" in job_repr
def test_to_string_functools_partial_job_func(self):
def job_fun(arg):
pass
job_fun = functools.partial(job_fun, "foo")
job_str = str(every().minute.do(job_fun, bar=True, somekey=23))
assert "functools.partial" in job_str
assert "bar=True" in job_str
assert "somekey=23" in job_str
def test_run_pending(self):
"""Check that run_pending() runs pending jobs.
We do this by overriding datetime.datetime with mock objects
that represent increasing system times.
Please note that it is *intended behavior that run_pending() does not
run missed jobs*. For example, if you've registered a job that
should run every minute and you only call run_pending() in one hour
increments then your job won't be run 60 times in between but
only once.
"""
mock_job = make_mock_job()
with mock_datetime(2010, 1, 6, 12, 15):
every().minute.do(mock_job)
every().hour.do(mock_job)
every().day.do(mock_job)
every().sunday.do(mock_job)
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 6, 12, 16):
schedule.run_pending()
assert mock_job.call_count == 1
with mock_datetime(2010, 1, 6, 13, 16):
mock_job.reset_mock()
schedule.run_pending()
assert mock_job.call_count == 2
with mock_datetime(2010, 1, 7, 13, 16):
mock_job.reset_mock()
schedule.run_pending()
assert mock_job.call_count == 3
with mock_datetime(2010, 1, 10, 13, 16):
mock_job.reset_mock()
schedule.run_pending()
assert mock_job.call_count == 4
def test_run_every_weekday_at_specific_time_today(self):
mock_job = make_mock_job()
with mock_datetime(2010, 1, 6, 13, 16):
every().wednesday.at("14:12").do(mock_job)
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 6, 14, 16):
schedule.run_pending()
assert mock_job.call_count == 1
def test_run_every_weekday_at_specific_time_past_today(self):
mock_job = make_mock_job()
with mock_datetime(2010, 1, 6, 13, 16):
every().wednesday.at("13:15").do(mock_job)
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 13, 13, 14):
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 13, 13, 16):
schedule.run_pending()
assert mock_job.call_count == 1
def test_run_every_n_days_at_specific_time(self):
mock_job = make_mock_job()
with mock_datetime(2010, 1, 6, 11, 29):
every(2).days.at("11:30").do(mock_job)
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 6, 11, 31):
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 7, 11, 31):
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 8, 11, 29):
schedule.run_pending()
assert mock_job.call_count == 0
with mock_datetime(2010, 1, 8, 11, 31):
schedule.run_pending()
assert mock_job.call_count == 1
with mock_datetime(2010, 1, 10, 11, 31):
schedule.run_pending()
assert mock_job.call_count == 2
def test_next_run_property(self):
original_datetime = datetime.datetime
with mock_datetime(2010, 1, 6, 13, 16):
hourly_job = make_mock_job("hourly")
daily_job = make_mock_job("daily")
every().day.do(daily_job)
every().hour.do(hourly_job)
assert len(schedule.jobs) == 2
# Make sure the hourly job is first
assert schedule.next_run() == original_datetime(2010, 1, 6, 14, 16)
def test_idle_seconds(self):
assert schedule.default_scheduler.next_run is None
assert schedule.idle_seconds() is None
mock_job = make_mock_job()
with mock_datetime(2020, 12, 9, 21, 46):
job = every().hour.do(mock_job)
assert schedule.idle_seconds() == 60 * 60
schedule.cancel_job(job)
assert schedule.next_run() is None
assert schedule.idle_seconds() is None
def test_cancel_job(self):
def stop_job():
return schedule.CancelJob
mock_job = make_mock_job()
every().second.do(stop_job)
mj = every().second.do(mock_job)
assert len(schedule.jobs) == 2
schedule.run_all()
assert len(schedule.jobs) == 1
assert schedule.jobs[0] == mj
schedule.cancel_job("Not a job")
assert len(schedule.jobs) == 1
schedule.default_scheduler.cancel_job("Not a job")
assert len(schedule.jobs) == 1
schedule.cancel_job(mj)
assert len(schedule.jobs) == 0
def test_cancel_jobs(self):
def stop_job():
return schedule.CancelJob
every().second.do(stop_job)
every().second.do(stop_job)
every().second.do(stop_job)
assert len(schedule.jobs) == 3
schedule.run_all()
assert len(schedule.jobs) == 0
def test_tag_type_enforcement(self):
job1 = every().second.do(make_mock_job(name="job1"))
self.assertRaises(TypeError, job1.tag, {})
self.assertRaises(TypeError, job1.tag, 1, "a", [])
job1.tag(0, "a", True)
assert len(job1.tags) == 3
def test_get_by_tag(self):
every().second.do(make_mock_job()).tag("job1", "tag1")
every().second.do(make_mock_job()).tag("job2", "tag2", "tag4")
every().second.do(make_mock_job()).tag("job3", "tag3", "tag4")
# Test None input yields all 3
jobs = schedule.get_jobs()
assert len(jobs) == 3
assert {"job1", "job2", "job3"}.issubset(
{*jobs[0].tags, *jobs[1].tags, *jobs[2].tags}
)
# Test each 1:1 tag:job
jobs = schedule.get_jobs("tag1")
assert len(jobs) == 1
assert "job1" in jobs[0].tags
# Test multiple jobs found.
jobs = schedule.get_jobs("tag4")
assert len(jobs) == 2
assert "job1" not in {*jobs[0].tags, *jobs[1].tags}
# Test no tag.
jobs = schedule.get_jobs("tag5")
assert len(jobs) == 0
schedule.clear()
assert len(schedule.jobs) == 0
def test_clear_by_tag(self):
every().second.do(make_mock_job(name="job1")).tag("tag1")
every().second.do(make_mock_job(name="job2")).tag("tag1", "tag2")
every().second.do(make_mock_job(name="job3")).tag(
"tag3", "tag3", "tag3", "tag2"
)
assert len(schedule.jobs) == 3
schedule.run_all()
assert len(schedule.jobs) == 3
schedule.clear("tag3")
assert len(schedule.jobs) == 2
schedule.clear("tag1")
assert len(schedule.jobs) == 0
every().second.do(make_mock_job(name="job1"))
every().second.do(make_mock_job(name="job2"))
every().second.do(make_mock_job(name="job3"))
schedule.clear()
assert len(schedule.jobs) == 0
def test_misconfigured_job_wont_break_scheduler(self):
"""
Ensure an interrupted job definition chain won't break
the scheduler instance permanently.
"""
scheduler = schedule.Scheduler()
scheduler.every()
scheduler.every(10).seconds
scheduler.run_pending()