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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
from __future__ import annotations
import sys
from pathlib import Path
from unittest import mock
import pytest
from datamodel_code_generator.format import CodeFormatter, Formatter, PythonVersion, PythonVersionMin
EXAMPLE_LICENSE_FILE = str(Path(__file__).parent / "data/python/custom_formatters/license_example.txt")
UN_EXIST_FORMATTER = "tests.data.python.custom_formatters.un_exist"
WRONG_FORMATTER = "tests.data.python.custom_formatters.wrong"
NOT_SUBCLASS_FORMATTER = "tests.data.python.custom_formatters.not_subclass"
ADD_COMMENT_FORMATTER = "tests.data.python.custom_formatters.add_comment"
ADD_LICENSE_FORMATTER = "tests.data.python.custom_formatters.add_license"
def test_python_version() -> None:
"""Ensure that the python version used for the tests is properly listed"""
_ = PythonVersion("{}.{}".format(*sys.version_info[:2]))
@pytest.mark.parametrize(
("skip_string_normalization", "expected_output"),
[
(True, "a = 'b'"),
(False, 'a = "b"'),
],
)
def test_format_code_with_skip_string_normalization(
skip_string_normalization: bool,
expected_output: str,
tmp_path: Path,
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.chdir(tmp_path)
formatter = CodeFormatter(PythonVersionMin, skip_string_normalization=skip_string_normalization)
formatted_code = formatter.format_code("a = 'b'")
assert formatted_code == expected_output + "\n"
def test_format_code_un_exist_custom_formatter() -> None:
with pytest.raises(ModuleNotFoundError):
_ = CodeFormatter(
PythonVersionMin,
custom_formatters=[UN_EXIST_FORMATTER],
)
def test_format_code_invalid_formatter_name() -> None:
with pytest.raises(NameError):
_ = CodeFormatter(
PythonVersionMin,
custom_formatters=[WRONG_FORMATTER],
)
def test_format_code_is_not_subclass() -> None:
with pytest.raises(TypeError):
_ = CodeFormatter(
PythonVersionMin,
custom_formatters=[NOT_SUBCLASS_FORMATTER],
)
def test_format_code_with_custom_formatter_without_kwargs(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.chdir(tmp_path)
formatter = CodeFormatter(
PythonVersionMin,
custom_formatters=[ADD_COMMENT_FORMATTER],
)
formatted_code = formatter.format_code("x = 1\ny = 2")
assert formatted_code == "# a comment\nx = 1\ny = 2" + "\n"
def test_format_code_with_custom_formatter_with_kwargs(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.chdir(tmp_path)
formatter = CodeFormatter(
PythonVersionMin,
custom_formatters=[ADD_LICENSE_FORMATTER],
custom_formatters_kwargs={"license_file": EXAMPLE_LICENSE_FILE},
)
formatted_code = formatter.format_code("x = 1\ny = 2")
assert (
formatted_code
== """# MIT License
#
# Copyright (c) 2023 Blah-blah
#
x = 1
y = 2
"""
)
def test_format_code_with_two_custom_formatters(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.chdir(tmp_path)
formatter = CodeFormatter(
PythonVersionMin,
custom_formatters=[
ADD_COMMENT_FORMATTER,
ADD_LICENSE_FORMATTER,
],
custom_formatters_kwargs={"license_file": EXAMPLE_LICENSE_FILE},
)
formatted_code = formatter.format_code("x = 1\ny = 2")
assert (
formatted_code
== """# MIT License
#
# Copyright (c) 2023 Blah-blah
#
# a comment
x = 1
y = 2
"""
)
def test_format_code_ruff_format_formatter() -> None:
formatter = CodeFormatter(
PythonVersionMin,
formatters=[Formatter.RUFF_FORMAT],
)
with mock.patch("subprocess.run") as mock_run:
mock_run.return_value.stdout = b"output"
formatted_code = formatter.format_code("input")
assert formatted_code == "output"
mock_run.assert_called_once_with(("ruff", "format", "-"), input=b"input", capture_output=True, check=False)
def test_format_code_ruff_check_formatter() -> None:
formatter = CodeFormatter(
PythonVersionMin,
formatters=[Formatter.RUFF_CHECK],
)
with mock.patch("subprocess.run") as mock_run:
mock_run.return_value.stdout = b"output"
formatted_code = formatter.format_code("input")
assert formatted_code == "output"
mock_run.assert_called_once_with(("ruff", "check", "--fix", "-"), input=b"input", capture_output=True, check=False)
|
