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
3 changes: 3 additions & 0 deletions .github/workflows/cicd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ jobs:
- name: Run tests
run: uv run --locked --python "${{ matrix.python-version }}" pytest liminal/

- name: Run tests on SQLAlchemy 2.0
run: uv run --locked --python "${{ matrix.python-version }}" --with "sqlalchemy>=2.0,<2.1" pytest liminal/

- name: Download wheel
uses: actions/download-artifact@v8
with:
Expand Down
12 changes: 10 additions & 2 deletions liminal/orm/base.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from sqlalchemy import MetaData
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import declarative_base

# This is necessary for SQLAlchemy, all DBmodels inherit from Base, either directly or indirectly.
# apply a naming convention to the metadata instance (for use in alembic revisions)
Expand All @@ -12,5 +12,13 @@
"pk": "pk_%(table_name)s",
}


class _BaseMixin:
# Liminal models annotate columns as `name: SqlColumn = Column(...)`, including generated
# model files. SQLAlchemy 2.0 rejects non-`Mapped[]` annotations on mapped attributes unless
# this flag is set; SQLAlchemy 1.4 ignores it. Keeps existing user models working on both.
__allow_unmapped__ = True


meta = MetaData(naming_convention=convention)
Base = declarative_base(metadata=meta)
Base = declarative_base(metadata=meta, cls=_BaseMixin)
6 changes: 3 additions & 3 deletions liminal/orm/base_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import pandas as pd # type: ignore
from sqlalchemy import DATETIME, Boolean, ForeignKey, String
from sqlalchemy import Column as SqlColumn
from sqlalchemy.orm import Query, RelationshipProperty, Session, relationship
from sqlalchemy.orm import Mapped, Query, Session, relationship
from sqlalchemy.orm.decl_api import declared_attr

from liminal.base.base_dropdown import BaseDropdown
Expand Down Expand Up @@ -156,13 +156,13 @@ def __init_subclass__(cls, **kwargs: Any):
cls._existing_schema_prefixes.append(cls.__schema_properties__.prefix.lower())

@declared_attr
def creator_id(cls) -> SqlColumn:
def creator_id(cls) -> Mapped[str | None]:
return SqlColumn(
"creator_id$", String, ForeignKey("user$raw.id"), nullable=True
)

@declared_attr
def creator(cls) -> RelationshipProperty:
def creator(cls) -> Mapped[Any]:
return relationship("User", foreign_keys=[cls.creator_id])

id = SqlColumn("id", String, nullable=True, primary_key=True)
Expand Down
6 changes: 3 additions & 3 deletions liminal/orm/base_results_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import pandas as pd # type: ignore
from sqlalchemy import DATETIME, Boolean, ForeignKey, String
from sqlalchemy import Column as SqlColumn
from sqlalchemy.orm import Query, RelationshipProperty, Session, relationship
from sqlalchemy.orm import Mapped, Query, Session, relationship
from sqlalchemy.orm.decl_api import declared_attr

from liminal.base.base_validation_filters import BaseValidatorFilters
Expand All @@ -31,13 +31,13 @@ class BaseResultsModel(Generic[T], Base):
__schema_properties__: ResultsSchemaProperties

@declared_attr
def creator_id(cls) -> SqlColumn:
def creator_id(cls) -> Mapped[str | None]:
return SqlColumn(
"creator_id$", String, ForeignKey("user$raw.id"), nullable=True
)

@declared_attr
def creator(cls) -> RelationshipProperty:
def creator(cls) -> Mapped[Any]:
return relationship("User", foreign_keys=[cls.creator_id])

id = SqlColumn("id", String, nullable=True, primary_key=True)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ dependencies = [
"pandas>=2.2.3,<4; python_version == '3.13'",
"pydantic>=2,<=2.13",
"rich>=13.9.2,<14",
"sqlalchemy>=1.4.53,<2",
"sqlalchemy>=1.4.53,<2.1",
"tenacity>=8,<10",
"typer>=0.12.5,<0.13",
"psycopg2-binary>=2.9.10,<3",
Expand Down
4 changes: 2 additions & 2 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.