cook-build 0.5.0__tar.gz → 0.6.0__tar.gz

cook_build-0.6.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: cook-build
+Version: 0.6.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: networkx>=3.2.1
+Dynamic: license-file
+
+# 🧑‍🍳 Cook [![](https://github.com/tillahoffmann/cook-build/actions/workflows/main.yaml/badge.svg)](https://github.com/tillahoffmann/cook-build/actions/workflows/main.yaml) [![](https://img.shields.io/pypi/v/cook-build)](https://pypi.org/project/cook-build)
+
+Cook is a task-centric build system with simple declarative recipes specified in Python.
+
+## Getting Started
+
+Tasks are declared in a `recipe.py` file using the `cook.manager.create_task` function. Each task must have a unique name, may depend on files or other tasks, and can execute an action, typically a shell command. The simple example below creates a C source file, compiles it, and executes the binary.
+
+```python
+>>> from cook import create_task
+
+>>> create_task("src", targets=["hello.c"],
+...             action="echo 'int main() { return 0; }' > hello.c")
+>>> create_task("cc", dependencies=["hello.c"], targets=["hello"],
+...             action="cc -o hello hello.c")
+>>> create_task("hello", dependencies=["hello"], action="./hello")
+```
+
+Running `cook ls` from the command line lists all known tasks, e.g.,
+
+```bash
+$ cook ls
+<task `src` @ /.../recipe.py:3>
+<task `cc` @ /.../recipe.py:6>
+<task `hello` @ /.../recipe.py:9>
+```
+
+Running `cook exec hello` creates the source file, compiles it, and executes the binary (using `--log-level=debug` can provide additional information).
+
+```bash
+$ cook exec hello
+INFO: executing <task `src` @ /.../recipe.py:3> ...
+INFO: completed <task `src` @ /.../recipe.py:3> in 0:00:...
+INFO: executing <task `cc` @ /.../recipe.py:6> ...
+INFO: completed <task `cc` @ /.../recipe.py:6> in 0:00:...
+INFO: executing <task `hello` @ /.../recipe.py:9> ...
+INFO: completed <task `hello` @ /.../recipe.py:9> in 0:00:...
+```
+
+To rerun a task, tell Cook to reset it.
+
+```bash
+$ cook reset cc
+INFO: reset 1 task
+```
+
+The full set of available commands can be explored using `cook --help` as shown below.
+
+```bash
+$ cook --help
+usage: cook [-h] [--recipe RECIPE] [--module MODULE] [--db DB]
+            [--log-level {warning,error,info,debug}]
+            {exec,ls,info,reset} ...
+
+positional arguments:
+  {exec,ls,info,reset}
+    exec                Execute one or more tasks.
+    ls                  List tasks.
+    info                Display information about one or more tasks.
+    reset               Reset the status of one or more tasks.
+
+options:
+  -h, --help            show this help message and exit
+  --recipe RECIPE       file containing declarative recipe for tasks
+  --module, -m MODULE   module containing declarative recipe for tasks
+  --db DB               database for keeping track of assets
+  --log-level {warning,error,info,debug}
+                        log level
+```
+
+## Tasks Are Dumb; Contexts Are Smart
+
+`cook.task.Task`s do not provide any functionality beyond storing metadata, including
+
+- `targets`, the files generated by the task,
+- `dependencies`, the files the task depends on,
+- `action`, the `cook.actions.Action` to execute when the task is run,
+- `task_dependencies`, other tasks that should be executed first,
+- `location`, filename and line number where the task was defined.
+
+All logic is handled by `cook.contexts.Context`s which are applied to each task when it is created. For example, `cook.contexts.create_group` adds all tasks created within the context to a group. This group can be executed to execute all child tasks.

cook_build-0.6.0/README.md

