python-dmon 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

dmon/cli.py

@@ -5,7 +5,7 @@ import sys
 from colorama import just_fix_windows_console
 
 from .config import check_name_in_config, get_task_config
-from .control import list_processes, restart, start, stop, status
+from .control import execute, list_processes, restart, start, stop, status
 from .constants import (
     DEFAULT_META_DIR,
     DEFAULT_RUN_NAME,
@@ -16,14 +16,28 @@ from .constants import (
 from .types import DmonTaskConfig
 
 
+def get_version():
+    # if python 3.8 or later, use importlib.metadata
+    import importlib.metadata
+
+    return importlib.metadata.version("python-dmon")
+
+
 def main():
     just_fix_windows_console()
 
     parser = argparse.ArgumentParser(
         prog="dmon",
-        description="Minimal cross-platform daemon manager",
+        description=f"dmon v{get_version()} - Lightweight cross-platform daemon manager",
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=get_version(),
+    )
+
     subparsers = parser.add_subparsers(dest="command")
 
     # start subcommand
@@ -34,7 +48,7 @@ def main():
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     sp_start.add_argument(
-        "name",
+        "task",
         help="Configured task name (default: the only task if there's just one)",
         nargs="?",
     )
@@ -55,7 +69,7 @@ def main():
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     sp_stop.add_argument(
-        "name",
+        "task",
         help="Configured task name (default: the only task if there's just one)",
         nargs="?",
     )
@@ -69,7 +83,7 @@ def main():
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     sp_restart.add_argument(
-        "name",
+        "task",
         help="Configured task name (default: the only task if there's just one)",
         nargs="?",
     )
@@ -90,7 +104,7 @@ def main():
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     sp_status.add_argument(
-        "name",
+        "task",
         help="Configured task name (default: the only task if there's just one)",
         nargs="?",
     )
@@ -162,41 +176,65 @@ def main():
         help="Command (with args) to run",
     )
 
+    sp_exec = subparsers.add_parser(
+        "exec",
+        help="Execute a configured task in the foreground",
+        description="Execute a configured task in the foreground",
+    )
+    sp_exec.add_argument(
+        "task",
+        help="Configured task name (default: the only task if there's just one)",
+        nargs="?",
+    )
+
+    # add custom config file option
+    for sp in [sp_start, sp_stop, sp_restart, sp_status, sp_exec]:
+        sp.add_argument(
+            "--config",
+            help="Path to config file (YAML or TOML) (default: search from current directory upwards)",
+        )
+
     args = parser.parse_args()
 
     if args.command in ["start", "restart"]:
         sp = sp_start if args.command == "start" else sp_restart
         try:
-            name, task_cfg = get_task_config(args.name)
+            task, task_cfg = get_task_config(args.task, args.config)
         except Exception as e:
             sp.error(str(e))
 
         task_cfg.meta_path = (
-            args.meta_file or task_cfg.meta_path or META_PATH_TEMPLATE.format(name=name)
+            args.meta_file or task_cfg.meta_path or META_PATH_TEMPLATE.format(task=task)
         )
         task_cfg.log_path = (
-            args.log_file or task_cfg.log_path or LOG_PATH_TEMPLATE.format(name=name)
+            args.log_file or task_cfg.log_path or LOG_PATH_TEMPLATE.format(task=task)
         )
         task_cfg.rotate_log_path = (
-            task_cfg.rotate_log_path or ROTATE_LOG_PATH_TEMPLATE.format(name=name)
+            task_cfg.rotate_log_path or ROTATE_LOG_PATH_TEMPLATE.format(task=task)
         )
         if args.command == "start":
             sys.exit(start(task_cfg))
         else:
             sys.exit(restart(task_cfg))
+    elif args.command == "exec":
+        try:
+            task, task_cfg = get_task_config(args.task, args.config)
+        except Exception as e:
+            sp_exec.error(str(e))
+        sys.exit(execute(task_cfg))
     elif args.command in ["stop", "status"]:
         sp = sp_stop if args.command == "stop" else sp_status
         if args.meta_file:
             meta_path = args.meta_file
         else:
-            if args.name:
-                name = args.name
+            if args.task:
+                task = args.task
             else:
                 try:
-                    name, _ = get_task_config(args.name)
+                    task, _ = get_task_config(args.task, args.config)
                 except Exception as e:
                     sp.error(str(e))
-            meta_path = META_PATH_TEMPLATE.format(name=name)
+            meta_path = META_PATH_TEMPLATE.format(task=task)
         if args.command == "stop":
             sys.exit(stop(meta_path))
         else:
@@ -209,18 +247,18 @@ def main():
             sp_run.error("Please provide a non-empty name for the task.")
         elif check_name_in_config(args.name):
             sp_run.error(
-                f"Name '{args.name}' already exists in config. Please choose another name."
+                f"Task '{args.name}' already exists in config. Please choose another name."
             )
 
         task_cfg = DmonTaskConfig(
-            name=args.name,
+            task=args.name,
             cmd=shlex.join(args.command_list) if args.shell else args.command_list,
             cwd=args.cwd,
-            meta_path=args.meta_file or META_PATH_TEMPLATE.format(name=args.name),
-            log_path=args.log_file or LOG_PATH_TEMPLATE.format(name=args.name),
+            meta_path=args.meta_file or META_PATH_TEMPLATE.format(task=args.name),
+            log_path=args.log_file or LOG_PATH_TEMPLATE.format(task=args.name),
             log_rotate=args.log_rotate,
             rotate_log_path=args.rotate_log_path
-            or ROTATE_LOG_PATH_TEMPLATE.format(name=args.name),
+            or ROTATE_LOG_PATH_TEMPLATE.format(task=args.name),
         )
         sys.exit(start(task_cfg))
     else:

dmon/config.py

@@ -43,7 +43,30 @@ def find_dmon_yaml(start: Optional[Path] = None):
     # raise FileNotFoundError(f"No dmon.yaml or dmon.yml found from {start} upwards.")
 
 
-def load_config():
+def load_config(cfg_path: Optional[str] = None):
+    """
+    Load configuration from the given path, or search for dmon.yaml or pyproject.toml.
+    """
+
+    # Load configuration from the given path
+    if cfg_path:
+        path = Path(cfg_path).resolve()
+        if not path.exists():
+            raise FileNotFoundError(f"Config file '{path}' does not exist.")
+        if path.suffix in [".yaml", ".yml"]:
+            import yaml
+
+            with path.open("r", encoding="utf-8") as f:
+                cfg = yaml.safe_load(f)
+        elif path.suffix == ".toml":
+            with path.open("rb") as f:
+                cfg = tomllib.load(f)
+            cfg = cfg.get("tool", {}).get("dmon", {})
+        else:
+            raise ValueError("Config file must be YAML (.yaml/.yml) or TOML (.toml)")
+        return cfg, path
+
+    # No path provided, search for dmon.yaml first, then pyproject.toml
     path = find_dmon_yaml()
     if path:
         import yaml
@@ -78,7 +101,7 @@ def validate_cmd_type(cmd, name: str) -> CmdType:
 
 
 def validate_task(task, name: str) -> DmonTaskConfig:
-    ret = DmonTaskConfig(name=name)
+    ret = DmonTaskConfig(task=name)
     if isinstance(task, str) or isinstance(task, list):
         ret.cmd = validate_cmd_type(task, name)
     elif isinstance(task, dict):
@@ -151,14 +174,15 @@ def validate_task(task, name: str) -> DmonTaskConfig:
     return ret
 
 
-def get_task_config(name: Optional[str] = None):
+def get_task_config(name: Optional[str], cfg_path: Optional[str]):
     """
-    Get the validated task configuration for the given task name from [tool.dmon.tasks] or dmon.yaml.
-
+    Get the validated task configuration for the given task name.
     If name is None or empty, and there is only one task, return that task; otherwise, raise ValueError.
     If the task is not found, or required fields are missing, raise TypeError or ValueError.
+
+    The config is loaded from the given path, or searched for dmon.yaml or pyproject.toml.
     """
-    cfg, path = load_config()
+    cfg, path = load_config(cfg_path)
     tasks = cfg.get("tasks", {})
 
     if not isinstance(tasks, dict):

dmon/constants.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+import sys
 
 
 DEFAULT_META_DIR = Path(".dmon")
@@ -6,9 +7,11 @@ DEFAULT_LOG_DIR = Path("logs")
 
 META_SUFFIX = ".meta.json"
 
-META_PATH_TEMPLATE = str(DEFAULT_META_DIR / ("{name}" + META_SUFFIX))
-LOG_PATH_TEMPLATE = str(DEFAULT_LOG_DIR / "{name}.log")
-ROTATE_LOG_PATH_TEMPLATE = str(DEFAULT_LOG_DIR / "{name}.rotate.log")
+META_PATH_TEMPLATE = str(DEFAULT_META_DIR / ("{task}" + META_SUFFIX))
+LOG_PATH_TEMPLATE = str(DEFAULT_LOG_DIR / "{task}.log")
+ROTATE_LOG_PATH_TEMPLATE = str(DEFAULT_LOG_DIR / "{task}.rotate.log")
 
 
 DEFAULT_RUN_NAME = "default_run"
+
+ON_WINDOWS = sys.platform.startswith("win")

dmon/control.py

@@ -2,6 +2,7 @@ import os
 from pathlib import Path
 import shlex
 import shutil
+import signal
 import sys
 import subprocess
 import time
@@ -10,7 +11,7 @@ from typing import List
 import psutil
 from termcolor import colored
 
-from .constants import DEFAULT_META_DIR, META_SUFFIX
+from .constants import DEFAULT_META_DIR, META_SUFFIX, ON_WINDOWS
 from .types import DmonTaskConfig, DmonMeta, PathType
 from .utils import len_ansi, pad_ansi
 
@@ -66,7 +67,7 @@ def start(cfg: DmonTaskConfig):
 
     # Platform-specific parameters to run the process in background detached from parent
     kwargs = {}
-    if sys.platform.startswith("win"):
+    if ON_WINDOWS:
         # DETACHED_PROCESS = 0x00000008
         CREATE_NO_WINDOW = 0x08000000
         kwargs["creationflags"] = CREATE_NO_WINDOW
@@ -78,7 +79,7 @@ def start(cfg: DmonTaskConfig):
         kwargs["start_new_session"] = True
 
     meta = DmonMeta(
-        name=cfg.name,
+        task=cfg.task,
         meta_path=str(meta_path),
         log_path=str(log_path),
         log_rotate=cfg.log_rotate,
@@ -213,7 +214,7 @@ def stop(
         meta_path.unlink(missing_ok=True)
         return 1
 
-    if sys.platform.startswith("win"):
+    if ON_WINDOWS:
         ret = terminate_win(proc, timeout)
     else:
         ret = terminate_posix(proc, timeout)
@@ -416,7 +417,7 @@ def print_status(meta: DmonMeta):
 
     # key-value pairs with aligned keys
     rows = [
-        ("TASK", colored(meta.name, "cyan", attrs=["bold"])),
+        ("TASK", colored(meta.task, "cyan", attrs=["bold"])),
         ("PID", colored(str(meta.pid), "cyan", attrs=["bold"])),
         ("STATUS", status),
         ("CMD", meta.cmd),
@@ -477,7 +478,7 @@ def print_process_table(metas: List[DmonMeta], full_width: bool = False):
             ppid = "N/A"
         rows.append(
             (
-                colored(meta.name, "cyan", attrs=["bold"]),
+                colored(meta.task, "cyan", attrs=["bold"]),
                 colored(meta.pid, "cyan", attrs=["bold"]),
                 ppid,
                 status,
@@ -540,3 +541,41 @@ def list_processes(dir: PathType, full_width: bool):
         file=sys.stderr,
     )
     return 0
+
+
+def execute(cfg: DmonTaskConfig):
+    """
+    Execute the command in the foreground.
+    This is used for the 'dmon exec' command.
+    """
+    cwd = Path(cfg.cwd).resolve()
+
+    env = None  # default behavior of Popen
+    if cfg.override_env:
+        env = cfg.env
+    elif cfg.env:
+        env = {**os.environ, **cfg.env}
+
+    shell = isinstance(cfg.cmd, str)
+
+    def signal_handler(signum: int, frame) -> None:
+        if ON_WINDOWS and signum == signal.SIGINT:
+            signum = signal.SIGTERM
+        proc.send_signal(signum)
+
+    prev_handle_int = signal.signal(signal.SIGINT, signal_handler)
+    prev_handle_term = signal.signal(signal.SIGTERM, signal_handler)
+
+    proc = subprocess.Popen(
+        cfg.cmd,
+        cwd=cwd,
+        env=env,
+        shell=shell,
+        bufsize=0,  # unbuffered
+        close_fds=False,
+    )
+    ret = proc.wait()
+
+    signal.signal(signal.SIGTERM, prev_handle_term)
+    signal.signal(signal.SIGINT, prev_handle_int)
+    return ret

dmon/runner.py

@@ -116,21 +116,13 @@ def main(
     )
 
     shell = isinstance(cmd, str)
-    # Start the child process with stdout/stderr redirected to the log
-    # env will be inherited from parent process
-    # cwd will be inherited from parent process
-    proc = subprocess.Popen(
-        cmd,
-        stdout=subprocess.PIPE,
-        stderr=subprocess.STDOUT,
-        shell=shell,
-        text=False,  # binary mode
-        bufsize=0,  # unbuffered
-    )
 
     # register signal handler to terminate the child process
-    def signal_handler(signum, frame):
+    def signal_handler(signum: int, frame):
         logger.info(f"Received signal {signum}, forwarding to child process...")
+        if sys.platform.startswith("win") and signum == signal.SIGINT:
+            signum = signal.SIGTERM
+            logger.info(f"On Windows, convert SIGINT to SIGTERM ({signum})")
         # proc.terminate()
         proc.send_signal(signum)
         logger.info("Waiting for child process to exit...")
@@ -142,6 +134,18 @@ def main(
     signal.signal(signal.SIGINT, signal_handler)
     signal.signal(signal.SIGTERM, signal_handler)
 
+    # Start the child process with stdout/stderr redirected to the log
+    # env will be inherited from parent process
+    # cwd will be inherited from parent process
+    proc = subprocess.Popen(
+        cmd,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+        shell=shell,
+        text=False,  # binary mode
+        bufsize=0,  # unbuffered
+    )
+
     logger.info(f"Started process {proc.pid} with command: {cmd} (shell={shell})")
 
     make_file_dir(log_path)

dmon/types.py

@@ -17,7 +17,7 @@ CmdType = Union[str, List[str]]
 
 @dataclass
 class DmonTaskConfig:
-    name: str = ""
+    task: str = ""
     """Name of the task"""
     cmd: CmdType = ""
     """Command to run, either a string (for shell) or a list of strings (for exec)"""

{python_dmon-0.2.0.dist-info → python_dmon-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-dmon
-Version: 0.2.0
+Version: 0.2.1
 Summary: A lightweight, cross-platform daemon manager that runs any command as a background process.
 Keywords: python-dmon,dmon,daemon,background,detach,process management
 Author: Atomie CHEN
@@ -12,7 +12,7 @@ Requires-Dist: termcolor>=2.4.0
 Requires-Dist: tomli>=2.2.1 ; python_full_version < '3.11'
 Requires-Python: >=3.8
 Project-URL: Bug Tracker, https://github.com/atomiechen/python-dmon/issues
-Project-URL: Changelog, https://github.com/atomiechen/python-dmon/blob/master/CHANGELOG.md
+Project-URL: Changelog, https://github.com/atomiechen/python-dmon/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://github.com/atomiechen/python-dmon
 Description-Content-Type: text/markdown
 
@@ -136,17 +136,17 @@ tasks:
     env:  # (default: inherit from parent process)
       PYTHONUNBUFFERED: "1"
     override_env: false  # override parent env and only use env defined here
-    log_path: "logs/<name>.log" # path to log file
+    log_path: "logs/<task>.log" # path to log file
     log_rotate: false  # enable log rotation
     log_max_size: 5  # max log file size before rotation in MB
-    rotate_log_path: "logs/<name>.rotate.log"  # path to rotation log
+    rotate_log_path: "logs/<task>.rotate.log"  # path to rotation log
     rotate_log_max_size: 5  # max rotation log file size in MB
-    meta_path: ".dmon/<name>.meta.json"  # path to meta file
+    meta_path: ".dmon/<task>.meta.json"  # path to meta file
 ```
 
 ## Under the Hood
 
-Each task is associated with a meta file (e.g. `.dmon/<name>.meta.json`) stored in the current working directory.
+Each task is associated with a meta file (e.g. `.dmon/<task>.meta.json`) stored in the current working directory.
 The file contains details such as the command, PID, log path, and more.
 **Do not** modify or delete these files manually.
 

python_dmon-0.2.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+dmon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dmon/__main__.py,sha256=wu5N2wk8mvBgyvr2ghmQf4prezAe0_i-p123VVreyYc,62
+dmon/cli.py,sha256=Dqu43_hcsx8iCJXAL1YXqBpp1jFt0Y7qBEr9mYzkAn8,8764
+dmon/config.py,sha256=a7YM4U_iMB1wQ03NpWGAjbX-N-8Rdt9n6XTzKzeGZq4,7566
+dmon/constants.py,sha256=uJPI66IJvT6vhamqEDeqHjZQS12RxCPe3DD5yCU0UR8,407
+dmon/control.py,sha256=u1sz2MtxHHDqsaFyc7QaG7HFPLnAkser_8riTYxFK1A,17276
+dmon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dmon/runner.py,sha256=iyotNIrbO6I_u02EcqwO7R7N3BEBP6b_8eL8yb3zeJQ,6082
+dmon/types.py,sha256=tTVoJzWk-Z8XiZCUt0VE8Z7-URpXMoS54HfVYXhW-0Q,1795
+dmon/utils.py,sha256=zVQC9YNhMQu4hrAp9k2ds2egnbWZZv7S5w8i2oVIPJg,808
+python_dmon-0.2.1.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+python_dmon-0.2.1.dist-info/entry_points.txt,sha256=rad5ugz4K_IyNXS_IrFPu0tS-UXlBCSJRhJv-OWd_yk,45
+python_dmon-0.2.1.dist-info/METADATA,sha256=gIMrWHILmOEnjtU-gZAoYdz8JAOxFYibkos4DYs_ba0,4496
+python_dmon-0.2.1.dist-info/RECORD,,

python_dmon-0.2.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-dmon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dmon/__main__.py,sha256=wu5N2wk8mvBgyvr2ghmQf4prezAe0_i-p123VVreyYc,62
-dmon/cli.py,sha256=IVJ5jCHkaLGTQjMmWCuJbhnt4MWEOaNWQajC-mm3LUQ,7599
-dmon/config.py,sha256=COzwN0Ms8q32pV6dqsZU59RFE2GQmqyAmfygDotc4CA,6610
-dmon/constants.py,sha256=y5S532iTeklaR28BFbvpdOHFj1udbEJ-reD1mTCcC6E,351
-dmon/control.py,sha256=0_NrrOA0sUM_lFHNyKGAmQsBbJhXwXfj8kxOp2S8Ni8,16311
-dmon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dmon/runner.py,sha256=zEW7TnHMfIw6g3UTjOTUcLFKueXpqSmNDP3ZOptXQKs,5892
-dmon/types.py,sha256=ZtTAK-cfs2MgUFRwDH61zeIU2B4dHZDbx1644tYI1h4,1795
-dmon/utils.py,sha256=zVQC9YNhMQu4hrAp9k2ds2egnbWZZv7S5w8i2oVIPJg,808
-python_dmon-0.2.0.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
-python_dmon-0.2.0.dist-info/entry_points.txt,sha256=rad5ugz4K_IyNXS_IrFPu0tS-UXlBCSJRhJv-OWd_yk,45
-python_dmon-0.2.0.dist-info/METADATA,sha256=s1AoObf2NB_kK_Era10wpm0X6OwH-J0UVeAS8Dg6pcs,4498
-python_dmon-0.2.0.dist-info/RECORD,,