Files
sqlalchemy/test/orm/test_bind.py
T
Mike Bayer 91f376692d Add future=True to create_engine/Session; unify select()
Several weeks of using the future_select() construct
has led to the proposal there be just one select() construct
again which features the new join() method, and otherwise accepts
both the 1.x and 2.x argument styles.   This would make
migration simpler and reduce confusion.

However, confusion may be increased by the fact that select().join()
is different  Current thinking is we may be better off
with a few hard behavioral changes to old and relatively unknown APIs
rather than trying to play both sides within two extremely similar
but subtly different APIs.  At the moment, the .join() thing seems
to be the only behavioral change that occurs without the user
taking any explicit steps.   Session.execute() will still
behave the old way as we are adding a future flag.

This change also adds the "future" flag to Session() and
session.execute(), so that interpretation of the incoming statement,
as well as that the new style result is returned, does not
occur for existing applications unless they add the use
of this flag.

The change in general is moving the "removed in 2.0" system
further along where we want the test suite to fully pass
even if the SQLALCHEMY_WARN_20 flag is set.

Get many tests to pass when SQLALCHEMY_WARN_20 is set; this
should be ongoing after this patch merges.

Improve the RemovedIn20 warning; these are all deprecated
"since" 1.4, so ensure that's what the messages read.
Make sure the inforamtion link is on all warnings.
Add deprecation warnings for parameters present and
add warnings to all FromClause.select() types of methods.

Fixes: #5379
Fixes: #5284
Change-Id: I765a0b912b3dcd0e995426427d8bb7997cbffd51
References: #5159
2020-07-08 11:05:11 -04:00

716 lines
21 KiB
Python