@@ -0,0 +1,81 @@
+# 🧑‍🍳 Cook [![](https://github.com/tillahoffmann/cook-build/actions/workflows/main.yaml/badge.svg)](https://github.com/tillahoffmann/cook-build/actions/workflows/main.yaml) [![](https://img.shields.io/pypi/v/cook-build)](https://pypi.org/project/cook-build)
+
+Cook is a task-centric build system with simple declarative recipes specified in Python.
+
+## Getting Started
+
+Tasks are declared in a `recipe.py` file using the `cook.manager.create_task` function. Each task must have a unique name, may depend on files or other tasks, and can execute an action, typically a shell command. The simple example below creates a C source file, compiles it, and executes the binary.
+
+```python
+>>> from cook import create_task
+
+>>> create_task("src", targets=["hello.c"],
+...             action="echo 'int main() { return 0; }' > hello.c")
+>>> create_task("cc", dependencies=["hello.c"], targets=["hello"],
+...             action="cc -o hello hello.c")
+>>> create_task("hello", dependencies=["hello"], action="./hello")
+```
+
+Running `cook ls` from the command line lists all known tasks, e.g.,
+
+```bash
+$ cook ls
+<task `src` @ /.../recipe.py:3>
+<task `cc` @ /.../recipe.py:6>
+<task `hello` @ /.../recipe.py:9>
+```
+
+Running `cook exec hello` creates the source file, compiles it, and executes the binary (using `--log-level=debug` can provide additional information).
+
+```bash
+$ cook exec hello
+INFO: executing <task `src` @ /.../recipe.py:3> ...
+INFO: completed <task `src` @ /.../recipe.py:3> in 0:00:...
+INFO: executing <task `cc` @ /.../recipe.py:6> ...
+INFO: completed <task `cc` @ /.../recipe.py:6> in 0:00:...
+INFO: executing <task `hello` @ /.../recipe.py:9> ...
+INFO: completed <task `hello` @ /.../recipe.py:9> in 0:00:...
+```
+
+To rerun a task, tell Cook to reset it.
+
+```bash
+$ cook reset cc
+INFO: reset 1 task
+```
+
+The full set of available commands can be explored using `cook --help` as shown below.
+
+```bash
+$ cook --help
+usage: cook [-h] [--recipe RECIPE] [--module MODULE] [--db DB]
+            [--log-level {warning,error,info,debug}]
+            {exec,ls,info,reset} ...
+
+positional arguments:
+  {exec,ls,info,reset}
+    exec                Execute one or more tasks.
+    ls                  List tasks.
+    info                Display information about one or more tasks.
+    reset               Reset the status of one or more tasks.
+
+options:
+  -h, --help            show this help message and exit
+  --recipe RECIPE       file containing declarative recipe for tasks
+  --module, -m MODULE   module containing declarative recipe for tasks
+  --db DB               database for keeping track of assets
+  --log-level {warning,error,info,debug}
+                        log level
+```
+
+## Tasks Are Dumb; Contexts Are Smart
+
+`cook.task.Task`s do not provide any functionality beyond storing metadata, including
+
+- `targets`, the files generated by the task,
+- `dependencies`, the files the task depends on,
+- `action`, the `cook.actions.Action` to execute when the task is run,
+- `task_dependencies`, other tasks that should be executed first,
+- `location`, filename and line number where the task was defined.
+
+All logic is handled by `cook.contexts.Context`s which are applied to each task when it is created. For example, `cook.contexts.create_group` adds all tasks created within the context to a group. This group can be executed to execute all child tasks.

{cook-build-0.5.0 → cook_build-0.6.0}/README.rst

@@ -30,8 +30,8 @@ Running :code:`cook ls` from the command line lists all known tasks, e.g.,
 
     $ cook ls
     <task `src` @ /.../recipe.py:3>
-    <task `cc` @ /.../recipe.py:4>
-    <task `hello` @ /.../recipe.py:5>
+    <task `cc` @ /.../recipe.py:6>
+    <task `hello` @ /.../recipe.py:9>
 
 Running :code:`cook exec hello` creates the source file, compiles it, and executes the binary (using :code:`--log-level=debug` can provide additional information).
 
