PyProd 0.2.0.post1__tar.gz → 0.4.0__tar.gz

{pyprod-0.2.0.post1 → pyprod-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyProd
-Version: 0.2.0.post1
+Version: 0.4.0
 Summary: PyProd: More Makeable than Make
 Project-URL: Homepage, https://github.com/atsuoishimoto/pyprod
 Project-URL: Documentation, https://pyprod.readthedocs.io/en/latest/
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst
 PyProd - More Makeable than Make
 =================================
 
-PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/latest/>`_.
+PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/stable/>`_.
 
 
 Features
@@ -42,22 +42,26 @@ With PyProd, a traditional Makefile for C can be expressed as a Python script li
 .. code-block:: python
 
     CC = "gcc"
-    CFLAGS = "-I."
+    CFLAGS = "-c -I."
     DEPS = "hello.h"
     OBJS = "hello.o main.o".split()
+    EXE = "hello.exe"
 
     @rule("%.o", depends=("%.c", DEPS))
     def compile(target, src, *deps):
-        run(CC, "-c -o", target, src, CFLAGS)
+        run(CC, "-o", target, src, CFLAGS)
 
-    @rule("hello.exe", depends=OBJS)
+    @rule(EXE, depends=OBJS)
     def link(target, *objs):
         run(CC, "-o", target, objs)
 
+    @task
     def clean():
         run("rm -f", OBJS, "hello.exe")
 
-    all = "hello.exe"
+    @task
+    def rebuild():
+        build(clean, EXE)
 
 
 To run the build script, simply execute:
@@ -67,6 +71,8 @@ To run the build script, simply execute:
     $ cd project
     $ pyprod
 
+Other examples can be found in the `samples <https://github.com/atsuoishimoto/pyprod/tree/main/samples>`_ directory.
+
 License
 -------
 PyProd is licensed under the MIT License. See the `LICENSE <LICENSE>`_ file for more details.

{pyprod-0.2.0.post1 → pyprod-0.4.0}/README.rst

@@ -1,7 +1,7 @@
 PyProd - More Makeable than Make
 =================================
 
-PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/latest/>`_.
+PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles. For detailed documentation, please refer to the `official documentation <https://pyprod.readthedocs.io/en/stable/>`_.
 
 
 Features
@@ -26,22 +26,26 @@ With PyProd, a traditional Makefile for C can be expressed as a Python script li
 .. code-block:: python
 
     CC = "gcc"
-    CFLAGS = "-I."
+    CFLAGS = "-c -I."
     DEPS = "hello.h"
     OBJS = "hello.o main.o".split()
+    EXE = "hello.exe"
 
     @rule("%.o", depends=("%.c", DEPS))
     def compile(target, src, *deps):
-        run(CC, "-c -o", target, src, CFLAGS)
+        run(CC, "-o", target, src, CFLAGS)
 
-    @rule("hello.exe", depends=OBJS)
+    @rule(EXE, depends=OBJS)
     def link(target, *objs):
         run(CC, "-o", target, objs)
 
+    @task
     def clean():
         run("rm -f", OBJS, "hello.exe")
 
-    all = "hello.exe"
+    @task
+    def rebuild():
+        build(clean, EXE)
 
 
 To run the build script, simply execute:
@@ -51,6 +55,8 @@ To run the build script, simply execute:
     $ cd project
     $ pyprod
 
+Other examples can be found in the `samples <https://github.com/atsuoishimoto/pyprod/tree/main/samples>`_ directory.
+
 License
 -------
 PyProd is licensed under the MIT License. See the `LICENSE <LICENSE>`_ file for more details.

{pyprod-0.2.0.post1 → pyprod-0.4.0}/docs/commandline.rst

@@ -5,16 +5,16 @@ Command line options
 ------------------------
 
 
-usage: pyprod [-h] [-f FILE] [-j JOB] [-v] [-C DIRECTORY] [targets ...]
+usage: pyprod [-h] [-C DIRECTORY] [-f FILE] [-j JOB] [-r] [-v] [targets ...]
 
 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``).
 
 options:
-  -f, --file FILE       Use FILE as the Prodfile (default: 'PRODFILE.py').
-  -j, --job JOB         Allow up to N jobs to run simultaneously (default: 1).
+  -h, --help            show this help message and exit
   -C, --directory DIRECTORY
-                        Change to DIRECTORY before performing any operations.
-  -v                    Increase verbosity level (default: 0). Use multiple -v options to increase verbosity, up to a maximum of 3.
-
-
+                        Change to DIRECTORY before performing any operations
+  -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
+  -v                    Increase verbosity level (default: 0)