import sqlalchemy as sa
from sqlalchemy import ForeignKey
from sqlalchemy import inspect
from sqlalchemy import Integer
from sqlalchemy import MetaData
from sqlalchemy import select
from sqlalchemy import table
from sqlalchemy import testing
from sqlalchemy import true
from sqlalchemy.orm import backref
from sqlalchemy.orm import create_session
from sqlalchemy.orm import mapper
from sqlalchemy.orm import relationship
from sqlalchemy.orm import Session
from sqlalchemy.orm import sessionmaker
from sqlalchemy.orm.query import Query
from sqlalchemy.testing import assert_raises_message
from sqlalchemy.testing import engines
from sqlalchemy.testing import eq_
from sqlalchemy.testing import fixtures
from sqlalchemy.testing import is_
from sqlalchemy.testing import mock
from sqlalchemy.testing.mock import Mock
from sqlalchemy.testing.schema import Column
from sqlalchemy.testing.schema import Table
from test.orm import _fixtures
class BindIntegrationTest(_fixtures.FixtureTest):
run_inserts = None
def test_mapped_binds(self):
Address, addresses, users, User = (
self.classes.Address,
self.tables.addresses,
self.tables.users,
self.classes.User,
)
# ensure tables are unbound
m2 = sa.MetaData()
users_unbound = users.to_metadata(m2)
addresses_unbound = addresses.to_metadata(m2)
mapper(Address, addresses_unbound)
mapper(
User,
users_unbound,
properties={
"addresses": relationship(
Address,
backref=backref("user", cascade="all"),
cascade="all",
)
},
)
sess = Session(
binds={User: self.metadata.bind, Address: self.metadata.bind}
)
u1 = User(id=1, name="ed")
sess.add(u1)
eq_(
sess.query(User).filter(User.id == 1).all(),
[User(id=1, name="ed")],
)
# test expression binding
sess.execute(users_unbound.insert(), params=dict(id=2, name="jack"))
eq_(
sess.execute(
users_unbound.select(users_unbound.c.id == 2)
).fetchall(),
[(2, "jack")],
)
eq_(
sess.execute(users_unbound.select(User.id == 2)).fetchall(),
[(2, "jack")],
)
sess.execute(users_unbound.delete())
eq_(sess.execute(users_unbound.select()).fetchall(), [])
sess.close()
def test_table_binds(self):
Address, addresses, users, User = (
self.classes.Address,
self.tables.addresses,
self.tables.users,
self.classes.User,
)
# ensure tables are unbound
m2 = sa.MetaData()
users_unbound = users.to_metadata(m2)
addresses_unbound = addresses.to_metadata(m2)
mapper(Address, addresses_unbound)
mapper(
User,
users_unbound,
properties={
"addresses": relationship(
Address,
backref=backref("user", cascade="all"),
cascade="all",
)
},
)
Session = sessionmaker(
binds={
users_unbound: self.metadata.bind,
addresses_unbound: self.metadata.bind,
}
)
sess = Session()
u1 = User(id=1, name="ed")
sess.add(u1)
eq_(
sess.query(User).filter(User.id == 1).all(),
[User(id=1, name="ed")],
)
sess.execute(users_unbound.insert(), params=dict(id=2, name="jack"))
eq_(
sess.execute(
users_unbound.select(users_unbound.c.id == 2)
).fetchall(),
[(2, "jack")],
)
eq_(
sess.execute(users_unbound.select(User.id == 2)).fetchall(),
[(2, "jack")],
)
sess.execute(users_unbound.delete())
eq_(sess.execute(users_unbound.select()).fetchall(), [])
sess.close()
def test_bind_from_metadata(self):
users, User = self.tables.users, self.classes.User
mapper(User, users)
session = create_session()
session.execute(users.insert(), dict(name="Johnny"))
assert len(session.query(User).filter_by(name="Johnny").all()) == 1
session.execute(users.delete())
assert len(session.query(User).filter_by(name="Johnny").all()) == 0
session.close()
@testing.combinations(
(lambda: {}, "e3"),
(lambda e1: {"bind": e1}, "e1"),
(lambda e1, Address: {"bind": e1, "mapper": Address}, "e1"),
(
lambda e1, Address: {
"bind": e1,
"clause": Query([Address])._statement_20(),
},
"e1",
),
(lambda Address: {"mapper": Address}, "e2"),
(lambda Address: {"clause": Query([Address])._statement_20()}, "e2"),
(lambda addresses: {"clause": select(addresses)}, "e2"),
(
lambda User, addresses: {
"mapper": User,
"clause": select(addresses),
},
"e1",
),
(
lambda e2, User, addresses: {
"mapper": User,
"clause": select(addresses),
"bind": e2,
},
"e2",
),
(
lambda User, Address: {
"clause": select(1).join_from(User, Address)
},
"e1",
),
(
lambda User, Address: {
"clause": select(1).join_from(Address, User)
},
"e2",
),
(lambda User: {"clause": select(1).where(User.name == "ed")}, "e1",),
(lambda: {"clause": select(1)}, "e3"),
(lambda User: {"clause": Query([User])._statement_20()}, "e1"),
(lambda: {"clause": Query([1])._statement_20()}, "e3"),
(
lambda User: {
"clause": Query([1]).select_from(User)._statement_20()
},
"e1",
),
(
lambda User: {
"clause": Query([1])
.select_from(User)
.join(User.addresses)
._statement_20()
},
"e1",
),
(
# forcing the "onclause" argument to be considered
# in visitors.iterate()
lambda User: {
"clause": Query([1])
.select_from(User)
.join(table("foo"), User.addresses)
._statement_20()
},
"e1",
),
(
lambda User: {
"clause": select(1).select_from(User).join(User.addresses)
},
"e1",
),
)
def test_get_bind(self, testcase, expected):
users, Address, addresses, User = (
self.tables.users,
self.classes.Address,
self.tables.addresses,
self.classes.User,
)
mapper(User, users, properties={"addresses": relationship(Address)})
mapper(Address, addresses)
e1 = engines.testing_engine()
e2 = engines.testing_engine()
e3 = engines.testing_engine()
testcase = testing.resolve_lambda(
testcase,
User=User,
Address=Address,
e1=e1,
e2=e2,
e3=e3,
addresses=addresses,
)
sess = Session(e3)
sess.bind_mapper(User, e1)
sess.bind_mapper(Address, e2)
engine = {"e1": e1, "e2": e2, "e3": e3}[expected]
conn = sess.connection(**testcase)
is_(conn.engine, engine)
sess.close()
@testing.combinations(
(
lambda session, Address: session.query(Address),
lambda Address: {"mapper": inspect(Address), "clause": mock.ANY},
"e2",
),
(lambda: select(1), lambda: {"clause": mock.ANY}, "e3"),
(
lambda User, Address: select(1).join_from(User, Address),
lambda User: {"clause": mock.ANY, "mapper": inspect(User)},
"e1",
),
(
lambda User, Address: select(1).join_from(Address, User),
lambda Address: {"clause": mock.ANY, "mapper": inspect(Address)},
"e2",
),
(
lambda User: select(1).where(User.name == "ed"),
# no mapper for this one because the plugin is not "orm"
lambda User: {"clause": mock.ANY},
"e1",
),
(
lambda User: select(1).select_from(User).where(User.name == "ed"),
lambda User: {"clause": mock.ANY, "mapper": inspect(User)},
"e1",
),
(
lambda User: select(User.id),
lambda User: {"clause": mock.ANY, "mapper": inspect(User)},
"e1",
),
)
def test_bind_through_execute(
self, statement, expected_get_bind_args, expected_engine_name
):
users, Address, addresses, User = (
self.tables.users,
self.classes.Address,
self.tables.addresses,
self.classes.User,
)
mapper(User, users, properties={"addresses": relationship(Address)})
mapper(Address, addresses)
e1 = engines.testing_engine()
e2 = engines.testing_engine()
e3 = engines.testing_engine()
canary = mock.Mock()
class GetBindSession(Session):
def _connection_for_bind(self, bind, **kw):
canary._connection_for_bind(bind, **kw)
return mock.Mock()
def get_bind(self, **kw):
canary.get_bind(**kw)
return Session.get_bind(self, **kw)
sess = GetBindSession(e3, future=True)
sess.bind_mapper(User, e1)
sess.bind_mapper(Address, e2)
lambda_args = dict(
session=sess,
User=User,
Address=Address,
e1=e1,
e2=e2,
e3=e3,
addresses=addresses,
)
statement = testing.resolve_lambda(statement, **lambda_args)
expected_get_bind_args = testing.resolve_lambda(
expected_get_bind_args, **lambda_args
)
engine = {"e1": e1, "e2": e2, "e3": e3}[expected_engine_name]
with mock.patch(
"sqlalchemy.orm.context.ORMCompileState.orm_setup_cursor_result"
):
sess.execute(statement)
eq_(
canary.mock_calls,
[
mock.call.get_bind(**expected_get_bind_args),
mock.call._connection_for_bind(engine, close_with_result=True),
],
)
sess.close()
def test_bind_arg(self):
sess = Session()
assert_raises_message(
sa.exc.ArgumentError,
"Not an acceptable bind target: foobar",
sess.bind_mapper,
"foobar",
testing.db,
)
mapper(self.classes.User, self.tables.users)
u_object = self.classes.User()
assert_raises_message(
sa.exc.ArgumentError,
"Not an acceptable bind target: User()",
sess.bind_mapper,
u_object,
testing.db,
)
@engines.close_open_connections
def test_bound_connection(self):
users, User = self.tables.users, self.classes.User
mapper(User, users)
c = testing.db.connect()
sess = create_session(bind=c)
sess.begin()
transaction = sess.transaction
u = User(name="u1")
sess.add(u)
sess.flush()
assert (
transaction._connection_for_bind(testing.db, None)
is transaction._connection_for_bind(c, None)
is c
)
assert_raises_message(
sa.exc.InvalidRequestError,
"Session already has a Connection " "associated",
transaction._connection_for_bind,
testing.db.connect(),
None,
)
transaction.rollback()
assert len(sess.query(User).all()) == 0
sess.close()
def test_bound_connection_transactional(self):
User, users = self.classes.User, self.tables.users
mapper(User, users)
c = testing.db.connect()
sess = create_session(bind=c, autocommit=False)
u = User(name="u1")
sess.add(u)
sess.flush()
sess.close()
assert not c.in_transaction()
assert c.exec_driver_sql("select count(1) from users").scalar() == 0
sess = create_session(bind=c, autocommit=False)
u = User(name="u2")
sess.add(u)
sess.flush()
sess.commit()
assert not c.in_transaction()
assert c.exec_driver_sql("select count(1) from users").scalar() == 1
c.exec_driver_sql("delete from users")
assert c.exec_driver_sql("select count(1) from users").scalar() == 0
c = testing.db.connect()
trans = c.begin()
sess = create_session(bind=c, autocommit=True)
u = User(name="u3")
sess.add(u)
sess.flush()
assert c.in_transaction()
trans.commit()
assert not c.in_transaction()
assert c.exec_driver_sql("select count(1) from users").scalar() == 1
class SessionBindTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"test_table",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", Integer),
)
@classmethod
def setup_classes(cls):
class Foo(cls.Basic):
pass
@classmethod
def setup_mappers(cls):
test_table, Foo = cls.tables.test_table, cls.classes.Foo
meta = MetaData()
test_table.to_metadata(meta)
assert meta.tables["test_table"].bind is None
mapper(Foo, meta.tables["test_table"])
def test_session_bind(self):
Foo = self.classes.Foo
engine = self.metadata.bind
for bind in (engine, engine.connect()):
try:
sess = create_session(bind=bind)
assert sess.bind is bind
f = Foo()
sess.add(f)
sess.flush()
assert sess.query(Foo).get(f.id) is f
finally:
if hasattr(bind, "close"):
bind.close()
def test_session_unbound(self):
Foo = self.classes.Foo
sess = create_session()
sess.add(Foo())
assert_raises_message(
sa.exc.UnboundExecutionError,
(
"Could not locate a bind configured on Mapper|Foo|test_table "
"or this Session"
),
sess.flush,
)
class GetBindTest(fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table("base_table", metadata, Column("id", Integer, primary_key=True))
Table(
"w_mixin_table", metadata, Column("id", Integer, primary_key=True)
)
Table(
"joined_sub_table",
metadata,
Column("id", ForeignKey("base_table.id"), primary_key=True),
)
Table(
"concrete_sub_table",
metadata,
Column("id", Integer, primary_key=True),
)
@classmethod
def setup_classes(cls):
class MixinOne(cls.Basic):
pass
class BaseClass(cls.Basic):
pass
class ClassWMixin(MixinOne, cls.Basic):
pass
class JoinedSubClass(BaseClass):
pass
class ConcreteSubClass(BaseClass):
pass
@classmethod
def setup_mappers(cls):
mapper(cls.classes.ClassWMixin, cls.tables.w_mixin_table)
mapper(cls.classes.BaseClass, cls.tables.base_table)
mapper(
cls.classes.JoinedSubClass,
cls.tables.joined_sub_table,
inherits=cls.classes.BaseClass,
)
mapper(
cls.classes.ConcreteSubClass,
cls.tables.concrete_sub_table,
inherits=cls.classes.BaseClass,
concrete=True,
)
def _fixture(self, binds):
return Session(binds=binds)
def test_fallback_table_metadata(self):
session = self._fixture({})
is_(session.get_bind(self.classes.BaseClass), testing.db)
def test_bind_base_table_base_class(self):
base_class_bind = Mock()
session = self._fixture({self.tables.base_table: base_class_bind})
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
def test_bind_base_table_joined_sub_class(self):
base_class_bind = Mock()
session = self._fixture({self.tables.base_table: base_class_bind})
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
is_(session.get_bind(self.classes.JoinedSubClass), base_class_bind)
def test_bind_joined_sub_table_joined_sub_class(self):
base_class_bind = Mock(name="base")
joined_class_bind = Mock(name="joined")
session = self._fixture(
{
self.tables.base_table: base_class_bind,
self.tables.joined_sub_table: joined_class_bind,
}
)
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
# joined table inheritance has to query based on the base
# table, so this is what we expect
is_(session.get_bind(self.classes.JoinedSubClass), base_class_bind)
def test_bind_base_table_concrete_sub_class(self):
base_class_bind = Mock()
session = self._fixture({self.tables.base_table: base_class_bind})
is_(session.get_bind(self.classes.ConcreteSubClass), testing.db)
def test_bind_sub_table_concrete_sub_class(self):
base_class_bind = Mock(name="base")
concrete_sub_bind = Mock(name="concrete")
session = self._fixture(
{
self.tables.base_table: base_class_bind,
self.tables.concrete_sub_table: concrete_sub_bind,
}
)
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
is_(session.get_bind(self.classes.ConcreteSubClass), concrete_sub_bind)
def test_bind_base_class_base_class(self):
base_class_bind = Mock()
session = self._fixture({self.classes.BaseClass: base_class_bind})
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
def test_bind_mixin_class_simple_class(self):
base_class_bind = Mock()
session = self._fixture({self.classes.MixinOne: base_class_bind})
is_(session.get_bind(self.classes.ClassWMixin), base_class_bind)
def test_bind_base_class_joined_sub_class(self):
base_class_bind = Mock()
session = self._fixture({self.classes.BaseClass: base_class_bind})
is_(session.get_bind(self.classes.JoinedSubClass), base_class_bind)
def test_bind_joined_sub_class_joined_sub_class(self):
base_class_bind = Mock(name="base")
joined_class_bind = Mock(name="joined")
session = self._fixture(
{
self.classes.BaseClass: base_class_bind,
self.classes.JoinedSubClass: joined_class_bind,
}
)
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
is_(session.get_bind(self.classes.JoinedSubClass), joined_class_bind)
def test_bind_base_class_concrete_sub_class(self):
base_class_bind = Mock()
session = self._fixture({self.classes.BaseClass: base_class_bind})
is_(session.get_bind(self.classes.ConcreteSubClass), base_class_bind)
def test_bind_sub_class_concrete_sub_class(self):
base_class_bind = Mock(name="base")
concrete_sub_bind = Mock(name="concrete")
session = self._fixture(
{
self.classes.BaseClass: base_class_bind,
self.classes.ConcreteSubClass: concrete_sub_bind,
}
)
is_(session.get_bind(self.classes.BaseClass), base_class_bind)
is_(session.get_bind(self.classes.ConcreteSubClass), concrete_sub_bind)
@testing.fixture
def two_table_fixture(self):
base_class_bind = Mock(name="base")
concrete_sub_bind = Mock(name="concrete")
session = self._fixture(
{
self.tables.base_table: base_class_bind,
self.tables.concrete_sub_table: concrete_sub_bind,
}
)
return session, base_class_bind, concrete_sub_bind
def test_bind_selectable_table(self, two_table_fixture):
session, base_class_bind, concrete_sub_bind = two_table_fixture
is_(session.get_bind(clause=self.tables.base_table), base_class_bind)
is_(
session.get_bind(clause=self.tables.concrete_sub_table),
concrete_sub_bind,
)
def test_bind_selectable_join(self, two_table_fixture):
session, base_class_bind, concrete_sub_bind = two_table_fixture
stmt = self.tables.base_table.join(
self.tables.concrete_sub_table, true()
)
is_(session.get_bind(clause=stmt), base_class_bind)
def test_bind_selectable_union(self, two_table_fixture):
session, base_class_bind, concrete_sub_bind = two_table_fixture
stmt = select(self.tables.base_table).union(
select(self.tables.concrete_sub_table)
)
is_(session.get_bind(clause=stmt), base_class_bind)