GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Allow hybrid_property, hybrid_method and association_proxy on SQLModel classes by alvinttang · Pull Request #1990 · fastapi/sqlmodel

Conversation

@alvinttang

@alvinttang alvinttang commented May 31, 2026

Copy link
Copy Markdown

Summary

Defining a SQLModel class with a SQLAlchemy descriptor (hybrid_property, hybrid_method, or association_proxy) crashes at class-construction time with:

pydantic.errors.PydanticUserError: A non-annotated attribute was detected: `area = <sqlalchemy.ext.hybrid.hybrid_property object at 0x...>`. ... code='model-field-missing-annotation'

This is the long-standing #299 (20 reactions / 13 comments). The issue was mass-closed on 2026-05-18 alongside many other un-triaged bugs, but the bug is still present on main and community workarounds (subclass SQLModel and set model_config['ignored_types'] yourself) remain the only path. Reopening for review.

Root cause

Pydantic v2's inspect_namespace rejects every non-dunder, non-annotated attribute. hybrid_property / hybrid_method / association_proxy are SQLAlchemy descriptors users add without Python type annotations — that's the whole point of these descriptors. SQLModel never told Pydantic to treat them as ignored types via model_config['ignored_types'], so class construction crashes before SQLModel's metaclass even sees the column logic.

Fix

sqlmodel/main.py (+11 / -1):

  • Import AssociationProxy from sqlalchemy.ext.associationproxy and hybrid_method/hybrid_property from sqlalchemy.ext.hybrid.
  • Set SQLModel.model_config = SQLModelConfig(from_attributes=True, ignored_types=(hybrid_property, hybrid_method, AssociationProxy)).

Production diff is 10 net LOC.

This is intentionally disjoint and minimal: it stops the crash so users can define these descriptors on SQLModel classes. It does NOT implement DDL/expression generation for hybrid properties (a separate concern that PR #801 attempts in a much larger ~4400-line patch). Most users hitting #299 just want the descriptor to work at the Python level, which this PR enables.

Tests

tests/test_hybrid_property.py (new, 110 LOC, 4 tests):

  • test_table_model_allows_hybrid_property — table model + @hybrid_property ; instance returns the computed value.
  • test_table_model_allows_hybrid_method — table model + @hybrid_method.
  • test_table_model_allows_association_proxy — table model + association_proxy(...).
  • test_non_table_model_allows_hybrid_property — non-table model.

RED proof on main (4/4 fail):

pydantic.errors.PydanticUserError: A non-annotated attribute was detected: `area = <sqlalchemy.ext.hybrid.hybrid_property object ...>`

GREEN after patch: 4/4 pass; broader sweep pytest tests/ → 88 passed. ruff check / ruff format --check clean.

Risk notes

  • Behaviour change for non-table models that intentionally used hybrid_property as an unannotated raw attribute hoping Pydantic would treat it as a field: vanishingly unlikely, since hybrid_property is meaningless outside an ORM context.
  • No SQL-expression support added — leaves that scope to user code or to PR Support hybrid_property, column_property, declared_attr #801.
  • Test does not stress the SQL-expression code path of hybrids, only the Python-side descriptor / instance-attribute path that the issue actually reports.

Refs #299

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

sunkunxi reacted with heart emoji
All reactions
  • ❤️ 1 reaction
@xingtang-sketch @claude
🐛 Ignore SQLAlchemy descriptors in SQLModel metaclass to fix Pydantic…
c2bd7de
… v2 crash

Defining a `sqlalchemy.ext.hybrid.hybrid_property` (or `hybrid_method`,
`association_proxy`) directly on a `SQLModel` class body raises
`pydantic.errors.PydanticUserError: A non-annotated attribute was detected`
under Pydantic v2 because those SQLAlchemy descriptors carry no Pydantic
annotation.

Add them to `SQLModel.model_config["ignored_types"]` so Pydantic skips them
during model construction, while SQLAlchemy continues to expose them as
descriptors at runtime.  Python-side hybrid evaluation now works on table
models; emitting them as SQL expressions/columns is intentionally still left
to user code (the proposed broader feature in PR fastapi#801).

Refs fastapi#299

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@alvinttang

alvinttang commented May 31, 2026

Copy link
Copy Markdown
Author

Friendly bump: this PR has a required check-labels CI gate that needs a maintainer to apply the bug label (#299 is the underlying bug; tests are RED-on-main / GREEN-with-patch). Happy to address any review feedback in the meantime.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@svlandeg svlandeg added the bug Something isn't working label Jun 1, 2026
@sunkunxi

sunkunxi commented Sep 22, 2026

Copy link
Copy Markdown

That would be cool if we can use hyper_property.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

chiragjangiir

This comment was marked as spam.

Sign in to view

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@chiragjangiir chiragjangiir chiragjangiir left review comments
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

bug Something isn't working

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@alvinttang @sunkunxi @chiragjangiir @svlandeg @xingtang-sketch
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.