PyProd 0.4.0__tar.gz → 0.5.0__tar.gz

{pyprod-0.4.0 → pyprod-0.5.0}/.gitignore

@@ -1,3 +1,5 @@
+.*
+!.github
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -98,7 +100,7 @@ ipython_config.py
 #   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
-#uv.lock
+uv.lock
 
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.

{pyprod-0.4.0 → pyprod-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyProd
-Version: 0.4.0
+Version: 0.5.0
 Summary: PyProd: More Makeable than Make
 Project-URL: Homepage, https://github.com/atsuoishimoto/pyprod
 Project-URL: Documentation, https://pyprod.readthedocs.io/en/latest/
@@ -12,6 +12,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
+Requires-Dist: python-dateutil
 Description-Content-Type: text/x-rst
 
 PyProd - More Makeable than Make

{pyprod-0.4.0 → pyprod-0.5.0}/docs/commandline.rst

@@ -5,16 +5,19 @@ Command line options
 ------------------------
 
 
-usage: pyprod [-h] [-C DIRECTORY] [-f FILE] [-j JOB] [-r] [-v] [targets ...]
+usage: pyprod [-h] [-C DIRECTORY] [-f FILE] [-j JOB] [-r] [-g] [-v] [targets ...]
+
+PyProd - More makable than make
 
 positional arguments:
-  targets               Build targets. If no specific target is provided on the command line, the first target defined in the Prodfile is selected by default. Arguments containing ``=`` specifies the value of a :ref:`params <params>` (e.g., ``key=value``).
+  targets               Build targets
 
 options:
   -h, --help            show this help message and exit
   -C, --directory DIRECTORY
                         Change to DIRECTORY before performing any operations
-  -f, --file FILE       Use FILE as the Prodfile (default: 'PRODFILE.py')
+  -f, --file FILE       Use FILE as the Prodfile (default: 'Prodfile.py')
   -j, --job JOB         Allow up to N jobs to run simultaneously (default: 1)
   -r, --rebuild         Rebuild all
+  -g, --use-git         Get file timestamps from Git
   -v                    Increase verbosity level (default: 0)

{pyprod-0.4.0 → pyprod-0.5.0}/docs/conf.py

@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "PyProd"
-copyright = "2024, Atsuo Ishimoto"
+copyright = "2024-2025, Atsuo Ishimoto"
 author = "Atsuo Ishimoto"
 
 # -- General configuration ---------------------------------------------------

{pyprod-0.4.0 → pyprod-0.5.0}/docs/prodfile.rst

@@ -142,19 +142,17 @@ Task definition
 
 A task is similar to a rule but does not have a target and is always executed when it is depended upon.
 
-.. py:function:: @task(*, name=None, depends=(), uses=())
+.. py:function:: @task(*, name=None, uses=(), default=False)
 
    Defines a task to be executed.
 
    :param name: The name of the task. Defaults to the function name.
    :type name: str
 
-   :param depends: Specify the dependencies of the task. The task is alwayes excused regardless of the timestamp of the dependencies. The dependencies are passed to the task function as arguments.
-   :type depends: str | Path | list[str | Path]
-
-   :param uses: Specify the dependencies of the target file. Unline the ``depends`` parameter, ``uses`` are not passed to the task function.
+   :param uses: Specify the dependencies of the target file.
    :type uses: str | Path | list[str | Path]
 
+   :param default: If True, this task will be executed when no target is specified in the command-line arguments.
 
 .. code-block:: python
 
@@ -180,24 +178,32 @@ In addition to the ``@rule`` and ``@check`` decorators, PyProd provides several
 
 The following built-ins are available:
 
-.. py:function:: build(*deps):
+
+.. py:function:: build(*deps)
 
    Schedule dependencies. The specified deps are built sequentially after the current build completes.
 
-   :param args: name or functions to be built.
+   :param deps: name of dependencies to be built.
+
+   Example:
+
+   .. code-block:: python
+
+      @task
+      def rebuild():
+          build(clean, EXE)
 
 .. py:function:: pip(*args)
 
    Install Python packages. It creates a virtual environment if one does not already exist and installs the specified packages.
    
    :param args: Arguments to pass to the pip install command.
-   :type target: str
 
-Example:
+   Example:
 
-.. code-block:: python
+   .. code-block:: python
    
-   pip("numpy", "pandas")
+      pip("numpy", "pandas")
 
 .. _run:
 
@@ -241,7 +247,7 @@ Example:
       files = run("ls", stdout=True).stdout # Capture output
    
    
-.. py:function:: def capture(*args, echo=True, cwd=None, check=True, text=True, shell=None)
+.. py:function:: capture(*args, echo=True, cwd=None, check=True, text=True, shell=None)
 
    Execute a command and capture the output. This function is a wrapper around 
    :ref:`run <run>`.
@@ -273,7 +279,7 @@ Example:
       msg = capture("echo Hello, World!")
    
 
-.. py:function:: read(filename):
+.. py:function:: read(filename)
    
    Read the contents of a file.
 
@@ -283,7 +289,7 @@ Example:
    :return: The contents of the file.
    :rtype: str
 
-.. py:function:: write(filename, txt, append=False):
+.. py:function:: write(filename, txt, append=False)
    
    Write text to a file.
 
@@ -296,7 +302,7 @@ Example:
    :param append: Append to the file instead of overwriting it (default ``False``).
    :type append: bool
 
-.. py:function:: makedirs(path):
+.. py:function:: makedirs(path)
    
    Create a directory along with any necessary parent directories if they do not already exist. This function wraps `os.makedirs() <https://docs.python.org/3/library/os.html#os.makedirs>`_ with the ``exists_ok`` parameter set to ``True``.
 
@@ -345,6 +351,13 @@ Example:
    :return: The quoted string.
    :rtype: str
 
+.. py:function:: use_git(use)
+   
+   Enable or disable git support. If enabled, PyProd retrieves the last modified time of the files from the git log.
+
+   :param use: Enable or disable git support.
+   :type bool: bool
+
 .. py:class::  Path
    
    A class representing file paths. This function is an alias for `pathlib.Path <https://docs.python.org/3/library/pathlib.html#pathlib.Path>`_.
@@ -354,8 +367,7 @@ Example:
 
 .. py:data::  shutil
 
-   Module to perform high-level file operations. See `shutil <https://docs.python.org/3/library/shutil.html>`_ for detail.
-
+   An alias for the Python Standard Library's `shutil <https://docs.python.org/3/library/shutil.html>`_ module. This module provides a higher-level interface for file operations than the built-in `os <https://docs.python.org/3/library/os.html>`_ module.
 
 .. py:data:: env
    

{pyprod-0.4.0 → pyprod-0.5.0}/docs/releasenotes.rst

@@ -1,12 +1,19 @@
 Release Notes
 ================
 
+0.5.0 (2025-2-12)
+-----------------------------
+
+- Added ``default`` to the ``@task``.
+- Removed ``depends`` from thr ``@task``.
+- Added --use-git commandline option.
+
 0.4.0 (2025-1-17)
 -------------------------
 - Swapped the behavior of quote() and squote() to make their naming more intuitive.
 - Add @task decorator.
 - Change the parameter name target to targets.
-- Add --rebuild option.
+- Added --rebuild option.
 
 0.3.0 (2025-01-03)
 ------------------

{pyprod-0.4.0 → pyprod-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "PyProd"
-version = "0.4.0"
+dynamic = ["version"]
 description = "PyProd: More Makeable than Make"
 readme = "README.rst"
 requires-python = ">=3.10"
@@ -12,7 +12,9 @@ classifiers = [
     "Environment :: Console",
     "Topic :: Software Development :: Build Tools",
 ]
-dependencies = []
+dependencies = [
+    "python-dateutil",
+]
 
 [project.urls]
 Homepage = "https://github.com/atsuoishimoto/pyprod"
@@ -25,6 +27,9 @@ pyprod = "pyprod.main:main"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+path = "src/pyprod/__init__.py"
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.4",

{pyprod-0.4.0 → pyprod-0.5.0}/samples/build-c/Makefile

@@ -7,7 +7,7 @@ OBJS = main.o hello.o
 %.o: %.c $(DEPS)
 	$(CC) -c -o $@ $< $(CFLAGS)
 
-hello.exe a.x: $(OBJS)
+hello.exe: $(OBJS)
 	$(CC) -o $@ $^
 
 clean:

pyprod-0.4.0/samples/generate-doc/PRODFILE.py → pyprod-0.5.0/samples/generate-doc/Prodfile.py

@@ -15,7 +15,7 @@ def build_app(target, *src):
 
 @rule(BUILDDIR)
 def build_dir(target):
-    run("mkdir", target)
+    run("mkdir -p", target)
 
 
 @rule(BUILDDIR / "%.o", depends=("%.txt", COMMON), uses=BUILDDIR)

{pyprod-0.4.0 → pyprod-0.5.0}/samples/md-to-pdf/Prodfile.py

@@ -39,7 +39,7 @@ def make_html(target, src, template, *_):
 # create outputs directory
 @rule(BUILD)
 def builds(target):
-    os.makedirs(target)
+    os.makedirs(target, exist_ok=True)
 
 
 @task

pyprod-0.5.0/src/pyprod/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"

{pyprod-0.4.0 → pyprod-0.5.0}/src/pyprod/main.py

@@ -22,7 +22,7 @@ parser.add_argument(
 )
 
 parser.add_argument(
-    "-f", "--file", help="Use FILE as the Prodfile (default: 'PRODFILE.py')"
+    "-f", "--file", help="Use FILE as the Prodfile (default: 'Prodfile.py')"
 )
 
 parser.add_argument(
@@ -36,6 +36,15 @@ parser.add_argument(
 parser.add_argument(
     "-r", "--rebuild", dest="rebuild", action="store_true", help="Rebuild all"
 )
+
+parser.add_argument(
+    "-g",
+    "--use-git",
+    dest="use_git",
+    action="store_true",
+    help="Get file timestamps from Git",
+)
+
 parser.add_argument(
     "-v",
     dest="verbose",
@@ -108,7 +117,6 @@ def main():
     try:
         # load module
         prod = pyprod.prod.Prod(mod, args.job, params)
-
         # select targets
         if not targets:
             target = prod.get_default_target()

{pyprod-0.4.0 → pyprod-0.5.0}/src/pyprod/prod.py

@@ -15,8 +15,9 @@ from collections import defaultdict
 from collections.abc import Collection
 from dataclasses import dataclass, field
 from fnmatch import fnmatch, translate
+from functools import wraps
 from pathlib import Path
-
+import dateutil.parser
 import pyprod
 
 from .utils import flatten, unique_list
@@ -103,9 +104,10 @@ def capture(*args, echo=True, cwd=None, check=True, text=True, shell=None):
 
 def glob(path, dir="."):
     ret = []
-    for c in Path(dir).glob(path):
+    root = Path(dir)
+    for c in root.glob(path):
         # ignore dot files
-        if any(p.startswith(".") for p in c.parts):
+        if any((p not in (".", "..")) and p.startswith(".") for p in c.parts):
             continue
         ret.append(c)
     return ret
@@ -175,6 +177,8 @@ def _name_to_str(name):
             return str(name)
         case str():
             return name
+        case _:
+            raise ValueError(f"Invalid dependency name: {name}")
 
     return name
 
@@ -182,6 +186,7 @@ def _name_to_str(name):
 class Rule:
     def __init__(self, targets, pattern=None, depends=(), uses=(), builder=None):
         self.targets = []
+        self.default = False
         self.first_target = None
         if targets:
             for target in flatten(targets):
@@ -239,18 +244,23 @@ class _TaskFunc:
         return self.f(*args, **kwargs)
 
 
-def default_builder(self, *args, **kwargs):
+def default_builder(*args, **kwargs):
     # default builder
     pass
 
 
 class Task(Rule):
-    def __init__(self, name, depends, uses, func=None):
-        super().__init__((), pattern=None, depends=depends, uses=uses, builder=func)
-        self.name = _name_to_str(name)
+    def __init__(self, name, uses, default, func=None):
+        super().__init__((), pattern=None, depends=(), uses=uses, builder=func)
         if name:
-            self.targets = [name]
-            self.first_target = self.name
+            self.name = _name_to_str(name)
+            if name:
+                self.targets = [name]
+                self.first_target = self.name
+        else:
+            self.name = None
+
+        self.default = default
         if func:
             self._set_funcname(func)
         if not self.builder:
@@ -292,10 +302,10 @@ class Rules:
         self.rules.append(dep)
         return dep
 
-    def add_task(self, name=None, depends=(), uses=(), func=None):
+    def add_task(self, name=None, uses=(), default=False, func=None):
         if self.frozen:
             raise RuntimeError("No new rule can be added after initialization")
-        dep = Task(name, depends, uses, func)
+        dep = Task(name, uses, default, func)
         self.rules.append(dep)
         return dep
 
@@ -306,12 +316,12 @@ class Rules:
         dep = self.add_rule([targets], pattern, depends, uses, None)
         return dep
 
-    def task(self, func=None, *, name=None, depends=(), uses=()):
+    def task(self, func=None, *, name=None, uses=(), default=False):
         if func:
             if not callable(func):
                 raise ValueError(f"{func} is not callable")
 
-        dep = self.add_task(name, depends, uses, func)
+        dep = self.add_task(name, uses, default, func)
         return dep
 
     def iter_rule(self, name):
@@ -353,10 +363,16 @@ class Rules:
         return unique_list(ret_depends), unique_list(ret_uses)
 
     def select_first_target(self):
+        first = None
         for dep in self.rules:
+            if dep.default and (not first):
+                first = dep.name
+
             if dep.first_target:
                 return dep.first_target
 
+        return first
+
     def select_builder(self, name):
         for depends, uses, dep in self.iter_rule(name):
             if not dep.builder:
@@ -419,10 +435,6 @@ class Checkers:
 MAX_TS = 1 << 63
 
 
-def is_file_exists(name):
-    return os.path.getmtime(name)
-
-
 class Exists:
     def __init__(self, name, exists, ts=None):
         self.name = name
@@ -506,10 +518,12 @@ class Prod:
         self.rules = Rules()
         self.checkers = Checkers()
         if njobs > 1:
-            self.executor = concurrent.futures.ThreadPoolExecutor(max_workers=njobs)
+            self.executor = concurrent.futures.ThreadPoolExecutor(max_workers=100)
         else:
             self.executor = None
         self.params = Params(params)
+        self.use_git_timestamp = pyprod.args.use_git
+
         self.buildings = {}
         self.module = None
         if self.modulefile:
@@ -536,6 +550,7 @@ class Prod:
             "run": run,
             "shutil": shutil,
             "task": self.rules.task,
+            "use_git": self.use_git,
             "write": write,
             "MAX_TS": MAX_TS,
             "Path": Path,
@@ -567,6 +582,52 @@ class Prod:
 
         return ret
 
+    def get_file_mtime(self, name):
+        return os.path.getmtime(name)
+
+    def get_file_mtime_git(self, name):
+        ret = subprocess.check_output(
+            ["git", "log", "-1", "--format=%ai", "--", name], text=True
+        ).strip()
+        if not ret:
+            raise FileNotFoundError(f"{name} did not match any file in git")
+
+        # 2025-01-17 00:05:48 +0900
+        return dateutil.parser.parse(ret)
+
+    async def is_exists(self, name):
+        checker = self.checkers.get_checker(name)
+        try:
+            if checker:
+                ret = await self.run_in_executor(checker, name)
+            elif self.use_git_timestamp:
+                ret = await self.run_in_executor(self.get_file_mtime_git, name)
+            else:
+                ret = await self.run_in_executor(self.get_file_mtime, name)
+        except FileNotFoundError:
+            ret = False
+
+        if isinstance(ret, FileNotFoundError):
+            ret = False
+
+        if not ret:
+            return Exists(name, False)
+        if isinstance(ret, datetime.datetime):
+            ret = ret.timestamp()
+        if ret < 0:
+            ret = MAX_TS
+        return Exists(name, True, ret)
+
+    def build(self, *deps):
+        children = []
+        for elem in deps:
+            child = [_name_to_str(name) for name in flatten(elem)]
+            children.append(child)
+        self.deps[0:0] = children
+
+    def use_git(self, use):
+        self.use_git_timestamp = use
+
     def get_default_target(self):
         return self.rules.select_first_target()
 
@@ -581,24 +642,26 @@ class Prod:
         return self.built
 
     async def schedule(self, deps):
+        deps = list(flatten(deps))
         tasks = []
         waits = []
         for dep in deps:
             if dep not in self.buildings:
                 ev = asyncio.Event()
                 self.buildings[dep] = ev
-                task = self.run(dep)
-                tasks.append((dep, task))
+                coro = self.run(dep)
+                tasks.append((dep, coro))
                 waits.append(ev)
             else:
                 obj = self.buildings[dep]
                 if isinstance(obj, asyncio.Event):
                     waits.append(obj)
 
-        for dep, task in tasks:
+        results = await asyncio.gather(*(coro for _, coro in tasks))
+        for ret, (dep, _) in zip(results, tasks):
             ev = self.buildings[dep]
             try:
-                self.buildings[dep] = await task
+                self.buildings[dep] = ret
             finally:
                 ev.set()
 
@@ -614,27 +677,6 @@ class Prod:
             return max(ts)
         return 0
 
-    async def is_exists(self, name):
-        checker = self.checkers.get_checker(name)
-        try:
-            if checker:
-                ret = await self.run_in_executor(checker, name)
-            else:
-                ret = await self.run_in_executor(is_file_exists, name)
-        except FileNotFoundError:
-            ret = False
-
-        if not ret:
-            return Exists(name, False)
-        if isinstance(ret, datetime.datetime):
-            ret = ret.timestamp()
-        if ret < 0:
-            ret = MAX_TS
-        return Exists(name, True, ret)
-
-    def build(self, *deps):
-        self.deps[0:0] = [_name_to_str(name) for name in flatten(deps)]
-
     async def run(self, name):  # -> Any | int:
         name = _name_to_str(name)
         self.rules.build_tree(name)
@@ -645,11 +687,18 @@ class Prod:
             deps = deps + build_deps
             uses = uses + build_uses
 
-        ts = 0
+        tasks = []
         if deps:
-            ts = await self.schedule(deps)
+            deps_task = asyncio.create_task(self.schedule(deps))
+            tasks.append(deps_task)
         if uses:
-            await self.schedule(uses)
+            uses_task = self.schedule(uses)
+            tasks.append(uses_task)
+
+        await asyncio.gather(*tasks)
+        ts = 0
+        if deps:
+            ts = deps_task.result()
 
         if selected and isinstance(builder, Task):
             self.built += 1

{pyprod-0.4.0 → pyprod-0.5.0}/src/pyprod/utils.py

@@ -1,13 +1,15 @@
 from collections.abc import Iterable
 
 
-def flatten(seq):
+def flatten(seq, ignore_none=True):
     if isinstance(seq, str) or (not isinstance(seq, Iterable)):
         yield seq
         return
 
     for item in seq:
         if isinstance(item, str) or (not isinstance(item, Iterable)):
+            if ignore_none and (item is None):
+                continue
             yield item
         else:
             yield from flatten(item)

{pyprod-0.4.0 → pyprod-0.5.0}/src/pyprod/venv.py

@@ -42,6 +42,15 @@ def pip(*args):
         makevenv(pyprod.modulefile)
     args = flatten(args)
     subprocess.run(
-        [venvdir / "bin/python", "-m", "pip", "--no-input", "install", *args],
+        [
+            venvdir / "bin/python",
+            "-m",
+            "pip",
+            "--disable-pip-version-check",
+            "--no-input",
+            "install",
+            "-q",
+            *args,
+        ],
         check=True,
     )

{pyprod-0.4.0 → pyprod-0.5.0}/tests/conftest.py

@@ -8,4 +8,4 @@ pyprod.verbose = 2
 
 @pytest.fixture(autouse=True)
 def init_args():
-    main.init_args()
+    main.init_args([])