{pyprod-0.2.0.post1 → pyprod-0.4.0}/docs/index.rst

@@ -1,17 +1,47 @@
 PyProd - More Makeable than Make
 ============================================
-
 PyProd is a Python script that can be used as an alternative to Makefile. By leveraging Python's versatility, it enables you to define build rules and dependencies programmatically, allowing for dynamic configurations, integration with existing Python libraries, and custom build logic not easily achievable with traditional Makefiles.
 
 Features
 --------
-
 - Define build rules in Python: Use Python functions to create clear and concise build logic.
 - Specify dependencies for each rule: Automatically track and resolve dependencies between files, such as source files and headers.
 - Easily extendable with custom Python functions: Integrate custom logic for specialized tasks, like code linting or deployment.
 - Manages virtual environments: Automatically create and manage virtual environments for each project, ensuring a clean and isolated build environment.
 
 
+Example
+-------
+With PyProd, a traditional Makefile for C can be expressed as a Python script like this:
+
+.. code-block:: python
+
+    CC = "gcc"
+    CFLAGS = "-c -I."
+    DEPS = "hello.h"
+    OBJS = "hello.o main.o".split()
+    EXE = "hello.exe"
+
+    @rule("%.o", depends=("%.c", DEPS))
+    def compile(target, src, *deps):
+        run(CC, "-o", target, src, CFLAGS)
+
+    @rule(EXE, depends=OBJS)
+    def link(target, *objs):
+        run(CC, "-o", target, objs)
+
+    @task
+    def clean():
+        run("rm -f", OBJS, "hello.exe")
+
+    @task
+    def rebuild():
+        build(clean, EXE)
+
+
+
+Other examples can be found in the `samples <https://github.com/atsuoishimoto/pyprod/tree/main/samples>`_ directory.
+
 Table of Contents
 --------------------
 
@@ -35,6 +65,8 @@ Table of Contents
    quickstart
    prodfile
    commandline
+   releasenotes
+   
 
 
 

{pyprod-0.2.0.post1 → pyprod-0.4.0}/docs/prodfile.rst

@@ -10,12 +10,12 @@ Rule definition
 
 A rule is defined using the ``@rule`` decorator, which takes the target file as an argument. The target file is the output of the rule, and the function that follows the decorator is the build logic that generates the target file.
 
-.. py:function:: @rule(target, pattern=None, depends=(), uses=())
+.. py:function:: @rule(targets, pattern=None, *, depends=(), uses=())
 
    Defines rule to build target files.
 
-   :param target: The target file or files to be generated by the rule. Wildcards can be used in filenames, and exactly one % must be included in the filename.
-   :type target: str | Path|list[str | Path]
+   :param targets: The target file or files to be generated by the rule. Wildcards can be used in filenames, and exactly one % must be included in the filename.
+   :type target: str | Path | list[str | Path]
 
    :param pattern: Specify the pattern used to extract the stem of the target filename.
 
@@ -29,7 +29,13 @@ A rule is defined using the ``@rule`` decorator, which takes the target file as
 
 Build function
 ~~~~~~~~~~~~~~~~~~~
-The first argument of the decorated function specifies the target file to be generated. The target can be a string or a Path object, depending on the value provided in the target parameter. Subsequent arguments correspond to the filenames listed in the depends parameter. The rule function must accept the target and the same number of arguments as those specified in depends.
+
+The function following the ``@rule`` decorator is the build function that generates the target file. 
+
+- The first argument of the build function specifies the target file to be generated.
+- Subsequent arguments correspond to the filenames listed in the depends parameter. The rule function must accept the target and the same number of arguments as those specified in depends.
+- ``uses`` dependencies are not passed to the build function.
+- Even if Path objects are specified in the ``rule``, all arguments passed to the builder function will be of type str.
 
 For example, the following code prints ``file1 ['file2', 'file3']`` when the target file ``file1`` is built:
 
@@ -79,8 +85,8 @@ The rule decorator can also be used as a standalone function without being tied
 
 .. code-block:: python
 
-   rule(target=("file1", "file2"), depends="inc1")
-   rule(target=("file3", "file4"), uses="inc2")
+   rule(targets=("file1", "file2"), depends="inc1")
+   rule(targets=("file3", "file4"), uses="inc2")
 
 
 
