Merge pull request #2 from dapper91/dev

weekday iteration bug fixed

Author: dapper91

.github/workflows/release.yml

@@ -6,7 +6,7 @@ on:
       - released
 
 jobs:
-  test:
+  release:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: release
+name: test
 
 on:
   pull_request:
@@ -26,4 +26,11 @@ jobs:
     - name: Run linter
       run: pipenv run flake8 .
     - name: Run tests
-      run: PYTHONPATH="$(pwd):$PYTHONPATH" pipenv run py.test --cov=crontools tests
+      run: PYTHONPATH="$(pwd):$PYTHONPATH" pipenv run py.test --cov=crontools --cov-report=xml tests
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        flags: unittests
+        fail_ci_if_error: true

CHANGELOG.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+0.1.1 (2021-03-16)
+------------------
+
+- Weekday iteration bug fixed
+
 
 0.1.0 (2021-03-15)
 ------------------

README.rst

@@ -2,6 +2,23 @@
 crontools
 =========
 
+.. image:: https://github.com/dapper91/crontools/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/dapper91/crontools/actions/workflows/test.yml
+    :alt: Build status
+.. image:: https://img.shields.io/pypi/l/crontools.svg
+    :target: https://pypi.org/project/crontools
+    :alt: License
+.. image:: https://img.shields.io/pypi/pyversions/crontools.svg
+    :target: https://pypi.org/project/crontools
+    :alt: Supported Python versions
+.. image:: https://codecov.io/gh/dapper91/crontools/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/dapper91/crontools
+    :alt: Code coverage
+
+
+``crontools`` is a library that allows you to parse crontab expression and iterate over scheduled fire times.
+
+
 Features:
 
 - crontab expression parser
@@ -22,28 +39,49 @@ You can install crontools with pip:
 Quickstart
 ----------
 
-On the server side everything is also pretty straightforward:
+
+Get next cron fire time:
+________________________
 
 .. code-block:: python
 
-    import datetime as dt
-    import crontools as ct
+    >>> import datetime as dt
+    >>> import crontools as ct
+    >>>
+    >>> tz = dt.timezone.utc
+    >>> now = dt.datetime.fromisoformat('2020-02-29 23:59:59.999+00:00')
+    >>> ct = ct.Crontab.parse(
+    ...     '* * * * * * *',
+    ...     seconds_ext=True,
+    ...     years_ext=True,
+    ...     tz=tz,
+    ... )
+    >>>
+    >>> print(f"Next fire time: {ct.next_fire_time(now=now)}")
+    Next fire time: 2020-03-01 00:00:00+00:00
 
-    tz = dt.timezone.utc
-    now = dt.datetime.fromisoformat('2021-02-01 00:00:00+00:00')
-    ct = ct.Crontab.parse(
-        '30 30 12-16/2 1,2 JAN SAT,SUN *',
-        seconds_ext=True,
-        years_ext=True,
-        tz=tz,
-    )
 
-    cron_iter = ct.iter(start_from=now)
-    for n, fire_datetime in zip(range(1, 31), cron_iter):
-        print("{n:2}: {dt}".format(n=n, dt=fire_datetime))
+Iteration over cron fire times starting from now:
+_________________________________________________
 
-    output:
+.. code-block:: python
 
+    >>> import crontools as ct
+    >>>
+    >>> tz = dt.timezone.utc
+    >>> now = dt.datetime.fromisoformat('2021-02-01 00:00:00+00:00')
+    >>> ct = ct.Crontab.parse(
+    ...     '30 30 12-16/2 1,2 JAN SAT,SUN *',
+    ...     seconds_ext=True,
+    ...     years_ext=True,
+    ...     tz=tz,
+    ... )
+    >>>
+    >>> cron_iter = ct.iter(start_from=now)
+    >>> for n, fire_datetime in zip(range(1, 31), cron_iter):
+    ...     print("{n:2}: {dt}".format(n=n, dt=fire_datetime))
+    ...
+    ...
      1: 2022-01-01 12:30:30+00:00
      2: 2022-01-01 14:30:30+00:00
      3: 2022-01-01 16:30:30+00:00

crontools/__about__.py

@@ -2,7 +2,7 @@
 __description__ = 'Python cron tools'
 __url__ = 'https://github.com/dapper91/crontools'
 
-__version__ = '0.1.0'
+__version__ = '0.1.1'
 
 __author__ = 'Dmitry Pershin'
 __email__ = '[email protected]'

crontools/crontab.py

