FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

✨ Add `alias_priority` parameter to `Field` by YuriiMotov · Pull Request #1727 · fastapi/sqlmodel · GitHub

  1. fastapi
  2. sqlmodel

Repository navigation

✨ Add alias_priority parameter to Field #1727

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

Open
YuriiMotov wants to merge 5 commits into
base: main
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 3 Commits 5 Checks 22 Files changed
Open

✨ Add alias_priority parameter to Field #1727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f37dcb9
Add `alias_priority` param to Field, add tests
YuriiMotov Jan 28, 2026
76c7dd1
🎨 Auto format
github-actions[bot] Jan 28, 2026
1ce12c6
Merge branch 'main' into add-alias_priority-param-to-field
YuriiMotov Feb 20, 2026
69f863b
Fix `Optional` in test
YuriiMotov Feb 20, 2026
d1370df
Merge branch 'main' into add-alias_priority-param-to-field
YuriiMotov Apr 3, 2026
File filter

Filter by extension

Filter by extension .py  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
15 changes: 15 additions & 0 deletions sqlmodel/main.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import builtins
import ipaddress
import uuid
import warnings
from collections.abc import Callable, Mapping, Sequence, Set
from dataclasses import dataclass
from datetime import date, datetime, time, timedelta
Expand Down Expand Up @@ -239,6 +240,7 @@ def Field(
*,
default_factory: NoArgAnyCallable | None = None,
alias: str | None = None,
alias_priority: int | None = None,
validation_alias: str | None = None,
serialization_alias: str | None = None,
title: str | None = None,
Expand Down Expand Up @@ -282,6 +284,7 @@ def Field(
*,
default_factory: NoArgAnyCallable | None = None,
alias: str | None = None,
alias_priority: int | None = None,
validation_alias: str | None = None,
serialization_alias: str | None = None,
title: str | None = None,
Expand Down Expand Up @@ -334,6 +337,7 @@ def Field(
*,
default_factory: NoArgAnyCallable | None = None,
alias: str | None = None,
alias_priority: int | None = None,
validation_alias: str | None = None,
serialization_alias: str | None = None,
title: str | None = None,
Expand Down Expand Up @@ -367,6 +371,7 @@ def Field(
*,
default_factory: NoArgAnyCallable | None = None,
alias: str | None = None,
alias_priority: int | None = None,
validation_alias: str | None = None,
serialization_alias: str | None = None,
title: str | None = None,
Expand Down Expand Up @@ -403,11 +408,21 @@ def Field(
schema_extra: dict[str, Any] | None = None,
) -> Any:
current_schema_extra = schema_extra or {}

for param_name in ("alias_priority",):
if param_name in current_schema_extra:
msg = f"Pass `{param_name}` parameter directly to Field instead of passing it via `schema_extra`"
warnings.warn(msg, DeprecationWarning, stacklevel=2)

# Extract possible alias settings from schema_extra so we can control precedence
schema_validation_alias = current_schema_extra.pop("validation_alias", None)
schema_serialization_alias = current_schema_extra.pop("serialization_alias", None)
current_alias_priority = alias_priority or current_schema_extra.pop(
"alias_priority", None
)
field_info_kwargs = {
"alias": alias,
"alias_priority": current_alias_priority,
"title": title,
"description": description,
"exclude": exclude,
Expand Down
56 changes: 55 additions & 1 deletion tests/test_pydantic/test_field.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from typing import Literal

import pytest
from pydantic import ValidationError
from pydantic import ConfigDict, ValidationError
from sqlmodel import Field, SQLModel


Expand Down Expand Up @@ -54,3 +54,57 @@ class Model(SQLModel):

instance = Model(id=123, foo="bar")
assert "foo=" not in repr(instance)


def test_alias_priority_1():
def to_camel(string: str) -> str:
return "".join(word.capitalize() for word in string.split("_"))

class Model(SQLModel):
model_config = ConfigDict(alias_generator=to_camel)

field: str = Field(alias="field_alias", alias_priority=1)

m = Model.model_validate({"Field": "value1"})
assert m.field == "value1"

with pytest.raises(ValidationError):
Model.model_validate({"field_alias": "value1"})


@pytest.mark.parametrize("alias_priority", [None, 2])
def test_alias_priority_2(alias_priority: int | None):
def to_camel(string: str) -> str:
return "".join(word.capitalize() for word in string.split("_"))

class Model(SQLModel):
model_config = ConfigDict(alias_generator=to_camel)

field: str = Field(alias="field_alias", alias_priority=alias_priority)

m = Model.model_validate({"field_alias": "value1"})
assert m.field == "value1"

with pytest.raises(ValidationError):
Model.model_validate({"Field": "value1"})


def test_alias_priority_via_schema_extra(): # Current workaround. Remove after some time
def to_camel(string: str) -> str:
return "".join(word.capitalize() for word in string.split("_"))

with pytest.warns(
DeprecationWarning,
match="Pass `alias_priority` parameter directly to Field instead of passing it via `schema_extra`",
):

class Model(SQLModel):
model_config = ConfigDict(alias_generator=to_camel)

field: str = Field(alias="field_alias", schema_extra={"alias_priority": 2})

m = Model.model_validate({"field_alias": "value1"})
assert m.field == "value1"

with pytest.raises(ValidationError):
Model.model_validate({"Field": "value1"})
Loading
Back | FazBrowse Home | New Git URL