Restore TOX_SKIP_ENV filtering #2707

mgedmin · 2022-12-14T09:16:49Z

This is still documented in docs/config.rst. The only missing thing is the reporting at verbosity level 2.

I feel bad about the missing reporting. Could someone help me figure it out?

Fixes #2698.

Thanks for contribution

Please, make sure you address all the checklists (for details on how see
development documentation)!

ran the linter to address style issues (tox -e fix)
wrote descriptive pull request text
ensured there are test(s) validating the fix
added news fragment in docs/changelog folder
updated/extended the documentation

mgedmin · 2022-12-14T09:32:34Z

I feel bad about the missing reporting. Could someone help me figure it out?

I think I have it, but what on earth is "verbosity level 2"? tox -vv? i.e. should I use logging.debug() for this?

mgedmin · 2022-12-14T09:41:56Z

I am very confused about logging levels. tox --help says

verbosity:
  every -v increases, every -q decreases verbosity level, default INFO, map 0=CRITICAL|1=ERROR|2=WARNING|3=INFO|4=DEBUG|5=NOTSET

  -v, --verbose               increase verbosity (default: 2)
  -q, --quiet                 decrease verbosity (default: 0)

so level 2 is WARNING, and the default level is INFO, which is 3, but also the default level is 2, which is WARNING.

→ #2709

Anyway, I'm logging with .info(), and it's visible only if you pass a single -v to tox, which means the actual default is WARNING and the --help output lies to me?

Should I change the log level of this message to .warning() so it would match docs/config.rst?

→ did so

gaborbernat · 2022-12-14T15:19:09Z

docs/changelog/2698.bugfix.rst

