datec 0.2__tar.gz → 0.3__tar.gz

{datec-0.2 → datec-0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datec
-Version: 0.2
+Version: 0.3
 Summary: Date Command
 Project-URL: Homepage, https://github.com/isaacto/datec
 Project-URL: Repository, https://github.com/isaacto/datec.git
@@ -40,15 +40,16 @@ to them, like this:
 A date command can be parsed from strings using the parse() function,
 which create a command from a string representation.  This forms the
 basis of the datec command, which is a command-line program to output
-datetime after applying date commands.  In general the date
-representation is NxYYYY-mm-ddTHH:MM:SS.ffffff, where unspecified
-parts are omitted leaving the symbols intact, like "2x-2-29T3::." (see
-the following for the meaning).  If the fractional part is not
-specified the "." may be omitted, if all time parts are not specified
-the "T::."  can be omitted, if all date parts are not specified the
-"--T" can be omitted, and if Nx may be omitted in some cases for
-setting a partial datetime or weekday.  There are a couple other more
-formats like +3week and -2wed for shifting by period and weekday.
+datetime after applying date commands, or sleep until that time if
+"-w" is given.  In general the date representation is
+NxYYYY-mm-ddTHH:MM:SS.ffffff, where unspecified parts are omitted
+leaving the symbols intact, like "2x-2-29T3::." (see the following for
+the meaning).  If the fractional part is not specified the "." may be
+omitted, if all time parts are not specified the "T::."  can be
+omitted, if all date parts are not specified the "--T" can be omitted,
+and if Nx may be omitted in some cases for setting a partial datetime
+or weekday.  There are a couple other more formats like +3week and
+-2wed for shifting by period and weekday.
 
 Date commands are in two forms: period shifting commands and partial
 datetime shifting commands.  The first type is more familiar: they
@@ -78,6 +79,11 @@ They are represented by either a Weekday object or a PartialDate
 object with a count.  A count of 0 means setting instead of shifting.
 Only integer counts are acceptable.
 
+A trailing "/" on a partial date command sets all fields after the
+last specified field to zero.  For example, `12::/` sets the hour to
+12 and the minute, second and microsecond to 0, whereas `12::` would
+leave those unchanged.
+
 It is an error to set to an invalid date (e.g., --31 applied on
 2019-06-25 is an error).  The datetime parts which are specified must
 be consecutive (it is an error to specify 12::05).  It is also an
@@ -95,6 +101,9 @@ will cause the date to moved backwards until the date is valid.  E.g.,
 if you shift by -6- with count 1 (next June) from 2019-05-31, you get
 2019-06-30.  With count 2 you get 2020-06-30.
 
+All these functionalities are available in the constructors too.  Read
+their docstring to find how to use them.
+
 This library is grown out of frustration that it is tedious to have a
 shell script or program to get a datetime like "the next 6pm from now"
 or "the next 3rd of any month from two days ago".  With this module

{datec-0.2 → datec-0.3}/README.md

@@ -16,15 +16,16 @@ to them, like this:
 A date command can be parsed from strings using the parse() function,
 which create a command from a string representation.  This forms the
 basis of the datec command, which is a command-line program to output
-datetime after applying date commands.  In general the date
-representation is NxYYYY-mm-ddTHH:MM:SS.ffffff, where unspecified
-parts are omitted leaving the symbols intact, like "2x-2-29T3::." (see
-the following for the meaning).  If the fractional part is not
-specified the "." may be omitted, if all time parts are not specified
-the "T::."  can be omitted, if all date parts are not specified the
-"--T" can be omitted, and if Nx may be omitted in some cases for
-setting a partial datetime or weekday.  There are a couple other more
-formats like +3week and -2wed for shifting by period and weekday.
+datetime after applying date commands, or sleep until that time if
+"-w" is given.  In general the date representation is
+NxYYYY-mm-ddTHH:MM:SS.ffffff, where unspecified parts are omitted
+leaving the symbols intact, like "2x-2-29T3::." (see the following for
+the meaning).  If the fractional part is not specified the "." may be
+omitted, if all time parts are not specified the "T::."  can be
+omitted, if all date parts are not specified the "--T" can be omitted,
+and if Nx may be omitted in some cases for setting a partial datetime
+or weekday.  There are a couple other more formats like +3week and
+-2wed for shifting by period and weekday.
 
 Date commands are in two forms: period shifting commands and partial
 datetime shifting commands.  The first type is more familiar: they
@@ -54,6 +55,11 @@ They are represented by either a Weekday object or a PartialDate
 object with a count.  A count of 0 means setting instead of shifting.
 Only integer counts are acceptable.
 
+A trailing "/" on a partial date command sets all fields after the
+last specified field to zero.  For example, `12::/` sets the hour to
+12 and the minute, second and microsecond to 0, whereas `12::` would
+leave those unchanged.
+
 It is an error to set to an invalid date (e.g., --31 applied on
 2019-06-25 is an error).  The datetime parts which are specified must
 be consecutive (it is an error to specify 12::05).  It is also an
@@ -71,6 +77,9 @@ will cause the date to moved backwards until the date is valid.  E.g.,
 if you shift by -6- with count 1 (next June) from 2019-05-31, you get
 2019-06-30.  With count 2 you get 2020-06-30.
 
+All these functionalities are available in the constructors too.  Read
+their docstring to find how to use them.
+
 This library is grown out of frustration that it is tedious to have a
 shell script or program to get a datetime like "the next 6pm from now"
 or "the next 3rd of any month from two days ago".  With this module

{datec-0.2 → datec-0.3}/datec/__init__.py

@@ -46,6 +46,11 @@ They are represented by either a Weekday object or a PartialDate
 object with a count.  A count of 0 means setting instead of shifting.
 Only integer counts are acceptable.
 
+A trailing "/" on a partial date command sets all fields after the
+last specified field to zero.  For example, `12::/` sets the hour to
+12 and the minute, second and microsecond to 0, whereas `12::` would
+leave those unchanged.
+
 It is an error to set to an invalid date (e.g., --31 applied on
 2019-06-25 is an error).  The datetime parts which are specified must
 be consecutive (it is an error to specify 12::05).  It is also an
@@ -79,6 +84,7 @@ is observed.  Contributions are welcome.
 
 """
 
+import contextlib
 import datetime
 import re
 import typing
@@ -86,9 +92,7 @@ import typing
 import dateutil.relativedelta as dr
 
 
-__metaclass__ = type
-
-__version__ = '0.2'
+__version__ = '0.3'
 
 class ParseError(ValueError):
     """Represent an error in parsing."""
@@ -111,8 +115,11 @@ class Period:
 
     """
     def __init__(self, count: float, period: str):
-        assert period in ('year', 'month', 'week', 'day',
-                          'hour', 'minute', 'second')
+        if period not in ('year', 'month', 'week', 'day',
+                          'hour', 'minute', 'second'):
+            raise ValueError(f'Invalid period: {period}')
+        if period in ('year', 'month') and count != int(count):
+            raise ValueError(f'Invalid count {count} for period {period}')
         self._count = count
         self._period = period
 
@@ -145,11 +152,12 @@ class Period:
             raise ParseError('Cannot parse string %s' % cmdstr)
         gdt = match.groupdict()
         cnt: float
+        with contextlib.suppress(ValueError):
+            return cls(int(gdt['count']), gdt['period'])
         try:
-            cnt = int(gdt['count'])
-        except Exception:
-            cnt = float(gdt['count'])
-        return cls(cnt, gdt['period'])
+            return cls(float(gdt['count']), gdt['period'])
+        except ValueError as err:
+            raise ParseError('Cannot parse string %s' % cmdstr)
 
 
 _WEEKDAY_CLS = [dr.SU, dr.MO, dr.TU, dr.WE, dr.TH, dr.FR, dr.SA]
@@ -178,7 +186,8 @@ class Weekday:
     """
     def __init__(self, count: int, day: int):
         self._count = count
-        assert day in range(7)
+        if day not in range(7):
+            raise ValueError('Invalid weekday: %d' % day)
         self._day = day
         self._drcls = _WEEKDAY_CLS[day]
 
@@ -196,7 +205,7 @@ class Weekday:
 
     PARSE_RE = re.compile(r'''
     ^
-    (?P<count> [+-] (?: [0-9]+ | [0-9]*\.[0-9]*) )?
+    (?P<count> [+-] (?: [0-9]+) )?
     (?P<weekday> sun|mon|tue|wed|thu|fri|sat)
     $
     ''', re.X)
@@ -242,14 +251,15 @@ class PartialDate:
 
     Args:
 
-        count (int): The number of periods to shift
-        year (int): The year number
-        month (int): The month number (1 to 12)
-        day (int): The day number (1 to 31)
-        hour (int): The hour number (0 to 23)
-        minute (int): The minute number (0 to 59)
-        second (int or float): The second number (0 to smaller than 60)
-        microsecond (int): The microsecond number (0 to 999999)
+        count: The number of periods to shift
+        year: The year number
+        month: The month number (1 to 12)
+        day: The day number (1 to 31)
+        hour: The hour number (0 to 23)
+        minute: The minute number (0 to 59)
+        second: The second number (0 to smaller than 60)
+        microsecond: The microsecond number (0 to 999999)
+        zero: Whether to zero out the fields after the last specified one
 
     """
 
@@ -259,19 +269,26 @@ class PartialDate:
         self, count: int = 0, year: typing.Optional[int] = None,
         month: typing.Optional[int] = None, day: typing.Optional[int] = None,
         hour: typing.Optional[int] = None, minute: typing.Optional[int] = None,
-        second: typing.Optional[int] = None,
-        microsecond: typing.Optional[int] = None
+        second: typing.Optional[typing.Union[int, float]] = None,
+        microsecond: typing.Optional[int] = None,
+        zero: bool = False
     ):