@@ -91,12 +97,12 @@ Checker definition
 PyProd provides default checkers for common file types for files and directories. For non-file targets requiring specialized checks, you can define a custom checker to determine whether a build is needed.
 A checker is defined using the ``@check`` decorator, which takes the target file as an argument.
 
-.. py:function:: @check(target)
+.. py:function:: @check(targets)
 
    Defines a checker to get last modified time of the target.
 
-   :param target: The target file to be checked. Wildcards can be used.
-   :type target: str | Path
+   :param targets: The target file or files to be checked. Wildcards can be used.
+ :type target: str | Path | list[str | Path]
 
    :return: Last modified time of the file if the target exists. Returns false or raise FileNotFoundError if the target does not exist.
    :rtype: false|float|datetime.datetime
@@ -131,6 +137,39 @@ For example, a checker to retrieve the last modified timestamp of a file on Amaz
               return
           raise
    
+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=())
+
+   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.
+   :type uses: str | Path | list[str | Path]
+
+
+.. code-block:: python
+
+   @task(depends=("file1", "file2"))
+   def my_task(*files):
+       print("Task executed", files)
+
+
+`@task` can be used without any arguments if no dependencies are specified.
+
+.. code-block:: python
+
+   @task
+   def my_task(*files):
+       print("Task executed", files)
 
 
 
@@ -141,6 +180,11 @@ In addition to the ``@rule`` and ``@check`` decorators, PyProd provides several
 
 The following built-ins are available:
 
+.. 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.
 
 .. py:function:: pip(*args)
 
@@ -190,8 +234,8 @@ Example:
    .. code-block:: python
    
       run(["echo", "Hello, World!"]) # list style args
-      run(["echo Hello, World"]) # Shell style args
-      run(["echo", "Hello,", "World"]) # Shell style args (automactic concatenation)
+      run("echo Hello, World") # Shell style args
+      run("echo", "Hello,", "World") # Shell style args (automactic concatenation)
       run("echo", ["hello", ["world"]]) # Shell style args (automactic flattening)
    
       files = run("ls", stdout=True).stdout # Capture output
@@ -205,10 +249,10 @@ Example:
    :param args: Command and arguments to execute. If first argument is a list, the first element is the command and the rest are arguments. Sequences specified for args are automatically flattened.
    :type args: str | Path | list[str | Path]
 
-   :echo: Print the command before executing it (default ``True``).
+   :param echo: Print the command before executing it (default ``True``).
    :type echo: bool
 
-   :cwd: Change the current working directory before executing the command.
+   :param cwd: Change the current working directory before executing the command.
    :type shell: str | Path | None
 
    :param check: Raise an exception if the command returns a non-zero exit code (default ``True``).
@@ -229,6 +273,36 @@ Example:
       msg = capture("echo Hello, World!")
    
 
+.. py:function:: read(filename):
+   
+   Read the contents of a file.
+
+   :param filename: The file to read.
+   :type filename: str | Path
+
+   :return: The contents of the file.
+   :rtype: str
+
+.. py:function:: write(filename, txt, append=False):
+   
+   Write text to a file.
+
+   :param filename: The file to write to.
+   :type filename: str | Path
+
+   :param txt: The text to write.
+   :type txt: str
+
+   :param append: Append to the file instead of overwriting it (default ``False``).
+   :type append: bool
+
+.. 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``.
+
+   :param path: The directory to create.
+   :type path: str | Path
+
 .. py:function::  glob(path, dir=".")
 
    Glob the given relative pattern in the directory represented by this path. This function is a wrapper around `pathlib.Path.glob() <https://docs.python.org/3/library/pathlib.html#pathlib.Path.glob>`_. Unlike ``pathlib.Path.glob()``, this function ignores files and directlies that start with a dot. Also, this function returns a list of Path objects.
@@ -249,12 +323,24 @@ Example:
    
       SRCFILES = glob("**/*.c")
    
-.. py:function::  quote(s)
+.. py:function::  quote(*s)
+.. py:function::  q(*s)
 
-   Quote a string for use as a shell command argument. This function is a wrapper around `shlex.quote() <https://docs.python.org/3/library/shlex.html#shlex.quote>`_.
+   Quote strings in ``s``. Each ``s`` is flattend.
 
    :param s: The string to quote.
-   :type s: str
+   :type s: str | list
+
+   :return: The list of quoted strings.
+   :rtype: list[str]
+
+.. py:function::  squote(s)
+.. py:function::  sq(s)
+
+   Convert ``s`` to string and quote for use as a shell command argument. This function is a wrapper around `shlex.quote() <https://docs.python.org/3/library/shlex.html#shlex.quote>`_.
+
+   :param s: The string to quote. If ``s`` is sequence, it is flattened and joined with space.
+   :type s: str | list
 
    :return: The quoted string.
    :rtype: str

