ppqs 2.3.0__tar.gz → 2.4.0__tar.gz

{ppqs-2.3.0/src/ppqs.egg-info → ppqs-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.3.0
+Version: 2.4.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -210,3 +210,18 @@ complete -C "ppqs --bash-completion" ppqs
 Typing `ppqs ` and hitting `TAB` will then show scripts available for the
 current project. Typing part of a script name and hitting `TAB` will show
 matching script name(s), or else complete the full name if unambiguous.
+
+By default, Bash completion will only complete names of scripts. Each script may
+additionally define a glob pattern, given as the option
+`bash-complete-file-glob` under `[tool.ppqs.scripts.<script-name>]`. Files
+matching that pattern (relative to the project root directory) will then be
+available as completions for additional arguments to the script. Example:
+
+```
+[tool.ppqs.scripts.test]
+bash-complete-file-glob = "test/**/test_*.py"
+script = "run-tests ..."
+```
+
+This script will complete on any files matching `test/**/test_*.py`, and pass
+the file names to the command `run-tests`.

{ppqs-2.3.0 → ppqs-2.4.0}/README.md

@@ -194,3 +194,18 @@ complete -C "ppqs --bash-completion" ppqs
 Typing `ppqs ` and hitting `TAB` will then show scripts available for the
 current project. Typing part of a script name and hitting `TAB` will show
 matching script name(s), or else complete the full name if unambiguous.
+
+By default, Bash completion will only complete names of scripts. Each script may
+additionally define a glob pattern, given as the option
+`bash-complete-file-glob` under `[tool.ppqs.scripts.<script-name>]`. Files
+matching that pattern (relative to the project root directory) will then be
+available as completions for additional arguments to the script. Example:
+
+```
+[tool.ppqs.scripts.test]
+bash-complete-file-glob = "test/**/test_*.py"
+script = "run-tests ..."
+```
+
+This script will complete on any files matching `test/**/test_*.py`, and pass
+the file names to the command `run-tests`.

{ppqs-2.3.0 → ppqs-2.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ppqs"
-version = "2.3.0"
+version = "2.4.0"
 description = "Python project quick scripts"
 authors = [
     { name = "Karl Wette", email = "karl.wette@anu.edu.au" },
@@ -28,15 +28,25 @@ Issues = "https://github.com/kwwette/ppqs/issues"
 [project.scripts]
 ppqs = "py_proj_quick_scripts:cli"
 
+[tool.ruff]
+fix = true
+show-fixes = true
+
 [tool.ruff.lint]
 select = [
-    "E4",
-    "E7",
-    "E9",
+    "D1", "D2", "D4",
+    "E4", "E7", "E9",
     "EM",
     "F",
+    "I",
+]
+ignore = [
+    "D105", "D202",
 ]
 
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "--cov=py_proj_quick_scripts --cov-report=term-missing --cov-fail-under=100"

{ppqs-2.3.0 → ppqs-2.4.0/src/ppqs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ppqs
-Version: 2.3.0
+Version: 2.4.0
 Summary: Python project quick scripts
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -210,3 +210,18 @@ complete -C "ppqs --bash-completion" ppqs
 Typing `ppqs ` and hitting `TAB` will then show scripts available for the
 current project. Typing part of a script name and hitting `TAB` will show
 matching script name(s), or else complete the full name if unambiguous.
+
+By default, Bash completion will only complete names of scripts. Each script may
+additionally define a glob pattern, given as the option
+`bash-complete-file-glob` under `[tool.ppqs.scripts.<script-name>]`. Files
+matching that pattern (relative to the project root directory) will then be
+available as completions for additional arguments to the script. Example:
+
+```
+[tool.ppqs.scripts.test]
+bash-complete-file-glob = "test/**/test_*.py"
+script = "run-tests ..."
+```
+
+This script will complete on any files matching `test/**/test_*.py`, and pass
+the file names to the command `run-tests`.

{ppqs-2.3.0 → ppqs-2.4.0}/src/py_proj_quick_scripts/__init__.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+"""Python project quick scripts."""
+
 import glob
 import os
 import re
@@ -20,19 +22,16 @@ __author__ = "Karl Wette"
 
 
 class MissingPyProjectError(Exception):
-    """
-    Raise if 'pyproject.toml' could not be found.
-    """
+    """Raise if 'pyproject.toml' could not be found."""
 
     pass
 
 
 class InvalidScriptError(Exception):
-    """
-    Raise for invalid 'pyproject.toml' script errors.
-    """
+    """Raise for invalid 'pyproject.toml' script errors."""
 
     def __init__(self, pyproject_path, msg):
+        """Initialise exception."""
         self.pyproject_path = pyproject_path
         self.msg = msg
         super().__init__(self.msg)
@@ -42,9 +41,7 @@ class InvalidScriptError(Exception):
 
 
 def find_pyproject():
-    """
-    Look for pyproject.toml in current/parent directories.
-    """
+    """Look for pyproject.toml in current/parent directories."""
 
     # Start in the current directory
     current_dir = starting_dir = Path.cwd()
@@ -70,9 +67,7 @@ def find_pyproject():
 
 
 def parse_scripts(pyproject_path):
-    """
-    Parse scripts from pyproject.toml.
-    """
+    """Parse scripts from pyproject.toml."""
 
     # Read pyproject.toml
     pyproject_toml = tomllib.load(pyproject_path.open("rb"))
@@ -92,6 +87,12 @@ def parse_scripts(pyproject_path):
         )
     except KeyError:
         default_script_print_header = False
+    try:
+        default_bash_complete_file_glob = bool(
+            pyproject_toml["tool"]["ppqs"]["defaults"]["bash-complete-file-glob"]
+        )
+    except KeyError:
+        default_bash_complete_file_glob = None
 
     # Parse scripts
     scripts = {}
@@ -109,6 +110,7 @@ def parse_scripts(pyproject_path):
         # Create default description
         script_description = f"Run {script_name} script"
         script_print_header = default_script_print_header
+        script_bash_complete_file_glob = default_bash_complete_file_glob
         script_commands_toml = script_toml
 
         if isinstance(script_toml, dict):
@@ -117,7 +119,13 @@ def parse_scripts(pyproject_path):
             invalid_keys = [
                 k
                 for k in script_toml.keys()
-                if k not in ("description", "print-header", "script")
+                if k
+                not in (
+                    "description",
+                    "print-header",
+                    "bash-complete-file-glob",
+                    "script",
+                )
             ]
             if len(invalid_keys) > 0:
                 invalid_keys_str = "', '".join(invalid_keys)
@@ -130,6 +138,11 @@ def parse_scripts(pyproject_path):
             script_print_header = bool(
                 script_toml.get("print-header", script_print_header)
             )
+            script_bash_complete_file_glob = script_toml.get(
+                "bash-complete-file-glob", script_bash_complete_file_glob
+            )
+            if script_bash_complete_file_glob is not None:
+                script_bash_complete_file_glob = str(script_bash_complete_file_glob)
             script_commands_toml = script_toml["script"]
 
         msg = f"script '{script_name}' may be either a string or a list of lists"
@@ -175,6 +188,7 @@ def parse_scripts(pyproject_path):
         scripts[script_name] = {
             "description": script_description,
             "print-header": script_print_header,
+            "bash-complete-file-glob": script_bash_complete_file_glob,
             "commands": script_commands,
         }
 
@@ -192,9 +206,7 @@ def parse_scripts(pyproject_path):
 
 
 def print_help(project_name, scripts):
-    """
-    Print help.
-    """
+    """Print help."""
     script_names = ",".join(scripts.keys())
     max_script_name_len = max(len(script_name) for script_name in scripts)
     list_of_scripts = "\n".join(
@@ -220,9 +232,7 @@ def print_help(project_name, scripts):
 
 
 def run_script(scripts, script_name, argv, cwd, has_been_run):
-    """
-    Run a script.
-    """
+    """Run a script."""
 
     col_width = shutil.get_terminal_size().columns
 
@@ -233,24 +243,6 @@ def run_script(scripts, script_name, argv, cwd, has_been_run):
     for command in script["commands"]:
         cmd = []
 
-        cmd_exec = command.pop(0)
-        if cmd_exec == "ppqs":
-
-            # Recursively run script
-            # - silently ignore scripts which have already been run
-            script_name_r = command.pop(0)
-            if script_name_r not in has_been_run:
-                run_script(scripts, script_name_r, argv, cwd, has_been_run)
-            continue
-
-        elif cmd_exec == "python":
-
-            # Use same Python as ppqs to run Python scripts
-            cmd.append(sys.executable)
-
-        else:
-            cmd.append(cmd_exec)
-
         for arg in command:
             if isinstance(arg, Path):
                 if "*" in arg.parts[-1]:
@@ -269,6 +261,20 @@ def run_script(scripts, script_name, argv, cwd, has_been_run):
             else:
                 cmd.append(arg)
 
+        if cmd[0] == "ppqs":
+
+            # Recursively run script
+            # - silently ignore scripts which have already been run
+            script_name_r = cmd[1]
+            if script_name_r not in has_been_run:
+                run_script(scripts, script_name_r, cmd[2:], cwd, has_been_run)
+            continue
+
+        elif cmd[0] == "python":
+
+            # Use same Python as ppqs to run Python scripts
+            cmd[0] = sys.executable
+
         # Print header
         if script["print-header"]:
             cmd_str = " ".join(cmd)
@@ -282,9 +288,7 @@ def run_script(scripts, script_name, argv, cwd, has_been_run):
 
 
 def bash_completion():  # pragma: no cover
-    """
-    Perform Bash command-line completion.
-    """
+    """Perform Bash command-line completion."""
 
     # Parse scripts
     pyproject_path = find_pyproject()
@@ -311,11 +315,37 @@ def bash_completion():  # pragma: no cover
                 print(script_name)
         return
 
+    script_name = words[1]
+    script_bash_complete_file_glob = scripts[script_name]["bash-complete-file-glob"]
+    if script_bash_complete_file_glob is not None:
+
+        # Generate list of files to complete on
+        project_dir = pyproject_path.parent
+        files = [
+            str(f.relative_to(project_dir))
+            for f in project_dir.glob(script_bash_complete_file_glob)
+        ]
+
+        if line.endswith(" "):
+
+            # Complete full script name, e.g.:
+            # $ ppqs script <TAB><TAB>
+            for file_name in files:
+                print(file_name)
+            return
+
+        else:
+
+            # Complete partial script name, e.g.:
+            # $ ppqs script fil<TAB>
+            for file_name in files:
+                if file_name.startswith(words[-1]):
+                    print(file_name)
+            return
+
 
 def cli(*argv):
-    """
-    Parse command line.
-    """
+    """Parse command line."""
 
     argv = [str(a) for a in (argv or sys.argv[1:] or ["--help"])]
 

{ppqs-2.3.0 → ppqs-2.4.0}/test/test_cli.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+"""Test command-line interface."""
+
 import os
 
 import pytest
@@ -13,9 +15,7 @@ from . import in_dir, write_file
 
 @pytest.fixture
 def pyproject_path(tmp_path):
-    """
-    Write pyproject.toml for command-line tests.
-    """
+    """Write pyproject.toml for command-line tests."""
 
     pyproject_path = tmp_path / "pyproject.toml"
     pyproject_toml = """
@@ -39,11 +39,11 @@ def pyproject_path(tmp_path):
         ["python", "-c", "import sys; print(*sys.argv[1:])", ["subdir", "*.txt"]],
     ]
     [tool.ppqs.scripts.greeting]
-    script = "echo Hello"
+    script = "echo Hello ..."
     [tool.ppqs.scripts.farewell]
     script = '''
-    ppqs greeting
-    ppqs greeting
+    ppqs greeting friend!
+    ppqs greeting comrade!
     echo Goodbye
     '''
     """
@@ -54,9 +54,7 @@ def pyproject_path(tmp_path):
 
 
 def test_help(pyproject_path):
-    """
-    Test command line help.
-    """
+    """Test command line help."""
 
     with in_dir(pyproject_path.parent):
         with pytest.raises(SystemExit):
@@ -64,9 +62,7 @@ def test_help(pyproject_path):
 
 
 def test_notest(pyproject_path):
-    """
-    Test a non-existent test.
-    """
+    """Test a non-existent test."""
 
     with in_dir(pyproject_path.parent):
         with pytest.raises(InvalidScriptError):
@@ -74,9 +70,7 @@ def test_notest(pyproject_path):
 
 
 def test_exit(pyproject_path):
-    """
-    Test `exit` script.
-    """
+    """Test `exit` script."""
 
     with in_dir(pyproject_path.parent):
         with pytest.raises(SystemExit):
@@ -84,9 +78,7 @@ def test_exit(pyproject_path):
 
 
 def test_echo(pyproject_path, capfd):
-    """
-    Test `echo` script.
-    """
+    """Test `echo` script."""
 
     with in_dir(pyproject_path.parent):
         cli("echo", "Hello")
@@ -96,9 +88,7 @@ def test_echo(pyproject_path, capfd):
 
 
 def test_echo_path(pyproject_path, capfd):
-    """
-    Test `echo-path` script.
-    """
+    """Test `echo-path` script."""
 
     with in_dir(pyproject_path.parent):
         cli("echo-path")
@@ -108,9 +98,7 @@ def test_echo_path(pyproject_path, capfd):
 
 
 def test_echo_wildcard(pyproject_path, capfd):
-    """
-    Test `echo-wildcard` script.
-    """
+    """Test `echo-wildcard` script."""
 
     with in_dir(pyproject_path.parent) as wd:
         subdir = wd / "subdir"
@@ -124,14 +112,12 @@ def test_echo_wildcard(pyproject_path, capfd):
 
 
 def test_recursion(pyproject_path, capfd):
-    """
-    Test recursive script running.
-    """
+    """Test recursive script running."""
 
     with in_dir(pyproject_path.parent):
         cli("farewell")
         captured = capfd.readouterr()
-        assert captured.out == "Hello\nGoodbye\n"
+        assert captured.out == "Hello friend!\nGoodbye\n"
         assert captured.err == ""
 
         with pytest.raises(InvalidScriptError):

{ppqs-2.3.0 → ppqs-2.4.0}/test/test_find_pyproject.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+"""Test find_pyproject()."""
+
 import pytest
 
 from py_proj_quick_scripts import (
@@ -13,9 +15,7 @@ from . import in_dir, write_file
 
 
 def test_find_pyproject(tmp_path):
-    """
-    Test find_pyproject().
-    """
+    """Test find_pyproject()."""
 
     with in_dir(tmp_path):
         with pytest.raises(MissingPyProjectError):

{ppqs-2.3.0 → ppqs-2.4.0}/test/test_parse_scripts.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+"""Test parse_scripts()."""
+
 from contextlib import nullcontext
 from pathlib import Path
 
@@ -56,6 +58,7 @@ from . import in_dir, write_file
                     "init": {
                         "description": "Run init script",
                         "print-header": False,
+                        "bash-complete-file-glob": None,
                         "commands": [["pip", "install", "-r", "requirements.txt"]],
                     }
                 }
@@ -75,6 +78,7 @@ from . import in_dir, write_file
                     "init": {
                         "description": "Run init script",
                         "print-header": False,
+                        "bash-complete-file-glob": None,
                         "commands": [
                             ["pip", "install", "-r", "requirements.txt"],
                             ["pre-commit", "install"],
@@ -121,6 +125,7 @@ from . import in_dir, write_file
                     "init": {
                         "description": "Initialise project",
                         "print-header": False,
+                        "bash-complete-file-glob": None,
                         "commands": [["pip", "install", "-r", "requirements.txt"]],
                     }
                 }
@@ -152,6 +157,7 @@ from . import in_dir, write_file
                     "init": {
                         "description": "Run init script",
                         "print-header": False,
+                        "bash-complete-file-glob": None,
                         "commands": [["pip", "install", "-r", "requirements.txt"]],
                     }
                 }
@@ -172,6 +178,7 @@ from . import in_dir, write_file
                     "init": {
                         "description": "Initialise project",
                         "print-header": True,
+                        "bash-complete-file-glob": None,
                         "commands": [["pip", "install", "-r", "requirements.txt"]],
                     }
                 }
@@ -192,6 +199,7 @@ from . import in_dir, write_file
                     "init": {
                         "description": "Initialise project",
                         "print-header": False,
+                        "bash-complete-file-glob": None,
                         "commands": [
                             ["pip", "install", "-r", "requirements.txt"],
                             ["pre-commit", "install"],
@@ -223,6 +231,7 @@ from . import in_dir, write_file
                     "paths": {
                         "description": "Run paths script",
                         "print-header": False,
+                        "bash-complete-file-glob": None,
                         "commands": [["echo", Path("a", "b")]],
                     }
                 }
@@ -253,12 +262,28 @@ from . import in_dir, write_file
             ),
             id="recursive script does not exist",
         ),
+        pytest.param(
+            """
+            [tool.ppqs.scripts.test]
+            bash-complete-file-glob = "test/**/test_*.py"
+            script = "run-tests ..."
+            """,
+            nullcontext(
+                {
+                    "test": {
+                        "description": "Run test script",
+                        "print-header": False,
+                        "bash-complete-file-glob": "test/**/test_*.py",
+                        "commands": [["run-tests", "..."]],
+                    }
+                }
+            ),
+            id="string script with complete file glob",
+        ),
     ],
 )
 def test_parse_scripts(tmp_path, script_toml, expectation):
-    """
-    Test parse_scripts().
-    """
+    """Test parse_scripts()."""
 
     pyproject_path = tmp_path / "pyproject.toml"
     pyproject_toml = f"""