summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2017-12-19 23:09:17 +0200
committerAlex Grönholm <alex.gronholm@nextday.fi>2017-12-19 23:10:52 +0200
commit79629ad79640fc52ce9a35851978ca5d812a353d (patch)
tree62c5374b5cd8338c159173e3cf1b59dd9ac0dc6a /docs/modules
parent5e56860088bab438b0cf234a920d276359f897fd (diff)
downloadapscheduler-79629ad79640fc52ce9a35851978ca5d812a353d.tar.gz
Added combining triggers (AndTrigger + OrTrigger)
Fixes #119.
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/triggers/combining.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/modules/triggers/combining.rst b/docs/modules/triggers/combining.rst
new file mode 100644
index 0000000..856cc60
--- /dev/null
+++ b/docs/modules/triggers/combining.rst
@@ -0,0 +1,35 @@
+:mod:`apscheduler.triggers.combining`
+=====================================
+
+These triggers combine the behavior of other triggers in different ways to produce schedules more
+complex than would be possible with any single built-in trigger.
+
+.. automodule:: apscheduler.triggers.combining
+
+API
+---
+
+.. autoclass:: AndTrigger
+
+.. autoclass:: OrTrigger
+
+
+Examples
+--------
+
+Run ``job_function`` every 2 hours, but only on Saturdays and Sundays::
+
+ from apscheduler.triggers.combining import AndTrigger
+ from apscheduler.triggers.interval import IntervalTrigger
+ from apscheduler.triggers.cron import CronTrigger
+
+
+ trigger = AndTrigger([IntervalTrigger(hours=2),
+ CronTrigger(day_of_week='sat,sun')])
+ scheduler.add_job(job_function, trigger)
+
+Run ``job_function`` every Monday at 2pm and every Tuesday at 3pm::
+
+ trigger = OrTrigger([CronTrigger(day_of_week='mon', hour=2),
+ CronTrigger(day_of_week='tue', hour=3)])
+ scheduler.add_job(job_function, trigger)