{pyprod-0.2.0.post1 → pyprod-0.4.0}/docs/quickstart.rst

@@ -52,16 +52,16 @@ Next, let's modify the ``Prodfile.py`` to output the file into an ``output`` dir
 
 .. code-block:: python
 
-    output = Path("output") # We can use pathlib.Path without importing it
-    
-    @rule(output / "hello.txt", depends=output) # hello now depends on output directory
-    def hello(target):
-        with open(target, "w") as f:
-            f.write("Hello, world!")
-
-    @rule(output)
-    def makedir(target):
-        target.mkdir()
+   output = Path("output") # We can use pathlib.Path without importing it
+   
+   @rule(output / "hello.txt", depends=output) # hello now depends on output directory
+   def hello(target):
+       with open(target, "w") as f:
+           f.write("Hello, world!")
+
+   @rule(output)
+   def makedir(target):
+       os.makedirs(target)
 
 In the modified ``Prodfile.py``, we have defined a rule to create the ``output`` directory and added a rule that makes the ``output/hello.txt`` file dependent on the ``output`` directory.
 

pyprod-0.4.0/docs/releasenotes.rst

@@ -0,0 +1,15 @@
+Release Notes
+================
+
+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.
+
+0.3.0 (2025-01-03)
+------------------
+- Arguments for build and check function are converted to string.
+- Add built-in functions.
+- Validate rule dependencies.