@@ -42,10 +42,10 @@ Running :code:`cook exec hello` creates the source file, compiles it, and execut
     $ cook exec hello
     INFO: executing <task `src` @ /.../recipe.py:3> ...
     INFO: completed <task `src` @ /.../recipe.py:3> in 0:00:...
-    INFO: executing <task `cc` @ /.../recipe.py:4> ...
-    INFO: completed <task `cc` @ /.../recipe.py:4> in 0:00:...
-    INFO: executing <task `hello` @ /.../recipe.py:5> ...
-    INFO: completed <task `hello` @ /.../recipe.py:5> in 0:00:...
+    INFO: executing <task `cc` @ /.../recipe.py:6> ...
+    INFO: completed <task `cc` @ /.../recipe.py:6> in 0:00:...
+    INFO: executing <task `hello` @ /.../recipe.py:9> ...
+    INFO: completed <task `hello` @ /.../recipe.py:9> in 0:00:...
 
 To rerun a task, tell Cook to reset it.
 

cook_build-0.6.0/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "cook-build"
+version = "0.6.0"
+readme = "README.md"
+dependencies = [
+    "colorama>=0.4.6",
+    "networkx>=3.2.1",
+]
+requires-python = ">=3.10"
+
+[dependency-groups]
+dev = [
+    "build>=1.3.0",
+    "furo>=2025.9.25",
+    "pyright>=1.1.406",
+    "pytest>=8.4.2",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.13.3",
+    "sphinx>=7.4.7",
+    "sphinxcontrib-shtest>=0.5.0",
+    "twine>=6.2.0",
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project.scripts]
+cook = "cook.__main__:__main__"

cook_build-0.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{cook-build-0.5.0 → cook_build-0.6.0/src}/cook/__main__.py

@@ -1,5 +1,6 @@
 import argparse
 import colorama
+from contextlib import closing
 from datetime import datetime
 import fnmatch
 import importlib.util
@@ -10,9 +11,13 @@ import re
 import sqlite3
 import sys
 import textwrap
-from typing import Iterable, List, Optional
+from typing import Iterable
 
-from .contexts import create_target_directories, normalize_action, normalize_dependencies
+from .contexts import (
+    create_target_directories,
+    normalize_action,
+    normalize_dependencies,
+)
 from .controller import Controller, QUERIES
 from .manager import Manager
 from .task import Task
@@ -23,19 +28,28 @@ LOGGER = logging.getLogger("cook")
 
 
 class NoMatchingTaskError(ValueError):
-    def __init__(self, patterns: Iterable[re.Pattern]):
-        patterns = [f"`{pattern}`" for pattern in patterns]
-        if len(patterns) == 1:
-            message = f"found no tasks matching pattern {patterns[0]}"
+    def __init__(
+        self, patterns: Iterable[re.Pattern | str], hidden_tasks_available: bool
+    ) -> None:
+        self.hidden_tasks_available = hidden_tasks_available
+        formatted_patterns = [f"`{pattern}`" for pattern in patterns]
+        if len(formatted_patterns) == 1:
+            message = f"found no tasks matching pattern {formatted_patterns[0]}"
         else:
-            *patterns, last = patterns
-            message = "found no tasks matching patterns " + ", ".join(patterns) \
-                + (", or " if len(patterns) > 1 else " or ") + last
+            *formatted_patterns, last = formatted_patterns
+            message = (
+                "found no tasks matching patterns "
+                + ", ".join(formatted_patterns)
+                + (", or " if len(formatted_patterns) > 1 else " or ")
+                + last
+            )
+        if hidden_tasks_available:
+            message = message + "; use --all or -a to include hidden tasks"
         super().__init__(message)
 
 
 class Args:
-    tasks: Iterable[re.Pattern]
+    tasks: Iterable[re.Pattern | str]
     re: bool
     all: bool
 