@@ -53,16 +53,7 @@ def __init_subclass__(cls, title: str, min_value: int, max_value: int, aliases:
         cls.aliases = aliases
 
     def __iter__(self) -> Iterator[int]:
-        if self.is_default:
-            begin = self.min_value
-            end = self.max_value
-        else:
-            begin = self.begin
-            end = self.begin if self.end is None else self.end
-
-        step = 1 if self.step is None else self.step
-
-        return iter(range(begin, end + 1, step))
+        return self.iter()
 
     def __str__(self) -> str:
         if self.begin is None:
@@ -139,11 +130,19 @@ def iter(self, start_from: Optional[int] = None) -> Iterator[int]:
         :return: range values iterator
         """
 
-        range_iter = iter(self)
-        if start_from:
-            range_iter = it.dropwhile(lambda value: value < start_from, range_iter)
+        if self.is_default:
+            begin = self.min_value
+            end = self.max_value
+        else:
+            begin = self.begin
+            end = self.begin if self.end is None else self.end
+
+        step = 1 if self.step is None else self.step
+
+        if start_from is not None:
+            begin = max(begin, start_from)
 
-        return range_iter
+        return iter(range(begin, end + 1, step))
 
 
 @dc.dataclass(frozen=True)
@@ -236,7 +235,7 @@ def __str__(self) -> str:
         return ",".join(map(str, self.ranges))
 
     def __iter__(self) -> Iterator[int]:
-        return unique(heapq.merge(*self.ranges))
+        return self.iter()
 
     def iter(self, start_from: Optional[int] = None) -> Iterator[int]:
         """
@@ -246,11 +245,7 @@ def iter(self, start_from: Optional[int] = None) -> Iterator[int]:
         :return: iterator over all field values
         """
 
-        range_iter = iter(self)
-        if start_from:
-            range_iter = it.dropwhile(lambda value: value < start_from, range_iter)
-
-        return range_iter
+        return unique(heapq.merge(*(rng.iter(start_from=start_from) for rng in self.ranges)))
 
     @classmethod
     def __init_subclass__(cls, range_type: Type[Range]):
@@ -339,22 +334,22 @@ def _weekday_iter(self, year: int, month: int, start_day: int = 1) -> Iterator[i
         curr_weekday = calendar.weekday(year, month, curr_day) + 1
         weekday_iter = self._weekday_field.iter(start_from=curr_weekday)
 
-        for _ in range(4):
-            for weekday in it.cycle(it.chain(weekday_iter, (None,))):
-                if weekday is None:
-                    curr_day += (8 - curr_weekday)
-                    curr_weekday = calendar.weekday(year, month, curr_day) + 1
-                    weekday_iter = self._weekday_field.iter()
-                    break
-                else:
-                    curr_day += (weekday - curr_weekday)
-                    curr_weekday = calendar.weekday(year, month, curr_day) + 1
-
+        for _ in range(5):
+            for weekday in weekday_iter:
+                curr_day += (weekday - curr_weekday)
+                curr_weekday += (weekday - curr_weekday)
                 if curr_day > calendar.monthrange(year, month)[1]:
                     return
 
                 yield curr_day
 
+            curr_day += (8 - curr_weekday)
+            curr_weekday = 1
+            if curr_day > calendar.monthrange(year, month)[1]:
+                return
+
+            weekday_iter = self._weekday_field.iter()
+
 
 @dc.dataclass(frozen=True)
 class Crontab:

tests/test_crontab.py

@@ -460,6 +460,20 @@ def test_cron_iterator_start_from(expr, start_from, result, years_ext, seconds_e
             True,
             True,
         ),
+        (
+                '0 0 * * MON',
+                dt.datetime(year=2021, month=2, day=28, hour=0, minute=0, second=0, microsecond=0, tzinfo=dt.timezone.utc),
+                dt.datetime(year=2021, month=3, day=1, hour=0, minute=0, second=0, microsecond=0, tzinfo=dt.timezone.utc),
+                False,
+                False,
+        ),
+        (
+                '0 0 * * WED,THU',
+                dt.datetime(year=2021, month=3, day=31, hour=0, minute=0, second=0, microsecond=1, tzinfo=dt.timezone.utc),
+                dt.datetime(year=2021, month=4, day=1, hour=0, minute=0, second=0, microsecond=0, tzinfo=dt.timezone.utc),
+                False,
+                False,
+        ),
     ],
 )
 @freezegun.freeze_time('2020-01-01 00:00:00.000Z+00:00')