diff options
author | Bernát Gábor <gaborjbernat@gmail.com> | 2022-12-14 18:53:08 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-12-14 18:53:08 -0800 |
commit | bfd9191942a153c8b05e90ed3a31a30f400fdbe1 (patch) | |
tree | 655bdcac2cb5f0572c8e0f3164ed4295b77c136a | |
parent | a63352330958a3fede3050b9db7a5201c47ca0df (diff) | |
download | tox-git-bfd9191942a153c8b05e90ed3a31a30f400fdbe1.tar.gz |
Show only default env list for tox config by default (#2726)
-rw-r--r-- | docs/changelog/2726.bugfix.rst | 1 | ||||
-rw-r--r-- | src/tox/session/cmd/show_config.py | 4 | ||||
-rw-r--r-- | tests/config/test_main.py | 13 | ||||
-rw-r--r-- | tests/session/cmd/test_show_config.py | 14 | ||||
-rw-r--r-- | tests/tox_env/test_tox_env_api.py | 2 |
5 files changed, 13 insertions, 21 deletions
diff --git a/docs/changelog/2726.bugfix.rst b/docs/changelog/2726.bugfix.rst new file mode 100644 index 00000000..a6fde490 --- /dev/null +++ b/docs/changelog/2726.bugfix.rst @@ -0,0 +1 @@ +``tox config`` should only show :ref:`env_list` arguments by default instead of ``ALL`` - by :user:`gaborbernat`. diff --git a/src/tox/session/cmd/show_config.py b/src/tox/session/cmd/show_config.py index 82181e3c..b00d30ee 100644 --- a/src/tox/session/cmd/show_config.py +++ b/src/tox/session/cmd/show_config.py @@ -32,10 +32,10 @@ def tox_add_option(parser: ToxParser) -> None: our.add_argument( "--core", action="store_true", - help="show core options too when selecting an env with -e", + help="show core options (by default is hidden unless -e ALL is passed)", dest="show_core", ) - register_env_select_flags(our, default=CliEnv("ALL")) + register_env_select_flags(our, default=CliEnv()) env_run_create_flags(our, mode="config") diff --git a/tests/config/test_main.py b/tests/config/test_main.py index cff7d2f4..25c07740 100644 --- a/tests/config/test_main.py +++ b/tests/config/test_main.py @@ -88,15 +88,8 @@ def test_args_are_paths_when_with_change_dir(tox_project: ToxProjectCreator) -> def test_relative_config_paths_resolve(tox_project: ToxProjectCreator) -> None: project = tox_project({"tox.ini": "[tox]"}) - result = project.run( - "c", - "-c", - str(Path(project.path.name) / "tox.ini"), - "-k", - "change_dir", - "env_dir", - from_cwd=project.path.parent, - ) + ini = str(Path(project.path.name) / "tox.ini") + result = project.run("c", "-c", ini, "-k", "change_dir", "env_dir", from_cwd=project.path.parent) result.assert_success() - expected = f"[testenv:py]\nchange_dir = {project.path}\nenv_dir = {project.path / '.tox' / 'py'}\n\n[tox]\n" + expected = f"[testenv:py]\nchange_dir = {project.path}\nenv_dir = {project.path / '.tox' / 'py'}\n" assert result.out == expected diff --git a/tests/session/cmd/test_show_config.py b/tests/session/cmd/test_show_config.py index cf2e719a..d4fa3b37 100644 --- a/tests/session/cmd/test_show_config.py +++ b/tests/session/cmd/test_show_config.py @@ -129,10 +129,9 @@ def test_show_config_pkg_env_once( patch_prev_py: Callable[[bool], tuple[str, str]], ) -> None: prev_ver, impl = patch_prev_py(True) - project = tox_project( - {"tox.ini": f"[tox]\nenv_list=py{prev_ver},py\n[testenv]\npackage=wheel", "pyproject.toml": ""}, - ) - result = project.run("c") + ini = f"[tox]\nenv_list=py{prev_ver},py\n[testenv]\npackage=wheel" + project = tox_project({"tox.ini": ini, "pyproject.toml": ""}) + result = project.run("c", "-e", "ALL") result.assert_success() parser = ConfigParser(interpolation=None) parser.read_string(result.out) @@ -145,10 +144,9 @@ def test_show_config_pkg_env_skip( patch_prev_py: Callable[[bool], tuple[str, str]], ) -> None: prev_ver, impl = patch_prev_py(False) - project = tox_project( - {"tox.ini": f"[tox]\nenv_list=py{prev_ver},py\n[testenv]\npackage=wheel", "pyproject.toml": ""}, - ) - result = project.run("c") + ini = f"[tox]\nenv_list=py{prev_ver},py\n[testenv]\npackage=wheel" + project = tox_project({"tox.ini": ini, "pyproject.toml": ""}) + result = project.run("c", "-e", "ALL") result.assert_success() parser = ConfigParser(interpolation=None) parser.read_string(result.out) diff --git a/tests/tox_env/test_tox_env_api.py b/tests/tox_env/test_tox_env_api.py index 70097443..65623b73 100644 --- a/tests/tox_env/test_tox_env_api.py +++ b/tests/tox_env/test_tox_env_api.py @@ -87,7 +87,7 @@ def test_tox_env_pass_env_fails_on_whitespace(tox_project: ToxProjectCreator) -> result.assert_success() msg = ( '[testenv:py]\npass_env = # Exception: Fail("pass_env values cannot contain whitespace, use comma to have ' - f'multiple values in a single line, invalid values found {first!r}, {second!r}")\n\n[tox]\n' + f'multiple values in a single line, invalid values found {first!r}, {second!r}")\n' ) assert result.out == msg |