ddeutil-workflow 0.0.19__py3-none-any.whl → 0.0.21__py3-none-any.whl

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.19"
+__version__: str = "0.0.21"

ddeutil/workflow/__cron.py

@@ -653,6 +653,20 @@ class CronJob:
 
 
 class CronJobYear(CronJob):
+    """The Cron Job Converter with Year extension object that generate datetime
+    dimension of cron job schedule format,
+
+        *  *  *  *  *  *  <command to execute>
+
+        (i)     minute (0 - 59)
+        (ii)    hour (0 - 23)
+        (iii)   day of the month (1 - 31)
+        (iv)    month (1 - 12)
+        (v)     day of the week (0 - 6) (Sunday to Saturday; 7 is also Sunday
+                on some systems)
+        (vi)    year (1990 - 2100)
+    """
+
     cron_length = 6
     cron_units = CRON_UNITS_YEAR
 
@@ -705,9 +719,17 @@ class CronRunner:
         else:
             self.date: datetime = datetime.now(tz=self.tz)
 
+        # NOTE: Add one second if the microsecond value more than 0.
+        if self.date.microsecond > 0:
+            self.date: datetime = self.date.replace(microsecond=0) + timedelta(
+                seconds=1
+            )
+
         # NOTE: Add one minute if the second value more than 0.
         if self.date.second > 0:
-            self.date: datetime = self.date + timedelta(minutes=1)
+            self.date: datetime = self.date.replace(second=0) + timedelta(
+                minutes=1
+            )
 
         self.__start_date: datetime = self.date
         self.cron: CronJob | CronJobYear = cron
@@ -753,7 +775,7 @@ class CronRunner:
                 not self.__shift_date(mode, reverse)
                 for mode in ("year", "month", "day", "hour", "minute")
             ):
-                return copy.deepcopy(self.date.replace(second=0, microsecond=0))
+                return copy.deepcopy(self.date)
 
         raise RecursionError("Unable to find execution time for schedule")
 
@@ -802,6 +824,10 @@ class CronRunner:
             # NOTE: Replace date that less than it mode to zero.
             self.date: datetime = replace_date(self.date, mode, reverse=reverse)
 
+            # NOTE: Replace second and microsecond values that change from
+            #   the replace_date func with reverse flag.
+            self.date: datetime = self.date.replace(second=0, microsecond=0)
+
             if current_value != getattr(self.date, switch[mode]):
                 return mode != "month"
 

ddeutil/workflow/__init__.py

@@ -15,7 +15,10 @@ from .exceptions import (
     UtilException,
     WorkflowException,
 )
-from .job import Job, Strategy
+from .job import (
+    Job,
+    Strategy,
+)
 from .on import (
     On,
     YearOn,
@@ -24,8 +27,6 @@ from .on import (
 from .scheduler import (
     Schedule,
     ScheduleWorkflow,
-    Workflow,
-    WorkflowTaskData,
 )
 from .stage import (
     BashStage,
@@ -34,7 +35,7 @@ from .stage import (
     PyStage,
     Stage,
     TriggerStage,
-    handler_result,
+    extract_hook,
 )
 from .utils import (
     FILTERS,
@@ -70,3 +71,7 @@ from .utils import (
     str2template,
     tag,
 )
+from .workflow import (
+    Workflow,
+    WorkflowTaskData,
+)

ddeutil/workflow/__types.py

@@ -101,6 +101,7 @@ class Re:
     #
     #   Examples:
     #       - tasks/function@dummy
+    #
     __re_task_fmt: str = r"""
         ^
             (?P<path>[^/@]+)

ddeutil/workflow/conf.py

@@ -33,6 +33,29 @@ load_dotenv()
 env = os.getenv
 
 
+@lru_cache
+def get_logger(name: str):
+    """Return logger object with an input module name.
+
+    :param name: A module name that want to log.
+    """
+    lg = logging.getLogger(name)
+    formatter = logging.Formatter(
+        fmt=(
+            "%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d, "
+            "%(thread)-5d) [%(levelname)-7s] %(message)-120s "
+            "(%(filename)s:%(lineno)s)"
+        ),
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+    stream = logging.StreamHandler()
+    stream.setFormatter(formatter)
+    lg.addHandler(stream)
+
+    lg.setLevel(logging.DEBUG if config.debug else logging.INFO)
+    return lg
+
+
 class Config:
     """Config object for keeping application configuration on current session
     without changing when if the application still running.
@@ -77,6 +100,9 @@ class Config:
 
     # NOTE: Workflow
     max_job_parallel: int = int(env("WORKFLOW_CORE_MAX_JOB_PARALLEL", "2"))
+    max_job_exec_timeout: int = int(
+        env("WORKFLOW_CORE_MAX_JOB_EXEC_TIMEOUT", "600")
+    )
     max_poking_pool_worker: int = int(
         os.getenv("WORKFLOW_CORE_MAX_NUM_POKING", "4")
     )
@@ -98,12 +124,14 @@ class Config:
         os.getenv("WORKFLOW_API_ENABLE_ROUTE_SCHEDULE", "true")
     )
 
-    def __init__(self):
+    def __init__(self) -> None:
+        # VALIDATE: the MAX_JOB_PARALLEL value should not less than 0.
         if self.max_job_parallel < 0:
             raise ValueError(
                 f"``MAX_JOB_PARALLEL`` should more than 0 but got "
                 f"{self.max_job_parallel}."
             )
+
         try:
             self.stop_boundary_delta: timedelta = timedelta(
                 **json.loads(self.stop_boundary_delta_str)
@@ -287,29 +315,7 @@ def get_type(t: str, params: Config) -> AnyModelType:
 
 
 config = Config()
-
-
-@lru_cache
-def get_logger(name: str):
-    """Return logger object with an input module name.
-
-    :param name: A module name that want to log.
-    """
-    logger = logging.getLogger(name)
-    formatter = logging.Formatter(
-        fmt=(
-            "%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d, "
-            "%(thread)-5d) [%(levelname)-7s] %(message)-120s "
-            "(%(filename)s:%(lineno)s)"
-        ),
-        datefmt="%Y-%m-%d %H:%M:%S",
-    )
-    stream = logging.StreamHandler()
-    stream.setFormatter(formatter)
-    logger.addHandler(stream)
-
-    logger.setLevel(logging.DEBUG if config.debug else logging.INFO)
-    return logger
+logger = get_logger("ddeutil.workflow")
 
 
 class BaseLog(BaseModel, ABC):
@@ -319,8 +325,8 @@ class BaseLog(BaseModel, ABC):
     """
 
     name: str = Field(description="A workflow name.")
-    on: str = Field(description="A cronjob string of this piepline schedule.")
     release: datetime = Field(description="A release datetime.")
+    type: str = Field(description="A running type before logging.")
     context: DictData = Field(
         default_factory=dict,
         description=(
@@ -462,6 +468,9 @@ class FileLog(BaseLog):
         if not config.enable_write_log:
             return self
 
+        logger.debug(
+            f"({self.run_id}) [LOG]: Start writing log: {self.name!r}."
+        )
         log_file: Path = self.pointer() / f"{self.run_id}.log"
         log_file.write_text(
             json.dumps(

ddeutil/workflow/exceptions.py

@@ -3,6 +3,10 @@
 # Licensed under the MIT License. See LICENSE in the project root for
 # license information.
 # ------------------------------------------------------------------------------
+"""Exception objects for this package do not do anything because I want to
+create the lightweight workflow package. So, this module do just a exception
+annotate for handle error only.
+"""
 from __future__ import annotations