{pyprod-0.2.0.post1 → pyprod-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "PyProd"
-version = "0.2.0.post1"
+version = "0.4.0"
 description = "PyProd: More Makeable than Make"
 readme = "README.rst"
 requires-python = ">=3.10"
@@ -29,6 +29,7 @@ build-backend = "hatchling.build"
 dev = [
     "pytest>=8.3.4",
     "pytest-asyncio>=0.25.0",
+    "pytest-mock>=3.14.0",
     "ruff>=0.8.4",
     "sphinx>=8.1.3",
     "sphinx-autobuild>=2024.10.3",
@@ -40,4 +41,4 @@ asyncio_default_fixture_loop_scope="function"
 
 [tool.ruff.lint]
 select = ["E","F","W","B","N","T10","I"]
-ignore = ["F401"]
+ignore = ["F401", "B9"]

pyprod-0.2.0.post1/sample/build-c/PRODFILE.py → pyprod-0.4.0/samples/build-c/Prodfile.py

@@ -3,7 +3,7 @@
 
 APP = "hello.exe"
 CC = "gcc"
-CFLAGS = "-I."
+CFLAGS = "-c -I."
 DEPS = "hello.h"
 OBJS = "hello.o main.o".split()
 
@@ -15,11 +15,14 @@ def link(target, *src):
 
 @rule("%.o", depends=("%.c", DEPS))
 def compile(target, src, *deps):
-    run(CC, "-c -o", target, src, CFLAGS)
+    run(CC, "-o", target, src, CFLAGS)
 
 
+@task
 def clean():
     run("rm", "-rf", OBJS, APP)
 
 
-all = APP
+@task
+def rebuild():
+    build(clean, APP)

{pyprod-0.2.0.post1/sample → pyprod-0.4.0/samples}/generate-doc/PRODFILE.py

@@ -23,8 +23,11 @@ def build_c(target, src, *commons):
     run("cat", *commons, src, ">", target)
 
 
+@task
 def clean():
     run("rm", "-rf", BUILDDIR, BUILDFILES, DOC)
 
 
-all = DOC
+@task
+def rebuild():
+    build(clean, DOC)

{pyprod-0.2.0.post1/sample → pyprod-0.4.0/samples}/md-to-pdf/Prodfile.py

@@ -31,18 +31,23 @@ def make_pdf(target, src):
 # Rebuilds when Python modules change
 @rule(BUILD / "%.html", depends=(Path("%.md"), TEMPLATE, MODULES), uses=BUILD)
 def make_html(target, src, template, *_):
-    src = src.read_text()
-    body = md_to_html(src)
-    html = template.read_text().format(body=body)
-    target.write_text(html)
+    body = md_to_html(open(src).read())
+    html = open(template).read().format(body=body)
+    open(target, "w").write(html)
 
 
 # create outputs directory
 @rule(BUILD)
 def builds(target):
-    target.mkdir(parents=True)
+    os.makedirs(target)
 
 
+@task
 def clean():
     shutil.rmtree(BUILD, ignore_errors=True)
     PDF.unlink(missing_ok=True)
+
+
+@task
+def rebuild():
+    build(clean, PDF)

pyprod-0.2.0.post1/sample/s3files/PRODFILE.py → pyprod-0.4.0/samples/s3files/Prodfile.py

@@ -1,13 +1,14 @@
 # ruff: NOQA
 # type: ignore
 
-pip("boto3")  # install boto3
+pip("boto3", "-q")  # install boto3
 
 import boto3, botocore
 from urllib.parse import urlparse
 
 s3 = boto3.client("s3")
-TARGET = f"s3://TESTBUCKET/S3TEST.txt"
+BUCKET = params.BUCKET or "TESTBUCKET"  # Run pyprod with BUCKET=bucket-name
+TARGET = f"s3://{BUCKET}/S3TEST.txt"
 
 
 def parse_s3url(s3url):
@@ -16,7 +17,7 @@ def parse_s3url(s3url):
     return parsed.netloc, parsed.path.lstrip("/")
 
 
-@rule(target=TARGET, pattern="*/%.txt", depends="%.txt")
+@rule(targets=TARGET, pattern="*/%.txt", depends="%.txt")
 def copyfile(target, src):
     """Copies a file to an S3 bucket."""
     bucket, key = parse_s3url(target)
@@ -35,16 +36,20 @@ def check_s3file(s3url):
         raise
 
 
+@task
 def clean():
     """Deletes an S3 file."""
     bucket, key = parse_s3url(TARGET)
     s3.delete_object(Bucket=bucket, Key=key)
 
 
+@task
 def ls():
     """Lists the contents of an S3 bucket."""
     bucket, key = parse_s3url(TARGET)
     run("aws s3 ls", bucket)
 
 
-rule("S3TEST.txt")  # Define target for default goal
+@task
+def rebuild():
+    build(clean, TARGET)

pyprod-0.4.0/samples/tutorial-1/Prodfile.py

@@ -0,0 +1,4 @@
+@rule("hello.txt")
+def hello(target):
+    with open(target, "w") as f:
+        f.write("Hello, world!")

pyprod-0.4.0/samples/tutorial-2/Prodfile.py

@@ -0,0 +1,13 @@
+output = Path("output")  # We can use pathlib.Path without importing it
+
+
+@rule(output / "hello.txt", depends=output)  # hello now depends on output directory
+def hello(target, *args):
+    # output_dir is not used
+    with open(target, "w") as f:
+        f.write("Hello, world!")
+
+
+@rule(output)
+def makedir(target):
+    os.makedirs(target)

{pyprod-0.2.0.post1 → pyprod-0.4.0}/src/pyprod/main.py

@@ -14,6 +14,13 @@ parser = argparse.ArgumentParser(
     description="""PyProd - More makable than make""",
 )
 
+parser.add_argument(
+    "-C",
+    "--directory",
+    dest="directory",
+    help="Change to DIRECTORY before performing any operations",
+)
+
 parser.add_argument(
     "-f", "--file", help="Use FILE as the Prodfile (default: 'PRODFILE.py')"
 )
@@ -27,12 +34,8 @@ parser.add_argument(
 )
 
 parser.add_argument(
-    "-C",
-    "--directory",
-    dest="directory",
-    help="Change to DIRECTORY before performing any operations",
+    "-r", "--rebuild", dest="rebuild", action="store_true", help="Rebuild all"
 )
-
 parser.add_argument(
     "-v",
     dest="verbose",
@@ -55,8 +58,13 @@ def print_exc(e):
             logger.exception("Terminated by exception")
 
 
+def init_args(args=None):
+    args = pyprod.args = parser.parse_args(args)
+    return args
+
+
 def main():
-    args = pyprod.args = parser.parse_args()
+    args = init_args()
     pyprod.verbose = args.verbose
     chdir = args.directory
     if chdir:
@@ -89,6 +97,7 @@ def main():
 
     params = {}
     targets = []
+
     for target in args.targets:
         if "=" in target:
             name, value = target.split("=", 1)
@@ -107,7 +116,10 @@ def main():
                 sys.exit("No default target")
             targets = [target]
 
-        ret = asyncio.run(prod.start(targets))
+        ret = 0
+        for target in targets:
+            ret += asyncio.run(prod.start([target]))
+
         if not ret:
             print(f"Nothing to be done for {targets}")