Class CliEnv

src/tox/session/env_select.py:41–103

The user's selection of tox test environments via ``-e`` or ``env_list`` config. It is in one of three forms: - A list of specific environments, instantiated with a string that is a comma-separated list of the environment names. (These may have spaces on either side of the commas whi

class CliEnv:  # noqa: PLW1641
    """The user's selection of tox test environments via ``-e`` or ``env_list`` config.

    It is in one of three forms:

    - A list of specific environments, instantiated with a string that is a comma-separated list of the environment
      names. (These may have spaces on either side of the commas which are removed.) As a sequence this will be a
      sequence of those names.
    - "ALL" which is all environments defined by the tox configuration. This is instantiated with ``ALL`` either alone
      or as any element of a comma-separated list; any other environment names are ignored. `is_all()` will be true and
      as a sequence it will be empty. This prints in string representation as ``ALL``.
    - The default environments as chosen by tox configuration. This is instantiated with `None` as the parameter,
      `is_default_list()` will be true, and as a sequence this will be empty. This prints in string representation as
      ``<env_list>``.

    """

    def __init__(self, value: list[str] | str | None = None) -> None:
        if isinstance(value, str):
            raw = value
            try:
                value = list(extend_factors(raw)) or None
            except ValueError:
                value = [v.strip() for v in raw.split(",") if v.strip()] or None
        self._names: list[str] | None = value

    def __iter__(self) -> Iterator[str]:
        if not self.is_all and self._names is not None:  # pragma: no branch
            yield from self._names

    def __bool__(self) -> bool:
        """A `CliEnv` is `True` if it's not the default set of environments."""
        return bool(self._names)

    def __str__(self) -> str:
        return "ALL" if self.is_all else ("<env_list>" if self.is_default_list else ",".join(self))

    def __repr__(self) -> str:
        return f"{self.__class__.__name__}({'' if self.is_default_list else repr(str(self))})"

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, CliEnv):
            return False
        return self._names == other._names

    def __ne__(self, other: object) -> bool:
        return not (self == other)

    def __iadd__(self, other: CliEnv) -> Self:
        if other._names is not None:
            if self._names is None:
                self._names = list(other._names)
            else:
                self._names.extend(other._names)
        return self

    @property
    def is_all(self) -> bool: