Add support for - in factor values.

You now escape a `-` with `-`; i.e.: `--` maps to `-` in a factor value
instead of breaking to the next factor.

Also fix `dev-cmd` `pyproject.toml` discovery when installed in editable
mode in another project as well as fixing over-eager command
deactivation in some cases where commands had multiple implementations
selected amongst via `when` markers.

Author: jsirois

CHANGES.md

@@ -1,5 +1,17 @@
 # Release Notes
 
+## 0.29.0
+
+Add support for `-` in factor values by escaping with a leading `-`; i.e. to pass the value of
+`bar-baz` for factor `foo` of command `test` you can now say: `test-foo:bar--baz` (or
+`test-foobar--baz`).
+
+Also fix an issue with `pyproject.toml` discovery when `dev-cmd` is installed in another repo in
+editable mode.
+
+Finally, fix over-eager command deactivation in some cases where commands had multiple
+implementations selected amongst via `when` markers.
+
 ## 0.28.0
 
 As long as there is at least one command left to execute, tasks and any groups they contain now

README.md

@@ -149,7 +149,8 @@ to ambiguity in which factor argument should be applied. An optional leading `:`
 factor argument value, and it will be stripped. So both `test-py:3.12` and `test-py3.12` pass `3.12`
 as the value for the `-py` factor parameter. The colon-prefix helps distinguish factor name from
 factor value, paralleling the default value syntax that can be used at factor parameter declaration
-sites.
+sites. If your factor value contains a `-`, just escape it with a `-`; i.e.: `--` will map to a
+single `-` in a factor value instead of indicating a new factor starts there.
 
 #### Documentation
 

dev_cmd/__init__.py

@@ -1,4 +1,4 @@
 # Copyright 2024 John Sirois.
 # Licensed under the Apache License, Version 2.0 (see LICENSE).
 
-__version__ = "0.28.0"
+__version__ = "0.29.0"

dev_cmd/parse.py

@@ -6,7 +6,7 @@
 import dataclasses
 import itertools
 import os
