prefect.server.schemas.schedules
¶
Schedule schemas
CronSchedule
¶
Bases: PrefectBaseModel
Cron schedule
NOTE: If the timezone is a DST-observing one, then the schedule will adjust itself appropriately. Cron's rules for DST are based on schedule times, not intervals. This means that an hourly cron schedule will fire on every new schedule hour, not every elapsed hour; for example, when clocks are set back this will result in a two-hour pause as the schedule will fire the first time 1am is reached and the first time 2am is reached, 120 minutes later. Longer schedules, such as one that fires at 9am every morning, will automatically adjust for DST.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cron |
str
|
a valid cron string |
required |
timezone |
str
|
a valid timezone string in IANA tzdata format (for example, America/New_York). |
required |
day_or |
bool
|
Control how croniter handles |
required |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
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 |
|
get_dates
async
¶
Retrieves dates from the schedule. Up to 1,000 candidate dates are checked following the start date.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n |
int
|
The number of dates to generate |
None
|
start |
datetime
|
The first returned date will be on or after this date. Defaults to None. If a timezone-naive datetime is provided, it is assumed to be in the schedule's timezone. |
None
|
end |
datetime
|
The maximum scheduled date to return. If a timezone-naive datetime is provided, it is assumed to be in the schedule's timezone. |
None
|
Returns:
Type | Description |
---|---|
List[DateTime]
|
List[pendulum.DateTime]: A list of dates |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
|
IntervalSchedule
¶
Bases: PrefectBaseModel
A schedule formed by adding interval
increments to an anchor_date
. If no
anchor_date
is supplied, the current UTC time is used. If a
timezone-naive datetime is provided for anchor_date
, it is assumed to be
in the schedule's timezone (or UTC). Even if supplied with an IANA timezone,
anchor dates are always stored as UTC offsets, so a timezone
can be
provided to determine localization behaviors like DST boundary handling. If
none is provided it will be inferred from the anchor date.
NOTE: If the IntervalSchedule
anchor_date
or timezone
is provided in a
DST-observing timezone, then the schedule will adjust itself appropriately.
Intervals greater than 24 hours will follow DST conventions, while intervals
of less than 24 hours will follow UTC intervals. For example, an hourly
schedule will fire every UTC hour, even across DST boundaries. When clocks
are set back, this will result in two runs that appear to both be
scheduled for 1am local time, even though they are an hour apart in UTC
time. For longer intervals, like a daily schedule, the interval schedule
will adjust for DST boundaries so that the clock-hour remains constant. This
means that a daily schedule that always fires at 9am will observe DST and
continue to fire at 9am in the local time zone.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interval |
timedelta
|
an interval to schedule on |
required |
anchor_date |
DateTimeTZ
|
an anchor date to schedule increments against; if not provided, the current timestamp will be used |
required |
timezone |
str
|
a valid timezone string |
required |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
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 |
|
get_dates
async
¶
Retrieves dates from the schedule. Up to 1,000 candidate dates are checked following the start date.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n |
int
|
The number of dates to generate |
None
|
start |
datetime
|
The first returned date will be on or after this date. Defaults to None. If a timezone-naive datetime is provided, it is assumed to be in the schedule's timezone. |
None
|
end |
datetime
|
The maximum scheduled date to return. If a timezone-naive datetime is provided, it is assumed to be in the schedule's timezone. |
None
|
Returns:
Type | Description |
---|---|
List[DateTime]
|
List[pendulum.DateTime]: A list of dates |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
|
RRuleSchedule
¶
Bases: PrefectBaseModel
RRule schedule, based on the iCalendar standard
(RFC 5545) as
implemented in dateutils.rrule
.
RRules are appropriate for any kind of calendar-date manipulation, including irregular intervals, repetition, exclusions, week day or day-of-month adjustments, and more.
Note that as a calendar-oriented standard, RRuleSchedules
are sensitive to
to the initial timezone provided. A 9am daily schedule with a daylight saving
time-aware start date will maintain a local 9am time through DST boundaries;
a 9am daily schedule with a UTC start date will maintain a 9am UTC time.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
rrule |
str
|
a valid RRule string |
required |
timezone |
str
|
a valid timezone string |
required |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
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 |
|
get_dates
async
¶
Retrieves dates from the schedule. Up to 1,000 candidate dates are checked following the start date.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
n |
int
|
The number of dates to generate |
None
|
start |
datetime
|
The first returned date will be on or after this date. Defaults to None. If a timezone-naive datetime is provided, it is assumed to be in the schedule's timezone. |
None
|
end |
datetime
|
The maximum scheduled date to return. If a timezone-naive datetime is provided, it is assumed to be in the schedule's timezone. |
None
|
Returns:
Type | Description |
---|---|
List[DateTime]
|
List[pendulum.DateTime]: A list of dates |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 |
|
to_rrule
¶
Since rrule doesn't properly serialize/deserialize timezones, we localize dates here
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/schedules.py
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 |
|