[103] add hourly and weekly ranges

pull/1582/head
meisnate12 1 year ago
parent 673d057ac8
commit afe1f6e32d

@ -1 +1 @@
1.19.0-develop102 1.19.0-develop103

@ -10,17 +10,17 @@ These schedules do not trigger PMM to run; they control what PMM will do if it h
The scheduling options are: The scheduling options are:
| Name | Description | Format | Example | | Name | Description | Format | Example |
|:-------------|:-------------------------------------------------------------------------------------------------|:----------------------|:----------------------------------| |:-------------|:-----------------------------------------------------------------------------------------------------------|:---------------------------------------------------|:-------------------------------------------------------------|
| Hourly | Update only when the script is run in that hour | hourly(Hour of Day) | `hourly(17)` | | Hourly | Update only when the script is run in that hour or hour range | hourly(Hour of Day)<br>hourly(Start Hour-End Hour) | `hourly(17)`<br>`hourly(17-04)` |
| Daily | Update once a day | daily | `daily` | | Daily | Update once a day | daily | `daily` |
| Weekly | Update once a week on the specified day | weekly(Day of Week) | `weekly(sunday)` | | Weekly | Update once a week on the specified days (For multiple days use a bar-separated (<code>&#124;</code>) list | weekly(Days of Week) | `weekly(sunday)`<br><code>weekly(sunday&#124;tuesday)</code> |
| Monthly | Update once a month on the specified day | monthly(Day of Month) | `monthly(1)` | | Monthly | Update once a month on the specified day | monthly(Day of Month) | `monthly(1)` |
| Yearly | Update once a year on the specified day | yearly(MM/DD) | `yearly(01/30)` | | Yearly | Update once a year on the specified day | yearly(MM/DD) | `yearly(01/30)` |
| Range | Updates whenever the date is within the range | range(MM/DD-MM/DD) | `range(12/01-12/31)` | | Range | Updates whenever the date is within the range | range(MM/DD-MM/DD) | `range(12/01-12/31)` |
| Never | Never updates | never | `never` | | Never | Never updates | never | `never` |
| Non Existing | Updates if it doesn't exist | non_existing | `non_existing` | | Non Existing | Updates if it doesn't exist | non_existing | `non_existing` |
| All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` | | All | Requires that all comma separated scheduling options inside its brackets be meet in order to run | all[Options] | `all[weekly(sunday), hourly(17)]` |
* `daily` is the default when `schedule` is not specified. * `daily` is the default when `schedule` is not specified.
* You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../../home/environmental.md#time-to-run). * You can run the script multiple times per day but using the `--time` command line argument detailed on the [Run Commands & Environmental Variables Page](../../home/environmental.md#time-to-run).

@ -603,22 +603,47 @@ def schedule_check(attribute, data, current_time, run_hour, is_all=False):
continue continue
param = match.group(1) param = match.group(1)
if run_time.startswith("hour"): if run_time.startswith("hour"):
try: if "-" in run_time:
if 0 <= int(param) <= 23: start, end = run_time.split("-")
schedule_str += f"\nScheduled to run on the {num2words(param, to='ordinal_num')} hour" try:
if run_hour == int(param): start = int(start)
all_check += 1 end = int(end)
else: if start != end and 0 <= start <= 23 and 0 <= end <= 23:
raise ValueError schedule_str += f"\nScheduled to run between the {num2words(start, to='ordinal_num')} hour and the {num2words(end, to='ordinal_num')} hour"
except ValueError: if end > start and start <= run_hour <= end:
logger.error(f"Schedule Error: hourly {display} must be an integer between 0 and 23") all_check += 1
elif start > end and (start <= run_hour or run_hour <= end):
all_check += 1
else:
raise ValueError
except ValueError:
logger.error(f"Schedule Error: hourly {start}-{end} each must be a different integer between 0 and 23")
else:
try:
if 0 <= int(param) <= 23:
schedule_str += f"\nScheduled to run on the {num2words(param, to='ordinal_num')} hour"
if run_hour == int(param):
all_check += 1
else:
raise ValueError
except ValueError:
logger.error(f"Schedule Error: hourly {display} must be an integer between 0 and 23")
elif run_time.startswith("week"): elif run_time.startswith("week"):
if param.lower() not in days_alias: ok_days = param.lower().split("|")
logger.error(f"Schedule Error: weekly {display} must be a day of the week i.e. weekly(Monday)") err = None
for ok_day in ok_days:
if ok_day not in days_alias:
err = f"Schedule Error: weekly {display} must be a day of the week i.e. weekly(Monday)"
if err:
logger.error(err)
continue continue
weekday = days_alias[param.lower()] pass_day = False
schedule_str += f"\nScheduled weekly on {pretty_days[weekday]}" for ok_day in ok_days:
if weekday == current_time.weekday(): weekday = days_alias[ok_day]
schedule_str += f"\nScheduled weekly on {pretty_days[weekday]}"
if weekday == current_time.weekday():
pass_day = True
if pass_day:
all_check += 1 all_check += 1
elif run_time.startswith("month"): elif run_time.startswith("month"):
try: try:

Loading…
Cancel
Save