ppqs 2.0.2__tar.gz → 2.1.0__tar.gz

{ppqs-2.0.2/src/ppqs.egg-info → ppqs-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.0.2
+Version: 2.1.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -100,17 +100,30 @@ $ ppqs print-something Hi
 Hi
 ```
 
-The following only applies to scripts defined as lists of lists: if a command
-argument is itself a list, it is concatenated into a path appropriate for the
-current operating system. For example,
+The following only applies to scripts defined as lists of lists:
 
-```toml
-[tool.ppqs.scripts]
-do-something = [["do-something-to", ["subdir", "afile"]]]
-```
+* If a command argument is itself a list, it is concatenated into a path
+  appropriate for the current operating system. For example,
+
+  ```toml
+  [tool.ppqs.scripts]
+  do-something = [["do-something-to", ["subdir", "afile"]]]
+  ```
+
+  would run the command `do-something-to subdir/afile` on a Unix-based operating
+  system.
+
+  If the last element of the path contains a wildcard (`*`), the path is
+  expanded at runtime into a list of files/directories matching the wildcard
+  expression. For example, if the directory `subdir/` contained the files
+  `file1.txt`, `file2.txt`, and `file3.dat`, then:
+
+  ```toml
+  [tool.ppqs.scripts]
+  do-something = [["do-something-to", ["subdir", "*.txt"]]]
+  ```
 
-would run the command `do-something-to subdir/afile` on a Unix-based operating
-system.
+  would run the command `do-something-to subdir/file1.txt subdir/file2.txt`
 
 Scripts may also be defined in their own section, which permit a few options:
 
@@ -146,10 +159,9 @@ The default value of some options may be overridden in the
 print-header = true
 ```
 
-Note that commands are *not* passed to the shell, so shell features
-(e.g. wildcards, conditional statements) are not available. The recommended
-solution is to write a helper script, e.g. `scripts/lots-to-do.py`, which may
-then be called by `ppqs` as:
+Note that commands are *not* passed to the shell, so shell features are not
+available. The recommended solution is to write a helper script,
+e.g. `scripts/lots-to-do.py`, which may then be called by `ppqs` as:
 
 ```toml
 [tool.ppqs.scripts]

{ppqs-2.0.2 → ppqs-2.1.0}/README.md

@@ -84,17 +84,30 @@ $ ppqs print-something Hi
 Hi
 ```
 
-The following only applies to scripts defined as lists of lists: if a command
-argument is itself a list, it is concatenated into a path appropriate for the
-current operating system. For example,
+The following only applies to scripts defined as lists of lists:
 
-```toml
-[tool.ppqs.scripts]
-do-something = [["do-something-to", ["subdir", "afile"]]]
-```
+* If a command argument is itself a list, it is concatenated into a path
+  appropriate for the current operating system. For example,
+
+  ```toml
+  [tool.ppqs.scripts]
+  do-something = [["do-something-to", ["subdir", "afile"]]]
+  ```
+
+  would run the command `do-something-to subdir/afile` on a Unix-based operating
+  system.
+
+  If the last element of the path contains a wildcard (`*`), the path is
+  expanded at runtime into a list of files/directories matching the wildcard
+  expression. For example, if the directory `subdir/` contained the files
+  `file1.txt`, `file2.txt`, and `file3.dat`, then:
+
+  ```toml
+  [tool.ppqs.scripts]
+  do-something = [["do-something-to", ["subdir", "*.txt"]]]
+  ```
 
-would run the command `do-something-to subdir/afile` on a Unix-based operating
-system.
+  would run the command `do-something-to subdir/file1.txt subdir/file2.txt`
 
 Scripts may also be defined in their own section, which permit a few options:
 
@@ -130,10 +143,9 @@ The default value of some options may be overridden in the
 print-header = true
 ```
 
-Note that commands are *not* passed to the shell, so shell features
-(e.g. wildcards, conditional statements) are not available. The recommended
-solution is to write a helper script, e.g. `scripts/lots-to-do.py`, which may
-then be called by `ppqs` as:
+Note that commands are *not* passed to the shell, so shell features are not
+available. The recommended solution is to write a helper script,
+e.g. `scripts/lots-to-do.py`, which may then be called by `ppqs` as:
 
 ```toml
 [tool.ppqs.scripts]

{ppqs-2.0.2 → ppqs-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ppqs"
-version = "2.0.2"
+version = "2.1.0"
 description = "Python project quick scripts"
 authors = [
     { name = "Karl Wette", email = "karl.wette@anu.edu.au" },

{ppqs-2.0.2 → ppqs-2.1.0/src/ppqs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.0.2
+Version: 2.1.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -100,17 +100,30 @@ $ ppqs print-something Hi
 Hi
 ```
 
-The following only applies to scripts defined as lists of lists: if a command
-argument is itself a list, it is concatenated into a path appropriate for the
-current operating system. For example,
+The following only applies to scripts defined as lists of lists:
 
-```toml
-[tool.ppqs.scripts]
-do-something = [["do-something-to", ["subdir", "afile"]]]
-```
+* If a command argument is itself a list, it is concatenated into a path
+  appropriate for the current operating system. For example,
+
+  ```toml
+  [tool.ppqs.scripts]
+  do-something = [["do-something-to", ["subdir", "afile"]]]
+  ```
+
+  would run the command `do-something-to subdir/afile` on a Unix-based operating
+  system.
+
+  If the last element of the path contains a wildcard (`*`), the path is
+  expanded at runtime into a list of files/directories matching the wildcard
+  expression. For example, if the directory `subdir/` contained the files
+  `file1.txt`, `file2.txt`, and `file3.dat`, then:
+
+  ```toml
+  [tool.ppqs.scripts]
+  do-something = [["do-something-to", ["subdir", "*.txt"]]]
+  ```
 
-would run the command `do-something-to subdir/afile` on a Unix-based operating
-system.
+  would run the command `do-something-to subdir/file1.txt subdir/file2.txt`
 
 Scripts may also be defined in their own section, which permit a few options:
 
@@ -146,10 +159,9 @@ The default value of some options may be overridden in the
 print-header = true
 ```
 
-Note that commands are *not* passed to the shell, so shell features
-(e.g. wildcards, conditional statements) are not available. The recommended
-solution is to write a helper script, e.g. `scripts/lots-to-do.py`, which may
-then be called by `ppqs` as:
+Note that commands are *not* passed to the shell, so shell features are not
+available. The recommended solution is to write a helper script,
+e.g. `scripts/lots-to-do.py`, which may then be called by `ppqs` as:
 
 ```toml
 [tool.ppqs.scripts]

{ppqs-2.0.2 → ppqs-2.1.0}/src/py_proj_quick_scripts/__init__.py

@@ -1,3 +1,4 @@
+import glob
 import os
 import re
 import shutil
@@ -12,7 +13,7 @@ else:  # pragma: no cover
     import tomli as tomllib
 
 __author__ = "Karl Wette"
-__version__ = "2.0.2"
+__version__ = "2.1.0"
 
 
 class MissingPyProjectError(Exception):
@@ -151,11 +152,14 @@ def parse_scripts(pyproject_path):
 
                         # List arguments are treated as paths
                         arg_path = Path(*arg)
+                        if any("*" in a for a in arg[:-1]):
+                            msg2 = f"path argument '{arg_path}' may contain wildcards only in the last element"
+                            raise InvalidScriptError(pyproject_path, msg2)
                         if arg_path.is_absolute():
                             msg2 = f"path argument '{arg_path}' must be a relative path"
                             raise InvalidScriptError(pyproject_path, msg2)
 
-                        script_line.append(str(arg_path))
+                        script_line.append(arg_path)
 
                     else:
                         script_line.append(arg)
@@ -211,7 +215,16 @@ def run_script(script_name, script, argv, cwd):
         cmd = []
 
         for arg in command:
-            if arg == "...":
+            if isinstance(arg, Path):
+                if "*" in arg.parts[-1]:
+
+                    # Expand wildcards in last path element
+                    cmd.extend(sorted(glob.glob(str(arg), recursive=False)))
+
+                else:
+                    cmd.append(str(arg))
+
+            elif arg == "...":
 
                 # Replace "..." in command with arguments
                 cmd.extend(argv)
@@ -222,7 +235,8 @@ def run_script(script_name, script, argv, cwd):
         # Print header
         if script["print-header"]:
             cmd_str = " ".join(cmd)
-            print(f" ppqs {script_name}: {cmd_str} ".center(col_width, "*"), flush=True)
+            header = f"*** ppqs {script_name}: {cmd_str} ***".center(col_width, "*")
+            print(header, flush=True)
 
         # Run command
         retn = subprocess.run(cmd, stdin=subprocess.DEVNULL, shell=False, cwd=cwd)

{ppqs-2.0.2 → ppqs-2.1.0}/test/test_cli.py

@@ -1,3 +1,5 @@
+import os
+
 import pytest
 
 from py_proj_quick_scripts import InvalidScriptError, cli
@@ -24,6 +26,14 @@ def pyproject_path(tmp_path):
     script = [
         ["python", "-c", "import sys; print(*sys.argv[1:])", "..."],
     ]
+    [tool.ppqs.scripts.echo-path]
+    script = [
+        ["python", "-c", "import sys; print(*sys.argv[1:])", ["afile"], ["subdir", "bfile"]],
+    ]
+    [tool.ppqs.scripts.echo-wildcard]
+    script = [
+        ["python", "-c", "import sys; print(*sys.argv[1:])", ["subdir", "*.txt"]],
+    ]
     """
 
     write_file(pyproject_path, pyproject_toml)
@@ -53,7 +63,7 @@ def test_notest(pyproject_path):
 
 def test_exit(pyproject_path):
     """
-    Test exit() script.
+    Test `exit` script.
     """
 
     with in_dir(pyproject_path.parent):
@@ -63,7 +73,7 @@ def test_exit(pyproject_path):
 
 def test_echo(pyproject_path, capfd):
     """
-    Test echo() script.
+    Test `echo` script.
     """
 
     with in_dir(pyproject_path.parent):
@@ -71,3 +81,31 @@ def test_echo(pyproject_path, capfd):
         captured = capfd.readouterr()
         assert captured.out == "Hello\n"
         assert captured.err == ""
+
+
+def test_echo_path(pyproject_path, capfd):
+    """
+    Test `echo-path` script.
+    """
+
+    with in_dir(pyproject_path.parent):
+        cli("echo-path")
+        captured = capfd.readouterr()
+        assert captured.out == "afile subdir/bfile\n".replace("/", os.sep)
+        assert captured.err == ""
+
+
+def test_echo_wildcard(pyproject_path, capfd):
+    """
+    Test `echo-wildcard` script.
+    """
+
+    with in_dir(pyproject_path.parent) as wd:
+        subdir = wd / "subdir"
+        subdir.mkdir()
+        write_file(subdir / "a.txt", "Some text")
+        write_file(subdir / "b.txt", "Some more text")
+        cli("echo-wildcard")
+        captured = capfd.readouterr()
+        assert captured.out == "subdir/a.txt subdir/b.txt\n".replace("/", os.sep)
+        assert captured.err == ""

{ppqs-2.0.2 → ppqs-2.1.0}/test/test_parse_scripts.py

@@ -219,12 +219,43 @@ from . import in_dir, write_file
                     "paths": {
                         "description": "Run paths script",
                         "print-header": False,
-                        "commands": [["echo", str(Path("a", "b"))]],
+                        "commands": [["echo", Path("a", "b")]],
                     }
                 }
             ),
             id="list script with relative path",
         ),
+        pytest.param(
+            """
+            [tool.ppqs.scripts]
+            paths = [
+                ["echo", ["*", "b"]],
+            ]
+            """,
+            pytest.raises(
+                InvalidScriptError,
+                match="may contain wildcards only in the last element",
+            ),
+            id="list script with path and invalid wildcard",
+        ),
+        pytest.param(
+            """
+            [tool.ppqs.scripts]
+            paths = [
+                ["echo", ["a", "*.txt"]],
+            ]
+            """,
+            nullcontext(
+                {
+                    "paths": {
+                        "description": "Run paths script",
+                        "print-header": False,
+                        "commands": [["echo", Path("a", "*.txt")]],
+                    }
+                }
+            ),
+            id="list script with path and valid wildcard",
+        ),
     ],
 )
 def test_parse_scripts(tmp_path, script_toml, expectation):