Schedaddle 0.1.0

Schedaddle is a Python module for getting dates and times on scheduled intervals.<br /><br />For more information, see http://www.davisd.com/projects/python-schedaddle<br /><br />Typical Usage is as follows:<br /><br />#!/usr/bin/env python<br /><br />import schedaddle<br /><br />schedaddle.next((2010, 1, 31), 'monthly')<br /><br />API<br /><br />The entire Schedaddle api consists of one dictionary, two date functions, and two generator functions.<br /><br />Dictionary<br /><br />A dictionary, KNOWN_INTERVALS is exposed by the Schedaddle API. This dictionary consists of string keys representing known interval names with values as tuples in (year, month, day, hour, minute, second, microsecond) format.<br /><br />Date Functions<br /><br />The Schedaddle API exposes two date functions<br /><br />next<br /><br />Get the next date/time tuple on a schedule.<br /><br />Keyword arguments:<br /><br /> start_date -- the date that the schedule began/begins<br /><br /> interval -- can be a string or a tuple.<br /><br /> If a string - valid values are defined in KNOWN_INTERVALS<br /><br /> If a tuple - (year, month, day, hour, minute, second, microsecond)<br /><br /> latest -- the most recent date that the schedule ran (optional, if not provided, start_date will be treated as the latest)<br /><br />Returns a 7 value tuple (year, month, day, hour, minute, second, microsecond)<br /><br />Example:<br /><br /> >>> import schedaddle<br /> >>> schedaddle.next((2010, 1, 31), 'monthly')<br /> (2010, 2, 28, 0, 0, 0, 0)<br /><br /> >>> import schedaddle<br /> >>> schedaddle.next((2010, 1, 31), 'monthly', latest=(2010, 3, 15))<br /> (2010, 3, 31, 0, 0, 0, 0)<br /><br />next_m<br /><br />Get the next identifiable date/time tuple resulting from an iterable of schedules.<br /><br />Keyword arguments:<br /><br /> schedules -- an iterable of schedules<br /> a single schedule is a three value tuple consisting of (identifier, start_date, interval)<br /><br /> latest -- the most recent date that the schedule ran (optional, if not provided, start_date will be treated as the latest for each schedule)<br /><br />Returns a two value tuple consisting of the identifier of the matching schedule, and the 7 value date/time tuple. (identifier, (year, month, day, hour, minute, second, microsecond))<br /><br />Example:<br /><br /> >>> import schedaddle<br /> >>> schedaddle.next_m([<br /> ... ('first', (2010, 1, 31), 'monthly'),<br /> ... ('second', (2010, 1, 31), 'weekly')])<br /> ('second', (2010, 2, 7, 0, 0, 0, 0))<br /><br /> >>> import schedaddle<br /> >>> schedaddle.next_m([<br /> ... ('first', (2010, 1, 31), (0, 1, 0, 0, 0, 0, 0)),<br /> ... ('second', (2010, 1, 31, 12, 30), 'weekly')],<br /> ... latest=(2010, 2, 21))<br /> ('first', (2010, 2, 28, 0, 0, 0, 0))<br /><br />Generators<br /><br />The Schedaddle API exposes two generator functions<br /><br />upcoming<br /><br />Get a generator that produces upcoming date/time tuples on a schedule.<br /><br />Keyword arguments:<br /><br /> start_date -- the date that the schedule begain/begins<br /><br /> interval -- can be a string or a tuple.<br /><br /> If a string - valid values are defined in KNOWN_INTERVALS<br /><br /> If a tuple - (year, month, day, hour, minute, second, microsecond)<br /><br /> latest -- the most recent date that the schedule ran (optional, if not provided, start_date will be treated as the latest)<br /><br /> end_date -- the last possible date in the generator (optional)<br /><br /> max_dates -- the maximum number of dates the generator should return (optional)<br /><br />Returns a generator that yields 7 value date/time tuples (year, month, day, hour, minute, second, microsecond)<br /><br />Notes:<br /> If end_date or max_dates is not provided, there will be no end to the amount of dates generated, and so it should then not be used in scenarios requiring a finite number of results, such as list comprehention.<br /><br />Example:<br /><br /> >>> import schedaddle<br /> >>> g = schedaddle.upcoming((2010, 1, 31, 12, 15), 'weekly', max_dates=3)<br /> >>> l = [s for s in g]<br /> >>> l<br /> [(2010, 2, 7, 12, 15, 0, 0), (2010, 2, 14, 12, 15, 0, 0), (2010, 2, 21, 12, 15, 0, 0)]<br /><br />upcoming_m<br /><br />Get a generator that produces upcoming, identifiable date/time tuples resulting from an iterable of schedules.<br /><br />Generate upcoming dates from an iterable of schedules.<br /><br />Keyword arguments:<br /><br /> schedules -- an iterable of schedules<br /> a single schedule is a tuple consisting of (identifier, start_date, interval)<br /><br /> latest -- the most recent date that the schedule ran (optional, if not provided, start_date will be treated as the latest for each schedule)<br /><br /> end_date -- the last possible date in the generator (optional)<br /><br /> max_dates -- the maximum number of dates the generator should return (optional)<br /><br />Returns a generator that yields two value date/time tuples consisting of the identifier of the matching schedule and the 7 value date/time tuple. (identifier, (year, month, day, hour, minute, second, microsecond))<br /><br />Notes:<br /> If end_date or max_dates is not provided, there will be no end to the amount of dates generated, and so it should then not be used in scenarios requiring a finite number of results, such as list comprehention.<br /><br />Example:<br /><br /> >>> import schedaddle<br /> >>> schedule1 = ('first', (2010, 1, 5), 'weekly')<br /> >>> schedule2 = ('second', (2007, 12, 31), 'monthly')<br /> >>> g = schedaddle.upcoming_m(<br /> ... (schedule1, schedule2),<br /> ... latest=(2010, 1, 12))<br /> >>> g.next()<br /> ('first', (2010, 1, 19, 0, 0, 0, 0))<br /> >>> g.next()<br /> ('first', (2010, 1, 26, 0, 0, 0, 0))<br /> >>> g.next()<br /> ('second', (2010, 1, 31, 0, 0, 0, 0))<br /><br />Notes<br /><br />Arguments<br /><br />When a date is accepted as an argument in a function, you may use a date or datetime object, or a tuple consisting of one to seven number values (year, month, day, hour, minute, second, microsecond). If using tuple and values are not provided for each of the places (eg, no second or microsecond as in (2010, 1, 31, 12, 30)), Schedaddle will fill in the blanks either with zeros or with the maximum value to end the day, whichever makes sense for the argument's context.<br /><br />When an interval is accepted as an argument in a function, you may use a string representing a known interval defined in the KNOWN_INTERVALS dictionary, OR you may represent an interval as a seven value tuple (years, months, days, hours, minutes, seconds, microseconds).<br /><br />Return Values<br /><br />The functions next and upcoming return and yield a tuple consisting of seven values (year, month, day, hour, minute, second, microsecond).<br /><br />The functions next_m and upcoming_m return and yield a tuple consisting of two values. The first value is the identifier that was passed as part of the schedule which was matched. The second is a tuple consisting of seven values (year, month, day, hour, minute, second, microsecond).

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Amount,  Finite,  Generated,  Notes,  Requiring,  Return,  Scenarios,  Upcoming,  Yields
Users rating:	0/10