U hbp@svdZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z m Z mZedZGdddeZGdd d eZGd d d eZGd d d eZGdddeZGdddeZeZejZd*eedddZddddZd+eddddZd,e ee edddZd-e edddd Z edd!d"d#Z!e ejdd$d%Z"e e#dd&d'Z$d(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.6, 3.7, 3.8, 3.9 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)SetListOptionalCallableUnionschedulec@seZdZdZdS) ScheduleErrorzBase schedule exceptionN__name__ __module__ __qualname____doc__rr5/tmp/pip-unpacked-wheel-oys3viw9/schedule/__init__.pyr 4sr c@seZdZdZdS)ScheduleValueErrorzBase schedule value errorNr rrrrr:src@seZdZdZdS) IntervalErrorzAn improper interval was usedNr rrrrr@src@seZdZdZdS) CancelJobz: Can be returned from a job to unschedule itself. Nr rrrrrFsrc@seZdZdZddddZddddZdedd d d Zd ee e d d ddZ d!ee dd ddZ d ddddZ d"ed dddZd ddddZeeejdddZeeedddZdS)# Schedulerz Objects instantiated by the :class:`Scheduler ` are factories to create jobs, keep record of scheduled jobs and handle their execution. NreturncCs g|_dSNjobsselfrrr__init__UszScheduler.__init__cCs,dd|jD}t|D]}||qdS)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. css|]}|jr|VqdSr) should_run.0jobrrr bsz(Scheduler.run_pending..N)rsorted_run_job)rZ runnable_jobsr rrr run_pendingXs  zScheduler.run_pendingr delay_secondsrcCs@tdt|j||jddD]}||t|q"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)loggerdebuglenrr#timesleep)rr&r rrrrun_allfs  zScheduler.run_allJobtagrcs.dkr|jddSfdd|jDSdS)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 Ncsg|]}|jkr|qSrtagsrr/rr s z&Scheduler.get_jobs..rrr/rr2rget_jobsyszScheduler.get_jobscsNdkr td|jdd=n*tdfdd|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"c3s|]}|jkr|VqdSrr0rr2rrr!s z"Scheduler.clear..)r'r(rr4rr2rclears   zScheduler.clearr rcCsJz tdt||j|Wn$tk rDtdt|YnXdS)zX Delete a scheduled job. :param job: The job to be unscheduled zCancelling job "%s"z!Cancelling not-scheduled job "%s"N)r'r(strrremove ValueError)rr rrr cancel_jobs zScheduler.cancel_jobintervalrcCst||}|S)z Schedule a new periodic job. :param interval: A quantity of a certain time unit :return: An unconfigured :class:`Job ` )r-)rr>r rrreverys zScheduler.everycCs(|}t|ts|tkr$||dSr)run isinstancerr;)rr retrrrr#szScheduler._run_jobcCs|js dSt|jjS)z Datetime when the next job should run. :return: A :class:`~datetime.datetime` object or None if no jobs scheduled N)rminnext_runrrrrrDszScheduler.next_runcCs|js dS|jtjS)z :return: Number of seconds until :meth:`next_run ` or None if no jobs are scheduled N)rDdatetimenow total_secondsrrrr idle_secondsszScheduler.idle_seconds)r)N)N)r<)r r r rrr$intr,rrrr5r6r;r?r#propertyrErDfloatrHrrrrrNs    rc@seZdZdZdIeedddZedddZe dd d Z d d Z e d dZ e ddZe ddZe ddZe ddZe ddZe ddZe ddZe ddZe dd Ze d!d"Ze d#d$Ze d%d&Ze d'd(Ze d)d*Ze d+d,Ze d-d.Zed/d0d1Zd2d3Z ed4d5d6Z!e"e#j#e#j$e#j%e fd7d8d9Z&e'd:d;d<Z(e edd=d>Z)d?d@Z*dddAdBZ+e#j#dCdDdEZ,e e-e e.e#j#dFdGdHZ/dS)Jr-aW 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`. N)r> schedulercCsN||_d|_d|_d|_d|_d|_d|_d|_d|_d|_ t |_ ||_ dSr) r>latestjob_funcunitat_timelast_runrDperiod start_day cancel_aftersetr1rL)rr>rLrrrrsz Job.__init__rcCs |j|jkS)z^ PeriodicJobs are sortable based on the scheduled time they run next. )rD)rotherrrr__lt__sz Job.__lt__cCsZt|jdr|jj}n t|j}d|j|j||jdkrrOargskeywords)r job_func_namerrr__str__s   z Job.__str__csdd}ddd||j||jf}t|jdr>|jj}n t|j}fdd|jjD}d d|jjD}|d d ||d }|j dk rd |j |j dkr|j ddn|j |j ||fSd|j dk rdndd}|t|j |j |j dkr|j ddn|j ||dSdS)NcSs|r|dSdS)N%Y-%m-%d %H:%M:%Sz[never])strftime)trrr format_time sz!Job.__repr__..format_timecSs t|t Sr)rAr-)jrrris_reprszJob.__repr__..is_reprz(last run: %s, next run: %s)r cs$g|]}|rt|nt|qSr)rYr8)rxrdrrr3sz Job.__repr__..cSs g|]\}}d|t|fqS)z%s=%s)rY)rkvrrrr3s(z, )zEvery %s %s at %s do %s %sr<zEvery %(interval)s zto %(latest)s z'%(unit)s do %(call_repr)s %(timestats)s)r>rMrO call_repr timestats)rQrDrXrNr rYr[r\itemsjoinrPr>rOrMdict)rrbrnr]r[kwargsrmfmtrrfr__repr__ sB     z Job.__repr__cCs|jdkrtd|jS)Nr<zUse seconds instead of second)r>rsecondsrrrrsecond7s z Job.secondcCs d|_|S)NrurOrrrrru=sz Job.secondscCs|jdkrtd|jS)Nr<zUse minutes instead of minute)r>rminutesrrrrminuteBs z Job.minutecCs d|_|S)NrxrwrrrrrxHsz Job.minutescCs|jdkrtd|jS)Nr<zUse hours instead of hour)r>rhoursrrrrhourMs zJob.hourcCs d|_|S)NrzrwrrrrrzSsz Job.hourscCs|jdkrtd|jS)Nr<zUse days instead of day)r>rdaysrrrrdayXs zJob.daycCs d|_|S)Nr|rwrrrrr|^szJob.dayscCs|jdkrtd|jS)Nr<zUse weeks instead of week)r>rweeksrrrrweekcs zJob.weekcCs d|_|S)Nr~rwrrrrr~isz Job.weekscCs|jdkrtdd|_|jS)Nr<zScheduling .monday() jobs is only allowed for weekly jobs. Using .monday() on a job scheduled to run every 2 or more weeks is not supported.mondayr>rrSr~rrrrrns  z Job.mondaycCs|jdkrtdd|_|jS)Nr<zScheduling .tuesday() jobs is only allowed for weekly jobs. Using .tuesday() on a job scheduled to run every 2 or more weeks is not supported.tuesdayrrrrrrys  z Job.tuesdaycCs|jdkrtdd|_|jS)Nr<zScheduling .wednesday() jobs is only allowed for weekly jobs. Using .wednesday() on a job scheduled to run every 2 or more weeks is not supported. wednesdayrrrrrrs  z Job.wednesdaycCs|jdkrtdd|_|jS)Nr<zScheduling .thursday() jobs is only allowed for weekly jobs. Using .thursday() on a job scheduled to run every 2 or more weeks is not supported.thursdayrrrrrrs  z Job.thursdaycCs|jdkrtdd|_|jS)Nr<zScheduling .friday() jobs is only allowed for weekly jobs. Using .friday() on a job scheduled to run every 2 or more weeks is not supported.fridayrrrrrrs  z Job.fridaycCs|jdkrtdd|_|jS)Nr<zScheduling .saturday() jobs is only allowed for weekly jobs. Using .saturday() on a job scheduled to run every 2 or more weeks is not supported.saturdayrrrrrrs  z Job.saturdaycCs|jdkrtdd|_|jS)Nr<zScheduling .sunday() jobs is only allowed for weekly jobs. Using .sunday() on a job scheduled to run every 2 or more weeks is not supported.sundayrrrrrrs  z Job.sundayr0cGs*tdd|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 css|]}t|tVqdSr)rAr)rr/rrrr!szJob.tag..zTags must be hashable)all TypeErrorr1update)rr1rrrr/s  zJob.tagcCs|jdkr|jstdt|ts*td|jdks:|jrNtd|sNtd|jdkrltd|sltd |jd krtd |std |d }t |dkr|\}}}njt |dkr|jd krd}d}|\}}nBt |dkr |jdkr t |dr d}|\}}n |\}}d}|jdks*|jrVt |}d|krJdks|ntdn&|jdkrhd}n|jd kr|d}d}t |}t |}t ||||_ |S)a 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')`). :return: The invoked job instance r|rzrxz=Invalid unit (valid units are `days`, `hours`, and `minutes`)zat() should be passed a stringr|z^([0-2]\d:)?[0-5]\d:[0-5]\d$zAInvalid time format for a daily job (valid format is HH:MM(:SS)?)rzz^([0-5]\d)?:[0-5]\d$z@Invalid time format for an hourly job (valid format is (MM)?:SS)rxz ^:[0-5]\d$zr randomrandintrErrRrFrDrSrZindexweekdayrPrvr{ryrrQr*r|)rr>ZweekdaysrZ days_aheadrrrFrrrrsn                zJob._schedule_next_run)whencCs|jdk o||jkSr)rT)rrrrrrszJob._is_overdue) datetime_strformatsrc Cs8|D].}ztj||WStk r0YqXqdSr)rEstrptimer:)rrrfrrrrs zJob._decode_datetimestr)N)0r r r rrIrrboolrWr8r^rtrJrvruryrxr{rzr}r|rr~rrrrrrrrr/rrrrErr*rrrrr@rrrrrrrrrr-sl+                 J DKr-r<r=cCs t|S)zmCalls :meth:`every ` on the :data:`default scheduler instance `. )default_schedulerr?)r>rrrr?sr?rcCs tdS)zyCalls :meth:`run_pending ` on the :data:`default scheduler instance `. N)rr$rrrrr$sr$r%cCstj|ddS)zqCalls :meth:`run_all ` on the :data:`default scheduler instance `. r&N)rr,rrrrr,sr,r.cCs t|S)zsCalls :meth:`get_jobs ` on the :data:`default scheduler instance `. )rr5r2rrrr5sr5cCst|dS)zmCalls :meth:`clear ` on the :data:`default scheduler instance `. N)rr6r2rrrr6sr6r7cCst|dS)zwCalls :meth:`cancel_job ` on the :data:`default scheduler instance `. N)rr;)r rrrr;$sr;cCstjS)zsCalls :meth:`next_run ` on the :data:`default scheduler instance `. )rrDrrrrrD+srDcCstjS)z{Calls :meth:`idle_seconds ` on the :data:`default scheduler instance `. )rrHrrrrrH2srHcsfdd}|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 ` csj|f|Sr)r)Zdecorated_functionr[r rrrr_schedule_decoratorCsz#repeat.._schedule_decoratorr)r r[rrrrrrrepeat9s r)r<)r)N)N)&rcollections.abcrrErloggingrrr*typingrrrrr getLoggerr' Exceptionr rrobjectrrr-rrrIr?r$r,r5r6r;rDrKrHrrrrrs<'  z7