Skip to content

Relax default protected_namespaces #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Relax default protected_namespaces #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e32d23
Relax default protected_namespaces
hramezani Nov 26, 2024
738641c
Merge branch 'main' into issue-482
hramezani Dec 2, 2024
4d1bfd7
Merge branch 'main' into issue-482
hramezani Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pydantic_settings/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ def _settings_build_values(
yaml_file_encoding=None,
toml_file=None,
secrets_dir=None,
protected_namespaces=('model_', 'settings_'),
protected_namespaces=('model_validate', 'model_dump', 'settings_customise_sources'),
)


Expand Down
12 changes: 7 additions & 5 deletions tests/test_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2202,26 +2202,28 @@ class Settings(BaseSettings):
def test_protected_namespace_defaults():
# pydantic default
with pytest.warns(
UserWarning, match='Field "model_prefixed_field" in Model has conflict with protected namespace "model_"'
UserWarning,
match='Field "model_dump_prefixed_field" in Model has conflict with protected namespace "model_dump"',
):

class Model(BaseSettings):
model_prefixed_field: str
model_dump_prefixed_field: str

# pydantic-settings default
with pytest.warns(
UserWarning, match='Field "settings_prefixed_field" in Model1 has conflict with protected namespace "settings_"'
UserWarning,
match='Field "settings_customise_sources_prefixed_field" in Model1 has conflict with protected namespace "settings_customise_sources"',
):

class Model1(BaseSettings):
settings_prefixed_field: str
settings_customise_sources_prefixed_field: str

with pytest.raises(
NameError,
match=(
'Field "settings_customise_sources" conflicts with member <bound method '
"BaseSettings.settings_customise_sources of <class 'pydantic_settings.main.BaseSettings'>> "
'of protected namespace "settings_".'
'of protected namespace "settings_customise_sources".'
),
):

Expand Down
Loading