diff --git a/README.md b/README.md index 1fa3dcd84..f7d58c7b3 100644 --- a/README.md +++ b/README.md @@ -290,6 +290,7 @@ By default, both `pip-compile` and `pip-sync` will look first for a `.pip-tools.toml` file and then in your `pyproject.toml`. You can also specify an alternate TOML configuration file with the `--config` option. +It is possible to specify configuration values both globally and tool-specific. For example, to by default generate `pip` hashes in the resulting requirements file output, you can specify in a configuration file: @@ -311,6 +312,27 @@ so the above could also be specified in this format: generate_hashes = true ``` +Configuration defaults specific to `pip-compile` and `pip-sync` can be put beneath +separate sections. For example, to by default perform a dry-run with `pip-compile`: + +```toml +[tool.pip-compile] +dry-run = true +``` + +This does not affect the `pip-sync` command, which also has a `--dry-run` option. +Note that tool-specific configuration overrides global settings, thus this would +also make `pip-compile` generate hashes, but discard the global dry-run setting: + +```toml +[tool.pip-tools] +generate-hashes = true +dry-run = true + +[tool.pip-compile] +dry-run = false +``` + You might be wrapping the `pip-compile` command in another script. To avoid confusing consumers of your custom script you can override the update command generated at the top of requirements files by setting the diff --git a/piptools/scripts/compile.py b/piptools/scripts/compile.py index 1e47b8a69..5d7ecb7cc 100755 --- a/piptools/scripts/compile.py +++ b/piptools/scripts/compile.py @@ -72,7 +72,10 @@ def _determine_linesep( }[strategy] -@click.command(context_settings={"help_option_names": options.help_option_names}) +@click.command( + name="pip-compile", + context_settings={"help_option_names": options.help_option_names}, +) @click.pass_context @options.version @options.verbose diff --git a/piptools/scripts/sync.py b/piptools/scripts/sync.py index acddf9279..b83e811cb 100755 --- a/piptools/scripts/sync.py +++ b/piptools/scripts/sync.py @@ -30,7 +30,9 @@ DEFAULT_REQUIREMENTS_FILE = "requirements.txt" -@click.command(context_settings={"help_option_names": options.help_option_names}) +@click.command( + name="pip-sync", context_settings={"help_option_names": options.help_option_names} +) @options.version @options.ask @options.dry_run diff --git a/piptools/utils.py b/piptools/utils.py index 70f1ee17f..e0aa37dc2 100644 --- a/piptools/utils.py +++ b/piptools/utils.py @@ -556,7 +556,7 @@ def override_defaults_from_config_file( ``None`` is returned if no such file is found. ``pip-tools`` will use the first config file found, searching in this order: - an explicitly given config file, a d``.pip-tools.toml``, a ``pyproject.toml`` + an explicitly given config file, a ``.pip-tools.toml``, a ``pyproject.toml`` file. Those files are searched for in the same directory as the requirements input file, or the current working directory if requirements come via stdin. """ @@ -570,10 +570,21 @@ def override_defaults_from_config_file( else: config_file = Path(value) - config = parse_config_file(ctx, config_file) - if config: - _validate_config(ctx, config) - _assign_config_to_cli_context(ctx, config) + piptools_config, pipcompile_config, pipsync_config = parse_config_file( + ctx, config_file + ) + + configs = [piptools_config] + + if ctx.command.name == "pip-compile": + configs.append(pipcompile_config) + elif ctx.command.name == "pip-sync": + configs.append(pipsync_config) + + for config in configs: + if config: + _validate_config(ctx, config) + _assign_config_to_cli_context(ctx, config) return config_file @@ -688,7 +699,7 @@ def get_cli_options(ctx: click.Context) -> dict[str, click.Parameter]: def parse_config_file( click_context: click.Context, config_file: Path -) -> dict[str, Any]: +) -> tuple[dict[str, Any], ...]: try: config = tomllib.loads(config_file.read_text(encoding="utf-8")) except OSError as os_err: @@ -702,14 +713,24 @@ def parse_config_file( hint=f"Could not parse '{config_file !s}': {value_err !s}", ) - # In a TOML file, we expect the config to be under `[tool.pip-tools]` + # In a TOML file, we expect the config to be under `[tool.pip-tools]`, + # `[tool.pip-compile]` or `[tool.pip-sync]` piptools_config: dict[str, Any] = config.get("tool", {}).get("pip-tools", {}) - piptools_config = _normalize_keys_in_config(piptools_config) - piptools_config = _invert_negative_bool_options_in_config( - ctx=click_context, - config=piptools_config, - ) - return piptools_config + pipcompile_config: dict[str, Any] = config.get("tool", {}).get("pip-compile", {}) + pipsync_config: dict[str, Any] = config.get("tool", {}).get("pip-sync", {}) + + configs = [] + + for config in (piptools_config, pipcompile_config, pipsync_config): + if config: + config = _normalize_keys_in_config(config) + config = _invert_negative_bool_options_in_config( + ctx=click_context, + config=config, + ) + configs.append(config) + + return tuple(configs) def _normalize_keys_in_config(config: dict[str, Any]) -> dict[str, Any]: diff --git a/tests/conftest.py b/tests/conftest.py index 4834f4bc1..0d2c012fe 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -455,6 +455,7 @@ def _maker( pyproject_param: str, new_default: Any, config_file_name: str = DEFAULT_CONFIG_FILE_NAMES[0], + section: str = "pip-tools", ) -> Path: # Create a nested directory structure if config_file_name includes directories config_dir = (tmpdir_cwd / config_file_name).parent @@ -462,7 +463,7 @@ def _maker( # Make a config file with this one config default override config_file = tmpdir_cwd / config_file_name - config_to_dump = {"tool": {"pip-tools": {pyproject_param: new_default}}} + config_to_dump = {"tool": {section: {pyproject_param: new_default}}} config_file.write_text(tomli_w.dumps(config_to_dump)) return cast(Path, config_file.relative_to(tmpdir_cwd)) diff --git a/tests/test_cli_compile.py b/tests/test_cli_compile.py index d4ae901c4..3d53715a0 100644 --- a/tests/test_cli_compile.py +++ b/tests/test_cli_compile.py @@ -3147,3 +3147,15 @@ def test_do_not_show_warning_on_explicit_strip_extras_option( assert out.exit_code == 0 assert strip_extras_warning not in out.stderr + + +def test_tool_specific_config_option(pip_conf, runner, tmp_path, make_config_file): + config_file = make_config_file("dry-run", True, section="pip-compile") + + req_in = tmp_path / "requirements.in" + req_in.touch() + + out = runner.invoke(cli, [req_in.as_posix(), "--config", config_file.as_posix()]) + + assert out.exit_code == 0 + assert "Dry-run, so nothing updated" in out.stderr diff --git a/tests/test_cli_sync.py b/tests/test_cli_sync.py index 20e9689ec..48bf12da5 100644 --- a/tests/test_cli_sync.py +++ b/tests/test_cli_sync.py @@ -450,3 +450,16 @@ def test_allow_in_config_pip_compile_option(run, runner, tmp_path, make_config_f assert out.exit_code == 0 assert "Using pip-tools configuration defaults found" in out.stderr + + +@mock.patch("piptools.sync.run") +def test_tool_specific_config_option(run, runner, make_config_file): + config_file = make_config_file("dry-run", True, section="pip-sync") + + with open(sync.DEFAULT_REQUIREMENTS_FILE, "w") as reqs_txt: + reqs_txt.write("six==1.10.0") + + out = runner.invoke(cli, ["--config", config_file.as_posix()]) + + assert out.exit_code == 1 + assert "Would install:" in out.stdout