# datetime_schedule
#
# @desc     Executes the function 'function' at the given time(s). This will
#               create a new thread for each scheduling event.
#
# @param    string      task_id         Unique task identifier.
#
# @param    labmda      function        Function to be executed.
# @param    []          arguments       Arguments for the function.
#
# @param    int / [int] year            Year.
# @param    int / [int] month           Month.
# @param    int / [int] week            Week.
# @param    int / [int] day             Day.
# @param    int / [int] hour            Hour.
# @param    int / [int] minute          Minute.
# @param    int / [int] second          Second.
#
# @param    bool        catchup         Catch-up scheduling events that occured
#                                           when the script was not running.
# @param    (int, int)  catchup_delay   Min and Max delay (in seconds) for
#                                           starting the catch-up job.
#
# @info     Set year / month / ... = None or empty list to execute the function
#               at every year / month / ...
#
# @raises   ValueError                  Raises a ValueError if the given task_id
#                                           is already in use.
def datetime_schedule(task_id, function, arguments, year, month, week, day, hour, minute, second, catchup = False, catchup_delay = None):
    ...

import TaskScheduler

def backup():
    # make backup
    print('Backup finished.')

# Start backup every day at 3:00 AM
datetime_schedule('dailyBackup', backup, [], None, None, None, None, 3, 0, 0)

# Start backup every day at 3:00 AM if month is between January and April
datetime_schedule('dailyBackupJanToApr', backup, [], None, [1, 2, 3, 4], None, None, 3, 0, 0)

# Start backup on the first day of every month at 3:00 AM
datetime_schedule('monthlyBackup', backup, [], None, None, None, 1, 3, 0, 0)

import TaskScheduler

def backup():
    # make backup
    print('Backup finished.')

# Start backup every day at 3:00 AM.
# If the laptop was turned off at 3:00 AM, start the backup when starting the
#     script with a delay between 30 seconds and 5 minutes.
datetime_schedule('dailyBackup', backup, [], None, None, None, None, 3, 0, 0, True, (30, 300))

# reccuring_schedule
#
# @desc     Executes the function 'function' every delay seconds.
#
# @param    string      task_id         Unique task identifier.
# @param    [string]    groups          Groups the task is part of.
#
# @param    labmda      function        Function to be executed.
# @param    []          arguments       Arguments for the function.
#
# @param    int         timedelta       "Delay".
#
# @param    bool        use_exec_log    If True, will check the execution log
#                                           to calculate the first execution
#                                           datetime.
#
# @param    int         max_instances   Maximum number of instances of the
#                                           function running simultaniously.
# @param    (int, int)  priority        Priority of the task. The first value
#                                           is the "fixed" priority. The second
#                                           value will be multiplied with the
#                                           number of second the task is
#                                           overdue.
#
# @info     total_priority = first_val + <seconds_overdue> * second_val
def reccuring_schedule(task_id, groups, function, arguments, timedelta, use_exec_log = False, max_instances = 1, priority = (0, 0)):
    ...

# set_reccuring_group
#
# @param    string      group_id        Group ID.
# @param    int         max_tasks       Maximum number of tasks allowed to run
#                                           simultaniously.
# @param    int         priority        Priority of the group. Prefer a group
#                                           with higher priority.
#
# @info     Set max_tasks = -1 for unlimited tasks.
def set_reccuring_group(group_id, max_tasks, priority = 0):
    ...

def func():
    print('Function started.')

# Execute a function every minute
reccuring_schedule('task_1', [], func, [], timedelta(seconds=60))

def backup(increment):
    # make backup
    print(f'Backup "{increment}" finished')


set_reccuring_group('backups', 4, priority = 0)

# "short-term" backups
set_reccuring_group('short_term', 2, priority = 1)
reccuring_schedule('backup_5min', ['backups', 'short_term'], backup, ['5min'], timedelta(seconds=60*5), priority=(2,0))
reccuring_schedule('backup_10min', ['backups', 'short_term'], backup, ['10min'], timedelta(seconds=60*10), priority=(1,0))
reccuring_schedule('backup_30min', ['backups', 'short_term'], backup, ['30min'], timedelta(seconds=60*30), priority=(0,0))

# "mid-term" backups
set_reccuring_group('mid_term', 2, priority = 2)
reccuring_schedule('backup_1hour', ['backups', 'mid_term'], backup, ['1hour'], timedelta(seconds=60*60), priority=(60*60*3,0))
reccuring_schedule('backup_1day', ['backups', 'mid_term'], backup, ['1day'], timedelta(seconds=60*60*24), priority=(0,1))

# "long-term" backups
set_reccuring_group('long_term', 1, priority = 3)
reccuring_schedule('backup_1month', ['backups', 'long_term'], backup, ['1month'], timedelta(seconds=60*60*24*30), priority=(0,0), use_exec_log = True)
reccuring_schedule('backup_1year', ['backups', 'long_term'], backup, ['1year'], timedelta(seconds=60*60*24*365), priority=(1,0), use_exec_log = True)