-        assert not count or not year, 'Absolute date with non-zero count'
-        assert not isinstance(second, float) or \
-            microsecond is None, 'Doubly specified microsecond'
-        vals = [year, month, day, hour, minute, second, microsecond]
-        sig = ''.join([("0" if v is None else "1") for v in vals])
-        assert not self._INVALID_SIG_RE.search(sig), \
-            'Non-consecutive components'
+        if count and year:
+            raise ValueError('Absolute date with non-zero count')
+        if isinstance(second, float) and microsecond is not None:
+            raise ValueError('Doubly specified microsecond')
         if isinstance(second, float):
             second, orig_second = int(second), second
             microsecond = int((orig_second - second) * 1000000 + 0.5)
+        vals = [year, month, day, hour, minute, second, microsecond]
+        sig = ''.join([("0" if v is None else "1") for v in vals])
+        if self._INVALID_SIG_RE.search(sig):
+            raise ValueError('Non-consecutive components')
+        if zero:
+            lastset = sig.rfind('1')
+            for i in range(lastset + 1, 7):
+                vals[i] = 0
+            year, month, day, hour, minute, second, microsecond = vals
         self._count = count
         self._year = year
         self._month = month
@@ -412,13 +429,17 @@ class PartialDate:
         empty string.  If all date parts are not specified the "--T"
         may be omitted.  If all the time parts are not specified the
         "T::." may be omitted.  If the microsecond part is not
