pFad - Phone/Frame/Anonymizer/Declutterfier! Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

URL: http://github.com/fastapi/sqlmodel/pull/1727/files

https://github.githubassets.com/assets/primer-primitives-10bf9dd67e3d70bd.css" /> ✨ Add `alias_priority` parameter to `Field` by YuriiMotov · Pull Request #1727 · fastapi/sqlmodel · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions sqlmodel/main.py
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
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
pFad - Phonifier reborn

Pfad - The Proxy pFad © 2024 Your Company Name. All rights reserved.





Check this box to remove all script contents from the fetched content.



Check this box to remove all images from the fetched content.


Check this box to remove all CSS styles from the fetched content.


Check this box to keep images inefficiently compressed and original size.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy