Files
sqlalchemy/test/ext/test_mutable.py
Mike Bayer 18abd47af3 Post black reformatting
Applied on top of a pure run of black -l 79 in
I7eda77fed3d8e73df84b3651fd6cfcfe858d4dc9,  this set of changes
resolves all remaining flake8 conditions for those codes
we have enabled in setup.cfg.

Included are resolutions for all remaining flake8 issues
including shadowed builtins, long lines, import order, unused
imports, duplicate imports, and docstring issues.

Change-Id: I4f72d3ba1380dd601610ff80b8fb06a2aff8b0fe
2019-01-06 11:51:20 -05:00

1414 lines
33 KiB
Python

from sqlalchemy import event
from sqlalchemy import ForeignKey
from sqlalchemy import func
from sqlalchemy import Integer
from sqlalchemy import String
from sqlalchemy.ext.mutable import MutableComposite
from sqlalchemy.ext.mutable import MutableDict
from sqlalchemy.ext.mutable import MutableList
from sqlalchemy.ext.mutable import MutableSet
from sqlalchemy.orm import attributes
from sqlalchemy.orm import column_property
from sqlalchemy.orm import composite
from sqlalchemy.orm import mapper
from sqlalchemy.orm import Session
from sqlalchemy.orm.instrumentation import ClassManager
from sqlalchemy.orm.mapper import Mapper
from sqlalchemy.testing import assert_raises
from sqlalchemy.testing import assert_raises_message
from sqlalchemy.testing import eq_
from sqlalchemy.testing import fixtures
from sqlalchemy.testing import mock
from sqlalchemy.testing.schema import Column
from sqlalchemy.testing.schema import Table
from sqlalchemy.testing.util import picklers
from sqlalchemy.types import PickleType
from sqlalchemy.types import TypeDecorator
from sqlalchemy.types import VARCHAR
class Foo(fixtures.BasicEntity):
pass
class SubFoo(Foo):
pass
class FooWithEq(object):
def __init__(self, **kw):
for k in kw:
setattr(self, k, kw[k])
def __hash__(self):
return hash(self.id)
def __eq__(self, other):
return self.id == other.id
class Point(MutableComposite):
def __init__(self, x, y):
self.x = x
self.y = y
def __setattr__(self, key, value):
object.__setattr__(self, key, value)
self.changed()
def __composite_values__(self):
return self.x, self.y
def __getstate__(self):
return self.x, self.y
def __setstate__(self, state):
self.x, self.y = state
def __eq__(self, other):
return (
isinstance(other, Point)
and other.x == self.x
and other.y == self.y
)
class MyPoint(Point):
@classmethod
def coerce(cls, key, value):
if isinstance(value, tuple):
value = Point(*value)
return value
class _MutableDictTestFixture(object):
@classmethod
def _type_fixture(cls):
return MutableDict
def teardown(self):
# clear out mapper events
Mapper.dispatch._clear()
ClassManager.dispatch._clear()
super(_MutableDictTestFixture, self).teardown()
class _MutableDictTestBase(_MutableDictTestFixture):
run_define_tables = "each"
def setup_mappers(cls):
foo = cls.tables.foo
mapper(Foo, foo)
def test_coerce_none(self):
sess = Session()
f1 = Foo(data=None)
sess.add(f1)
sess.commit()
eq_(f1.data, None)
def test_coerce_raise(self):
assert_raises_message(
ValueError,
"Attribute 'data' does not accept objects of type",
Foo,
data=set([1, 2, 3]),
)
def test_in_place_mutation(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.commit()
f1.data["a"] = "c"
sess.commit()
eq_(f1.data, {"a": "c"})
def test_modified_event(self):
canary = mock.Mock()
event.listen(Foo.data, "modified", canary)
f1 = Foo(data={"a": "b"})
f1.data["a"] = "c"
eq_(
canary.mock_calls,
[
mock.call(
f1, attributes.Event(Foo.data.impl, attributes.OP_MODIFIED)
)
],
)
def test_clear(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.commit()
f1.data.clear()
sess.commit()
eq_(f1.data, {})
def test_update(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.commit()
f1.data.update({"a": "z"})
sess.commit()
eq_(f1.data, {"a": "z"})
def test_pop(self):
sess = Session()
f1 = Foo(data={"a": "b", "c": "d"})
sess.add(f1)
sess.commit()
eq_(f1.data.pop("a"), "b")
sess.commit()
assert_raises(KeyError, f1.data.pop, "g")
eq_(f1.data, {"c": "d"})
def test_pop_default(self):
sess = Session()
f1 = Foo(data={"a": "b", "c": "d"})
sess.add(f1)
sess.commit()
eq_(f1.data.pop("a", "q"), "b")
eq_(f1.data.pop("a", "q"), "q")
sess.commit()
eq_(f1.data, {"c": "d"})
def test_popitem(self):
sess = Session()
orig = {"a": "b", "c": "d"}
# the orig dict remains unchanged when we assign,
# but just making this future-proof
data = dict(orig)
f1 = Foo(data=data)
sess.add(f1)
sess.commit()
k, v = f1.data.popitem()
assert k in ("a", "c")
orig.pop(k)
sess.commit()
eq_(f1.data, orig)
def test_setdefault(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.commit()
eq_(f1.data.setdefault("c", "d"), "d")
sess.commit()
eq_(f1.data, {"a": "b", "c": "d"})
eq_(f1.data.setdefault("c", "q"), "d")
sess.commit()
eq_(f1.data, {"a": "b", "c": "d"})
def test_replace(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.flush()
f1.data = {"b": "c"}
sess.commit()
eq_(f1.data, {"b": "c"})
def test_replace_itself_still_ok(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.flush()
f1.data = f1.data
f1.data["b"] = "c"
sess.commit()
eq_(f1.data, {"a": "b", "b": "c"})
def test_pickle_parent(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.commit()
f1.data
sess.close()
for loads, dumps in picklers():
sess = Session()
f2 = loads(dumps(f1))
sess.add(f2)
f2.data["a"] = "c"
assert f2 in sess.dirty
def test_unrelated_flush(self):
sess = Session()
f1 = Foo(data={"a": "b"}, unrelated_data="unrelated")
sess.add(f1)
sess.flush()
f1.unrelated_data = "unrelated 2"
sess.flush()
f1.data["a"] = "c"
sess.commit()
eq_(f1.data["a"], "c")
def _test_non_mutable(self):
sess = Session()
f1 = Foo(non_mutable_data={"a": "b"})
sess.add(f1)
sess.commit()
f1.non_mutable_data["a"] = "c"
sess.commit()
eq_(f1.non_mutable_data, {"a": "b"})
class _MutableListTestFixture(object):
@classmethod
def _type_fixture(cls):
return MutableList
def teardown(self):
# clear out mapper events
Mapper.dispatch._clear()
ClassManager.dispatch._clear()
super(_MutableListTestFixture, self).teardown()
class _MutableListTestBase(_MutableListTestFixture):
run_define_tables = "each"
def setup_mappers(cls):
foo = cls.tables.foo
mapper(Foo, foo)
def test_coerce_none(self):
sess = Session()
f1 = Foo(data=None)
sess.add(f1)
sess.commit()
eq_(f1.data, None)
def test_coerce_raise(self):
assert_raises_message(
ValueError,
"Attribute 'data' does not accept objects of type",
Foo,
data=set([1, 2, 3]),
)
def test_in_place_mutation(self):
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data[0] = 3
sess.commit()
eq_(f1.data, [3, 2])
def test_in_place_slice_mutation(self):
sess = Session()
f1 = Foo(data=[1, 2, 3, 4])
sess.add(f1)
sess.commit()
f1.data[1:3] = 5, 6
sess.commit()
eq_(f1.data, [1, 5, 6, 4])
def test_del_slice(self):
sess = Session()
f1 = Foo(data=[1, 2, 3, 4])
sess.add(f1)
sess.commit()
del f1.data[1:3]
sess.commit()
eq_(f1.data, [1, 4])
def test_clear(self):
if not hasattr(list, "clear"):
# py2 list doesn't have 'clear'
return
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data.clear()
sess.commit()
eq_(f1.data, [])
def test_pop(self):
sess = Session()
f1 = Foo(data=[1, 2, 3])
sess.add(f1)
sess.commit()
eq_(f1.data.pop(), 3)
eq_(f1.data.pop(0), 1)
sess.commit()
assert_raises(IndexError, f1.data.pop, 5)
eq_(f1.data, [2])
def test_append(self):
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data.append(5)
sess.commit()
eq_(f1.data, [1, 2, 5])
def test_extend(self):
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data.extend([5])
sess.commit()
eq_(f1.data, [1, 2, 5])
def test_operator_extend(self):
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data += [5]
sess.commit()
eq_(f1.data, [1, 2, 5])
def test_insert(self):
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data.insert(1, 5)
sess.commit()
eq_(f1.data, [1, 5, 2])
def test_remove(self):
sess = Session()
f1 = Foo(data=[1, 2, 3])
sess.add(f1)
sess.commit()
f1.data.remove(2)
sess.commit()
eq_(f1.data, [1, 3])
def test_sort(self):
sess = Session()
f1 = Foo(data=[1, 3, 2])
sess.add(f1)
sess.commit()
f1.data.sort()
sess.commit()
eq_(f1.data, [1, 2, 3])
def test_reverse(self):
sess = Session()
f1 = Foo(data=[1, 3, 2])
sess.add(f1)
sess.commit()
f1.data.reverse()
sess.commit()
eq_(f1.data, [2, 3, 1])
def test_pickle_parent(self):
sess = Session()
f1 = Foo(data=[1, 2])
sess.add(f1)
sess.commit()
f1.data
sess.close()
for loads, dumps in picklers():
sess = Session()
f2 = loads(dumps(f1))
sess.add(f2)
f2.data[0] = 3
assert f2 in sess.dirty
def test_unrelated_flush(self):
sess = Session()
f1 = Foo(data=[1, 2], unrelated_data="unrelated")
sess.add(f1)
sess.flush()
f1.unrelated_data = "unrelated 2"
sess.flush()
f1.data[0] = 3
sess.commit()
eq_(f1.data[0], 3)
class _MutableSetTestFixture(object):
@classmethod
def _type_fixture(cls):
return MutableSet
def teardown(self):
# clear out mapper events
Mapper.dispatch._clear()
ClassManager.dispatch._clear()
super(_MutableSetTestFixture, self).teardown()
class _MutableSetTestBase(_MutableSetTestFixture):
run_define_tables = "each"
def setup_mappers(cls):
foo = cls.tables.foo
mapper(Foo, foo)
def test_coerce_none(self):
sess = Session()
f1 = Foo(data=None)
sess.add(f1)
sess.commit()
eq_(f1.data, None)
def test_coerce_raise(self):
assert_raises_message(
ValueError,
"Attribute 'data' does not accept objects of type",
Foo,
data=[1, 2, 3],
)
def test_clear(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data.clear()
sess.commit()
eq_(f1.data, set())
def test_pop(self):
sess = Session()
f1 = Foo(data=set([1]))
sess.add(f1)
sess.commit()
eq_(f1.data.pop(), 1)
sess.commit()
assert_raises(KeyError, f1.data.pop)
eq_(f1.data, set())
def test_add(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data.add(5)
sess.commit()
eq_(f1.data, set([1, 2, 5]))
def test_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data.update(set([2, 5]))
sess.commit()
eq_(f1.data, set([1, 2, 5]))
def test_binary_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data |= set([2, 5])
sess.commit()
eq_(f1.data, set([1, 2, 5]))
def test_intersection_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data.intersection_update(set([2, 5]))
sess.commit()
eq_(f1.data, set([2]))
def test_binary_intersection_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data &= set([2, 5])
sess.commit()
eq_(f1.data, set([2]))
def test_difference_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data.difference_update(set([2, 5]))
sess.commit()
eq_(f1.data, set([1]))
def test_operator_difference_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data -= set([2, 5])
sess.commit()
eq_(f1.data, set([1]))
def test_symmetric_difference_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data.symmetric_difference_update(set([2, 5]))
sess.commit()
eq_(f1.data, set([1, 5]))
def test_binary_symmetric_difference_update(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data ^= set([2, 5])
sess.commit()
eq_(f1.data, set([1, 5]))
def test_remove(self):
sess = Session()
f1 = Foo(data=set([1, 2, 3]))
sess.add(f1)
sess.commit()
f1.data.remove(2)
sess.commit()
eq_(f1.data, set([1, 3]))
def test_discard(self):
sess = Session()
f1 = Foo(data=set([1, 2, 3]))
sess.add(f1)
sess.commit()
f1.data.discard(2)
sess.commit()
eq_(f1.data, set([1, 3]))
f1.data.discard(2)
sess.commit()
eq_(f1.data, set([1, 3]))
def test_pickle_parent(self):
sess = Session()
f1 = Foo(data=set([1, 2]))
sess.add(f1)
sess.commit()
f1.data
sess.close()
for loads, dumps in picklers():
sess = Session()
f2 = loads(dumps(f1))
sess.add(f2)
f2.data.add(3)
assert f2 in sess.dirty
def test_unrelated_flush(self):
sess = Session()
f1 = Foo(data=set([1, 2]), unrelated_data="unrelated")
sess.add(f1)
sess.flush()
f1.unrelated_data = "unrelated 2"
sess.flush()
f1.data.add(3)
sess.commit()
eq_(f1.data, set([1, 2, 3]))
class MutableColumnDefaultTest(_MutableDictTestFixture, fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
MutableDict = cls._type_fixture()
mutable_pickle = MutableDict.as_mutable(PickleType)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", mutable_pickle, default={}),
)
def setup_mappers(cls):
foo = cls.tables.foo
mapper(Foo, foo)
def test_evt_on_flush_refresh(self):
# test for #3427
sess = Session()
f1 = Foo()
sess.add(f1)
sess.flush()
assert isinstance(f1.data, self._type_fixture())
assert f1 not in sess.dirty
f1.data["foo"] = "bar"
assert f1 in sess.dirty
class MutableWithScalarPickleTest(_MutableDictTestBase, fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
MutableDict = cls._type_fixture()
mutable_pickle = MutableDict.as_mutable(PickleType)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("skip", mutable_pickle),
Column("data", mutable_pickle),
Column("non_mutable_data", PickleType),
Column("unrelated_data", String(50)),
)
def test_non_mutable(self):
self._test_non_mutable()
class MutableWithScalarJSONTest(_MutableDictTestBase, fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
import json
class JSONEncodedDict(TypeDecorator):
impl = VARCHAR(50)
def process_bind_param(self, value, dialect):
if value is not None:
value = json.dumps(value)
return value
def process_result_value(self, value, dialect):
if value is not None:
value = json.loads(value)
return value
MutableDict = cls._type_fixture()
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", MutableDict.as_mutable(JSONEncodedDict)),
Column("non_mutable_data", JSONEncodedDict),
Column("unrelated_data", String(50)),
)
def test_non_mutable(self):
self._test_non_mutable()
class MutableIncludeNonPrimaryTest(MutableWithScalarJSONTest):
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
mapper(Foo, foo)
mapper(Foo, foo, non_primary=True, properties={"foo_bar": foo.c.data})
class MutableColumnCopyJSONTest(_MutableDictTestBase, fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
import json
from sqlalchemy.ext.declarative import declarative_base
class JSONEncodedDict(TypeDecorator):
impl = VARCHAR(50)
def process_bind_param(self, value, dialect):
if value is not None:
value = json.dumps(value)
return value
def process_result_value(self, value, dialect):
if value is not None:
value = json.loads(value)
return value
MutableDict = cls._type_fixture()
Base = declarative_base(metadata=metadata)
class AbstractFoo(Base):
__abstract__ = True
id = Column(
Integer, primary_key=True, test_needs_autoincrement=True
)
data = Column(MutableDict.as_mutable(JSONEncodedDict))
non_mutable_data = Column(JSONEncodedDict)
unrelated_data = Column(String(50))
class Foo(AbstractFoo):
__tablename__ = "foo"
column_prop = column_property(
func.lower(AbstractFoo.unrelated_data)
)
assert Foo.data.property.columns[0].type is not AbstractFoo.data.type
def test_non_mutable(self):
self._test_non_mutable()
class MutableColumnCopyArrayTest(_MutableListTestBase, fixtures.MappedTest):
__requires__ = ("array_type",)
@classmethod
def define_tables(cls, metadata):
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.sql.sqltypes import ARRAY
MutableList = cls._type_fixture()
Base = declarative_base(metadata=metadata)
class Mixin(object):
data = Column(MutableList.as_mutable(ARRAY(Integer)))
class Foo(Mixin, Base):
__tablename__ = "foo"
id = Column(Integer, primary_key=True)
class MutableListWithScalarPickleTest(
_MutableListTestBase, fixtures.MappedTest
):
@classmethod
def define_tables(cls, metadata):
MutableList = cls._type_fixture()
mutable_pickle = MutableList.as_mutable(PickleType)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("skip", mutable_pickle),
Column("data", mutable_pickle),
Column("non_mutable_data", PickleType),
Column("unrelated_data", String(50)),
)
class MutableSetWithScalarPickleTest(_MutableSetTestBase, fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
MutableSet = cls._type_fixture()
mutable_pickle = MutableSet.as_mutable(PickleType)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("skip", mutable_pickle),
Column("data", mutable_pickle),
Column("non_mutable_data", PickleType),
Column("unrelated_data", String(50)),
)
class MutableAssocWithAttrInheritTest(
_MutableDictTestBase, fixtures.MappedTest
):
@classmethod
def define_tables(cls, metadata):
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", PickleType),
Column("non_mutable_data", PickleType),
Column("unrelated_data", String(50)),
)
Table(
"subfoo",
metadata,
Column("id", Integer, ForeignKey("foo.id"), primary_key=True),
)
def setup_mappers(cls):
foo = cls.tables.foo
subfoo = cls.tables.subfoo
mapper(Foo, foo)
mapper(SubFoo, subfoo, inherits=Foo)
MutableDict.associate_with_attribute(Foo.data)
def test_in_place_mutation(self):
sess = Session()
f1 = SubFoo(data={"a": "b"})
sess.add(f1)
sess.commit()
f1.data["a"] = "c"
sess.commit()
eq_(f1.data, {"a": "c"})
def test_replace(self):
sess = Session()
f1 = SubFoo(data={"a": "b"})
sess.add(f1)
sess.flush()
f1.data = {"b": "c"}
sess.commit()
eq_(f1.data, {"b": "c"})
class MutableAssociationScalarPickleTest(
_MutableDictTestBase, fixtures.MappedTest
):
@classmethod
def define_tables(cls, metadata):
MutableDict = cls._type_fixture()
MutableDict.associate_with(PickleType)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("skip", PickleType),
Column("data", PickleType),
Column("unrelated_data", String(50)),
)
class MutableAssocIncludeNonPrimaryTest(MutableAssociationScalarPickleTest):
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
mapper(Foo, foo)
mapper(Foo, foo, non_primary=True, properties={"foo_bar": foo.c.data})
class MutableAssociationScalarJSONTest(
_MutableDictTestBase, fixtures.MappedTest
):
@classmethod
def define_tables(cls, metadata):
import json
class JSONEncodedDict(TypeDecorator):
impl = VARCHAR(50)
def process_bind_param(self, value, dialect):
if value is not None:
value = json.dumps(value)
return value
def process_result_value(self, value, dialect):
if value is not None:
value = json.loads(value)
return value
MutableDict = cls._type_fixture()
MutableDict.associate_with(JSONEncodedDict)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", JSONEncodedDict),
Column("unrelated_data", String(50)),
)
class CustomMutableAssociationScalarJSONTest(
_MutableDictTestBase, fixtures.MappedTest
):
CustomMutableDict = None
@classmethod
def _type_fixture(cls):
if not (getattr(cls, "CustomMutableDict")):
MutableDict = super(
CustomMutableAssociationScalarJSONTest, cls
)._type_fixture()
class CustomMutableDict(MutableDict):
pass
cls.CustomMutableDict = CustomMutableDict
return cls.CustomMutableDict
@classmethod
def define_tables(cls, metadata):
import json
class JSONEncodedDict(TypeDecorator):
impl = VARCHAR(50)
def process_bind_param(self, value, dialect):
if value is not None:
value = json.dumps(value)
return value
def process_result_value(self, value, dialect):
if value is not None:
value = json.loads(value)
return value
CustomMutableDict = cls._type_fixture()
CustomMutableDict.associate_with(JSONEncodedDict)
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("data", JSONEncodedDict),
Column("unrelated_data", String(50)),
)
def test_pickle_parent(self):
# Picklers don't know how to pickle CustomMutableDict,
# but we aren't testing that here
pass
def test_coerce(self):
sess = Session()
f1 = Foo(data={"a": "b"})
sess.add(f1)
sess.flush()
eq_(type(f1.data), self._type_fixture())
class _CompositeTestBase(object):
@classmethod
def define_tables(cls, metadata):
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("x", Integer),
Column("y", Integer),
Column("unrelated_data", String(50)),
)
def setup(self):
from sqlalchemy.ext import mutable
mutable._setup_composite_listener()
super(_CompositeTestBase, self).setup()
def teardown(self):
# clear out mapper events
Mapper.dispatch._clear()
ClassManager.dispatch._clear()
super(_CompositeTestBase, self).teardown()
@classmethod
def _type_fixture(cls):
return Point
class MutableCompositeColumnDefaultTest(
_CompositeTestBase, fixtures.MappedTest
):
@classmethod
def define_tables(cls, metadata):
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("x", Integer, default=5),
Column("y", Integer, default=9),
Column("unrelated_data", String(50)),
)
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
cls.Point = cls._type_fixture()
mapper(
Foo,
foo,
properties={"data": composite(cls.Point, foo.c.x, foo.c.y)},
)
def test_evt_on_flush_refresh(self):
# this still worked prior to #3427 being fixed in any case
sess = Session()
f1 = Foo(data=self.Point(None, None))
sess.add(f1)
sess.flush()
eq_(f1.data, self.Point(5, 9))
assert f1 not in sess.dirty
f1.data.x = 10
assert f1 in sess.dirty
class MutableCompositesUnpickleTest(_CompositeTestBase, fixtures.MappedTest):
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
cls.Point = cls._type_fixture()
mapper(
FooWithEq,
foo,
properties={"data": composite(cls.Point, foo.c.x, foo.c.y)},
)
def test_unpickle_modified_eq(self):
u1 = FooWithEq(data=self.Point(3, 5))
for loads, dumps in picklers():
loads(dumps(u1))
class MutableCompositesTest(_CompositeTestBase, fixtures.MappedTest):
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
Point = cls._type_fixture()
mapper(
Foo, foo, properties={"data": composite(Point, foo.c.x, foo.c.y)}
)
def test_in_place_mutation(self):
sess = Session()
d = Point(3, 4)
f1 = Foo(data=d)
sess.add(f1)
sess.commit()
f1.data.y = 5
sess.commit()
eq_(f1.data, Point(3, 5))
def test_pickle_of_parent(self):
sess = Session()
d = Point(3, 4)
f1 = Foo(data=d)
sess.add(f1)
sess.commit()
f1.data
assert "data" in f1.__dict__
sess.close()
for loads, dumps in picklers():
sess = Session()
f2 = loads(dumps(f1))
sess.add(f2)
f2.data.y = 12
assert f2 in sess.dirty
def test_set_none(self):
sess = Session()
f1 = Foo(data=None)
sess.add(f1)
sess.commit()
eq_(f1.data, Point(None, None))
f1.data.y = 5
sess.commit()
eq_(f1.data, Point(None, 5))
def test_set_illegal(self):
f1 = Foo()
assert_raises_message(
ValueError,
"Attribute 'data' does not accept objects",
setattr,
f1,
"data",
"foo",
)
def test_unrelated_flush(self):
sess = Session()
f1 = Foo(data=Point(3, 4), unrelated_data="unrelated")
sess.add(f1)
sess.flush()
f1.unrelated_data = "unrelated 2"
sess.flush()
f1.data.x = 5
sess.commit()
eq_(f1.data.x, 5)
class MutableCompositeCallableTest(_CompositeTestBase, fixtures.MappedTest):
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
Point = cls._type_fixture()
# in this case, this is not actually a MutableComposite.
# so we don't expect it to track changes
mapper(
Foo,
foo,
properties={
"data": composite(lambda x, y: Point(x, y), foo.c.x, foo.c.y)
},
)
def test_basic(self):
sess = Session()
f1 = Foo(data=Point(3, 4))
sess.add(f1)
sess.flush()
f1.data.x = 5
sess.commit()
# we didn't get the change.
eq_(f1.data.x, 3)
class MutableCompositeCustomCoerceTest(
_CompositeTestBase, fixtures.MappedTest
):
@classmethod
def _type_fixture(cls):
return MyPoint
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
Point = cls._type_fixture()
mapper(
Foo, foo, properties={"data": composite(Point, foo.c.x, foo.c.y)}
)
def test_custom_coerce(self):
f = Foo()
f.data = (3, 4)
eq_(f.data, Point(3, 4))
def test_round_trip_ok(self):
sess = Session()
f = Foo()
f.data = (3, 4)
sess.add(f)
sess.commit()
eq_(f.data, Point(3, 4))
class MutableInheritedCompositesTest(_CompositeTestBase, fixtures.MappedTest):
@classmethod
def define_tables(cls, metadata):
Table(
"foo",
metadata,
Column(
"id", Integer, primary_key=True, test_needs_autoincrement=True
),
Column("x", Integer),
Column("y", Integer),
)
Table(
"subfoo",
metadata,
Column("id", Integer, ForeignKey("foo.id"), primary_key=True),
)
@classmethod
def setup_mappers(cls):
foo = cls.tables.foo
subfoo = cls.tables.subfoo
Point = cls._type_fixture()
mapper(
Foo, foo, properties={"data": composite(Point, foo.c.x, foo.c.y)}
)
mapper(SubFoo, subfoo, inherits=Foo)
def test_in_place_mutation_subclass(self):
sess = Session()
d = Point(3, 4)
f1 = SubFoo(data=d)
sess.add(f1)
sess.commit()
f1.data.y = 5
sess.commit()
eq_(f1.data, Point(3, 5))
def test_pickle_of_parent_subclass(self):
sess = Session()
d = Point(3, 4)
f1 = SubFoo(data=d)
sess.add(f1)
sess.commit()
f1.data
assert "data" in f1.__dict__
sess.close()
for loads, dumps in picklers():
sess = Session()
f2 = loads(dumps(f1))
sess.add(f2)
f2.data.y = 12
assert f2 in sess.dirty