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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
"""
Test pydantic_settings.PyprojectTomlConfigSettingsSource.
"""
import sys
from pathlib import Path
import pytest
from pydantic import BaseModel
from pytest_mock import MockerFixture
from pydantic_settings import (
BaseSettings,
PydanticBaseSettingsSource,
PyprojectTomlConfigSettingsSource,
SettingsConfigDict,
)
try:
import tomli
except ImportError:
tomli = None
MODULE = 'pydantic_settings.sources.providers.pyproject'
SOME_TOML_DATA = """
field = "top-level"
[some]
[some.table]
field = "some"
[other.table]
field = "other"
"""
class SimpleSettings(BaseSettings):
"""Simple settings."""
model_config = SettingsConfigDict(pyproject_toml_depth=1, pyproject_toml_table_header=('some', 'table'))
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
class TestPyprojectTomlConfigSettingsSource:
"""Test PyprojectTomlConfigSettingsSource."""
def test___init__(self, mocker: MockerFixture, tmp_path: Path) -> None:
"""Test __init__."""
mocker.patch(f'{MODULE}.Path.cwd', return_value=tmp_path)
pyproject = tmp_path / 'pyproject.toml'
pyproject.write_text(SOME_TOML_DATA)
obj = PyprojectTomlConfigSettingsSource(SimpleSettings)
assert obj.toml_table_header == ('some', 'table')
assert obj.toml_data == {'field': 'some'}
assert obj.toml_file_path == tmp_path / 'pyproject.toml'
def test___init___explicit(self, mocker: MockerFixture, tmp_path: Path) -> None:
"""Test __init__ explicit file."""
mocker.patch(f'{MODULE}.Path.cwd', return_value=tmp_path)
pyproject = tmp_path / 'child' / 'pyproject.toml'
pyproject.parent.mkdir()
pyproject.write_text(SOME_TOML_DATA)
obj = PyprojectTomlConfigSettingsSource(SimpleSettings, pyproject)
assert obj.toml_table_header == ('some', 'table')
assert obj.toml_data == {'field': 'some'}
assert obj.toml_file_path == pyproject
def test___init___explicit_missing(self, mocker: MockerFixture, tmp_path: Path) -> None:
"""Test __init__ explicit file missing."""
mocker.patch(f'{MODULE}.Path.cwd', return_value=tmp_path)
pyproject = tmp_path / 'child' / 'pyproject.toml'
obj = PyprojectTomlConfigSettingsSource(SimpleSettings, pyproject)
assert obj.toml_table_header == ('some', 'table')
assert not obj.toml_data
assert obj.toml_file_path == pyproject
@pytest.mark.parametrize('depth', [0, 99])
def test___init___no_file(self, depth: int, mocker: MockerFixture, tmp_path: Path) -> None:
"""Test __init__ no file."""
class Settings(BaseSettings):
model_config = SettingsConfigDict(pyproject_toml_depth=depth)
mocker.patch(f'{MODULE}.Path.cwd', return_value=tmp_path / 'foo')
obj = PyprojectTomlConfigSettingsSource(Settings)
assert obj.toml_table_header == ('tool', 'pydantic-settings')
assert not obj.toml_data
assert obj.toml_file_path == tmp_path / 'foo' / 'pyproject.toml'
def test___init___parent(self, mocker: MockerFixture, tmp_path: Path) -> None:
"""Test __init__ parent directory."""
mocker.patch(f'{MODULE}.Path.cwd', return_value=tmp_path / 'child')
pyproject = tmp_path / 'pyproject.toml'
pyproject.write_text(SOME_TOML_DATA)
obj = PyprojectTomlConfigSettingsSource(SimpleSettings)
assert obj.toml_table_header == ('some', 'table')
assert obj.toml_data == {'field': 'some'}
assert obj.toml_file_path == tmp_path / 'pyproject.toml'
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
def test_pyproject_toml_file(cd_tmp_path: Path):
pyproject = cd_tmp_path / 'pyproject.toml'
pyproject.write_text(
"""
[tool.pydantic-settings]
foobar = "Hello"
[tool.pydantic-settings.nested]
nested_field = "world!"
"""
)
class Nested(BaseModel):
nested_field: str
class Settings(BaseSettings):
foobar: str
nested: Nested
model_config = SettingsConfigDict()
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls),)
s = Settings()
assert s.foobar == 'Hello'
assert s.nested.nested_field == 'world!'
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
def test_pyproject_toml_file_explicit(cd_tmp_path: Path):
pyproject = cd_tmp_path / 'child' / 'grandchild' / 'pyproject.toml'
pyproject.parent.mkdir(parents=True)
pyproject.write_text(
"""
[tool.pydantic-settings]
foobar = "Hello"
[tool.pydantic-settings.nested]
nested_field = "world!"
"""
)
(cd_tmp_path / 'pyproject.toml').write_text(
"""
[tool.pydantic-settings]
foobar = "fail"
[tool.pydantic-settings.nested]
nested_field = "fail"
"""
)
class Nested(BaseModel):
nested_field: str
class Settings(BaseSettings):
foobar: str
nested: Nested
model_config = SettingsConfigDict()
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls, pyproject),)
s = Settings()
assert s.foobar == 'Hello'
assert s.nested.nested_field == 'world!'
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
def test_pyproject_toml_file_parent(mocker: MockerFixture, tmp_path: Path):
cwd = tmp_path / 'child' / 'grandchild' / 'cwd'
cwd.mkdir(parents=True)
mocker.patch('pydantic_settings.sources.providers.toml.Path.cwd', return_value=cwd)
(cwd.parent.parent / 'pyproject.toml').write_text(
"""
[tool.pydantic-settings]
foobar = "Hello"
[tool.pydantic-settings.nested]
nested_field = "world!"
"""
)
(tmp_path / 'pyproject.toml').write_text(
"""
[tool.pydantic-settings]
foobar = "fail"
[tool.pydantic-settings.nested]
nested_field = "fail"
"""
)
class Nested(BaseModel):
nested_field: str
class Settings(BaseSettings):
foobar: str
nested: Nested
model_config = SettingsConfigDict(pyproject_toml_depth=2)
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls),)
s = Settings()
assert s.foobar == 'Hello'
assert s.nested.nested_field == 'world!'
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
def test_pyproject_toml_file_header(cd_tmp_path: Path):
pyproject = cd_tmp_path / 'subdir' / 'pyproject.toml'
pyproject.parent.mkdir()
pyproject.write_text(
"""
[tool.pydantic-settings]
foobar = "Hello"
[tool.pydantic-settings.nested]
nested_field = "world!"
[tool."my.tool".foo]
status = "success"
"""
)
class Settings(BaseSettings):
status: str
model_config = SettingsConfigDict(extra='forbid', pyproject_toml_table_header=('tool', 'my.tool', 'foo'))
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls, pyproject),)
s = Settings()
assert s.status == 'success'
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
@pytest.mark.parametrize('depth', [0, 99])
def test_pyproject_toml_no_file(cd_tmp_path: Path, depth: int):
class Settings(BaseSettings):
model_config = SettingsConfigDict(pyproject_toml_depth=depth)
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls),)
s = Settings()
assert s.model_dump() == {}
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
def test_pyproject_toml_no_file_explicit(tmp_path: Path):
pyproject = tmp_path / 'child' / 'pyproject.toml'
(tmp_path / 'pyproject.toml').write_text('[tool.pydantic-settings]\nfield = "fail"')
class Settings(BaseSettings):
model_config = SettingsConfigDict()
field: str | None = None
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls, pyproject),)
s = Settings()
assert s.model_dump() == {'field': None}
@pytest.mark.skipif(sys.version_info <= (3, 11) and tomli is None, reason='tomli/tomllib is not installed')
@pytest.mark.parametrize('depth', [0, 1, 2])
def test_pyproject_toml_no_file_too_shallow(depth: int, mocker: MockerFixture, tmp_path: Path):
cwd = tmp_path / 'child' / 'grandchild' / 'cwd'
cwd.mkdir(parents=True)
mocker.patch('pydantic_settings.sources.providers.toml.Path.cwd', return_value=cwd)
(tmp_path / 'pyproject.toml').write_text(
"""
[tool.pydantic-settings]
foobar = "fail"
[tool.pydantic-settings.nested]
nested_field = "fail"
"""
)
class Nested(BaseModel):
nested_field: str | None = None
class Settings(BaseSettings):
foobar: str | None = None
nested: Nested = Nested()
model_config = SettingsConfigDict(pyproject_toml_depth=depth)
@classmethod
def settings_customise_sources(
cls, settings_cls: type[BaseSettings], **_kwargs: PydanticBaseSettingsSource
) -> tuple[PydanticBaseSettingsSource, ...]:
return (PyprojectTomlConfigSettingsSource(settings_cls),)
s = Settings()
assert not s.foobar
assert not s.nested.nested_field
|