@@ -44,34 +58,65 @@ class Command:
     """
     Abstract base class for commands.
     """
-    NAME: Optional[str] = None
+
+    NAME: str | None = None
     ALLOW_EMPTY_PATTERN: bool = False
 
     def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("--re", "-r", action="store_true",
-                            help="use regular expressions for pattern matching instead of glob")
-        parser.add_argument("--all", "-a", action="store_true",
-                            help="include tasks starting with `_` prefix")
-        parser.add_argument("tasks", nargs="*" if self.ALLOW_EMPTY_PATTERN else "+",
-                            help="task or tasks to execute as regular expressions or glob patterns")
+        parser.add_argument(
+            "--re",
+            "-r",
+            action="store_true",
+            help="use regular expressions for pattern matching instead of glob",
+        )
+        parser.add_argument(
+            "--all",
+            "-a",
+            action="store_true",
+            help="include tasks starting with `_` prefix",
+        )
+        parser.add_argument(
+            "tasks",
+            nargs="*" if self.ALLOW_EMPTY_PATTERN else "+",
+            help="task or tasks to execute as regular expressions or glob patterns",
+        )
 
     def execute(self, controller: Controller, args: argparse.Namespace) -> None:
         raise NotImplementedError
 
-    def discover_tasks(self, controller: Controller, args: Args) -> List[Task]:
+    def discover_tasks(self, controller: Controller, args: Args) -> list[Task]:
+        task: Task
+        tasks: list[Task] = []
+
+        # Get tasks based on the pattern matching.
         if not args.tasks:
-            return list(controller.dependencies)
+            tasks = list(controller.dependencies)
+        else:
+            for task in controller.dependencies:
+                if args.re:
+                    match = any(re.match(pattern, task.name) for pattern in args.tasks)
+                else:
+                    match = any(
+                        fnmatch.fnmatch(task.name, pattern)  # pyright: ignore[reportArgumentType]
+                        for pattern in args.tasks
+                    )
+                if match:
+                    tasks.append(task)
+
+        # Store whether any of the candidates are hidden by default.
+        has_hidden_task = any(task.name.startswith("_") for task in tasks)
+
+        # Filter out hidden tasks if desired unless the name is an exact match to a specified
+        # pattern.
+        if not args.all:
+            tasks = [
+                task
+                for task in tasks
+                if not task.name.startswith("_") or task.name in args.tasks
+            ]
 
-        tasks: List[Task] = []
-        task: Task
-        for task in controller.dependencies:
-            match = any(re.match(pattern, task.name) for pattern in args.tasks) if args.re else \
-                any(fnmatch.fnmatch(task.name, pattern) for pattern in args.tasks)
-            match = match and (args.all or not task.name.startswith("_"))
-            if match:
-                tasks.append(task)
         if not tasks:
-            raise NoMatchingTaskError(args.tasks)
+            raise NoMatchingTaskError(args.tasks, not args.all and has_hidden_task)
         return tasks
 
 
@@ -83,13 +128,16 @@ class ExecCommand(Command):
     """
     Execute one or more tasks.
     """
+
     NAME = "exec"
 
     def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("--jobs", "-j", help="number of concurrent jobs", type=int, default=1)
+        parser.add_argument(
+            "--jobs", "-j", help="number of concurrent jobs", type=int, default=1
+        )
         super().configure_parser(parser)
 
-    def execute(self, controller: Controller, args: ExecArgs) -> None:
+    def execute(self, controller: Controller, args: ExecArgs) -> None:  # pyright: ignore[reportIncompatibleMethodOverride]
         tasks = self.discover_tasks(controller, args)
         controller.execute(tasks, num_concurrent=args.jobs)
 
@@ -103,28 +151,43 @@ class LsCommand(Command):
     """
     List tasks.
     """
+
     NAME = "ls"
     ALLOW_EMPTY_PATTERN = True
 
     def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("--stale", "-s", action="store_true", help="only show stale tasks")
