appier 1.34.2__tar.gz → 1.34.3__tar.gz

{appier-1.34.2/src/appier.egg-info → appier-1.34.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: appier
-Version: 1.34.2
+Version: 1.34.3
 Summary: Appier Framework
 Home-page: http://appier.hive.pt
 Author: Hive Solutions Lda.

{appier-1.34.2 → appier-1.34.3}/setup.py

@@ -44,7 +44,7 @@ def read_file(path):
 
 setuptools.setup(
     name="appier",
-    version="1.34.2",
+    version="1.34.3",
     author="Hive Solutions Lda.",
     author_email="development@hive.pt",
     description="Appier Framework",

{appier-1.34.2 → appier-1.34.3}/src/appier/base.py

@@ -94,7 +94,7 @@ NAME = "appier"
 """ The name to be used to describe the framework while working
 on its own environment, this is just a descriptive value """
 
-VERSION = "1.34.2"
+VERSION = "1.34.3"
 """ The version of the framework that is currently installed
 this value may be used for debugging/diagnostic purposes """
 
@@ -2328,7 +2328,7 @@ class App(
         thread.daemon = True
         thread.start()
 
-    def cron(self, job, cron):
+    def cron(self, job, cron, id=None, description=None):
         """
         Schedule the provided method for regular execution using
         the provided Cron like string.
@@ -2342,6 +2342,11 @@ class App(
         :type cron: String/SchedulerDate
         :param cron: The cron like string that is going to be used to
         define the execution time of the provided method.
+        :type id: String
+        :param id: The unique identifier for the task to be created.
+        :type description: String
+        :param description: The description for the task to be created
+        that describes the goal of the task.
         :rtype: SchedulerTask
         :return: The task that has been scheduled for execution at the
         provided time.
@@ -2350,7 +2355,7 @@ class App(
         if self._cron == None:
             self._cron = scheduler.CronScheduler(self)
             self._cron.start()
-        return self._cron.schedule(job, cron)
+        return self._cron.schedule(job, cron, id=id, description=description)
 
     def chunks(self, data, size=32768):
         for index in range(0, len(data), size):

{appier-1.34.2 → appier-1.34.3}/src/appier/scheduler.py

@@ -29,6 +29,7 @@ __license__ = "Apache License, Version 2.0"
 """ The license for the module """
 
 import time
+import uuid
 import heapq
 import datetime
 import logging
@@ -143,7 +144,7 @@ class CronScheduler(Scheduler):
 
         self.timeout = max(0, timestamp - current_ts())
 
-    def schedule(self, job, cron, now=None):
+    def schedule(self, job, cron, id=None, description=None, now=None):
         """
         Schedules the provided job function for execution according
         to the provided cron string.
@@ -156,13 +157,18 @@ class CronScheduler(Scheduler):
         :param job: The function to be executed as the job.
         :type cron: String/SchedulerDate
         :param cron: The cron like string defining the schedule.
+        :type id: String
+        :param id: The unique identifier for the task to be created.
+        :type description: String
+        :param description: The description for the task to be created
+        that describes the goal of the task.
         :type now: datetime
         :param now: Optional time reference for the job scheduling.
         :rtype: SchedulerTask
         :return: The task object that was created for the job.
         """
 
-        task = SchedulerTask(job, cron)
+        task = SchedulerTask(job, cron, id=id, description=description)
         heapq.heappush(self._tasks, (task.next_timestamp(now=now), task))
         self.awake()
         return task
@@ -181,16 +187,18 @@ class CronScheduler(Scheduler):
 
 class SchedulerTask(object):
 
-    def __init__(self, job, cron):
+    def __init__(self, job, cron, id=None, description=None):
         self.job = job
         self.date = SchedulerDate.from_cron(cron)
+        self.id = str(uuid.uuid4()) if id == None else id
+        self.description = description
         self._enabled = True
 
     def __repr__(self):
-        return "<SchedulerTask: %s, %s>" % (self.job, self.date)
+        return "<SchedulerTask: [%s] %s, %s>" % (self.id[:-12], self.job, self.date)
 
     def __str__(self):
-        return "<SchedulerTask: %s, %s>" % (self.job, self.date)
+        return "<SchedulerTask: [%s] %s, %s>" % (self.id[:-12], self.job, self.date)
 
     def __eq__(self, other):
         if isinstance(other, self.__class__):
@@ -216,6 +224,10 @@ class SchedulerTask(object):
     def enabled(self):
         return self._enabled
 
+    @property
+    def cron(self):
+        return self.date.into_cron()
+
 
 class SchedulerDate(object):
 
@@ -229,10 +241,10 @@ class SchedulerDate(object):
         self.days_of_week = self._parse_field(days_of_week, 0, 6)
 
     def __repr__(self):
-        return "<SchedulerDate: %s>" % self.next_run()
+        return "<SchedulerDate: %s, %s>" % (self.into_cron(), self.next_run())
 
     def __str__(self):
-        return "<SchedulerDate: %s>" % self.next_run()
+        return "<SchedulerDate: %s, %s>" % (self.into_cron(), self.next_run())
 
     @classmethod
     def from_cron(cls, cron):
@@ -241,6 +253,17 @@ class SchedulerDate(object):
         values = (value.strip().split(",") for value in cron.split(" "))
         return cls(*values)
 
+    def into_cron(self):
+        return " ".join(
+            [
+                self._into_cron_field(self.minutes, 0, 59),
+                self._into_cron_field(self.hours, 0, 23),
+                self._into_cron_field(self.days_of_month, 1, 31),
+                self._into_cron_field(self.months, 1, 12),
+                self._into_cron_field(self.days_of_week, 0, 6),
+            ]
+        )
+
     def next_timestamp(self, now=None):
         date = self.next_run(now=now)
         return legacy.to_timestamp(date)
@@ -301,6 +324,11 @@ class SchedulerDate(object):
         else:
             return set((int(field),))
 
+    def _into_cron_field(self, field, min_value, max_value):
+        if field == set(range(min_value, max_value + 1)):
+            return "*"
+        return ",".join(str(v) for v in sorted(field))
+
 
 class Cron(object):
     pass

{appier-1.34.2 → appier-1.34.3}/src/appier/scheduler.pyi

@@ -29,7 +29,12 @@ class CronScheduler(Scheduler):
     def __init__(self, owner: App | None, timeout: float = ..., daemon: bool = ...): ...
     def tick(self, now_ts: float | None = ...): ...
     def schedule(
-        self, job: JobFunction, cron: Cron, now: datetime | None = ...
+        self,
+        job: JobFunction,
+        cron: Cron,
+        id: str | None = ...,
+        description: str | None = ...,
+        now: datetime | None = ...,
     ) -> SchedulerTask: ...
     def next_run(self) -> datetime | None: ...
     def next_timestamp(self) -> float | None: ...
@@ -38,13 +43,21 @@ class SchedulerTask(object):
     job: JobFunction
     date: SchedulerDate
 
-    def __init__(self, job: JobFunction, cron: Cron): ...
+    def __init__(
+        self,
+        job: JobFunction,
+        cron: Cron,
+        id: str | None = ...,
+        description: str | None = ...,
+    ): ...
     def enable(self): ...
     def disable(self): ...
     def next_run(self, now: datetime | None = ...) -> datetime: ...
     def next_timestamp(self, now: datetime | None = ...) -> float: ...
     @property
     def enabled(self) -> bool: ...
+    @property
+    def cron(self) -> str: ...
 
 class SchedulerDate(object):
     minutes: set[int]
@@ -63,8 +76,12 @@ class SchedulerDate(object):
     ): ...
     @classmethod
     def from_cron(cls, cron: Cron) -> SchedulerDate: ...
+    def into_cron(self) -> str: ...
     def next_timestamp(self, now: datetime | None = None) -> float: ...
     def next_run(self, now: datetime | None = None) -> datetime: ...
     def _parse_field(
         self, field: CronField, min_value: int, max_value: int
     ) -> set[int]: ...
+    def _into_cron_field(
+        self, field: set[int], min_value: int, max_value: int
+    ) -> str: ...

{appier-1.34.2 → appier-1.34.3}/src/appier/test/scheduler.py

@@ -164,6 +164,12 @@ class CronSchedulerTest(unittest.TestCase):
 
 class SchedulerDateTest(unittest.TestCase):
 
+    def test_repr(self):
+        date = appier.SchedulerDate.from_cron("11")
+        self.assertEqual(
+            repr(date), "<SchedulerDate: 11 * * * *, %s>" % str(date.next_run())
+        )
+
     def test_from_cron(self):
         date = appier.SchedulerDate.from_cron("11")
         self.assertEqual(date.minutes, set((11,)))
@@ -172,6 +178,25 @@ class SchedulerDateTest(unittest.TestCase):
         self.assertEqual(date.months, set(range(1, 13)))
         self.assertEqual(date.days_of_week, set(range(0, 7)))
 
+    def test_into_cron(self):
+        date = appier.SchedulerDate.from_cron("11")
+        self.assertEqual(date.into_cron(), "11 * * * *")
+
+        date = appier.SchedulerDate.from_cron("11 3")
+        self.assertEqual(date.into_cron(), "11 3 * * *")
+
+        date = appier.SchedulerDate.from_cron("11 3 10")
+        self.assertEqual(date.into_cron(), "11 3 10 * *")
+
+        date = appier.SchedulerDate.from_cron("11 3 10 5")
+        self.assertEqual(date.into_cron(), "11 3 10 5 *")
+
+        date = appier.SchedulerDate.from_cron("11 3 10 5 2")
+        self.assertEqual(date.into_cron(), "11 3 10 5 2")
+
+        date = appier.SchedulerDate.from_cron("* 3 10 5 2")
+        self.assertEqual(date.into_cron(), "* 3 10 5 2")
+
     def test_next_run(self):
         date = appier.SchedulerDate.from_cron("11")
 

{appier-1.34.2 → appier-1.34.3/src/appier.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: appier
-Version: 1.34.2
+Version: 1.34.3
 Summary: Appier Framework
 Home-page: http://appier.hive.pt
 Author: Hive Solutions Lda.