1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
"""Convert string configuration values to tox python configuration objects."""
from __future__ import annotations
import shlex
import sys
from itertools import chain
from pathlib import Path
from typing import Any, Iterator
from tox.config.loader.convert import Convert
from tox.config.types import Command, EnvList
class StrConvert(Convert[str]):
"""A class converting string values to tox types"""
@staticmethod
def to_str(value: str) -> str:
return str(value).strip()
@staticmethod
def to_path(value: str) -> Path:
return Path(value)
@staticmethod
def to_list(value: str, of_type: type[Any]) -> Iterator[str]:
splitter = "\n" if issubclass(of_type, Command) or "\n" in value else ","
splitter = splitter.replace("\r", "")
for token in value.split(splitter):
value = token.strip()
if value:
yield value
@staticmethod
def to_set(value: str, of_type: type[Any]) -> Iterator[str]:
yield from StrConvert.to_list(value, of_type)
@staticmethod
def to_dict(value: str, of_type: tuple[type[Any], type[Any]]) -> Iterator[tuple[str, str]]: # noqa: U100
for row in value.split("\n"):
if row.strip():
key, sep, value = row.partition("=")
if sep:
yield key.strip(), value.strip()
else:
raise TypeError(f"dictionary lines must be of form key=value, found {row!r}")
@staticmethod
def to_command(value: str) -> Command:
is_win = sys.platform == "win32"
value = value.replace(r"\#", "#")
splitter = shlex.shlex(value, posix=not is_win)
splitter.whitespace_split = True
splitter.commenters = "" # comments handled earlier, and the shlex does not know escaped comment characters
args: list[str] = []
pos = 0
try:
for arg in splitter:
if is_win and len(arg) > 1 and arg[0] == arg[-1] and arg.startswith(("'", '"')): # pragma: win32 cover
# on Windows quoted arguments will remain quoted, strip it
arg = arg[1:-1]
args.append(arg)
pos = splitter.instream.tell()
except ValueError:
args.append(value[pos:])
if len(args) == 0:
raise ValueError(f"attempting to parse {value!r} into a command failed")
if args[0] != "-" and args[0].startswith("-"):
args[0] = args[0][1:]
args = ["-"] + args
return Command(args)
@staticmethod
def to_env_list(value: str) -> EnvList:
from tox.config.loader.ini.factor import extend_factors
elements = list(chain.from_iterable(extend_factors(expr) for expr in value.split("\n")))
return EnvList(elements)
TRUTHFUL_VALUES = {"true", "1", "yes", "on"}
FALSE_VALUES = {"false", "0", "no", "off", ""}
VALID_BOOL = sorted(TRUTHFUL_VALUES | FALSE_VALUES)
@staticmethod
def to_bool(value: str) -> bool:
norm = str(value).strip().lower()
if norm in StrConvert.TRUTHFUL_VALUES:
return True
elif norm in StrConvert.FALSE_VALUES:
return False
else:
raise TypeError(
f"value {value!r} cannot be transformed to bool, valid: {', '.join(StrConvert.VALID_BOOL)}",
)
__all__ = ("StrConvert",)
|