-        specified the "." part may be omitted.
+        specified the "." part may be omitted.  A trailing "/" causes
+        all fields after the last specified field to be set to 0.
 
         Args:
 
             cmdstr (str): The command string
 
         """
+        zero = cmdstr.endswith('/')
+        if zero:
+            cmdstr = cmdstr[:-1]
         match = cls.PARSE_RE1.match(cmdstr.lower())
         if not match:
             match = cls.PARSE_RE2.match(cmdstr)
@@ -443,7 +464,8 @@ class PartialDate:
                    _matchval('hour'),
                    _matchval('minute'),
                    _matchval('second'),
-                   microsecond)
+                   microsecond,
+                   zero)
 
 
 def parse(cmdstr: str) -> typing.Union[Period, Weekday, PartialDate]:

{datec-0.2 → datec-0.3}/datec/__main__.py

@@ -1,21 +1,25 @@
 from __future__ import print_function
 
-import sys
 import datetime
+import sys
+import time
 
 import datec
 
 
 def main() -> None:
     dt = datetime.datetime.now()
+    wait = False
     for cmd in sys.argv[1:]:
         if cmd == '-h':
             print('''Date command
 
-Usage: datec [<command>] ...
+Usage: datec [-w] [<command>] ...
 
-Datec starts from the current time and apply commands.  The ending
-datetime is printed in ISO YYYY-MM-DDTHH:MM:SS.ffffff format.
+Datec starts from the current time and apply commands.  Normally the
+ending datetime is printed in ISO YYYY-MM-DDTHH:MM:SS.ffffff format.
+But if -w is given, no output is printed; instead the program sleeps
+until the ending datetime.
 
 <command> may be of the following forms:
 
@@ -28,8 +32,16 @@ datetime is printed in ISO YYYY-MM-DDTHH:MM:SS.ffffff format.
 
 ''', file=sys.stderr)
             sys.exit(0)
+        if cmd == '-w':
+            wait = True
+            continue
         dt = dt + datec.parse(cmd.lower())
-    print(dt.isoformat())
+    if wait:
+        delta = (dt - datetime.datetime.now()).total_seconds()
+        if delta > 0:
+            time.sleep(delta)
+    else:
+        print(dt.isoformat())
 
 
 if __name__ == '__main__':

{datec-0.2 → datec-0.3}/tests/datec_test.py

@@ -13,6 +13,8 @@ class DatecTest(unittest.TestCase):
                          datetime.datetime(2019, 5, 15, 0, 0, 1, 500000))
         with self.assertRaises(datec.ParseError):
             datec.Period.parse('+1mon')
+        with self.assertRaises(datec.ParseError):
+            datec.Period.parse('+.day')
 
     def test_weekday(self):
         dt = datetime.datetime(2019, 5, 15)
@@ -41,6 +43,8 @@ class DatecTest(unittest.TestCase):
                          datetime.datetime(2019, 5, 15, 8, 17, 16))
         self.assertEqual(dt + datec.PartialDate(2, minute=7, second=16),
                          datetime.datetime(2019, 5, 15, 10, 7, 16))
+        self.assertEqual(dt + datec.PartialDate(2, minute=7, second=16.5),
+                         datetime.datetime(2019, 5, 15, 10, 7, 16, 500000))
         self.assertEqual(dt + datec.PartialDate.parse(':7:16'),
                          datetime.datetime(2019, 5, 15, 8, 7, 16))
         self.assertEqual(dt + datec.PartialDate.parse('-1x:7:16'),
@@ -80,3 +84,35 @@ class DatecTest(unittest.TestCase):
                          datetime.datetime(2019, 3, 30))
         with self.assertRaises(ValueError):
             dt + datec.PartialDate(1, month=2, day=30)
+
+    def test_partialdate_zero(self):
+        dt = datetime.datetime(2019, 5, 15, 8, 15)
+        self.assertEqual(dt + datec.PartialDate(0, hour=12, zero=True),
+                         datetime.datetime(2019, 5, 15, 12, 0, 0))
+        self.assertEqual(dt + datec.PartialDate(0, minute=30, zero=True),
+                         datetime.datetime(2019, 5, 15, 8, 30, 0))
+        self.assertEqual(dt + datec.parse('12::/'),
+                         datetime.datetime(2019, 5, 15, 12, 0, 0))
+        self.assertEqual(dt + datec.parse('12:30:/'),
+                         datetime.datetime(2019, 5, 15, 12, 30, 0))
+        self.assertEqual(dt + datec.parse('2020-03-15/'),
+                         datetime.datetime(2020, 3, 15, 0, 0, 0))
+        # without zero, minute/second are unchanged
+        self.assertEqual(dt + datec.PartialDate(0, hour=12),
+                         datetime.datetime(2019, 5, 15, 12, 15))
+        self.assertEqual(dt + datec.parse('12::'),
+                         datetime.datetime(2019, 5, 15, 12, 15))
+
+    def test_validation(self):
+        with self.assertRaises(ValueError):
+            datec.Period(1, 'invalid')
+        with self.assertRaises(ValueError):
+            datec.Period(1.5, 'month')
+        with self.assertRaises(ValueError):
+            datec.Weekday(1, 7)
+        with self.assertRaises(ValueError):
+            datec.PartialDate(1, year=2020)
+        with self.assertRaises(ValueError):
+            datec.PartialDate(second=1.5, microsecond=500)
+        with self.assertRaises(ValueError):
+            datec.PartialDate(hour=12, second=30)