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
|
from dataclasses import dataclass
from typing import Optional, Tuple
from pytoolconfig import UniversalKey, field
from pytoolconfig.documentation import _generate_table, _type_to_str
@dataclass
class SubTool:
foo: str = field(description="foobar", default="lo")
@dataclass
class NestedModel:
subtool: SubTool = field(default_factory=lambda: SubTool())
foo_other: Optional[str] = field(
description="Tool One",
default="no",
command_line=("--foo", "-f"),
)
min_py_ver: Tuple[int, int] = field(
default=None,
description="sauf",
universal_config=UniversalKey.min_py_version,
)
test_truth: bool = False
def test_type_to_str():
assert _type_to_str(bool) == "bool"
assert _type_to_str(int) == "int"
assert _type_to_str(Tuple[int, int]) == "Tuple[int, int]"
def test_documentation():
lines = list(_generate_table(NestedModel))
assert "description" in lines[1]
assert "foo_other" in lines[3]
assert "Tool One" in lines[3]
assert "no" in lines[3]
assert "str" in lines[3]
assert "bool" in lines[6]
|