-from collections import defaultdict
+from collections import defaultdict, deque
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Any, Container, Dict, Iterable, Iterator, List, Mapping, Set, cast
@@ -838,7 +838,7 @@ def _gather_all_required_step_names(
 
 def parse_dev_config(
     pyproject_toml: PyProjectToml, *requested_steps: str, requested_python: Python | None = None
-) -> Configuration:
+) -> tuple[Configuration, tuple[str, ...]]:
     pyproject_data = pyproject_toml.parse()
     try:
         dev_cmd_data = _assert_dict_str_keys(
@@ -875,6 +875,7 @@ def pop_dict(key: str, *, path: str) -> dict[str, Any] | None:
     required_step_names = (
         _gather_all_required_step_names(requested_steps, tasks_data) or known_names
     )
+    requested_step_names: dict[str, str] = {step: step for step in requested_steps}
     for required_step_name in required_step_names:
         if required_step_name in known_names:
             required_steps[required_step_name].append(())
@@ -883,23 +884,46 @@ def pop_dict(key: str, *, path: str) -> dict[str, Any] | None:
             if not required_step_name.startswith(f"{known_name}-"):
                 continue
 
-            required_steps[known_name].append(
-                tuple(
-                    Factor(factor)
-                    for factor in required_step_name[len(known_name) + 1 :].split("-")
-                )
+            factors = []  # type: List[Factor]
+            factor_chars = []  # type: List[str]
+            chars = deque(required_step_name[len(known_name) + 1 :])
+            while chars:
+                while chars:
+                    char = chars.popleft()
+
+                    if char != "-":
+                        factor_chars.append(char)
+                        continue
+
+                    # Escaped - (--)
+                    if chars and chars[0] == "-":
+                        factor_chars.append(char)
+                        chars.popleft()
+                        continue
+
+                    if not chars:
+                        factor_chars.append(char)
+
+                    break
+                factors.append(Factor("".join(factor_chars)))
+                factor_chars.clear()
+
+            required_steps[known_name].append(tuple(factors))
+            requested_step_names[required_step_name] = (
+                f"{known_name}-{'-'.join(factors)}" if factors else known_name
             )
             break
 
-    commands: dict[str, Command | DeactivatedCommand] = {
-        cmd.name: cmd
-        for cmd in _parse_commands(
-            commands_data,
-            required_steps,
-            project_dir=pyproject_toml.path.parent,
-            marker_environment=marker_environment,
-        )
-    }
+    commands: dict[str, Command | DeactivatedCommand] = {}
+    for cmd in _parse_commands(
+        commands_data,
+        required_steps,
+        project_dir=pyproject_toml.path.parent,
+        marker_environment=marker_environment,
+    ):
+        existing = commands.setdefault(cmd.name, cmd)
+        if isinstance(existing, DeactivatedCommand) and isinstance(cmd, Command):
+            commands[cmd.name] = cmd
     if not commands:
         raise InvalidModelError(
             "No commands are defined in the [tool.dev-cmd.commands] table. At least one must be "
@@ -919,7 +943,7 @@ def pop_dict(key: str, *, path: str) -> dict[str, Any] | None:
             f"Unexpected configuration keys in the [tool.dev-cmd] table: {' '.join(dev_cmd_data)}"
         )
 
-    return Configuration(
+    configuration = Configuration(
         commands=tuple(cmd for cmd in commands.values() if isinstance(cmd, Command)),
         tasks=tuple(tasks.values()),
         default=default,
@@ -929,3 +953,5 @@ def pop_dict(key: str, *, path: str) -> dict[str, Any] | None:
         pythons=pythons,
         source=pyproject_toml.path,
     )
+
+    return configuration, tuple(requested_step_names[step] for step in requested_steps)

dev_cmd/project.py

@@ -5,8 +5,6 @@
 
 import os
 from dataclasses import dataclass
-from importlib import metadata
-from importlib.metadata import PackageNotFoundError
 from pathlib import Path
 from typing import Any
 
@@ -35,18 +33,7 @@ def parse(self) -> dict[str, Any]:
 
 
 def find_pyproject_toml() -> PyProjectToml:
-    module = Path(__file__)
-    start = module.parent
-    try:
-        dist_files = metadata.files("dev-cmd")
-        if dist_files and any(module == dist_file.locate() for dist_file in dist_files):
-            # N.B.: We're running from an installed package; so use the PWD as the search start.
-            start = Path()
-    except PackageNotFoundError:
-        # N.B.: We're being run directly from sources that are not installed or are installed in
-        # editable mode.
-        pass
-
+    start = Path()
     candidate = start.resolve()
     while True:
         pyproject_toml = candidate / "pyproject.toml"

dev_cmd/run.py

@@ -99,7 +99,7 @@ def ensure_venv(python: Python, *, quiet: bool) -> Venv:
 
 def _run(
     config: Configuration,
-    *names: str,
+    *steps: str,
     skips: Collection[str] = (),
     console: Console = Console(),
     parallel: bool = False,
@@ -126,21 +126,22 @@ def _run(
             f"configured command or task names."
         )
 
-    if names:
+    if steps:
         try:
             invocation = Invocation.create(
-                *(available_tasks.get(name) or available_cmds[name] for name in names),
+                *(available_tasks.get(step) or available_cmds[step] for step in steps),
                 skips=skips,
                 console=console,
                 grace_period=grace_period,
                 timings=timings,
                 venv=config.venv,
             )
         except KeyError as e:
+            print(e, file=sys.stderr)
             raise InvalidArgumentError(
                 os.linesep.join(
                     (
-                        f"A requested task is not defined in {config.source}: {e}",
+                        f"A requested step is not defined in {config.source}: {e}",
                         "",
                         f"Available tasks: {' '.join(sorted(available_tasks))}",
                         f"Available commands: {' '.join(sorted(available_cmds))}",
@@ -193,7 +194,7 @@ def _run(
 
 @dataclass(frozen=True)
 class Options:
-    tasks: tuple[str, ...]
+    steps: tuple[str, ...]
     skips: frozenset[str]
     list: bool
     quiet: bool
@@ -322,7 +323,7 @@ def _parse_args() -> Options:
         ),
     )
     parser.add_argument(
-        "tasks",
+        "steps",
         nargs="*",
         metavar="cmd|task",
         help=(
@@ -346,10 +347,10 @@ def _parse_args() -> Options:
     options = parser.parse_args(args)
     color.set_color(ColorChoice(options.color))
 
-    tasks = tuple(itertools.chain.from_iterable(expand(task) for task in options.tasks))
-    parallel = options.parallel and len(tasks) > 1
+    steps = tuple(itertools.chain.from_iterable(expand(step) for step in options.steps))
+    parallel = options.parallel and len(steps) > 1
     if options.parallel and not parallel and not options.quiet:
-        single_task = repr(tasks[0]) if tasks else "the default"
+        single_task = repr(steps[0]) if steps else "the default"
         print(
             color.yellow(
                 f"A parallel run of top-level tasks was requested but only one was requested, "
@@ -358,7 +359,7 @@ def _parse_args() -> Options:
         )
 
     return Options(
-        tasks=tasks,
+        steps=steps,
         skips=frozenset(options.skips),
         list=options.list,
         quiet=options.quiet,
@@ -407,7 +408,7 @@ def _list(
             factor_desc_header = f"    -{factor_description.factor}"
             rendered_factor = color.magenta(factor_desc_header)
             default = factor_description.default
-            if default:
+            if default is not None:
                 substituted_default = DEFAULT_ENVIRONMENT.substitute(default).value
                 if substituted_default != default:
                     extra_info = f"[default: {default} (currently {substituted_default})]"
@@ -459,7 +460,7 @@ def main() -> Any:
     python = Python(options.python) if options.python else None
     try:
         pyproject_toml = find_pyproject_toml()
-        config = parse_dev_config(pyproject_toml, *options.tasks, requested_python=python)
+        config, steps = parse_dev_config(pyproject_toml, *options.steps, requested_python=python)
     except DevCmdError as e:
         return 1 if console.quiet else f"{color.red('Configuration error')}: {color.yellow(str(e))}"
 
@@ -470,7 +471,7 @@ def main() -> Any:
     try:
         _run(
             config,
-            *options.tasks,
+            *steps,
             skips=options.skips,
             console=console,
             parallel=options.parallel,

tests/test_parse.py

@@ -26,7 +26,7 @@ def parse_config(tmp_path: Path) -> Iterator[ConfigurationParser]:
     def parse(content: str) -> Configuration:
         pyproject_toml = tmp_path / "pyproject.toml"
         pyproject_toml.write_text(content)
-        return parse_dev_config(PyProjectToml(pyproject_toml))
+        return parse_dev_config(PyProjectToml(pyproject_toml))[0]
 
     yield parse