AjvdZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z m Z mZejdZGddeZGdd eZGd d eZGd d ZGddZGddZeZejZd!dedefdZd"dZd#deddfdZd$de ede efdZd$de eddfdZdeddfdZ d$de ede ejfdZ!de e"fdZ#d Z$dS)%a Python job scheduling for humans. github.com/dbader/schedule An in-process scheduler for periodic jobs that uses the builder pattern for configuration. Schedule lets you run Python functions (or any other callable) periodically at pre-determined intervals using a simple, human-friendly syntax. Inspired by Addam Wiggins' article "Rethinking Cron" [1] and the "clockwork" Ruby module [2][3]. Features: - A simple to use API for scheduling jobs. - Very lightweight and no external dependencies. - Excellent test coverage. - Tested on Python 3.7, 3.8, 3.9, 3.10 and 3.11 Usage: >>> import schedule >>> import time >>> def job(message='stuff'): >>> print("I'm working on:", message) >>> schedule.every(10).minutes.do(job) >>> schedule.every(5).to(10).days.do(job) >>> schedule.every().hour.do(job, message='things') >>> schedule.every().day.at("10:30").do(job) >>> while True: >>> schedule.run_pending() >>> time.sleep(1) [1] https://adam.herokuapp.com/past/2010/4/13/rethinking_cron/ [2] https://github.com/Rykian/clockwork [3] https://adam.herokuapp.com/past/2010/6/30/replace_cron_with_clockwork/ )HashableN)SetListOptionalCallableUnionscheduleceZdZdZdS) ScheduleErrorzBase schedule exceptionN__name__ __module__ __qualname____doc__UC:\Projects\Historical\FacebookAutoPoster\venv\Lib\site-packages\schedule/__init__.pyr r 4s!!Drr ceZdZdZdS)ScheduleValueErrorzBase schedule value errorNr rrrrr:s##DrrceZdZdZdS) IntervalErrorzAn improper interval was usedNr rrrrr@s''DrrceZdZdZdS) CancelJobz: Can be returned from a job to unschedule itself. Nr rrrrrFs DrrceZdZdZddZddZddeddfdZdd ee de d fd Z dd ee ddfd Z ddZ ddedd fdZddZ dd ee deejfdZeeZedeefdZdS) Schedulerz Objects instantiated by the :class:`Scheduler ` are factories to create jobs, keep record of scheduled jobs and handle their execution. returnNcg|_dSNjobsselfs r__init__zScheduler.__init__Us ! rcvd|jD}t|D]}||dS)at Run all jobs that are scheduled to run. 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. c3(K|] }|j |VdSr) should_run).0jobs r z(Scheduler.run_pending..bs)DDS^DDDDDDDrN)r sorted_run_job)r" runnable_jobsr(s r run_pendingzScheduler.run_pendingXsPED DDD -((  C MM#      rr delay_secondsctdt|j||jddD]+}||t j|,dS)a4 Run all jobs regardless if they are scheduled to run or not. A delay of `delay` seconds is added between each job. This helps distribute system load generated by the jobs more evenly over time. :param delay_seconds: A delay added between every executed job z/Running *all* %i jobs with %is delay in betweenN)loggerdebuglenr r+timesleep)r"r.r(s rrun_allzScheduler.run_allfsu  =  NN    9QQQ< & &C MM#    J} % % % % & &rtagJobcL|jddSfd|jDS)z Gets scheduled jobs marked with the given tag, or all jobs if tag is omitted. :param tag: An identifier used to identify a subset of jobs to retrieve Nc&g|] }|jv |Srtagsr'r(r6s r z&Scheduler.get_jobs..s @@@CsxCrrr"r6s `rget_jobszScheduler.get_jobsys6 ;9QQQ< @@@@49@@@ @rc&td|jdd=dStdfd|jD|jdd<dS)z Deletes scheduled jobs marked with the given tag, or all jobs if tag is omitted. :param tag: An identifier used to identify a subset of jobs to delete NzDeleting *all* jobszDeleting all jobs tagged "%s"c3.K|]}|jv |VdSrr:r<s rr)z"Scheduler.clear..s/LLC388K8KC8K8K8K8KLLr)r0r1r r>s `rclearzScheduler.clearsl ; LL. / / / !!! LL8# > > >LLLL49LLLDIaaaLLLrr(c tdt||j|dS#t $r,tdt|YdSwxYw)zX Delete a scheduled job. :param job: The job to be unscheduled zCancelling job "%s"z!Cancelling not-scheduled job "%s"N)r0r1strr remove ValueError)r"r(s r cancel_jobzScheduler.cancel_jobs  H LL.C 9 9 9 I  S ! ! ! ! ! H H H LL` )r7)r"rIr(s reveryzScheduler.everys(D!! rc|}t|ts |tur||dSdSr)run isinstancerrG)r"r(rets rr+zScheduler._run_jobsKggii c9 % % ! )9)9 OOC *:)9rcn|jsdS||}|sdSt|jS)z Datetime when the next job should run. :param tag: Filter the next run for the given tag parameter :return: A :class:`~datetime.datetime` object or None if no jobs scheduled N)r r?minnext_run)r"r6 jobs_filtereds r get_next_runzScheduler.get_next_runsBy 4 c**  4=!!**rc|jsdS|jtjz S)z :return: Number of seconds until :meth:`next_run ` or None if no jobs are scheduled N)rRdatetimenow total_secondsr!s r idle_secondszScheduler.idle_secondss;} 4  1 5 5 7 77FFHHHrrNrr)r(r7rNrH)r rrrr#r-intr5rrrr?rBrGrKr+rVrTpropertyrRfloatrYrrrrrNs """"    &&S&&&&&& A AHX. A$u+ A A A A M M(+ Mt M M M M H H H Hc%!!!! )-++H%+ (# $++++$x %%H IhuoIIIXIIIrrceZdZdZd.dedeefdZdefdZ de fdZ d Z e d Ze d Ze d Ze d Ze dZe dZe dZe dZe dZe dZe dZe dZe dZe dZe dZe dZe dZdefdZ d.de dee fdZ!d efd!Z"d"e#e$j$e$j%e$j&e ffd#Z'd$e(fd%Z)e defd&Z*d'Z+d/d(Z,d)e$j$fd*Z-d+e d,e.e dee$j$fd-Z/dS)0r7aW A periodic job as used by :class:`Scheduler`. :param interval: A quantity of a certain time unit :param scheduler: The :class:`Scheduler ` instance that this job will register itself with once it has been fully configured in :meth:`Job.do()`. Every job runs at a given fixed time interval that is defined by: * a :meth:`time unit ` * a quantity of `time units` defined by `interval` A job is usually created and returned by :meth:`Scheduler.every` method, which also defines its `interval`. NrI schedulerc||_d|_d|_d|_d|_d|_d|_d|_d|_d|_ d|_ t|_ ||_ dSr)rIlatestjob_funcunitat_time at_time_zonelast_runrRperiod start_day cancel_aftersetr;ra)r"rIras rr#z Job.__init__sw% %) 59 $( 15 !6: 6: 59 )-:>#&55 .7rrc"|j|jkS)z^ PeriodicJobs are sortable based on the scheduled time they run next. )rR)r"others r__lt__z Job.__lt__s }u~--rct|jdr |jj}nt|j}d|j|j||jdn |jj|jdn |jjS)Nr z4Job(interval={}, unit={}, do={}, args={}, kwargs={})z()z{}) hasattrrdr reprformatrIreargskeywords)r" job_func_names r__str__z Job.__str__ s| 4=* - - 0 M2MM //MFNN M I M)DDt}/AM)DDt}/E    rc d}dd||jd||jd}t|jdr |jj}nt |j}|jbfd|jjD}d|jjD}|d zd ||zzdz}nd }|j :d |j d |j dkr|j ddn|j d|j d|d | Sd|j dndzdz}|t|j |j |j dkr|j ddn|j ||zS)Nc4|r|dndS)N%Y-%m-%d %H:%M:%Sz[never])strftime)ts r format_timez!Job.__repr__..format_times67F1::1222Y Frc.t|t Sr)rNr7)js ris_reprzJob.__repr__..is_reprs!!S))) )rz (last run: z , next run: )r cbg|]+}|rt|nt|,Sr)rrrD)r'xrs rr=z Job.__repr__..)s6RRR!wwqzz5DGGGs1vvRRRrc<g|]\}}|dt|S)=)rr)r'kvs rr=z Job.__repr__..*s-XXXADGGG,XXXr(z, z[None]zEvery  rHz at z do zEvery %(interval)s zto %(latest)s z'%(unit)s do %(call_repr)s %(timestats)s)rIrcre call_repr timestats)rhrRrqrdr rrrtruitemsjoinrfrIrercdict) r"r}rrvrtkwargsrfmtrs @r__repr__z Job.__repr__s G G G * * * * K & & & & K & & & & 4=* - - 0 M2MM //M = $RRRRt}?QRRRDXX9O9U9U9W9WXXXF%+diiv .F.FFLII I < # # "&-1"4"4 #2#$)CC    &'+{'>##BH;<  {(, (:(:dinn ##  rcD|jdkrtd|jS)NrHzUse seconds instead of second)rIrsecondsr!s rsecondz Job.secondF& =A   ?@@ @|rcd|_|S)Nrrer!s rrz Job.secondsL  rcD|jdkrtd|jS)NrHzUse minutes instead of minute)rIrminutesr!s rminutez Job.minuteQrrcd|_|S)Nrrr!s rrz Job.minutesWrrcD|jdkrtd|jS)NrHzUse hours instead of hour)rIrhoursr!s rhourzJob.hour\& =A   ;<< <zrcd|_|S)Nrrr!s rrz Job.hoursb  rcD|jdkrtd|jS)NrHzUse days instead of day)rIrdaysr!s rdayzJob.daygs& =A   9:: :yrcd|_|S)Nrrr!s rrzJob.daysms  rcD|jdkrtd|jS)NrHzUse weeks instead of week)rIrweeksr!s rweekzJob.weekrrrcd|_|S)Nrrr!s rrz Job.weeksxrrcR|jdkrtdd|_|jS)NrHzScheduling .monday() jobs is only allowed for weekly jobs. Using .monday() on a job scheduled to run every 2 or more weeks is not supported.mondayrIrrjrr!s rrz Job.monday}7 =A  $  "zrcR|jdkrtdd|_|jS)NrHzScheduling .tuesday() jobs is only allowed for weekly jobs. Using .tuesday() on a job scheduled to run every 2 or more weeks is not supported.tuesdayrr!s rrz Job.tuesdays7 =A  $  #zrcR|jdkrtdd|_|jS)NrHzScheduling .wednesday() jobs is only allowed for weekly jobs. Using .wednesday() on a job scheduled to run every 2 or more weeks is not supported. wednesdayrr!s rrz Job.wednesdays7 =A  $  %zrcR|jdkrtdd|_|jS)NrHzScheduling .thursday() jobs is only allowed for weekly jobs. Using .thursday() on a job scheduled to run every 2 or more weeks is not supported.thursdayrr!s rrz Job.thursday7 =A  $  $zrcR|jdkrtdd|_|jS)NrHzScheduling .friday() jobs is only allowed for weekly jobs. Using .friday() on a job scheduled to run every 2 or more weeks is not supported.fridayrr!s rrz Job.fridayrrcR|jdkrtdd|_|jS)NrHzScheduling .saturday() jobs is only allowed for weekly jobs. Using .saturday() on a job scheduled to run every 2 or more weeks is not supported.saturdayrr!s rrz Job.saturdayrrcR|jdkrtdd|_|jS)NrHzScheduling .sunday() jobs is only allowed for weekly jobs. Using .sunday() on a job scheduled to run every 2 or more weeks is not supported.sundayrr!s rrz Job.sundayrrr;ctd|Dstd|j||S)z Tags the job with one or more unique identifiers. Tags must be hashable. Duplicate tags are discarded. :param tags: A unique list of ``Hashable`` tags. :return: The invoked job instance c3@K|]}t|tVdSr)rNr)r'r6s rr)zJob.tag..s,==:c8,,======rzTags must be hashable)all TypeErrorr;update)r"r;s rr6zJob.tagsM======= 5344 4  rtime_strtzc|jdvr|jstd|`ddl}t |t r|||_n,t ||jr||_ntdt |t std|jdks|jr$tj d|std |jd kr$tj d |std |jd kr$tj d|std| d}t|dkr|\}}}njt|dkr|jd kr d}d}|\}}nBt|dkr(|jd krt|drd}|\}}n|\}}d}|jdks|jr.t|}d|cxkrdksntdn|jd krd}n|jd krd}d}t|}t|}t|}tj||||_|S)ac Specify a particular time that the job should be run at. :param time_str: A string in one of the following formats: - For daily jobs -> `HH:MM:SS` or `HH:MM` - For hourly jobs -> `MM:SS` or `:MM` - For minute jobs -> `:SS` The format must make sense given how often the job is repeating; for example, a job that repeats every minute should not be given a string in the form `HH:MM:SS`. The difference between `:MM` and `:SS` is inferred from the selected time-unit (e.g. `every().hour.at(':30')` vs. `every().minute.at(':30')`). :param tz: The timezone that this timestamp refers to. Can be a string that can be parsed by pytz.timezone(), or a pytz.BaseTzInfo object :return: The invoked job instance rrrz=Invalid unit (valid units are `days`, `hours`, and `minutes`)Nrz/Timezone must be string or pytz.timezone objectzat() should be passed a stringrz^[0-2]\d:[0-5]\d(:[0-5]\d)?$zAInvalid time format for a daily job (valid format is HH:MM(:SS)?)rz^([0-5]\d)?:[0-5]\d$z@Invalid time format for an hourly job (valid format is (MM)?:SS)rz ^:[0-5]\d$z KKK"c"" $(MM"$5$5!!B00 $&!!(E(C(( ><== = 9  $. 8;XFF (W 9  83X>> (V 9 ! !8M844 (RnnS))  {  q #. D&&&    " "tyI'='=DF#IAvv    " "tyG';';KPQN@S@S';D(NFFF&LD&F 9  $. t99DOOOOOOOO(J$Y' ! !DD Y) # #DF4yyVV}T66::  rrcc||_|S)a Schedule the job to run at an irregular (randomized) interval. The job's interval will randomly vary from the value given to `every` to `latest`. The range defined is inclusive on both ends. For example, `every(A).to(B).seconds` executes the job function every N seconds such that A <= N <= B. :param latest: Maximum interval between randomized job runs :return: The invoked job instance )rc)r"rcs rtozJob.to3s  r until_timec.t|tjr ||_n;t|tjr'tj|z|_nt|tjrBtjtj||_nt|trz||gd}|tdd|vrEtj}| |j |j |j }||_ntd|jtjkrtd|S)aK Schedule job to run until the specified moment. The job is canceled whenever the next run is calculated and it turns out the next run is after the until_time. The job is also canceled right before it runs, if the current time is after until_time. This latter case can happen when the the job was scheduled to run before until_time, but runs after until_time. If until_time is a moment in the past, ScheduleValueError is thrown. :param until_time: A moment in the future representing the latest time a job can be run. If only a time is supplied, the date is set to today. The following formats are accepted: - datetime.datetime - datetime.timedelta - datetime.time - String in one of the following formats: "%Y-%m-%d %H:%M:%S", "%Y-%m-%d %H:%M", "%Y-%m-%d", "%H:%M:%S", "%H:%M" as defined by strptime() behaviour. If an invalid string format is passed, ScheduleValueError is thrown. :return: The invoked job instance )rzz%Y-%m-%d %H:%Mz%Y-%m-%dz%H:%M:%Sz%H:%MNz!Invalid string format for until()-)yearmonthrzVuntil() takes a string, datetime.datetime, datetime.timedelta, datetime.time parameterz5Cannot schedule a job to run until a time in the past)rNrVrk timedeltarWr3combinerD_decode_datetimestrrreplacerrrr)r"rrkrWs runtilz Job.untilBs: j("3 4 4  *D    H$6 7 7  ( 1 5 5 7 7* DD    HM 2 2  ( 1 9 9!%%''!!D   C ( ( 33  L#()LMMM*$$'++--+33 4   !-D  *   x04466 6 6$G  rrdctj|g|Ri||_tj|j|||jt d|jj||S)a Specifies the job_func that should be called every time the job runs. Any additional arguments are passed on to job_func when the job runs. :param job_func: The function to be scheduled :return: The invoked job instance NzHUnable to a add job to schedule. Job is not associated with an scheduler) functoolspartialrdupdate_wrapper_schedule_next_runrar r append)r"rdrtrs rdozJob.dos")(DTDDDVDD  999 !!! > !:  ""4((( rcr|j Jdtj|jkS)zA :return: ``True`` if the job should be run now. Nz"must run _schedule_next_run before)rRrVrWr!s rr&zJob.should_runs7 }((*N((( $$&&$-77rc|tjr"td|t Std||}tj|_|||j r"td|t S|S)a Run the job and immediately reschedule it. If the job's deadline is reached (configured using .until()), the job is not run and CancelJob is returned immediately. If the next scheduled run exceeds the job's deadline, CancelJob is returned after the execution. In this latter case CancelJob takes priority over any other returned value. :return: The return value returned by the `job_func`, or CancelJob if the job's deadline is reached. zCancelling job %szRunning job %s) _is_overduerVrWr0r1rrdrhrrR)r"rOs rrMzJob.runs   H-1133 4 4  LL,d 3 3 3  %t,,,mmoo )--//  !!!   DM * *  LL,d 3 3 3  rc|jdvrtd|j?|j|jkst dt j|j|j}n|j}tjdi|j|i|_ tj |j z|_ |j |jdkrtdd}|j |vr"td |||j }||j z }|d kr|d z }|xj tj||j z z c_ |j+|jd vr|j td |jjd d }|jdks|j |jj|d<|jdvs|j |jj|d<|j jdi||_ |jJ|j|j d|_ |jr|j |jz |j kr5tj }|jdkr]|j |kr.|jdkr#|j tjdz |_ n|jdkrb|jj|jks*|jj|jkr8|jj|jkr#|j tjdz |_ nB|jdkr7|jj|jkr"|j tjdz |_ |j M|jH|j tj z jd kr|xj |j zc_ dSdSdSdS)zD Compute the instant when this job should run next. )rrrrrzQInvalid unit (valid units are `seconds`, `minutes`, `hours`, `days`, and `weeks`)Nz#`latest` is greater than `interval`rz`unit` should be 'weeks')rrrrrrrz+Invalid start day (valid start days are {})rrz)Invalid unit without specifying start day)r microsecondrr)rrr)tzinforH)rr)rr)rr)rerrcrIr randomrandintrVrrirWrRrjrsindexweekdayrfrrrrrglocalize astimezonerhr3r)r"rIweekdaysr days_aheadrrWs rrzJob._schedule_next_runs 9L L L$'  ; "K4=00#$IJJJ~dmT[AAHH}H(AADIx+@AA  )--//$+= > %yG##()CDDDH~X--(AHHRRnnT^44G 4=#8#8#:#::JQa MMX/ ;;dkI IMM < #y <<<AW()TUUU $ 3AFFFyF""dn&@!%!2vy---1K#'<#6x 1DM1;;F;;DM ,%..t}==Z\\WDW)) = RT]T]%Bdk$Q$Q'++--I'' **,,sxxzz99 **$(MH4FA4N4N4N$NDMMY'))L'#*44 +sz99 L/#*<<%)MH4FQ4O4O4O$ODMMY)++ 0Ccj0P0P$(MH4Fq4Q4Q4Q$QDM > %$,*B  1 5 5 7 77=BB ,  & %*B*BBBrwhenc*|jduo ||jkSr)rk)r"rs rrzJob._is_overdues ,I8I1IIr datetime_strformatsct|D]4} tj||cS#t$rY1wxYwdSr)rVstrptimerF)r"rrfs rrzJob._decode_datetimestrs\  A (11,BBBBB    ts ( 55rrZ)0r rrrr]rrr#boolrorDrwrr^rrrrrrrrrrrrrrrrrrr6rrrrVrr3rrrr&rMrrrrrrrr7r7s"888)1D8888@.t....       ---^X XX XX XX XX XXXXXXXX     YY3YHSMYYYYv     B(+X-?PSSTBBBBH8,8D888X84S-S-S-S-jJ 1JJJJ*.s) (# $rr7rHrIrc6t|S)zmCalls :meth:`every ` on the :data:`default scheduler instance `. )default_schedulerrK)rIs rrKrK+s  " "8 , ,,rc8tdS)zyCalls :meth:`run_pending ` on the :data:`default scheduler instance `. N)rr-rrrr-r-2s!!#####rr.c<t|dS)zqCalls :meth:`run_all ` on the :data:`default scheduler instance `. r.N)rr5rs rr5r59s!M:::::rr6c6t|S)zsCalls :meth:`get_jobs ` on the :data:`default scheduler instance `. )rr?r6s rr?r?@s  % %c * **rc:t|dS)zmCalls :meth:`clear ` on the :data:`default scheduler instance `. N)rrBrs rrBrBGsC     rr(c:t|dS)zwCalls :meth:`cancel_job ` on the :data:`default scheduler instance `. N)rrG)r(s rrGrGNs  %%%%%rc6t|S)zsCalls :meth:`next_run ` on the :data:`default scheduler instance `. )rrTrs rrRrRUs  ) )# . ..rctjS)z{Calls :meth:`idle_seconds ` on the :data:`default scheduler instance `. )rrYrrrrYrY\s   ))rcfd}|S)z Decorator to schedule a new periodic job. Any additional arguments are passed on to the decorated function when the job runs. :param job: a :class:`Jobs ` c*j|gRi|Sr)r)decorated_functionrtr(rs r_schedule_decoratorz#repeat.._schedule_decoratorms,!3D333F333!!rr)r(rtrr s``` rrepeatr cs0""""""" rr\rZr[r)%rcollections.abcrrVrloggingrrr3typingrrrrr getLoggerr0 Exceptionr rrrrr7rr r]rKr-r5r?rBrGrRr_rYr rrrrs&&N%$$$$$ 77777777777777  : & &     I                &           IIIIIIIIDN N N N N N N N jIKK--C-----$$$$;;3;t;;;;++(8$+S ++++!!x!!T!!!!&C&D&&&&//(8$/9J0K////*huo****r