-        parser.add_argument("--current", "-c", action="store_true", help="only show current tasks")
+        parser.add_argument(
+            "--stale", "-s", action="store_true", help="only show stale tasks"
+        )
+        parser.add_argument(
+            "--current", "-c", action="store_true", help="only show current tasks"
+        )
         super().configure_parser(parser)
 
-    def execute(self, controller: Controller, args: LsArgs) -> None:
+    def execute(self, controller: Controller, args: LsArgs) -> None:  # pyright: ignore[reportIncompatibleMethodOverride]
         tasks = self.discover_tasks(controller, args)
-        tasks = [task.format(colorama.Fore.YELLOW if is_stale else colorama.Fore.GREEN)
-                 for is_stale, task in zip(controller.is_stale(tasks), tasks)]
+        tasks = [
+            task.format(colorama.Fore.YELLOW if is_stale else colorama.Fore.GREEN)
+            for is_stale, task in zip(controller.is_stale(tasks), tasks)
+        ]
         print("\n".join(tasks))
 
-    def discover_tasks(self, controller: Controller, args: LsArgs) -> List[Task]:
+    def discover_tasks(self, controller: Controller, args: LsArgs) -> list[Task]:  # pyright: ignore[reportIncompatibleMethodOverride]
         if args.current and args.stale:
-            raise ValueError("only one of `--stale` and `--current` may be given at the same time")
+            raise ValueError(
+                "only one of `--stale` and `--current` may be given at the same time"
+            )
         tasks = super().discover_tasks(controller, args)
         if args.stale:
-            return [task for stale, task in zip(controller.is_stale(tasks), tasks) if stale]
+            return [
+                task for stale, task in zip(controller.is_stale(tasks), tasks) if stale
+            ]
         elif args.current:
-            return [task for stale, task in zip(controller.is_stale(tasks), tasks) if not stale]
+            return [
+                task
+                for stale, task in zip(controller.is_stale(tasks), tasks)
+                if not stale
+            ]
         return tasks
 
 
@@ -132,6 +195,7 @@ class InfoCommand(LsCommand):
     """
     Display information about one or more tasks.
     """
+
     NAME = "info"
 
     def execute(self, controller: Controller, args: LsArgs) -> None:
@@ -150,21 +214,26 @@ class InfoCommand(LsCommand):
             ]
             # Show when the task last completed and failed.
             last = controller.connection.execute(
-                "SELECT last_completed, last_failed FROM tasks WHERE name = :name",
-                {"name": task.name}
-            ).fetchone() or (None, None)
-            for key, value in zip(["completed", "failed"], last):
+                "SELECT last_started, last_completed, last_failed FROM tasks WHERE name = :name",
+                {"name": task.name},
+            ).fetchone() or (None, None, None)
+            for key, value in zip(["started", "completed", "failed"], last):
                 if value is None:
                     parts.append(f"last {key}: -")
                     continue
-                parts.append(f"last {key}: {format_timedelta(datetime.now() - value)} ago "
-                             f"({format_datetime(value)})")
+                parts.append(
+                    f"last {key}: {format_timedelta(datetime.now() - value)} ago "
+                    f"({format_datetime(value)})"
+                )
             # Show dependencies and targets.