@@ -0,0 +1,2 @@
+``TOX_SKIP_ENV`` environment variable now works again (it was unintentionally


Please wrap at 120 characters.

Also do you want to add your user name here?

- :by:`x`.

gaborbernat · 2022-12-14T15:20:45Z

tests/session/test_env_select.py

+    ini = """
+        [tox]
+        env_list = py3{10,9},mypy
+        """


You can include this in one line considering its simplicity.

gaborbernat · 2022-12-14T15:20:51Z

tests/session/test_env_select.py

+    monkeypatch.setenv("TOX_SKIP_ENV", "m[y]py")
+    ini = """
+        [tox]
+        env_list = py3{10,9},mypy


You can include this in one line considering its simplicity.

gaborbernat · 2022-12-14T15:21:50Z

src/tox/session/env_select.py

    def __init__(self, state: State) -> None:
        # needs core to load the default tox environment list
        # to load the package environments of a run environments we need the run environment builder
        # to load labels we need core + the run environment
        self.on_empty_fallback_py = True
+        self._warned_about = set()


You can move line 111 here; no need to define and then initialize it here; just initializing it is enough

gaborbernat · 2022-12-14T15:22:36Z

src/tox/session/env_select.py

+        tox_env_filter = os.environ.get("TOX_SKIP_ENV")
+        tox_env_filter_re = re.compile(tox_env_filter) if tox_env_filter is not None else None


This definition should happen in the constructor of this class, not every time on this call, no?

This is still documented in docs/config.rst. The only missing thing is the reporting at verbosity level 2. Fixes tox-dev#2698.

Logging this at DEBUG level (tox -vv) felt wrong to me, so I went with INFO (tox -v).

tox --help says verbosity level 2 is WARNING.

As far as I can tell, during runtime there's only one EnvSelector instance, so there's no danger of repeatedly warning about the same skipped environment when .iter() gets called several times. Fixes failing unit tests. (Oops. I only ran each test in isolation, because the entire test suite is a bit slow.)

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>

mgedmin · 2022-12-15T11:29:21Z

Ah, sorry, I meant to take another look at this but was too busy yesterday.

Thank you for finishing it!

mgedmin · 2022-12-15T11:30:06Z

src/tox/session/env_select.py

@@ -88,6 +93,8 @@ def register_env_select_flags(
        add_to.add_argument("-m", dest="labels", metavar="label", help=help_msg, default=[], type=str, nargs="+")
        help_msg = "factors to evaluate"
        add_to.add_argument("-f", dest="factors", metavar="factor", help=help_msg, default=[], type=str, nargs="+")
+    help_msg = "exclude all environments selected that match this regular expression"
+    add_to.add_argument("--skip-env", dest="skip_env", metavar="re", help=help_msg, default="", type=str)


I like this even more than the environment variable!

This PR contains the following updates: | Package | Type | Update | Change | Pending | |---|---|---|---|---| | [tox](https://togithub.com/tox-dev/tox) | dev | patch | `4.0.9` -> `4.0.11` | `4.1.0` (+8) | --- ### Release Notes <details> <summary>tox-dev/tox</summary> ### [`v4.0.11`](https://togithub.com/tox-dev/tox/releases/tag/4.0.11) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.0.10...4.0.11) #### What's Changed - Show only default env list for tox config by default by [@gaborbernat](https://togithub.com/gaborbernat) in [tox-dev/tox#2726 - NO_COLOR follows no-color.org logic instead of tox boolean by [@gaborbernat](https://togithub.com/gaborbernat) in [tox-dev/tox#2727 - Restore TOX_SKIP_ENV filtering by [@mgedmin](https://togithub.com/mgedmin) in [tox-dev/tox#2707 **Full Changelog**: tox-dev/tox@4.0.10...4.0.11 ### [`v4.0.10`](https://togithub.com/tox-dev/tox/compare/4.0.9...4.0.10) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.0.9...4.0.10) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box  Co-authored-by: descope[bot] <descope[bot]@users.noreply.github.com>

mgedmin requested a review from gaborbernat as a code owner December 14, 2022 09:16

psf-chronographer bot added the bot:chronographer:provided label Dec 14, 2022

mgedmin mentioned this pull request Dec 14, 2022

tox 4 ignores TOX_SKIP_ENV #2698

Closed

gaborbernat requested changes Dec 14, 2022

View reviewed changes

mgedmin and others added 7 commits December 14, 2022 18:39

Restore TOX_SKIP_ENV filtering

8a28e88

This is still documented in docs/config.rst. The only missing thing is the reporting at verbosity level 2. Fixes tox-dev#2698.

Add a news fragment

a6887fa

Log about skipped environments

fe2d258

Logging this at DEBUG level (tox -vv) felt wrong to me, so I went with INFO (tox -v).

Add missing test fixture type annotations

c101da7

Change the log level to WARNING to match the documentation

89572aa

tox --help says verbosity level 2 is WARNING.

PR feedback

924e32c

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>

gaborbernat force-pushed the restore-tox-skip-env branch from 18971ca to 924e32c Compare December 15, 2022 02:44

gaborbernat added 2 commits December 14, 2022 18:52

Add CLI flag too

ad3e3ed

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>

fix tests

449d884

Signed-off-by: Bernát Gábor <bgabor8@bloomberg.net>

gaborbernat merged commit c9394e8 into tox-dev:main Dec 15, 2022

mgedmin deleted the restore-tox-skip-env branch December 15, 2022 11:29

mgedmin commented Dec 15, 2022

View reviewed changes

mikelane mentioned this pull request Dec 16, 2022

Bump tox from 4.0.10 to 4.0.11 mikelane/reddit-get#108

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restore TOX_SKIP_ENV filtering #2707

Restore TOX_SKIP_ENV filtering #2707

mgedmin commented Dec 14, 2022

mgedmin commented Dec 14, 2022

mgedmin commented Dec 14, 2022 •

edited

gaborbernat Dec 14, 2022

gaborbernat Dec 14, 2022

gaborbernat Dec 14, 2022

gaborbernat Dec 14, 2022

gaborbernat Dec 14, 2022

gaborbernat Dec 14, 2022

mgedmin commented Dec 15, 2022

mgedmin Dec 15, 2022

		@@ -0,0 +1,2 @@
		``TOX_SKIP_ENV`` environment variable now works again (it was unintentionally

		tox_env_filter = os.environ.get("TOX_SKIP_ENV")
		tox_env_filter_re = re.compile(tox_env_filter) if tox_env_filter is not None else None

Restore TOX_SKIP_ENV filtering #2707

Restore TOX_SKIP_ENV filtering #2707

Conversation

mgedmin commented Dec 14, 2022

Thanks for contribution

mgedmin commented Dec 14, 2022

mgedmin commented Dec 14, 2022 • edited

gaborbernat Dec 14, 2022

Choose a reason for hiding this comment

gaborbernat Dec 14, 2022

Choose a reason for hiding this comment

gaborbernat Dec 14, 2022

Choose a reason for hiding this comment

gaborbernat Dec 14, 2022

Choose a reason for hiding this comment

gaborbernat Dec 14, 2022

Choose a reason for hiding this comment

gaborbernat Dec 14, 2022

Choose a reason for hiding this comment

mgedmin commented Dec 15, 2022

mgedmin Dec 15, 2022

Choose a reason for hiding this comment

mgedmin commented Dec 14, 2022 •

edited