Skip to content

Commit

Permalink
Add docstring for '_is_test_env'
Browse files Browse the repository at this point in the history
  • Loading branch information
sinoroc committed Oct 12, 2020
1 parent 8fb090d commit fed2195
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/tox_poetry_dev_dependencies/_hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,18 @@ def tox_addoption(parser: tox.config.Parser) -> None:


def _is_test_env(env_config: tox.config.TestenvConfig) -> bool:
"""Check if it is a test environment.
Tox creates environments for provisioning (`.tox`) and for isolated build
(`.packaging`) in addition to the usual test environments. And in hooks
such as `tox_testenv_create` it is not clear if the environment is a test
environment or one of those environments used for tox's own purposes.
So we start by excluding the provisioning environment named after
`provision_tox_env` and the build isolation environment named after
`isolated_build_env`. Then we keep only the environments listed in
`envlist`.
"""
#
is_test_env = False
#
Expand Down

0 comments on commit fed2195

Please sign in to comment.