-            task_dependencies = list(sorted(controller.dependencies.successors(task),
-                                            key=lambda t: t.name))
+            task_dependencies = list(
+                sorted(controller.dependencies.successors(task), key=lambda t: t.name)
+            )
             task_dependencies = [
                 dep.format(colorama.Fore.YELLOW if is_stale else colorama.Fore.GREEN)
-                for is_stale, dep in zip(controller.is_stale(task_dependencies), task_dependencies)
+                for is_stale, dep in zip(
+                    controller.is_stale(task_dependencies), task_dependencies
+                )
             ]
             items = [
                 ("dependencies", task.dependencies),
@@ -179,22 +248,22 @@ class InfoCommand(LsCommand):
                     parts.append(f"{key}: -")
             parts.append(f"action: {task.action if task.action else '-'}")
 
-            parts = textwrap.indent('\n'.join(parts), indent)
+            parts = textwrap.indent("\n".join(parts), indent)
             print(f"{task}\n{parts}")
 
 
-class ResetArgs(argparse.Namespace):
-    tasks: Iterable[re.Pattern]
-    re: bool
+class ResetArgs(Args):
+    pass
 
 
 class ResetCommand(Command):
     """
     Reset the status of one or more tasks.
     """
+
     NAME = "reset"
 
-    def execute(self, controller: Controller, args: ResetArgs) -> None:
+    def execute(self, controller: Controller, args: ResetArgs) -> None:  # pyright: ignore[reportIncompatibleMethodOverride]
         tasks = self.discover_tasks(controller, args)
         controller.reset(*tasks)
 
@@ -217,14 +286,26 @@ class Formatter(logging.Formatter):
         return formatted
 
 
-def __main__(cli_args: Optional[List[str]] = None) -> None:
+def __main__(cli_args: list[str] | None = None) -> None:
     parser = argparse.ArgumentParser("cook")
-    parser.add_argument("--recipe", help="file containing declarative recipe for tasks",
-                        default="recipe.py", type=Path)
-    parser.add_argument("--module", "-m", help="module containing declarative recipe for tasks")
-    parser.add_argument("--db", help="database for keeping track of assets", default=".cook")
-    parser.add_argument("--log-level", help="log level", default="info",
-                        choices={"error", "warning", "info", "debug"})
+    parser.add_argument(
+        "--recipe",
+        help="file containing declarative recipe for tasks",
+        default="recipe.py",
+        type=Path,
+    )
+    parser.add_argument(
+        "--module", "-m", help="module containing declarative recipe for tasks"
+    )
+    parser.add_argument(
+        "--db", help="database for keeping track of assets", default=".cook"
+    )
+    parser.add_argument(
+        "--log-level",
+        help="log level",
+        default="info",
+        choices={"error", "warning", "info", "debug"},
+    )
     subparsers = parser.add_subparsers()
     subparsers.required = True
 
@@ -242,11 +323,13 @@ def __main__(cli_args: Optional[List[str]] = None) -> None:
 
     with Manager() as manager:
         try:
-            manager.contexts.extend([
-                create_target_directories(),
-                normalize_action(),
-                normalize_dependencies(),
-            ])
+            manager.contexts.extend(
+                [
+                    create_target_directories(),
+                    normalize_action(),
+                    normalize_dependencies(),
+                ]
+            )
             if args.module:
                 # Temporarily add the current working directory to the path.
                 try:
@@ -257,16 +340,22 @@ def __main__(cli_args: Optional[List[str]] = None) -> None:
             elif args.recipe.is_file():
                 # Parse the recipe.
                 spec = importlib.util.spec_from_file_location("recipe", args.recipe)
+                assert spec, f"Could not load spec for '{args.recipe}'."
                 recipe = importlib.util.module_from_spec(spec)
+                assert spec.loader, f"Could not load recipe '{args.recipe}'."
                 spec.loader.exec_module(recipe)
             else:  # pragma: no cover
-                raise ValueError("recipe file or module must be specified; default recipe.py not "
-                                 "found")
+                raise ValueError(
+                    "recipe file or module must be specified; default recipe.py not "
+                    "found"
+                )
         except:  # noqa: E722
             LOGGER.fatal("failed to load recipe", exc_info=sys.exc_info())
             sys.exit(1)
 
-    with sqlite3.connect(args.db, detect_types=sqlite3.PARSE_DECLTYPES) as connection:
+    with closing(
+        sqlite3.connect(args.db, detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection:
         connection.executescript(QUERIES["schema"])
         controller = Controller(manager.resolve_dependencies(), connection)
         command: Command = args.command