from sqlalchemy import Boolean
from sqlalchemy import case
from sqlalchemy import column
from sqlalchemy import event
from sqlalchemy import exc as sa_exc
from sqlalchemy import ForeignKey
from sqlalchemy import ForeignKeyConstraint
from sqlalchemy import func
from sqlalchemy import inspect
from sqlalchemy import Integer
from sqlalchemy import MetaData
from sqlalchemy import select
from sqlalchemy import String
from sqlalchemy import table
from sqlalchemy import testing
from sqlalchemy import util
from sqlalchemy.orm import attributes
from sqlalchemy.orm import class_mapper
from sqlalchemy.orm import clear_mappers
from sqlalchemy.orm import column_property
from sqlalchemy.orm import composite
from sqlalchemy.orm import declarative_base
from sqlalchemy.orm import deferred
from sqlalchemy.orm import exc as orm_exc
from sqlalchemy.orm import joinedload
from sqlalchemy.orm import Mapped
from sqlalchemy.orm import mapped_column
from sqlalchemy.orm import object_mapper
from sqlalchemy.orm import polymorphic_union
from sqlalchemy.orm import relationship
from sqlalchemy.orm import Session
from sqlalchemy.orm import synonym
from sqlalchemy.orm.util import instance_str
from sqlalchemy.sql.selectable import LABEL_STYLE_TABLENAME_PLUS_COL
from sqlalchemy.testing import assert_raises
from sqlalchemy.testing import assert_raises_message
from sqlalchemy.testing import eq_
from sqlalchemy.testing import expect_raises_message
from sqlalchemy.testing import expect_warnings
from sqlalchemy.testing import fixtures
from sqlalchemy.testing import is_
from sqlalchemy.testing import mock
from sqlalchemy.testing.assertions import assert_warns_message
from sqlalchemy.testing.assertsql import AllOf
from sqlalchemy.testing.assertsql import CompiledSQL
from sqlalchemy.testing.assertsql import Conditional
from sqlalchemy.testing.assertsql import Or
from sqlalchemy.testing.assertsql import RegexSQL
from sqlalchemy.testing.entities import BasicEntity
from sqlalchemy.testing.entities import ComparableEntity
from sqlalchemy.testing.fixtures import fixture_session
from sqlalchemy.testing.schema import Column
from sqlalchemy.testing.schema import Table
class O2MTest(fixtures.MappedTest):
"""deals with inheritance and one-to-many relationships"""
@classmethod
def define_tables(cls, metadata):
global foo, bar, blub
foo = Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", String(20)),
)
bar = Table(
"bar",
metadata,
Column("id", Integer, ForeignKey("foo.id"), primary_key=True),
Column("bar_data", String(20)),
)
blub = Table(
"blub",
metadata,
Column("id", Integer, ForeignKey("bar.id"), primary_key=True),
Column("foo_id", Integer, ForeignKey("foo.id"), nullable=False),
Column("blub_data", String(20)),
)
def test_basic(self):
class Foo:
def __init__(self, data=None):
self.data = data
def __repr__(self):
return "Foo id %d, data %s" % (self.id, self.data)
self.mapper_registry.map_imperatively(Foo, foo)
class Bar(Foo):
def __repr__(self):
return "Bar id %d, data %s" % (self.id, self.data)
self.mapper_registry.map_imperatively(Bar, bar, inherits=Foo)
class Blub(Bar):
def __repr__(self):
return "Blub id %d, data %s" % (self.id, self.data)
self.mapper_registry.map_imperatively(
Blub,
blub,
inherits=Bar,
properties={"parent_foo": relationship(Foo)},
)
sess = fixture_session()
b1 = Blub("blub #1")
b2 = Blub("blub #2")
f = Foo("foo #1")
sess.add(b1)
sess.add(b2)
sess.add(f)
b1.parent_foo = f
b2.parent_foo = f
sess.flush()
compare = ",".join(
[repr(b1), repr(b2), repr(b1.parent_foo), repr(b2.parent_foo)]
)
sess.expunge_all()
result = sess.query(Blub).all()
result_str = ",".join(
[
repr(result[0]),
repr(result[1]),
repr(result[0].parent_foo),
repr(result[1].parent_foo),
]
)
eq_(compare, result_str)
eq_(result[0].parent_foo.data, "foo #1")
eq_(result[1].parent_foo.data, "foo #1")
class ColExpressionsTest(fixtures.DeclarativeMappedTest):
__backend__ = True
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(Base):
__tablename__ = "a"
id = Column(
Integer, primary_key=True, test_needs_autoincrement=True
)
type = Column(String(10))
__mapper_args__ = {
"polymorphic_on": type,
"polymorphic_identity": "a",
}
class B(A):
__tablename__ = "b"
id = Column(ForeignKey("a.id"), primary_key=True)
data = Column(Integer)
__mapper_args__ = {"polymorphic_identity": "b"}
@classmethod
def insert_data(cls, connection):
A, B = cls.classes("A", "B")
s = Session(connection)
s.add_all([B(data=5), B(data=7)])
s.commit()
def test_group_by(self):
B = self.classes.B
s = fixture_session()
rows = (
s.query(B.id.expressions[0], B.id.expressions[1], func.sum(B.data))
.group_by(*B.id.expressions)
.order_by(B.id.expressions[0])
.all()
)
eq_(rows, [(1, 1, 5), (2, 2, 7)])
class PolyExpressionEagerLoad(fixtures.DeclarativeMappedTest):
run_setup_mappers = "once"
__dialect__ = "default"
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(ComparableEntity, Base):
__tablename__ = "a"
id = Column(
Integer, primary_key=True, test_needs_autoincrement=True
)
discriminator = Column(String(50), nullable=False)
child_id = Column(Integer, ForeignKey("a.id"))
child = relationship("A")
__mapper_args__ = {
"polymorphic_identity": "a",
"polymorphic_on": case((discriminator == "a", "a"), else_="b"),
}
class B(A):
__mapper_args__ = {"polymorphic_identity": "b"}
@classmethod
def insert_data(cls, connection):
A = cls.classes.A
session = Session(connection)
session.add_all(
[
A(id=1, discriminator="a"),
A(id=2, discriminator="b", child_id=1),
A(id=3, discriminator="c", child_id=1),
]
)
session.commit()
def test_joinedload(self):
A = self.classes.A
B = self.classes.B
session = fixture_session()
result = (
session.query(A)
.filter_by(child_id=None)
.options(joinedload(A.child))
.one()
)
eq_(result, A(id=1, discriminator="a", child=[B(id=2), B(id=3)]))
class PolymorphicResolutionMultiLevel(
fixtures.DeclarativeMappedTest, testing.AssertsCompiledSQL
):
run_setup_mappers = "once"
__dialect__ = "default"
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(Base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
class B(A):
__tablename__ = "b"
id = Column(Integer, ForeignKey("a.id"), primary_key=True)
class C(A):
__tablename__ = "c"
id = Column(Integer, ForeignKey("a.id"), primary_key=True)
class D(B):
__tablename__ = "d"
id = Column(Integer, ForeignKey("b.id"), primary_key=True)
def test_ordered_b_d(self):
a_mapper = inspect(self.classes.A)
eq_(
a_mapper._mappers_from_spec(
[self.classes.B, self.classes.D], None
),
[a_mapper, inspect(self.classes.B), inspect(self.classes.D)],
)
def test_a(self):
a_mapper = inspect(self.classes.A)
eq_(a_mapper._mappers_from_spec([self.classes.A], None), [a_mapper])
def test_b_d_selectable(self):
a_mapper = inspect(self.classes.A)
spec = [self.classes.D, self.classes.B]
eq_(
a_mapper._mappers_from_spec(
spec, self.classes.B.__table__.join(self.classes.D.__table__)
),
[inspect(self.classes.B), inspect(self.classes.D)],
)
def test_d_selectable(self):
a_mapper = inspect(self.classes.A)
spec = [self.classes.D]
eq_(
a_mapper._mappers_from_spec(
spec, self.classes.B.__table__.join(self.classes.D.__table__)
),
[inspect(self.classes.D)],
)
def test_reverse_d_b(self):
a_mapper = inspect(self.classes.A)
spec = [self.classes.D, self.classes.B]
eq_(
a_mapper._mappers_from_spec(spec, None),
[a_mapper, inspect(self.classes.B), inspect(self.classes.D)],
)
mappers, selectable = a_mapper._with_polymorphic_args(spec=spec)
self.assert_compile(
selectable,
"a LEFT OUTER JOIN b ON a.id = b.id "
"LEFT OUTER JOIN d ON b.id = d.id",
)
def test_d_b_missing(self):
a_mapper = inspect(self.classes.A)
spec = [self.classes.D]
eq_(
a_mapper._mappers_from_spec(spec, None),
[a_mapper, inspect(self.classes.B), inspect(self.classes.D)],
)
mappers, selectable = a_mapper._with_polymorphic_args(spec=spec)
self.assert_compile(
selectable,
"a LEFT OUTER JOIN b ON a.id = b.id "
"LEFT OUTER JOIN d ON b.id = d.id",
)
def test_d_c_b(self):
a_mapper = inspect(self.classes.A)
spec = [self.classes.D, self.classes.C, self.classes.B]
ms = a_mapper._mappers_from_spec(spec, None)
eq_(ms[-1], inspect(self.classes.D))
eq_(ms[0], a_mapper)
eq_(set(ms[1:3]), set(a_mapper._inheriting_mappers))
class PolymorphicOnNotLocalTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"t1",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("x", String(10)),
Column("q", String(10)),
)
Table(
"t2",
metadata,
Column(
"t2id",
Integer,
primary_key=True,
test_needs_autoincrement=True,
),
Column("y", String(10)),
Column("xid", ForeignKey("t1.id")),
)
@classmethod
def setup_classes(cls):
class Parent(cls.Comparable):
pass
class Child(Parent):
pass
def test_non_col_polymorphic_on(self):
Parent = self.classes.Parent
t2 = self.tables.t2
assert_raises_message(
sa_exc.ArgumentError,
"Can't determine polymorphic_on "
"value 'im not a column' - no "
"attribute is mapped to this name.",
self.mapper_registry.map_imperatively,
Parent,
t2,
polymorphic_on="im not a column",
)
def test_polymorphic_on_non_expr_prop(self):
t2 = self.tables.t2
Parent = self.classes.Parent
assert_raises_message(
sa_exc.ArgumentError,
r"Column expression or string key expected for argument "
r"'polymorphic_on'; got .*function",
self.mapper,
Parent,
t2,
polymorphic_on=lambda: "hi",
polymorphic_identity=0,
)
def test_polymorphic_on_not_present_col_partial_wpoly(self):
"""fix for partial with_polymorphic().
found_during_type_annotation
"""
t2, t1 = self.tables.t2, self.tables.t1
Parent = self.classes.Parent
t1t2_join = select(t1.c.x).select_from(t1.join(t2)).alias()
def go():
t1t2_join_2 = (
select(t1.c.q).select_from(t1.join(t2)).alias()
)
self.mapper_registry.map_imperatively(
Parent,
t2,
polymorphic_on=t1t2_join.c.x,
with_polymorphic=("*", None),
polymorphic_identity=0,
)
assert_raises_message(
sa_exc.InvalidRequestError,
"Could not map polymorphic_on column 'x' to the mapped table - "
"polymorphic loads will not function properly",
go,
)
def test_polymorphic_on_not_present_col(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent = self.classes.Parent
t1t2_join = select(t1.c.x).select_from(t1.join(t2)).alias()
def go():
t1t2_join_2 = select(t1.c.q).select_from(t1.join(t2)).alias()
self.mapper_registry.map_imperatively(
Parent,
t2,
polymorphic_on=t1t2_join.c.x,
with_polymorphic=("*", t1t2_join_2),
polymorphic_identity=0,
)
assert_raises_message(
sa_exc.InvalidRequestError,
"Could not map polymorphic_on column 'x' to the mapped table - "
"polymorphic loads will not function properly",
go,
)
def test_polymorphic_on_only_in_with_poly(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent = self.classes.Parent
t1t2_join = select(t1.c.x).select_from(t1.join(t2)).alias()
self.mapper_registry.map_imperatively(
Parent,
t2,
polymorphic_on=t1t2_join.c.x,
with_polymorphic=("*", t1t2_join),
polymorphic_identity=0,
)
def test_polymorphic_on_not_in_with_poly(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent = self.classes.Parent
t1t2_join = select(t1.c.x).select_from(t1.join(t2)).alias()
def go():
t1t2_join_2 = select(t1.c.q).select_from(t1.join(t2)).alias()
self.mapper_registry.map_imperatively(
Parent,
t2,
polymorphic_on=t1t2_join.c.x,
with_polymorphic=("*", t1t2_join_2),
polymorphic_identity=0,
)
assert_raises_message(
sa_exc.InvalidRequestError,
"Could not map polymorphic_on column 'x' "
"to the mapped table - "
"polymorphic loads will not function properly",
go,
)
def test_polymorphic_on_expr_explicit_map(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child"))
self.mapper_registry.map_imperatively(
Parent,
t1,
properties={"discriminator": column_property(expr)},
polymorphic_identity="parent",
polymorphic_on=expr,
)
self.mapper_registry.map_imperatively(
Child, t2, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_expr_implicit_map_no_label_joined(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child"))
self.mapper_registry.map_imperatively(
Parent, t1, polymorphic_identity="parent", polymorphic_on=expr
)
self.mapper_registry.map_imperatively(
Child, t2, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_expr_implicit_map_w_label_joined(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child")).label(
None
)
self.mapper_registry.map_imperatively(
Parent, t1, polymorphic_identity="parent", polymorphic_on=expr
)
self.mapper_registry.map_imperatively(
Child, t2, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_expr_implicit_map_no_label_single(self):
"""test that single_table_criterion is propagated
with a standalone expr"""
t1 = self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child"))
self.mapper_registry.map_imperatively(
Parent, t1, polymorphic_identity="parent", polymorphic_on=expr
)
self.mapper_registry.map_imperatively(
Child, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_expr_implicit_map_w_label_single(self):
"""test that single_table_criterion is propagated
with a standalone expr"""
t1 = self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child")).label(
None
)
self.mapper_registry.map_imperatively(
Parent, t1, polymorphic_identity="parent", polymorphic_on=expr
)
self.mapper_registry.map_imperatively(
Child, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_column_prop(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child"))
cprop = column_property(expr)
self.mapper_registry.map_imperatively(
Parent,
t1,
properties={"discriminator": cprop},
polymorphic_identity="parent",
polymorphic_on=cprop,
)
self.mapper_registry.map_imperatively(
Child, t2, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_column_str_prop(self):
t2, t1 = self.tables.t2, self.tables.t1
Parent, Child = self.classes.Parent, self.classes.Child
expr = case((t1.c.x == "p", "parent"), (t1.c.x == "c", "child"))
cprop = column_property(expr)
self.mapper_registry.map_imperatively(
Parent,
t1,
properties={"discriminator": cprop},
polymorphic_identity="parent",
polymorphic_on="discriminator",
)
self.mapper_registry.map_imperatively(
Child, t2, inherits=Parent, polymorphic_identity="child"
)
self._roundtrip(parent_ident="p", child_ident="c")
def test_polymorphic_on_synonym(self):
t1 = self.tables.t1
Parent = self.classes.Parent
cprop = column_property(t1.c.x)
assert_raises_message(
sa_exc.ArgumentError,
"Only direct column-mapped property or "
"SQL expression can be passed for polymorphic_on",
self.mapper_registry.map_imperatively,
Parent,
t1,
properties={"discriminator": cprop, "discrim_syn": synonym(cprop)},
polymorphic_identity="parent",
polymorphic_on="discrim_syn",
)
def _roundtrip(
self, set_event=True, parent_ident="parent", child_ident="child"
):
Parent, Child = self.classes.Parent, self.classes.Child
parent_mapper = inspect(Parent)
for prop in parent_mapper.column_attrs:
if not prop.instrument:
break
else:
prop = parent_mapper._columntoproperty[
parent_mapper.polymorphic_on
]
is_(parent_mapper.polymorphic_on, prop.columns[0])
if set_event:
@event.listens_for(Parent, "init", propagate=True)
def set_identity(instance, *arg, **kw):
ident = object_mapper(instance).polymorphic_identity
if ident == "parent":
instance.x = parent_ident
elif ident == "child":
instance.x = child_ident
else:
assert False, "Got unexpected identity %r" % ident
s = fixture_session()
s.add_all([Parent(q="p1"), Child(q="c1", y="c1"), Parent(q="p2")])
s.commit()
s.close()
eq_(
[type(t) for t in s.query(Parent).order_by(Parent.id)],
[Parent, Child, Parent],
)
eq_([type(t) for t in s.query(Child).all()], [Child])
class SortOnlyOnImportantFKsTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"a",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column(
"b_id",
Integer,
ForeignKey("b.id", use_alter=True, name="b_fk"),
),
)
Table(
"b",
metadata,
Column("id", Integer, ForeignKey("a.id"), primary_key=True),
)
@classmethod
def setup_classes(cls):
Base = declarative_base()
class A(Base):
__tablename__ = "a"
id = Column(
Integer, primary_key=True, test_needs_autoincrement=True
)
b_id = Column(Integer, ForeignKey("b.id"))
class B(A):
__tablename__ = "b"
id = Column(Integer, ForeignKey("a.id"), primary_key=True)
__mapper_args__ = {"inherit_condition": id == A.id}
cls.classes.A = A
cls.classes.B = B
def test_flush(self):
s = fixture_session()
s.add(self.classes.B())
s.flush()
class FalseDiscriminatorTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
global t1
t1 = Table(
"t1",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", Boolean, nullable=False),
)
def test_false_on_sub(self):
class Foo:
pass
class Bar(Foo):
pass
self.mapper_registry.map_imperatively(
Foo, t1, polymorphic_on=t1.c.type, polymorphic_identity=True
)
self.mapper_registry.map_imperatively(
Bar, inherits=Foo, polymorphic_identity=False
)
sess = fixture_session()
b1 = Bar()
sess.add(b1)
sess.flush()
assert b1.type is False
sess.expunge_all()
assert isinstance(sess.query(Foo).one(), Bar)
def test_false_on_base(self):
class Ding:
pass
class Bat(Ding):
pass
self.mapper_registry.map_imperatively(
Ding, t1, polymorphic_on=t1.c.type, polymorphic_identity=False
)
self.mapper_registry.map_imperatively(
Bat, inherits=Ding, polymorphic_identity=True
)
sess = fixture_session()
d1 = Ding()
sess.add(d1)
sess.flush()
assert d1.type is False
sess.expunge_all()
assert sess.query(Ding).one() is not None
class PolymorphicSynonymTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
global t1, t2
t1 = Table(
"t1",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(10), nullable=False),
Column("info", String(255)),
)
t2 = Table(
"t2",
metadata,
Column("id", Integer, ForeignKey("t1.id"), primary_key=True),
Column("data", String(10), nullable=False),
)
def test_polymorphic_synonym(self):
class T1(ComparableEntity):
def info(self):
return "THE INFO IS:" + self._info
def _set_info(self, x):
self._info = x
info = property(info, _set_info)
class T2(T1):
pass
self.mapper_registry.map_imperatively(
T1,
t1,
polymorphic_on=t1.c.type,
polymorphic_identity="t1",
properties={"info": synonym("_info", map_column=True)},
)
self.mapper_registry.map_imperatively(
T2, t2, inherits=T1, polymorphic_identity="t2"
)
sess = fixture_session()
at1 = T1(info="at1")
at2 = T2(info="at2", data="t2 data")
sess.add(at1)
sess.add(at2)
sess.flush()
sess.expunge_all()
eq_(sess.query(T2).filter(T2.info == "at2").one(), at2)
eq_(at2.info, "THE INFO IS:at2")
class PolymorphicAttributeManagementTest(fixtures.MappedTest):
"""Test polymorphic_on can be assigned, can be mirrored, etc."""
run_setup_mappers = "once"
@classmethod
def define_tables(cls, metadata):
Table(
"table_a",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("class_name", String(50)),
)
Table(
"table_b",
metadata,
Column("id", Integer, ForeignKey("table_a.id"), primary_key=True),
Column("class_name", String(50)),
)
Table(
"table_c",
metadata,
Column("id", Integer, ForeignKey("table_b.id"), primary_key=True),
Column("data", String(10)),
)
@classmethod
def setup_classes(cls):
class A(cls.Basic):
pass
class B(A):
pass
class C(B):
pass
class D(B):
pass
@classmethod
def setup_mappers(cls):
A, B, C, D = cls.classes("A", "B", "C", "D")
table_b, table_c, table_a = (
cls.tables.table_b,
cls.tables.table_c,
cls.tables.table_a,
)
cls.mapper_registry.map_imperatively(
A,
table_a,
polymorphic_on=table_a.c.class_name,
polymorphic_identity="a",
)
cls.mapper_registry.map_imperatively(
B,
table_b,
inherits=A,
polymorphic_on=table_b.c.class_name,
polymorphic_identity="b",
properties=dict(
class_name=[table_a.c.class_name, table_b.c.class_name]
),
)
cls.mapper_registry.map_imperatively(
C, table_c, inherits=B, polymorphic_identity="c"
)
cls.mapper_registry.map_imperatively(
D, inherits=B, polymorphic_identity="d"
)
def test_poly_configured_immediate(self):
A, C, B = (self.classes.A, self.classes.C, self.classes.B)
a = A()
b = B()
c = C()
eq_(a.class_name, "a")
eq_(b.class_name, "b")
eq_(c.class_name, "c")
def test_base_class(self):
A, C, B = (self.classes.A, self.classes.C, self.classes.B)
sess = fixture_session()
c1 = C()
sess.add(c1)
sess.commit()
assert isinstance(sess.query(B).first(), C)
sess.close()
assert isinstance(sess.query(A).first(), C)
def test_valid_assignment_upwards(self):
"""test that we can assign 'd' to a B, since B/D
both involve the same set of tables.
"""
D, B = self.classes.D, self.classes.B
sess = fixture_session()
b1 = B()
b1.class_name = "d"
sess.add(b1)
sess.commit()
sess.close()
assert isinstance(sess.query(B).first(), D)
def test_invalid_assignment_downwards(self):
"""test that we warn on assign of 'b' to a C, since this adds
a row to the C table we'd never load.
"""
C = self.classes.C
sess = fixture_session()
c1 = C()
c1.class_name = "b"
sess.add(c1)
assert_warns_message(
sa_exc.SAWarning,
"Flushing object %s with incompatible "
"polymorphic identity 'b'; the object may not "
"refresh and/or load correctly" % instance_str(c1),
sess.flush,
)
def test_invalid_assignment_upwards(self):
"""test that we warn on assign of 'c' to a B, since we will have a
"C" row that has no joined row, which will cause object
deleted errors.
"""
B = self.classes.B
sess = fixture_session()
b1 = B()
b1.class_name = "c"
sess.add(b1)
assert_warns_message(
sa_exc.SAWarning,
"Flushing object %s with incompatible "
"polymorphic identity 'c'; the object may not "
"refresh and/or load correctly" % instance_str(b1),
sess.flush,
)
def test_entirely_oob_assignment(self):
"""test warn on an unknown polymorphic identity."""
B = self.classes.B
sess = fixture_session()
b1 = B()
b1.class_name = "xyz"
sess.add(b1)
assert_warns_message(
sa_exc.SAWarning,
"Flushing object %s with incompatible "
"polymorphic identity 'xyz'; the object may not "
"refresh and/or load correctly" % instance_str(b1),
sess.flush,
)
def test_not_set_on_upate(self):
C = self.classes.C
sess = fixture_session()
c1 = C()
sess.add(c1)
sess.commit()
sess.expire(c1)
c1.data = "foo"
sess.flush()
def test_validate_on_upate(self):
C = self.classes.C
sess = fixture_session()
c1 = C()
sess.add(c1)
sess.commit()
sess.expire(c1)
c1.class_name = "b"
assert_warns_message(
sa_exc.SAWarning,
"Flushing object %s with incompatible "
"polymorphic identity 'b'; the object may not "
"refresh and/or load correctly" % instance_str(c1),
sess.flush,
)
class CascadeTest(fixtures.MappedTest):
"""that cascades on polymorphic relationships continue
cascading along the path of the instance's mapper, not
the base mapper."""
@classmethod
def define_tables(cls, metadata):
global t1, t2, t3, t4
t1 = Table(
"t1",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", String(30)),
)
t2 = Table(
"t2",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("t1id", Integer, ForeignKey("t1.id")),
Column("type", String(30)),
Column("data", String(30)),
)
t3 = Table(
"t3",
metadata,
Column("id", Integer, ForeignKey("t2.id"), primary_key=True),
Column("moredata", String(30)),
)
t4 = Table(
"t4",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("t3id", Integer, ForeignKey("t3.id")),
Column("data", String(30)),
)
def test_cascade(self):
class T1(BasicEntity):
pass
class T2(BasicEntity):
pass
class T3(T2):
pass
class T4(BasicEntity):
pass
self.mapper_registry.map_imperatively(
T1, t1, properties={"t2s": relationship(T2, cascade="all")}
)
self.mapper_registry.map_imperatively(
T2, t2, polymorphic_on=t2.c.type, polymorphic_identity="t2"
)
self.mapper_registry.map_imperatively(
T3,
t3,
inherits=T2,
polymorphic_identity="t3",
properties={"t4s": relationship(T4, cascade="all")},
)
self.mapper_registry.map_imperatively(T4, t4)
sess = fixture_session()
t1_1 = T1(data="t1")
t3_1 = T3(data="t3", moredata="t3")
t2_1 = T2(data="t2")
t1_1.t2s.append(t2_1)
t1_1.t2s.append(t3_1)
t4_1 = T4(data="t4")
t3_1.t4s.append(t4_1)
sess.add(t1_1)
assert t4_1 in sess.new
sess.flush()
sess.delete(t1_1)
assert t4_1 in sess.deleted
sess.flush()
class M2OUseGetTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"base",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(30)),
)
Table(
"sub",
metadata,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
)
Table(
"related",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("sub_id", Integer, ForeignKey("sub.id")),
)
def test_use_get(self):
base, sub, related = (
self.tables.base,
self.tables.sub,
self.tables.related,
)
class Base(BasicEntity):
pass
class Sub(Base):
pass
class Related(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="b"
)
self.mapper_registry.map_imperatively(
Sub, sub, inherits=Base, polymorphic_identity="s"
)
self.mapper_registry.map_imperatively(
Related,
related,
properties={
"sub": relationship(Sub)
},
)
assert class_mapper(Related).get_property("sub").strategy.use_get
sess = fixture_session()
s1 = Sub()
r1 = Related(sub=s1)
sess.add(r1)
sess.flush()
sess.expunge_all()
r1 = sess.query(Related).first()
s1 = sess.query(Sub).first()
def go():
assert r1.sub
self.assert_sql_count(testing.db, go, 0)
class GetTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
global foo, bar, blub
foo = Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(30)),
Column("data", String(20)),
)
bar = Table(
"bar",
metadata,
Column("id", Integer, ForeignKey("foo.id"), primary_key=True),
Column("bar_data", String(20)),
)
blub = Table(
"blub",
metadata,
Column(
"blub_id",
Integer,
primary_key=True,
test_needs_autoincrement=True,
),
Column("foo_id", Integer, ForeignKey("foo.id")),
Column("bar_id", Integer, ForeignKey("bar.id")),
Column("blub_data", String(20)),
)
@classmethod
def setup_classes(cls):
class Foo(cls.Basic):
pass
class Bar(Foo):
pass
class Blub(Bar):
pass
@testing.combinations(
("polymorphic", True), ("test_get_nonpolymorphic", False), id_="ia"
)
def test_get(self, polymorphic):
foo, Bar, Blub, blub, bar, Foo = (
self.tables.foo,
self.classes.Bar,
self.classes.Blub,
self.tables.blub,
self.tables.bar,
self.classes.Foo,
)
if polymorphic:
self.mapper_registry.map_imperatively(
Foo, foo, polymorphic_on=foo.c.type, polymorphic_identity="foo"
)
self.mapper_registry.map_imperatively(
Bar, bar, inherits=Foo, polymorphic_identity="bar"
)
self.mapper_registry.map_imperatively(
Blub, blub, inherits=Bar, polymorphic_identity="blub"
)
else:
self.mapper_registry.map_imperatively(Foo, foo)
self.mapper_registry.map_imperatively(Bar, bar, inherits=Foo)
self.mapper_registry.map_imperatively(Blub, blub, inherits=Bar)
sess = fixture_session()
f = Foo()
b = Bar()
bl = Blub()
sess.add(f)
sess.add(b)
sess.add(bl)
sess.flush()
if polymorphic:
def go():
assert sess.get(Foo, f.id) is f
assert sess.get(Foo, b.id) is b
assert sess.get(Foo, bl.id) is bl
assert sess.get(Bar, b.id) is b
assert sess.get(Bar, bl.id) is bl
assert sess.get(Blub, bl.id) is bl
assert sess.get(Blub, f.id) is None
assert sess.get(Blub, b.id) is None
assert sess.get(Bar, f.id) is None
self.assert_sql_count(testing.db, go, 0)
else:
def go():
assert sess.get(Foo, f.id) is f
bb = sess.get(Foo, b.id)
assert isinstance(b, Foo) and bb.id == b.id
bll = sess.get(Foo, bl.id)
assert isinstance(bll, Foo) and bll.id == bl.id
assert sess.get(Bar, b.id) is b
bll = sess.get(Bar, bl.id)
assert isinstance(bll, Bar) and bll.id == bl.id
assert sess.get(Blub, bl.id) is bl
self.assert_sql_count(testing.db, go, 3)
class EagerLazyTest(fixtures.MappedTest):
"""tests eager load/lazy load of child items off inheritance mappers, tests
that LazyLoader constructs the right query condition."""
@classmethod
def define_tables(cls, metadata):
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", String(30)),
)
Table(
"bar",
metadata,
Column("id", Integer, ForeignKey("foo.id"), primary_key=True),
Column("bar_data", String(30)),
)
Table(
"bar_foo",
metadata,
Column("bar_id", Integer, ForeignKey("bar.id")),
Column("foo_id", Integer, ForeignKey("foo.id")),
)
@classmethod
def setup_mappers(cls):
foo, bar, bar_foo = cls.tables("foo", "bar", "bar_foo")
class Foo(cls.Comparable):
pass
class Bar(Foo):
pass
foos = cls.mapper_registry.map_imperatively(Foo, foo)
bars = cls.mapper_registry.map_imperatively(Bar, bar, inherits=foos)
bars.add_property("lazy", relationship(foos, bar_foo, lazy="select"))
bars.add_property(
"eager", relationship(foos, bar_foo, lazy="joined", viewonly=True)
)
@classmethod
def insert_data(cls, connection):
foo, bar, bar_foo = cls.tables("foo", "bar", "bar_foo")
connection.execute(foo.insert(), dict(data="foo1"))
connection.execute(bar.insert(), dict(id=1, data="bar1"))
connection.execute(foo.insert(), dict(data="foo2"))
connection.execute(bar.insert(), dict(id=2, data="bar2"))
connection.execute(foo.insert(), dict(data="foo3"))
connection.execute(foo.insert(), dict(data="foo4"))
connection.execute(bar_foo.insert(), dict(bar_id=1, foo_id=3))
connection.execute(bar_foo.insert(), dict(bar_id=2, foo_id=4))
def test_basic(self):
Bar = self.classes.Bar
sess = fixture_session()
q = sess.query(Bar)
self.assert_(len(q.first().lazy) == 1)
self.assert_(len(q.first().eager) == 1)
class EagerTargetingTest(fixtures.MappedTest):
"""test a scenario where joined table inheritance might be
confused as an eagerly loaded joined table."""
@classmethod
def define_tables(cls, metadata):
Table(
"a_table",
metadata,
Column("id", Integer, primary_key=True),
Column("name", String(50)),
Column("type", String(30), nullable=False),
Column("parent_id", Integer, ForeignKey("a_table.id")),
)
Table(
"b_table",
metadata,
Column("id", Integer, ForeignKey("a_table.id"), primary_key=True),
Column("b_data", String(50)),
)
def test_adapt_stringency(self):
b_table, a_table = self.tables.b_table, self.tables.a_table
class A(ComparableEntity):
pass
class B(A):
pass
self.mapper_registry.map_imperatively(
A,
a_table,
polymorphic_on=a_table.c.type,
polymorphic_identity="A",
properties={"children": relationship(A, order_by=a_table.c.name)},
)
self.mapper_registry.map_imperatively(
B,
b_table,
inherits=A,
polymorphic_identity="B",
properties={
"b_derived": column_property(b_table.c.b_data + "DATA")
},
)
sess = fixture_session()
b1 = B(id=1, name="b1", b_data="i")
sess.add(b1)
sess.flush()
b2 = B(id=2, name="b2", b_data="l", parent_id=1)
sess.add(b2)
sess.flush()
bid = b1.id
sess.expunge_all()
node = sess.query(B).filter(B.id == bid).all()[0]
eq_(node, B(id=1, name="b1", b_data="i"))
eq_(node.children[0], B(id=2, name="b2", b_data="l"))
sess.expunge_all()
node = (
sess.query(B)
.options(joinedload(B.children))
.filter(B.id == bid)
.all()[0]
)
eq_(node, B(id=1, name="b1", b_data="i"))
eq_(node.children[0], B(id=2, name="b2", b_data="l"))
class FlushTest(fixtures.MappedTest):
"""test dependency sorting among inheriting mappers"""
@classmethod
def define_tables(cls, metadata):
Table(
"users",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("email", String(128)),
Column("password", String(16)),
)
Table(
"roles",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("description", String(32)),
)
Table(
"user_roles",
metadata,
Column(
"user_id", Integer, ForeignKey("users.id"), primary_key=True
),
Column(
"role_id", Integer, ForeignKey("roles.id"), primary_key=True
),
)
Table(
"admins",
metadata,
Column(
"admin_id",
Integer,
primary_key=True,
test_needs_autoincrement=True,
),
Column("user_id", Integer, ForeignKey("users.id")),
)
def test_one(self):
admins, users, roles, user_roles = (
self.tables.admins,
self.tables.users,
self.tables.roles,
self.tables.user_roles,
)
class User:
pass
class Role:
pass
class Admin(User):
pass
self.mapper_registry.map_imperatively(Role, roles)
user_mapper = self.mapper_registry.map_imperatively(
User,
users,
properties={
"roles": relationship(
Role, secondary=user_roles, lazy="joined"
)
},
)
self.mapper_registry.map_imperatively(
Admin, admins, inherits=user_mapper
)
sess = fixture_session()
adminrole = Role()
sess.add(adminrole)
sess.flush()
a = Admin()
a.roles.append(adminrole)
a.password = "admin"
sess.add(a)
sess.flush()
eq_(sess.scalar(select(func.count("*")).select_from(user_roles)), 1)
def test_two(self):
admins, users, roles, user_roles = (
self.tables.admins,
self.tables.users,
self.tables.roles,
self.tables.user_roles,
)
class User:
def __init__(self, email=None, password=None):
self.email = email
self.password = password
class Role:
def __init__(self, description=None):
self.description = description
class Admin(User):
pass
self.mapper_registry.map_imperatively(Role, roles)
user_mapper = self.mapper_registry.map_imperatively(
User,
users,
properties={
"roles": relationship(
Role, secondary=user_roles, lazy="joined"
)
},
)
self.mapper_registry.map_imperatively(
Admin, admins, inherits=user_mapper
)
adminrole = Role("admin")
sess = fixture_session()
sess.add(adminrole)
sess.flush()
a = Admin(email="tim", password="admin")
a.roles.append(adminrole)
sess.add(a)
sess.flush()
a.password = "sadmin"
sess.flush()
eq_(sess.scalar(select(func.count("*")).select_from(user_roles)), 1)
class PassiveDeletesTest(fixtures.MappedTest):
__requires__ = ("foreign_keys",)
@classmethod
def define_tables(cls, metadata):
Table(
"a",
metadata,
Column("id", Integer, primary_key=True),
Column("type", String(30)),
)
Table(
"b",
metadata,
Column(
"id",
Integer,
ForeignKey("a.id", ondelete="CASCADE"),
primary_key=True,
),
Column("data", String(10)),
)
Table(
"c",
metadata,
Column("cid", Integer, primary_key=True),
Column("bid", ForeignKey("b.id", ondelete="CASCADE")),
)
@classmethod
def setup_classes(cls):
class A(cls.Basic):
pass
class B(A):
pass
class C(B):
pass
def _fixture(self, a_p=False, b_p=False, c_p=False):
A, B, C = self.classes("A", "B", "C")
a, b, c = self.tables("a", "b", "c")
self.mapper_registry.map_imperatively(
A,
a,
passive_deletes=a_p,
polymorphic_on=a.c.type,
polymorphic_identity="a",
)
self.mapper_registry.map_imperatively(
B, b, inherits=A, passive_deletes=b_p, polymorphic_identity="b"
)
self.mapper_registry.map_imperatively(
C, c, inherits=B, passive_deletes=c_p, polymorphic_identity="c"
)
def test_none(self):
A, B, C = self.classes("A", "B", "C")
self._fixture()
s = fixture_session()
a1, b1, c1 = A(id=1), B(id=2), C(cid=1, id=3)
s.add_all([a1, b1, c1])
s.commit()
c1 = s.query(B).filter_by(id=3).first()
s.delete(c1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
RegexSQL(
"SELECT .* FROM c WHERE :param_1 = c.bid", [{"param_1": 3}]
),
CompiledSQL("DELETE FROM c WHERE c.cid = :cid", [{"cid": 1}]),
CompiledSQL("DELETE FROM b WHERE b.id = :id", [{"id": 3}]),
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 3}]),
)
def test_c_only(self):
A, B, C = self.classes("A", "B", "C")
self._fixture(c_p=True)
s = fixture_session()
a1, b1, c1 = A(id=1), B(id=2), C(cid=1, id=3)
s.add_all([a1, b1, c1])
s.commit()
s.delete(a1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL(
"SELECT a.id AS a_id, a.type AS a_type "
"FROM a WHERE a.id = :pk_1",
[{"pk_1": 1}],
),
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 1}]),
)
b1.id
s.delete(b1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL("DELETE FROM b WHERE b.id = :id", [{"id": 2}]),
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 2}]),
)
c1 = s.query(A).filter_by(id=3).first()
s.delete(c1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL("DELETE FROM b WHERE b.id = :id", [{"id": 3}]),
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 3}]),
)
def test_b_only(self):
A, B, C = self.classes("A", "B", "C")
self._fixture(b_p=True)
s = fixture_session()
a1, b1, c1 = A(id=1), B(id=2), C(cid=1, id=3)
s.add_all([a1, b1, c1])
s.commit()
s.delete(a1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL(
"SELECT a.id AS a_id, a.type AS a_type "
"FROM a WHERE a.id = :pk_1",
[{"pk_1": 1}],
),
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 1}]),
)
b1.id
s.delete(b1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 2}])
)
c1.id
s.delete(c1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 3}])
)
def test_a_only(self):
A, B, C = self.classes("A", "B", "C")
self._fixture(a_p=True)
s = fixture_session()
a1, b1, c1 = A(id=1), B(id=2), C(cid=1, id=3)
s.add_all([a1, b1, c1])
s.commit()
s.delete(a1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL(
"SELECT a.id AS a_id, a.type AS a_type "
"FROM a WHERE a.id = :pk_1",
[{"pk_1": 1}],
),
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 1}]),
)
b1.id
s.delete(b1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 2}])
)
c1 = s.query(A).filter_by(id=3).first()
s.delete(c1)
with self.sql_execution_asserter(testing.db) as asserter:
s.flush()
asserter.assert_(
CompiledSQL("DELETE FROM a WHERE a.id = :id", [{"id": 3}])
)
class OptimizedGetOnDeferredTest(fixtures.MappedTest):
"""test that the 'optimized get' path accommodates deferred columns.
Original issue tested is #3468, where loading of a deferred column
in an inherited subclass would fail.
At some point, the logic tested was no longer used and a less efficient
query was used to load these columns, but the test here did not inspect
the SQL such that this would be detected.
Test was then revised to more carefully test and now targets
#7463 as well.
"""
@classmethod
def define_tables(cls, metadata):
Table(
"a",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(10)),
)
Table(
"b",
metadata,
Column("id", Integer, ForeignKey("a.id"), primary_key=True),
Column("data", String(10)),
)
@classmethod
def setup_classes(cls):
class A(cls.Basic):
pass
class B(A):
pass
@classmethod
def setup_mappers(cls):
A, B = cls.classes("A", "B")
a, b = cls.tables("a", "b")
cls.mapper_registry.map_imperatively(A, a, polymorphic_on=a.c.type)
cls.mapper_registry.map_imperatively(
B,
b,
inherits=A,
polymorphic_identity="b",
properties={
"data": deferred(b.c.data),
"expr": column_property(b.c.data + "q", deferred=True),
},
)
def test_column_property(self):
A, B = self.classes("A", "B")
sess = fixture_session()
b1 = B(data="x")
sess.add(b1)
sess.flush()
b_id = b1.id
with self.sql_execution_asserter(testing.db) as asserter:
eq_(b1.expr, "xq")
asserter.assert_(
CompiledSQL(
"SELECT b.data || :data_1 AS anon_1 "
"FROM b WHERE :param_1 = b.id",
[{"param_1": b_id, "data_1": "q"}],
)
)
def test_expired_column(self):
A, B = self.classes("A", "B")
sess = fixture_session()
b1 = B(data="x")
sess.add(b1)
sess.flush()
b_id = b1.id
sess.expire(b1, ["data"])
with self.sql_execution_asserter(testing.db) as asserter:
eq_(b1.data, "x")
asserter.assert_(
CompiledSQL(
"SELECT b.data AS b_data FROM b WHERE :param_1 = b.id",
[{"param_1": b_id}],
)
)
def test_refresh_column(self):
"""refresh currently does not use the mapper "optimized get".
This could be added later by generalizing the code in
loading.py->load_scalar_attributes() to be used by session.refresh().
For #8703, where we are revisiting some of this logic for 2.0.0,
not doing this yet as enough is changing in 2.0 already.
"""
A, B = self.classes("A", "B")
sess = fixture_session()
b1 = B(data="x")
sess.add(b1)
sess.flush()
pk = b1.id
sess.expire(b1, ["data"])
with self.sql_execution_asserter(testing.db) as asserter:
sess.refresh(b1, ["data"])
asserter.assert_(
CompiledSQL(
"SELECT b.data FROM a JOIN b ON a.id = b.id "
"WHERE a.id = :pk_1",
[{"pk_1": pk}],
)
)
def test_load_from_unloaded_subclass(self):
A, B = self.classes("A", "B")
sess = fixture_session()
b1 = B(data="x")
sess.add(b1)
sess.commit()
b_id = b1.id
sess.close()
b1 = sess.execute(select(A)).scalar()
assert "data" not in b1.__dict__
with self.sql_execution_asserter(testing.db) as asserter:
eq_(b1.data, "x")
asserter.assert_(
CompiledSQL(
"SELECT b.data AS b_data FROM b WHERE :param_1 = b.id",
[{"param_1": b_id}],
)
)
def test_load_from_expired_subclass(self):
A, B = self.classes("A", "B")
sess = fixture_session()
b1 = B(data="x")
sess.add(b1)
sess.commit()
b_id = b1.id
sess.close()
b1 = sess.execute(select(A)).scalar()
assert "data" not in b1.__dict__
eq_(b1.data, "x")
sess.expire(b1, ["data"])
with self.sql_execution_asserter(testing.db) as asserter:
eq_(b1.data, "x")
asserter.assert_(
CompiledSQL(
"SELECT b.data AS b_data FROM b WHERE :param_1 = b.id",
[{"param_1": b_id}],
)
)
class JoinedNoFKSortingTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"a",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
)
Table("b", metadata, Column("id", Integer, primary_key=True))
Table("c", metadata, Column("id", Integer, primary_key=True))
@classmethod
def setup_classes(cls):
class A(cls.Basic):
pass
class B(A):
pass
class C(A):
pass
@classmethod
def setup_mappers(cls):
A, B, C = cls.classes.A, cls.classes.B, cls.classes.C
cls.mapper_registry.map_imperatively(A, cls.tables.a)
cls.mapper_registry.map_imperatively(
B,
cls.tables.b,
inherits=A,
inherit_condition=cls.tables.a.c.id == cls.tables.b.c.id,
inherit_foreign_keys=cls.tables.b.c.id,
)
cls.mapper_registry.map_imperatively(
C,
cls.tables.c,
inherits=A,
inherit_condition=cls.tables.a.c.id == cls.tables.c.c.id,
inherit_foreign_keys=cls.tables.c.c.id,
)
def test_ordering(self):
B, C = self.classes.B, self.classes.C
sess = fixture_session()
sess.add_all([B(), C(), B(), C()])
self.assert_sql_execution(
testing.db,
sess.flush,
Conditional(
testing.db.dialect.insert_executemany_returning,
[
CompiledSQL(
"INSERT INTO a (id) VALUES (DEFAULT) RETURNING a.id",
[{}, {}, {}, {}],
),
],
[
CompiledSQL("INSERT INTO a () VALUES ()", {}),
CompiledSQL("INSERT INTO a () VALUES ()", {}),
CompiledSQL("INSERT INTO a () VALUES ()", {}),
CompiledSQL("INSERT INTO a () VALUES ()", {}),
],
),
AllOf(
CompiledSQL(
"INSERT INTO b (id) VALUES (:id)", [{"id": 1}, {"id": 3}]
),
CompiledSQL(
"INSERT INTO c (id) VALUES (:id)", [{"id": 2}, {"id": 4}]
),
),
)
class VersioningTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"base",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("version_id", Integer, nullable=False),
Column("value", String(40)),
Column("discriminator", Integer, nullable=False),
)
Table(
"subtable",
metadata,
Column("id", None, ForeignKey("base.id"), primary_key=True),
Column("subdata", String(50)),
)
Table(
"stuff",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("parent", Integer, ForeignKey("base.id")),
)
@testing.requires.sane_rowcount
def test_save_update(self):
subtable, base, stuff = (
self.tables.subtable,
self.tables.base,
self.tables.stuff,
)
class Base(BasicEntity):
pass
class Sub(Base):
pass
class Stuff(Base):
pass
self.mapper_registry.map_imperatively(Stuff, stuff)
self.mapper_registry.map_imperatively(
Base,
base,
polymorphic_on=base.c.discriminator,
version_id_col=base.c.version_id,
polymorphic_identity=1,
properties={"stuff": relationship(Stuff)},
)
self.mapper_registry.map_imperatively(
Sub, subtable, inherits=Base, polymorphic_identity=2
)
sess = fixture_session(autoflush=False)
b1 = Base(value="b1")
s1 = Sub(value="sub1", subdata="some subdata")
sess.add(b1)
sess.add(s1)
sess.commit()
sess2 = fixture_session(autoflush=False)
s2 = sess2.get(Base, s1.id)
s2.subdata = "sess2 subdata"
s1.subdata = "sess1 subdata"
sess.commit()
assert_raises(
orm_exc.StaleDataError,
sess2.get,
Base,
s1.id,
with_for_update=dict(read=True),
)
if not testing.db.dialect.supports_sane_rowcount:
sess2.flush()
else:
assert_raises(orm_exc.StaleDataError, sess2.flush)
sess2.rollback()
sess2.refresh(s2)
if testing.db.dialect.supports_sane_rowcount:
assert s2.subdata == "sess1 subdata"
s2.subdata = "sess2 subdata"
sess2.flush()
@testing.requires.sane_rowcount
def test_delete(self):
subtable, base = self.tables.subtable, self.tables.base
class Base(BasicEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base,
base,
polymorphic_on=base.c.discriminator,
version_id_col=base.c.version_id,
polymorphic_identity=1,
)
self.mapper_registry.map_imperatively(
Sub, subtable, inherits=Base, polymorphic_identity=2
)
sess = fixture_session(autoflush=False, expire_on_commit=False)
b1 = Base(value="b1")
s1 = Sub(value="sub1", subdata="some subdata")
s2 = Sub(value="sub2", subdata="some other subdata")
sess.add(b1)
sess.add(s1)
sess.add(s2)
sess.commit()
sess2 = fixture_session(autoflush=False, expire_on_commit=False)
s3 = sess2.get(Base, s1.id)
sess2.delete(s3)
sess2.commit()
s2.subdata = "some new subdata"
sess.commit()
s1.subdata = "some new subdata"
if testing.db.dialect.supports_sane_rowcount:
assert_raises(orm_exc.StaleDataError, sess.commit)
else:
sess.commit()
class DistinctPKTest(fixtures.MappedTest):
"""test the construction of mapper.primary_key when an inheriting
relationship joins on a column other than primary key column."""
run_inserts = "once"
run_deletes = None
@classmethod
def define_tables(cls, metadata):
global person_table, employee_table, Person, Employee
person_table = Table(
"persons",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("name", String(80)),
)
employee_table = Table(
"employees",
metadata,
Column(
"eid", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("salary", Integer),
Column("person_id", Integer, ForeignKey("persons.id")),
)
class Person:
def __init__(self, name):
self.name = name
class Employee(Person):
pass
@classmethod
def insert_data(cls, connection):
person_insert = person_table.insert()
connection.execute(person_insert, dict(id=1, name="alice"))
connection.execute(person_insert, dict(id=2, name="bob"))
employee_insert = employee_table.insert()
connection.execute(
employee_insert, dict(id=2, salary=250, person_id=1)
)
connection.execute(
employee_insert, dict(id=3, salary=200, person_id=2)
)
def test_implicit(self):
person_mapper = self.mapper_registry.map_imperatively(
Person, person_table
)
self.mapper_registry.map_imperatively(
Employee, employee_table, inherits=person_mapper
)
assert list(class_mapper(Employee).primary_key) == [person_table.c.id]
def test_explicit_props(self):
person_mapper = self.mapper_registry.map_imperatively(
Person, person_table
)
self.mapper_registry.map_imperatively(
Employee,
employee_table,
inherits=person_mapper,
properties={"pid": person_table.c.id, "eid": employee_table.c.eid},
)
self._do_test(False)
def test_explicit_composite_pk(self):
person_mapper = self.mapper_registry.map_imperatively(
Person, person_table
)
self.mapper_registry.map_imperatively(
Employee,
employee_table,
inherits=person_mapper,
properties=dict(id=[employee_table.c.eid, person_table.c.id]),
primary_key=[person_table.c.id, employee_table.c.eid],
)
assert_warns_message(
sa_exc.SAWarning,
r"On mapper Mapper\[Employee\(employees\)\], "
"primary key column 'persons.id' is being "
"combined with distinct primary key column 'employees.eid' "
"in attribute 'id'. Use explicit properties to give "
"each column its own mapped attribute name.",
self._do_test,
True,
)
def test_explicit_pk(self):
person_mapper = self.mapper_registry.map_imperatively(
Person, person_table
)
self.mapper_registry.map_imperatively(
Employee,
employee_table,
inherits=person_mapper,
primary_key=[person_table.c.id],
)
self._do_test(False)
def _do_test(self, composite):
session = fixture_session()
if composite:
alice1 = session.get(Employee, [1, 2])
bob = session.get(Employee, [2, 3])
alice2 = session.get(Employee, [1, 2])
else:
alice1 = session.get(Employee, 1)
bob = session.get(Employee, 2)
alice2 = session.get(Employee, 1)
assert alice1.name == alice2.name == "alice"
assert bob.name == "bob"
class SyncCompileTest(fixtures.MappedTest):
"""test that syncrules compile properly on custom inherit conds"""
@classmethod
def define_tables(cls, metadata):
global _a_table, _b_table, _c_table
_a_table = Table(
"a",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data1", String(128)),
)
_b_table = Table(
"b",
metadata,
Column("a_id", Integer, ForeignKey("a.id"), primary_key=True),
Column("data2", String(128)),
)
_c_table = Table(
"c",
metadata,
Column("b_a_id", Integer, ForeignKey("b.a_id"), primary_key=True),
Column("data3", String(128)),
)
@testing.combinations(
lambda _a_table, _b_table: None,
lambda _a_table, _b_table: _b_table.c.a_id == _a_table.c.id,
lambda _a_table, _b_table: _a_table.c.id == _b_table.c.a_id,
argnames="j1",
)
@testing.combinations(
lambda _b_table, _c_table: None,
lambda _b_table, _c_table: _b_table.c.a_id == _c_table.c.b_a_id,
lambda _b_table, _c_table: _c_table.c.b_a_id == _b_table.c.a_id,
argnames="j2",
)
def test_joins(self, j1, j2):
_a_table, _b_table, _c_table = self.tables("a", "b", "c")
j1 = testing.resolve_lambda(j1, **locals())
j2 = testing.resolve_lambda(j2, **locals())
class A:
def __init__(self, **kwargs):
for key, value in list(kwargs.items()):
setattr(self, key, value)
class B(A):
pass
class C(B):
pass
self.mapper_registry.map_imperatively(A, _a_table)
self.mapper_registry.map_imperatively(
B, _b_table, inherits=A, inherit_condition=j1
)
self.mapper_registry.map_imperatively(
C, _c_table, inherits=B, inherit_condition=j2
)
session = fixture_session()
a = A(data1="a1")
session.add(a)
b = B(data1="b1", data2="b2")
session.add(b)
c = C(data1="c1", data2="c2", data3="c3")
session.add(c)
session.flush()
session.expunge_all()
assert len(session.query(A).all()) == 3
assert len(session.query(B).all()) == 2
assert len(session.query(C).all()) == 1
class OverrideColKeyTest(fixtures.MappedTest):
"""test overriding of column attributes."""
@classmethod
def define_tables(cls, metadata):
global base, subtable, subtable_two
base = Table(
"base",
metadata,
Column(
"base_id",
Integer,
primary_key=True,
test_needs_autoincrement=True,
),
Column("data", String(255)),
Column("sqlite_fixer", String(10)),
)
subtable = Table(
"subtable",
metadata,
Column(
"base_id",
Integer,
ForeignKey("base.base_id"),
primary_key=True,
),
Column("subdata", String(255)),
)
subtable_two = Table(
"subtable_two",
metadata,
Column("base_id", Integer, primary_key=True),
Column("fk_base_id", Integer, ForeignKey("base.base_id")),
Column("subdata", String(255)),
)
def test_plain(self):
class Base:
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(Base, base)
self.mapper_registry.map_imperatively(Sub, subtable, inherits=Base)
eq_(
class_mapper(Sub).get_property("base_id").columns,
[subtable.c.base_id, base.c.base_id],
)
def test_override_explicit(self):
class Base:
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, properties={"id": base.c.base_id}
)
self.mapper_registry.map_imperatively(
Sub,
subtable,
inherits=Base,
properties={
"id": [base.c.base_id, subtable.c.base_id]
},
)
eq_(
class_mapper(Sub).get_property("id").columns,
[base.c.base_id, subtable.c.base_id],
)
s1 = Sub()
s1.id = 10
sess = fixture_session()
sess.add(s1)
sess.flush()
assert sess.get(Sub, 10) is s1
def test_override_onlyinparent(self):
class Base:
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, properties={"id": base.c.base_id}
)
self.mapper_registry.map_imperatively(Sub, subtable, inherits=Base)
eq_(class_mapper(Sub).get_property("id").columns, [base.c.base_id])
eq_(
class_mapper(Sub).get_property("base_id").columns,
[subtable.c.base_id],
)
s1 = Sub()
s1.id = 10
s2 = Sub()
s2.base_id = 15
sess = fixture_session()
sess.add_all([s1, s2])
sess.flush()
assert sess.get(Sub, 10) is s1
assert s2.id == s2.base_id != 15
def test_subclass_renames_superclass_col_single_inh(self, decl_base):
"""tested as part of #8705.
The step where we configure columns mapped to specific keys must
take place even if the given column is already in _columntoproperty,
as would be the case if the superclass maps that column already.
"""
class A(decl_base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
a_data = Column(String)
class B(A):
b_data = column_property(A.__table__.c.a_data)
is_(A.a_data.property.columns[0], A.__table__.c.a_data)
is_(B.a_data.property.columns[0], A.__table__.c.a_data)
is_(B.b_data.property.columns[0], A.__table__.c.a_data)
def test_subsubclass_groups_super_cols(self, decl_base):
"""tested for #9220, which is a regression caused by #8705."""
class BaseClass(decl_base):
__tablename__ = "basetable"
id = Column(Integer, primary_key=True)
name = Column(String(50))
type = Column(String(20))
__mapper_args__ = {
"polymorphic_on": type,
"polymorphic_identity": "base",
}
class SubClass(BaseClass):
__tablename__ = "subtable"
id = column_property(
Column(Integer, primary_key=True), BaseClass.id
)
base_id = Column(Integer, ForeignKey("basetable.id"))
subdata1 = Column(String(50))
__mapper_args__ = {"polymorphic_identity": "sub"}
class SubSubClass(SubClass):
__tablename__ = "subsubtable"
id = column_property(
Column(Integer, ForeignKey("subtable.id"), primary_key=True),
SubClass.id,
BaseClass.id,
)
subdata2 = Column(String(50))
__mapper_args__ = {"polymorphic_identity": "subsub"}
is_(SubSubClass.id.property.columns[0], SubSubClass.__table__.c.id)
is_(
SubSubClass.id.property.columns[1]._deannotate(),
SubClass.__table__.c.id,
)
is_(
SubSubClass.id.property.columns[2]._deannotate(),
BaseClass.__table__.c.id,
)
def test_column_setup_sanity_check(self, decl_base):
class A(decl_base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
a_data = Column(String)
class B(A):
__tablename__ = "b"
id = Column(Integer, ForeignKey("a.id"), primary_key=True)
b_data = Column(String)
is_(A.id.property.parent, inspect(A))
is_(B.id.property.parent, inspect(B))
eq_(B.id.property.columns, [B.__table__.c.id, A.__table__.c.id])
is_(B.a_data.property.parent, inspect(A))
is_(B.b_data.property.parent, inspect(B))
def test_override_implicit(self):
class Base:
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, properties={"id": base.c.base_id}
)
with expect_raises_message(
sa_exc.InvalidRequestError,
"Implicitly combining column base.base_id with column "
"subtable.base_id under attribute 'id'. Please configure one "
"or more attributes for these same-named columns explicitly.",
):
self.mapper_registry.map_imperatively(
Sub,
subtable,
inherits=Base,
properties={"id": subtable.c.base_id},
)
def test_pk_fk_different(self):
class Base:
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(Base, base)
def go():
self.mapper_registry.map_imperatively(
Sub, subtable_two, inherits=Base
)
assert_warns_message(
sa_exc.SAWarning,
"Implicitly combining column base.base_id with "
"column subtable_two.base_id under attribute 'base_id'",
go,
)
def test_plain_descriptor(self):
"""test that descriptors prevent inheritance from propagating
properties to subclasses."""
class Base:
pass
class Sub(Base):
@property
def data(self):
return "im the data"
self.mapper_registry.map_imperatively(Base, base)
self.mapper_registry.map_imperatively(Sub, subtable, inherits=Base)
s1 = Sub()
sess = fixture_session()
sess.add(s1)
sess.flush()
assert sess.query(Sub).one().data == "im the data"
def test_custom_descriptor(self):
"""test that descriptors prevent inheritance from propagating
properties to subclasses."""
class MyDesc:
def __get__(self, instance, owner):
if instance is None:
return self
return "im the data"
class Base:
pass
class Sub(Base):
data = MyDesc()
self.mapper_registry.map_imperatively(Base, base)
self.mapper_registry.map_imperatively(Sub, subtable, inherits=Base)
s1 = Sub()
sess = fixture_session()
sess.add(s1)
sess.flush()
assert sess.query(Sub).one().data == "im the data"
def test_sub_columns_over_base_descriptors(self):
class Base:
@property
def subdata(self):
return "this is base"
class Sub(Base):
pass
self.mapper_registry.map_imperatively(Base, base)
self.mapper_registry.map_imperatively(Sub, subtable, inherits=Base)
sess = fixture_session()
b1 = Base()
assert b1.subdata == "this is base"
s1 = Sub()
s1.subdata = "this is sub"
assert s1.subdata == "this is sub"
sess.add_all([s1, b1])
sess.flush()
sess.expunge_all()
assert sess.get(Base, b1.base_id).subdata == "this is base"
assert sess.get(Sub, s1.base_id).subdata == "this is sub"
def test_base_descriptors_over_base_cols(self):
class Base:
@property
def data(self):
return "this is base"
class Sub(Base):
pass
self.mapper_registry.map_imperatively(Base, base)
self.mapper_registry.map_imperatively(Sub, subtable, inherits=Base)
sess = fixture_session()
b1 = Base()
assert b1.data == "this is base"
s1 = Sub()
assert s1.data == "this is base"
sess.add_all([s1, b1])
sess.flush()
sess.expunge_all()
assert sess.get(Base, b1.base_id).data == "this is base"
assert sess.get(Sub, s1.base_id).data == "this is base"
class OptimizedLoadTest(fixtures.MappedTest):
"""tests for the "optimized load" routine."""
__backend__ = True
@classmethod
def define_tables(cls, metadata):
Table(
"base",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", String(50)),
Column("type", String(50)),
Column("counter", Integer, server_default="1"),
)
Table(
"sub",
metadata,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
Column("sub", String(50)),
Column("subcounter", Integer, server_default="1"),
Column("subcounter2", Integer, server_default="1"),
)
Table(
"subsub",
metadata,
Column("id", Integer, ForeignKey("sub.id"), primary_key=True),
Column("subsubcounter2", Integer, server_default="1"),
)
Table(
"with_comp",
metadata,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
Column("a", String(10)),
Column("b", String(10)),
)
def test_no_optimize_on_map_to_join(self):
base, sub = self.tables.base, self.tables.sub
class Base(ComparableEntity):
pass
class JoinBase(ComparableEntity):
pass
class SubJoinBase(JoinBase):
pass
self.mapper_registry.map_imperatively(Base, base)
self.mapper_registry.map_imperatively(
JoinBase,
base.outerjoin(sub),
properties=util.OrderedDict(
[
("id", [base.c.id, sub.c.id]),
("counter", [base.c.counter, sub.c.subcounter]),
]
),
)
self.mapper_registry.map_imperatively(SubJoinBase, inherits=JoinBase)
sess = fixture_session()
sess.add(Base(data="data"))
sess.commit()
sjb = sess.query(SubJoinBase).one()
sjb_id = sjb.id
sess.expire(sjb)
def go():
eq_(sjb.data, "data")
self.assert_sql_execution(
testing.db,
go,
CompiledSQL(
"SELECT base.id AS base_id, sub.id AS sub_id, "
"base.data AS base_data, base.type AS base_type, "
"base.counter AS base_counter, "
"sub.subcounter AS sub_subcounter, "
"sub.sub AS sub_sub, sub.subcounter2 AS sub_subcounter2 "
"FROM base LEFT OUTER JOIN sub ON base.id = sub.id "
"WHERE base.id = :pk_1",
{"pk_1": sjb_id},
),
)
def test_optimized_load_subclass_labels(self):
base, sub = self.tables.base, self.tables.sub
class Base(ComparableEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
self.mapper_registry.map_imperatively(
Sub,
sub,
inherits=Base,
polymorphic_identity="sub",
with_polymorphic=(
"*",
base.outerjoin(sub)
.select()
.set_label_style(LABEL_STYLE_TABLENAME_PLUS_COL)
.alias("foo"),
),
)
sess = fixture_session()
s1 = Sub(
data="s1data", sub="s1sub", subcounter=1, counter=1, subcounter2=1
)
sess.add(s1)
sess.flush()
sess.expire(s1, ["sub"])
def _key_fallback(self, key, raiseerr):
raise KeyError(key)
with mock.patch(
"sqlalchemy.engine.result.ResultMetaData._key_fallback",
_key_fallback,
):
eq_(s1.sub, "s1sub")
def test_optimized_get_blank_intermediary(self, registry, connection):
"""test #7507"""
Base = registry.generate_base()
class A(Base):
__tablename__ = "a"
id = Column(
Integer, primary_key=True, test_needs_autoincrement=True
)
a = Column(String(20), nullable=False)
type_ = Column("type", String(20))
__mapper_args__ = {
"polymorphic_on": type_,
"polymorphic_identity": "a",
}
class B(A):
__tablename__ = "b"
__mapper_args__ = {"polymorphic_identity": "b"}
id = Column(Integer, ForeignKey("a.id"), primary_key=True)
b = Column(String(20), nullable=False)
class C(B):
__tablename__ = "c"
__mapper_args__ = {"polymorphic_identity": "c"}
id = Column(Integer, ForeignKey("b.id"), primary_key=True)
class D(C):
__tablename__ = "d"
__mapper_args__ = {"polymorphic_identity": "d"}
id = Column(Integer, ForeignKey("c.id"), primary_key=True)
c = Column(String(20), nullable=False)
Base.metadata.create_all(connection)
session = Session(connection)
session.add(D(a="x", b="y", c="z"))
session.commit()
with self.sql_execution_asserter(connection) as asserter:
d = session.query(A).one()
eq_(d.c, "z")
asserter.assert_(
CompiledSQL(
"SELECT a.id AS a_id, a.a AS a_a, a.type AS a_type FROM a",
[],
),
Or(
CompiledSQL(
"SELECT d.c AS d_c, b.b AS b_b FROM d, b, c WHERE "
":param_1 = b.id AND b.id = c.id AND c.id = d.id",
[{"param_1": 1}],
),
CompiledSQL(
"SELECT b.b AS b_b, d.c AS d_c FROM b, d, c WHERE "
":param_1 = b.id AND b.id = c.id AND c.id = d.id",
[{"param_1": 1}],
),
),
)
def test_optimized_passes(self):
"""test that the 'optimized load' routine doesn't crash when
a column in the join condition is not available."""
base, sub = self.tables.base, self.tables.sub
class Base(ComparableEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
self.mapper_registry.map_imperatively(
Sub,
sub,
inherits=Base,
polymorphic_identity="sub",
properties={"id": [sub.c.id, base.c.id]},
)
sess = fixture_session()
s1 = Sub(data="s1data", sub="s1sub")
sess.add(s1)
sess.commit()
sess.expunge_all()
s1 = sess.query(Base).first()
assert s1.sub == "s1sub"
def test_column_expression(self):
base, sub = self.tables.base, self.tables.sub
class Base(ComparableEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
self.mapper_registry.map_imperatively(
Sub,
sub,
inherits=Base,
polymorphic_identity="sub",
properties={
"concat": column_property(sub.c.sub + "|" + sub.c.sub)
},
)
sess = fixture_session()
s1 = Sub(data="s1data", sub="s1sub")
sess.add(s1)
sess.commit()
sess.expunge_all()
s1 = sess.query(Base).first()
assert s1.concat == "s1sub|s1sub"
def test_column_expression_joined(self):
base, sub = self.tables.base, self.tables.sub
class Base(ComparableEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
self.mapper_registry.map_imperatively(
Sub,
sub,
inherits=Base,
polymorphic_identity="sub",
properties={
"concat": column_property(base.c.data + "|" + sub.c.sub)
},
)
sess = fixture_session()
s1 = Sub(data="s1data", sub="s1sub")
s2 = Sub(data="s2data", sub="s2sub")
s3 = Sub(data="s3data", sub="s3sub")
sess.add_all([s1, s2, s3])
sess.commit()
sess.expunge_all()
eq_(
sess.query(Base).order_by(Base.id).all(),
[
Sub(data="s1data", sub="s1sub", concat="s1data|s1sub"),
Sub(data="s2data", sub="s2sub", concat="s2data|s2sub"),
Sub(data="s3data", sub="s3sub", concat="s3data|s3sub"),
],
)
def test_composite_column_joined(self):
base, with_comp = self.tables.base, self.tables.with_comp
class Base(BasicEntity):
pass
class WithComp(Base):
pass
class Comp:
def __init__(self, a, b):
self.a = a
self.b = b
def __composite_values__(self):
return self.a, self.b
def __eq__(self, other):
return (self.a == other.a) and (self.b == other.b)
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
self.mapper_registry.map_imperatively(
WithComp,
with_comp,
inherits=Base,
polymorphic_identity="wc",
properties={"comp": composite(Comp, with_comp.c.a, with_comp.c.b)},
)
sess = fixture_session()
s1 = WithComp(data="s1data", comp=Comp("ham", "cheese"))
s2 = WithComp(data="s2data", comp=Comp("bacon", "eggs"))
sess.add_all([s1, s2])
sess.commit()
sess.expunge_all()
s1test, s2test = sess.query(Base).order_by(Base.id).all()
assert s1test.comp
assert s2test.comp
eq_(s1test.comp, Comp("ham", "cheese"))
eq_(s2test.comp, Comp("bacon", "eggs"))
@testing.variation("eager_defaults", [True, False])
def test_load_expired_on_pending(self, eager_defaults):
base, sub = self.tables.base, self.tables.sub
expected_eager_defaults = bool(eager_defaults)
expect_returning = (
expected_eager_defaults and testing.db.dialect.insert_returning
)
class Base(BasicEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base,
base,
polymorphic_on=base.c.type,
polymorphic_identity="base",
eager_defaults=bool(eager_defaults),
)
self.mapper_registry.map_imperatively(
Sub, sub, inherits=Base, polymorphic_identity="sub"
)
sess = fixture_session()
s1 = Sub(data="s1")
sess.add(s1)
self.assert_sql_execution(
testing.db,
sess.flush,
Conditional(
expect_returning,
[
CompiledSQL(
"INSERT INTO base (data, type) VALUES (:data, :type) "
"RETURNING base.id, base.counter",
[{"data": "s1", "type": "sub"}],
),
CompiledSQL(
"INSERT INTO sub (id, sub) VALUES (:id, :sub) "
"RETURNING sub.subcounter, sub.subcounter2",
lambda ctx: {"id": s1.id, "sub": None},
),
],
[
CompiledSQL(
"INSERT INTO base (data, type) VALUES (:data, :type)",
[{"data": "s1", "type": "sub"}],
enable_returning=False,
),
CompiledSQL(
"INSERT INTO sub (id, sub) VALUES (:id, :sub)",
lambda ctx: {"id": s1.id, "sub": None},
enable_returning=False,
),
Conditional(
bool(eager_defaults),
[
CompiledSQL(
"SELECT base.counter AS base_counter, "
"sub.subcounter AS sub_subcounter, "
"sub.subcounter2 AS sub_subcounter2 "
"FROM base JOIN sub ON base.id = sub.id "
"WHERE base.id = :pk_1",
lambda ctx: {"pk_1": s1.id},
)
],
[],
),
],
),
)
def go():
eq_(s1.subcounter2, 1)
self.assert_sql_execution(
testing.db,
go,
Conditional(
not eager_defaults and not expect_returning,
[
CompiledSQL(
"SELECT base.counter AS base_counter, "
"sub.subcounter AS sub_subcounter, sub.subcounter2 "
"AS sub_subcounter2 FROM base "
"JOIN sub ON base.id = sub.id WHERE base.id = :pk_1",
lambda ctx: {"pk_1": s1.id},
)
],
[],
),
)
def test_dont_generate_on_none(self):
base, sub = self.tables.base, self.tables.sub
class Base(BasicEntity):
pass
class Sub(Base):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
m = self.mapper_registry.map_imperatively(
Sub, sub, inherits=Base, polymorphic_identity="sub"
)
s1 = Sub()
assert (
m._optimized_get_statement(
attributes.instance_state(s1), ["subcounter2"]
)
is None
)
eq_(s1.id, None)
assert (
m._optimized_get_statement(
attributes.instance_state(s1), ["subcounter2"]
)
is None
)
s1.id = 1
attributes.instance_state(s1)._commit_all(s1.__dict__, None)
assert (
m._optimized_get_statement(
attributes.instance_state(s1), ["subcounter2"]
)
is not None
)
def test_load_expired_on_pending_twolevel(self):
base, sub, subsub = (
self.tables.base,
self.tables.sub,
self.tables.subsub,
)
class Base(BasicEntity):
pass
class Sub(Base):
pass
class SubSub(Sub):
pass
self.mapper_registry.map_imperatively(
Base, base, polymorphic_on=base.c.type, polymorphic_identity="base"
)
self.mapper_registry.map_imperatively(
Sub, sub, inherits=Base, polymorphic_identity="sub"
)
self.mapper_registry.map_imperatively(
SubSub, subsub, inherits=Sub, polymorphic_identity="subsub"
)
sess = fixture_session()
s1 = SubSub(data="s1", counter=1, subcounter=2)
sess.add(s1)
self.assert_sql_execution(
testing.db,
sess.flush,
CompiledSQL(
"INSERT INTO base (data, type, counter) VALUES "
"(:data, :type, :counter)",
[{"data": "s1", "type": "subsub", "counter": 1}],
),
CompiledSQL(
"INSERT INTO sub (id, sub, subcounter) VALUES "
"(:id, :sub, :subcounter)",
lambda ctx: [{"subcounter": 2, "sub": None, "id": s1.id}],
),
CompiledSQL(
"INSERT INTO subsub (id) VALUES (:id)",
lambda ctx: {"id": s1.id},
),
)
def go():
eq_(s1.subcounter2, 1)
self.assert_sql_execution(
testing.db,
go,
Or(
CompiledSQL(
"SELECT subsub.subsubcounter2 AS subsub_subsubcounter2, "
"sub.subcounter2 AS sub_subcounter2 FROM subsub, sub "
"WHERE :param_1 = sub.id AND sub.id = subsub.id",
lambda ctx: {"param_1": s1.id},
),
CompiledSQL(
"SELECT sub.subcounter2 AS sub_subcounter2, "
"subsub.subsubcounter2 AS subsub_subsubcounter2 "
"FROM sub, subsub "
"WHERE :param_1 = sub.id AND sub.id = subsub.id",
lambda ctx: {"param_1": s1.id},
),
),
)
class NoPKOnSubTableWarningTest(fixtures.MappedTest):
def _fixture(self):
metadata = MetaData()
parent = Table(
"parent", metadata, Column("id", Integer, primary_key=True)
)
child = Table(
"child", metadata, Column("id", Integer, ForeignKey("parent.id"))
)
return parent, child
def test_warning_on_sub(self):
parent, child = self._fixture()
class P:
pass
class C(P):
pass
self.mapper_registry.map_imperatively(P, parent)
assert_warns_message(
sa_exc.SAWarning,
"Could not assemble any primary keys for locally mapped "
"table 'child' - no rows will be persisted in this Table.",
self.mapper_registry.map_imperatively,
C,
child,
inherits=P,
)
def test_no_warning_with_explicit(self):
parent, child = self._fixture()
class P:
pass
class C(P):
pass
self.mapper_registry.map_imperatively(P, parent)
mc = self.mapper_registry.map_imperatively(
C, child, inherits=P, primary_key=[parent.c.id]
)
eq_(mc.primary_key, (parent.c.id,))
class InhCondTest(fixtures.MappedTest):
def test_inh_cond_nonexistent_table_unrelated(self):
metadata = MetaData()
base_table = Table(
"base", metadata, Column("id", Integer, primary_key=True)
)
derived_table = Table(
"derived",
metadata,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
Column("owner_id", Integer, ForeignKey("owner.owner_id")),
)
class Base:
pass
class Derived(Base):
pass
self.mapper_registry.map_imperatively(Base, base_table)
m2 = self.mapper_registry.map_imperatively(
Derived, derived_table, inherits=Base
)
assert m2.inherit_condition.compare(
base_table.c.id == derived_table.c.id
)
def test_inh_cond_nonexistent_col_unrelated(self):
m = MetaData()
base_table = Table("base", m, Column("id", Integer, primary_key=True))
derived_table = Table(
"derived",
m,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
Column("order_id", Integer, ForeignKey("order.foo")),
)
Table("order", m, Column("id", Integer, primary_key=True))
class Base:
pass
class Derived(Base):
pass
self.mapper_registry.map_imperatively(Base, base_table)
m2 = self.mapper_registry.map_imperatively(
Derived, derived_table, inherits=Base
)
assert m2.inherit_condition.compare(
base_table.c.id == derived_table.c.id
)
def test_inh_cond_no_fk(self):
metadata = MetaData()
base_table = Table(
"base", metadata, Column("id", Integer, primary_key=True)
)
derived_table = Table(
"derived", metadata, Column("id", Integer, primary_key=True)
)
class Base:
pass
class Derived(Base):
pass
self.mapper_registry.map_imperatively(Base, base_table)
assert_raises_message(
sa_exc.NoForeignKeysError,
"Can't determine the inherit condition between inherited table "
"'base' and inheriting table 'derived'; tables have no foreign "
"key relationships established. Please ensure the inheriting "
"table has a foreign key relationship to the inherited table, "
"or provide an 'on clause' using the 'inherit_condition' "
"mapper argument.",
self.mapper,
Derived,
derived_table,
inherits=Base,
)
def test_inh_cond_ambiguous_fk(self):
metadata = MetaData()
base_table = Table(
"base",
metadata,
Column("id", Integer, primary_key=True),
Column("favorite_derived", ForeignKey("derived.id")),
)
derived_table = Table(
"derived",
metadata,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
)
class Base:
pass
class Derived(Base):
pass
self.mapper(Base, base_table)
assert_raises_message(
sa_exc.AmbiguousForeignKeysError,
"Can't determine the inherit condition between inherited table "
"'base' and inheriting table 'derived'; tables have more than "
"one foreign key relationship established. Please specify the "
"'on clause' using the 'inherit_condition' mapper argument.",
self.mapper,
Derived,
derived_table,
inherits=Base,
)
def test_inh_cond_nonexistent_table_related(self):
m1 = MetaData()
m2 = MetaData()
base_table = Table("base", m1, Column("id", Integer, primary_key=True))
derived_table = Table(
"derived",
m2,
Column("id", Integer, ForeignKey("base.id"), primary_key=True),
)
class Base:
pass
class Derived(Base):
pass
clear_mappers()
self.mapper_registry.map_imperatively(Base, base_table)
assert_raises_message(
sa_exc.NoReferencedTableError,
"Foreign key associated with column 'derived.id' "
"could not find table 'base' with which to generate "
"a foreign key to target column 'id'",
self.mapper,
Derived,
derived_table,
inherits=Base,
)
def test_inh_cond_nonexistent_col_related(self):
m = MetaData()
base_table = Table("base", m, Column("id", Integer, primary_key=True))
derived_table = Table(
"derived",
m,
Column("id", Integer, ForeignKey("base.q"), primary_key=True),
)
class Base:
pass
class Derived(Base):
pass
clear_mappers()
self.mapper_registry.map_imperatively(Base, base_table)
assert_raises_message(
sa_exc.NoReferencedColumnError,
"Could not initialize target column for ForeignKey "
"'base.q' on table "
"'derived': table 'base' has no column named 'q'",
self.mapper,
Derived,
derived_table,
inherits=Base,
)
class PKDiscriminatorTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"parents",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("name", String(60)),
)
Table(
"children",
metadata,
Column("id", Integer, ForeignKey("parents.id"), primary_key=True),
Column("type", Integer, primary_key=True),
Column("name", String(60)),
)
def test_pk_as_discriminator(self):
parents, children = self.tables.parents, self.tables.children
class Parent:
def __init__(self, name=None):
self.name = name
class Child:
def __init__(self, name=None):
self.name = name
class A(Child):
pass
self.mapper_registry.map_imperatively(
Parent,
parents,
properties={"children": relationship(Child, backref="parent")},
)
self.mapper_registry.map_imperatively(
Child,
children,
polymorphic_on=children.c.type,
polymorphic_identity=1,
)
self.mapper_registry.map_imperatively(
A, inherits=Child, polymorphic_identity=2
)
s = fixture_session()
p = Parent("p1")
a = A("a1")
p.children.append(a)
s.add(p)
s.flush()
assert a.id
assert a.type == 2
p.name = "p1new"
a.name = "a1new"
s.flush()
s.expire_all()
assert a.name == "a1new"
assert p.name == "p1new"
class NoPolyIdentInMiddleTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"base",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(50), nullable=False),
)
@classmethod
def setup_classes(cls):
class A(cls.Comparable):
pass
class B(A):
pass
class C(B):
pass
class D(B):
pass
class E(A):
pass
@classmethod
def setup_mappers(cls):
A, C, B, E, D, base = (
cls.classes.A,
cls.classes.C,
cls.classes.B,
cls.classes.E,
cls.classes.D,
cls.tables.base,
)
cls.mapper_registry.map_imperatively(
A, base, polymorphic_on=base.c.type
)
with expect_warnings(
r"Mapper\[B\(base\)\] does not indicate a "
"'polymorphic_identity',"
):
cls.mapper_registry.map_imperatively(B, inherits=A)
cls.mapper_registry.map_imperatively(
C, inherits=B, polymorphic_identity="c"
)
cls.mapper_registry.map_imperatively(
D, inherits=B, polymorphic_identity="d"
)
cls.mapper_registry.map_imperatively(
E, inherits=A, polymorphic_identity="e"
)
cls.mapper_registry.configure()
def test_warning(self, decl_base):
"""test #7545"""
class A(decl_base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
type = Column(String)
__mapper_args__ = {"polymorphic_on": type}
class B(A):
__mapper_args__ = {"polymorphic_identity": "b"}
with expect_warnings(
r"Mapper\[C\(a\)\] does not indicate a 'polymorphic_identity',"
):
class C(A):
__mapper_args__ = {}
def test_load_from_middle(self):
C, B = self.classes.C, self.classes.B
s = fixture_session()
s.add(C())
o = s.query(B).first()
eq_(o.type, "c")
assert isinstance(o, C)
def test_load_from_base(self):
A, C = self.classes.A, self.classes.C
s = fixture_session()
s.add(C())
o = s.query(A).first()
eq_(o.type, "c")
assert isinstance(o, C)
def test_discriminator(self):
C, B, base = (self.classes.C, self.classes.B, self.tables.base)
assert class_mapper(B).polymorphic_on is base.c.type
assert class_mapper(C).polymorphic_on is base.c.type
def test_load_multiple_from_middle(self):
C, B, E, D, base = (
self.classes.C,
self.classes.B,
self.classes.E,
self.classes.D,
self.tables.base,
)
s = fixture_session()
s.add_all([C(), D(), E()])
eq_(s.query(B).order_by(base.c.type).all(), [C(), D()])
class DeleteOrphanTest(fixtures.MappedTest):
"""Test the fairly obvious, that an error is raised
when attempting to insert an orphan.
Previous SQLA versions would check this constraint
in memory which is the original rationale for this test.
"""
@classmethod
def define_tables(cls, metadata):
global single, parent
single = Table(
"single",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(50), nullable=False),
Column("data", String(50)),
Column(
"parent_id", Integer, ForeignKey("parent.id"), nullable=False
),
)
parent = Table(
"parent",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", String(50)),
)
def test_orphan_message(self):
class Base(BasicEntity):
pass
class SubClass(Base):
pass
class Parent(BasicEntity):
pass
self.mapper_registry.map_imperatively(
Base,
single,
polymorphic_on=single.c.type,
polymorphic_identity="base",
)
self.mapper_registry.map_imperatively(
SubClass, inherits=Base, polymorphic_identity="sub"
)
self.mapper_registry.map_imperatively(
Parent,
parent,
properties={
"related": relationship(Base, cascade="all, delete-orphan")
},
)
sess = fixture_session()
s1 = SubClass(data="s1")
sess.add(s1)
assert_raises(sa_exc.DBAPIError, sess.flush)
class PolymorphicUnionTest(fixtures.TestBase, testing.AssertsCompiledSQL):
__dialect__ = "default"
def _fixture(self):
t1 = table(
"t1",
column("c1", Integer),
column("c2", Integer),
column("c3", Integer),
)
t2 = table(
"t2",
column("c1", Integer),
column("c2", Integer),
column("c3", Integer),
column("c4", Integer),
)
t3 = table(
"t3",
column("c1", Integer),
column("c3", Integer),
column("c5", Integer),
)
return t1, t2, t3
def test_type_col_present(self):
t1, t2, t3 = self._fixture()
self.assert_compile(
polymorphic_union(
util.OrderedDict([("a", t1), ("b", t2), ("c", t3)]), "q1"
),
"SELECT t1.c1, t1.c2, t1.c3, CAST(NULL AS INTEGER) AS c4, "
"CAST(NULL AS INTEGER) AS c5, 'a' AS q1 FROM t1 UNION ALL "
"SELECT t2.c1, t2.c2, t2.c3, t2.c4, CAST(NULL AS INTEGER) AS c5, "
"'b' AS q1 FROM t2 UNION ALL SELECT t3.c1, "
"CAST(NULL AS INTEGER) AS c2, t3.c3, CAST(NULL AS INTEGER) AS c4, "
"t3.c5, 'c' AS q1 FROM t3",
)
def test_type_col_non_present(self):
t1, t2, t3 = self._fixture()
self.assert_compile(
polymorphic_union(
util.OrderedDict([("a", t1), ("b", t2), ("c", t3)]), None
),
"SELECT t1.c1, t1.c2, t1.c3, CAST(NULL AS INTEGER) AS c4, "
"CAST(NULL AS INTEGER) AS c5 FROM t1 UNION ALL SELECT t2.c1, "
"t2.c2, t2.c3, t2.c4, CAST(NULL AS INTEGER) AS c5 FROM t2 "
"UNION ALL SELECT t3.c1, CAST(NULL AS INTEGER) AS c2, t3.c3, "
"CAST(NULL AS INTEGER) AS c4, t3.c5 FROM t3",
)
def test_no_cast_null(self):
t1, t2, t3 = self._fixture()
self.assert_compile(
polymorphic_union(
util.OrderedDict([("a", t1), ("b", t2), ("c", t3)]),
"q1",
cast_nulls=False,
),
"SELECT t1.c1, t1.c2, t1.c3, NULL AS c4, NULL AS c5, 'a' AS q1 "
"FROM t1 UNION ALL SELECT t2.c1, t2.c2, t2.c3, t2.c4, NULL AS c5, "
"'b' AS q1 FROM t2 UNION ALL SELECT t3.c1, NULL AS c2, t3.c3, "
"NULL AS c4, t3.c5, 'c' AS q1 FROM t3",
)
class DiscriminatorOrPkNoneTest(fixtures.DeclarativeMappedTest):
run_setup_mappers = "once"
__dialect__ = "default"
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class Parent(ComparableEntity, Base):
__tablename__ = "parent"
id = Column(Integer, primary_key=True)
class A(ComparableEntity, Base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
parent_id = Column(ForeignKey("parent.id"))
type = Column(String(50))
__mapper_args__ = {
"polymorphic_on": type,
"polymorphic_identity": "a",
}
class B(A):
__tablename__ = "b"
id = Column(ForeignKey("a.id"), primary_key=True)
__mapper_args__ = {"polymorphic_identity": "b"}
@classmethod
def insert_data(cls, connection):
Parent, A, B = cls.classes("Parent", "A", "B")
with Session(connection) as s:
p1 = Parent(id=1)
p2 = Parent(id=2)
s.add_all([p1, p2])
s.flush()
s.add_all(
[
A(id=1, parent_id=1),
B(id=2, parent_id=1),
A(id=3, parent_id=1),
B(id=4, parent_id=1),
]
)
s.flush()
s.query(A).filter(A.id.in_([3, 4])).update(
{A.type: None}, synchronize_session=False
)
s.commit()
def test_pk_is_null(self):
Parent, A = self.classes("Parent", "A")
sess = fixture_session()
q = (
sess.query(Parent, A)
.select_from(Parent)
.outerjoin(A)
.filter(Parent.id == 2)
)
row = q.all()[0]
eq_(row, (Parent(id=2), None))
def test_pk_not_null_discriminator_null_from_base(self):
(A,) = self.classes("A")
sess = fixture_session()
q = sess.query(A).filter(A.id == 3)
assert_raises_message(
sa_exc.InvalidRequestError,
r"Row with identity key \(<class '.*A'>, \(3,\), None\) can't be "
"loaded into an object; the polymorphic discriminator "
"column 'a.type' is NULL",
q.all,
)
def test_pk_not_null_discriminator_null_from_sub(self):
(B,) = self.classes("B")
sess = fixture_session()
q = sess.query(B).filter(B.id == 4)
assert_raises_message(
sa_exc.InvalidRequestError,
r"Row with identity key \(<class '.*A'>, \(4,\), None\) can't be "
"loaded into an object; the polymorphic discriminator "
"column 'a.type' is NULL",
q.all,
)
class UnexpectedPolymorphicIdentityTest(fixtures.DeclarativeMappedTest):
run_setup_mappers = "once"
__dialect__ = "default"
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class AJoined(ComparableEntity, Base):
__tablename__ = "ajoined"
id = Column(Integer, primary_key=True)
type = Column(String(10), nullable=False)
__mapper_args__ = {
"polymorphic_on": type,
"polymorphic_identity": "a",
}
class AJoinedSubA(AJoined):
__tablename__ = "ajoinedsuba"
id = Column(ForeignKey("ajoined.id"), primary_key=True)
__mapper_args__ = {"polymorphic_identity": "suba"}
class AJoinedSubB(AJoined):
__tablename__ = "ajoinedsubb"
id = Column(ForeignKey("ajoined.id"), primary_key=True)
__mapper_args__ = {"polymorphic_identity": "subb"}
class ASingle(ComparableEntity, Base):
__tablename__ = "asingle"
id = Column(Integer, primary_key=True)
type = Column(String(10), nullable=False)
__mapper_args__ = {
"polymorphic_on": type,
"polymorphic_identity": "a",
}
class ASingleSubA(ASingle):
__mapper_args__ = {"polymorphic_identity": "suba"}
class ASingleSubB(ASingle):
__mapper_args__ = {"polymorphic_identity": "subb"}
@classmethod
def insert_data(cls, connection):
ASingleSubA, ASingleSubB, AJoinedSubA, AJoinedSubB = cls.classes(
"ASingleSubA", "ASingleSubB", "AJoinedSubA", "AJoinedSubB"
)
with Session(connection) as s:
s.add_all(
[ASingleSubA(), ASingleSubB(), AJoinedSubA(), AJoinedSubB()]
)
s.commit()
def test_single_invalid_ident(self):
ASingle, ASingleSubA = self.classes("ASingle", "ASingleSubA")
s = fixture_session()
q = s.query(ASingleSubA).from_statement(select(ASingle))
assert_raises_message(
sa_exc.InvalidRequestError,
r"Row with identity key \(.*ASingle.*\) can't be loaded into an "
r"object; the polymorphic discriminator column '.*.type' refers "
r"to Mapper\[ASingleSubB\(asingle\)\], which is not a "
r"sub-mapper of the requested "
r"Mapper\[ASingleSubA\(asingle\)\]",
q.all,
)
def test_joined_invalid_ident(self):
AJoined, AJoinedSubA = self.classes("AJoined", "AJoinedSubA")
s = fixture_session()
q = s.query(AJoinedSubA).from_statement(select(AJoined))
assert_raises_message(
sa_exc.InvalidRequestError,
r"Row with identity key \(.*AJoined.*\) can't be loaded into an "
r"object; the polymorphic discriminator column '.*.type' refers "
r"to Mapper\[AJoinedSubB\(ajoinedsubb\)\], which is "
"not a "
r"sub-mapper of the requested "
r"Mapper\[AJoinedSubA\(ajoinedsuba\)\]",
q.all,
)
class CompositeJoinedInTest(fixtures.DeclarativeMappedTest):
"""test #9164"""
run_setup_mappers = "once"
__dialect__ = "default"
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(ComparableEntity, Base):
__tablename__ = "table_a"
order_id: Mapped[str] = mapped_column(String(50), primary_key=True)
_sku: Mapped[str] = mapped_column(String(50), primary_key=True)
__mapper_args__ = {
"polymorphic_identity": "a",
"polymorphic_on": "type",
}
type: Mapped[str]
def __init__(self, order_id: str, sku: str):
self.order_id = order_id
self._sku = sku
class B(A):
__tablename__ = "table_b"
_increment_id: Mapped[str] = mapped_column(
String(50), primary_key=True
)
_sku: Mapped[str] = mapped_column(String(50), primary_key=True)
__table_args__ = (
ForeignKeyConstraint(
["_increment_id", "_sku"],
["table_a.order_id", "table_a._sku"],
),
)
__mapper_args__ = {"polymorphic_identity": "b"}
def test_round_trip(self):
B = self.classes.B
sess = fixture_session()
b1 = B(order_id="iid1", sku="sku1")
sess.add(b1)
sess.commit()
eq_(sess.scalar(select(B)), b1)
class NameConflictTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"content",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("type", String(30)),
)
Table(
"foo",
metadata,
Column("id", Integer, ForeignKey("content.id"), primary_key=True),
Column("content_type", String(30)),
)
def test_name_conflict(self):
class Content:
pass
class Foo(Content):
pass
self.mapper_registry.map_imperatively(
Content,
self.tables.content,
polymorphic_on=self.tables.content.c.type,
)
self.mapper_registry.map_imperatively(
Foo, self.tables.foo, inherits=Content, polymorphic_identity="foo"
)
sess = fixture_session()
f = Foo()
f.content_type = "bar"
sess.add(f)
sess.flush()
f_id = f.id
sess.expunge_all()
assert sess.get(Content, f_id).content_type == "bar"