PageRenderTime 58ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/test/ext/declarative/test_inheritance.py

https://bitbucket.org/paulgb/sqlalchemy
Python | 1099 lines | 870 code | 207 blank | 22 comment | 7 complexity | 12f1e6b04777733db4f74fe1647280ca MD5 | raw file
  1. from test.lib.testing import eq_, assert_raises, \
  2. assert_raises_message, is_
  3. from sqlalchemy.ext import declarative as decl
  4. from sqlalchemy import exc
  5. import sqlalchemy as sa
  6. from test.lib import testing
  7. from sqlalchemy import MetaData, Integer, String, ForeignKey, \
  8. ForeignKeyConstraint, Index
  9. from test.lib.schema import Table, Column
  10. from sqlalchemy.orm import relationship, create_session, class_mapper, \
  11. joinedload, configure_mappers, backref, clear_mappers, \
  12. polymorphic_union, deferred, column_property, composite,\
  13. Session
  14. from test.lib.testing import eq_
  15. from sqlalchemy.util import classproperty
  16. from sqlalchemy.ext.declarative import declared_attr, AbstractConcreteBase, ConcreteBase
  17. from test.lib import fixtures
  18. Base = None
  19. class DeclarativeTestBase(fixtures.TestBase, testing.AssertsExecutionResults):
  20. def setup(self):
  21. global Base
  22. Base = decl.declarative_base(testing.db)
  23. def teardown(self):
  24. Session.close_all()
  25. clear_mappers()
  26. Base.metadata.drop_all()
  27. class DeclarativeInheritanceTest(DeclarativeTestBase):
  28. def test_we_must_copy_mapper_args(self):
  29. class Person(Base):
  30. __tablename__ = 'people'
  31. id = Column(Integer, primary_key=True)
  32. discriminator = Column('type', String(50))
  33. __mapper_args__ = {'polymorphic_on': discriminator,
  34. 'polymorphic_identity': 'person'}
  35. class Engineer(Person):
  36. primary_language = Column(String(50))
  37. assert 'inherits' not in Person.__mapper_args__
  38. assert class_mapper(Engineer).polymorphic_identity is None
  39. assert class_mapper(Engineer).polymorphic_on is Person.__table__.c.type
  40. def test_we_must_only_copy_column_mapper_args(self):
  41. class Person(Base):
  42. __tablename__ = 'people'
  43. id = Column(Integer, primary_key=True)
  44. a=Column(Integer)
  45. b=Column(Integer)
  46. c=Column(Integer)
  47. d=Column(Integer)
  48. discriminator = Column('type', String(50))
  49. __mapper_args__ = {'polymorphic_on': discriminator,
  50. 'polymorphic_identity': 'person',
  51. 'version_id_col': 'a',
  52. 'column_prefix': 'bar',
  53. 'include_properties': ['id', 'a', 'b'],
  54. }
  55. assert class_mapper(Person).version_id_col == 'a'
  56. assert class_mapper(Person).include_properties == set(['id', 'a', 'b'])
  57. def test_custom_join_condition(self):
  58. class Foo(Base):
  59. __tablename__ = 'foo'
  60. id = Column('id', Integer, primary_key=True)
  61. class Bar(Foo):
  62. __tablename__ = 'bar'
  63. id = Column('id', Integer, primary_key=True)
  64. foo_id = Column('foo_id', Integer)
  65. __mapper_args__ = {'inherit_condition': foo_id == Foo.id}
  66. # compile succeeds because inherit_condition is honored
  67. configure_mappers()
  68. def test_joined(self):
  69. class Company(Base, fixtures.ComparableEntity):
  70. __tablename__ = 'companies'
  71. id = Column('id', Integer, primary_key=True,
  72. test_needs_autoincrement=True)
  73. name = Column('name', String(50))
  74. employees = relationship('Person')
  75. class Person(Base, fixtures.ComparableEntity):
  76. __tablename__ = 'people'
  77. id = Column('id', Integer, primary_key=True,
  78. test_needs_autoincrement=True)
  79. company_id = Column('company_id', Integer,
  80. ForeignKey('companies.id'))
  81. name = Column('name', String(50))
  82. discriminator = Column('type', String(50))
  83. __mapper_args__ = {'polymorphic_on': discriminator}
  84. class Engineer(Person):
  85. __tablename__ = 'engineers'
  86. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  87. id = Column('id', Integer, ForeignKey('people.id'),
  88. primary_key=True)
  89. primary_language = Column('primary_language', String(50))
  90. class Manager(Person):
  91. __tablename__ = 'managers'
  92. __mapper_args__ = {'polymorphic_identity': 'manager'}
  93. id = Column('id', Integer, ForeignKey('people.id'),
  94. primary_key=True)
  95. golf_swing = Column('golf_swing', String(50))
  96. Base.metadata.create_all()
  97. sess = create_session()
  98. c1 = Company(name='MegaCorp, Inc.',
  99. employees=[Engineer(name='dilbert',
  100. primary_language='java'), Engineer(name='wally',
  101. primary_language='c++'), Manager(name='dogbert',
  102. golf_swing='fore!')])
  103. c2 = Company(name='Elbonia, Inc.',
  104. employees=[Engineer(name='vlad',
  105. primary_language='cobol')])
  106. sess.add(c1)
  107. sess.add(c2)
  108. sess.flush()
  109. sess.expunge_all()
  110. eq_(sess.query(Company).filter(Company.employees.of_type(Engineer).
  111. any(Engineer.primary_language
  112. == 'cobol')).first(), c2)
  113. # ensure that the Manager mapper was compiled with the Manager id
  114. # column as higher priority. this ensures that "Manager.id"
  115. # is appropriately treated as the "id" column in the "manager"
  116. # table (reversed from 0.6's behavior.)
  117. assert Manager.id.property.columns == [Manager.__table__.c.id, Person.__table__.c.id]
  118. # assert that the "id" column is available without a second
  119. # load. as of 0.7, the ColumnProperty tests all columns
  120. # in it's list to see which is present in the row.
  121. sess.expunge_all()
  122. def go():
  123. assert sess.query(Manager).filter(Manager.name == 'dogbert'
  124. ).one().id
  125. self.assert_sql_count(testing.db, go, 1)
  126. sess.expunge_all()
  127. def go():
  128. assert sess.query(Person).filter(Manager.name == 'dogbert'
  129. ).one().id
  130. self.assert_sql_count(testing.db, go, 1)
  131. def test_add_subcol_after_the_fact(self):
  132. class Person(Base, fixtures.ComparableEntity):
  133. __tablename__ = 'people'
  134. id = Column('id', Integer, primary_key=True,
  135. test_needs_autoincrement=True)
  136. name = Column('name', String(50))
  137. discriminator = Column('type', String(50))
  138. __mapper_args__ = {'polymorphic_on': discriminator}
  139. class Engineer(Person):
  140. __tablename__ = 'engineers'
  141. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  142. id = Column('id', Integer, ForeignKey('people.id'),
  143. primary_key=True)
  144. Engineer.primary_language = Column('primary_language',
  145. String(50))
  146. Base.metadata.create_all()
  147. sess = create_session()
  148. e1 = Engineer(primary_language='java', name='dilbert')
  149. sess.add(e1)
  150. sess.flush()
  151. sess.expunge_all()
  152. eq_(sess.query(Person).first(), Engineer(primary_language='java'
  153. , name='dilbert'))
  154. def test_add_parentcol_after_the_fact(self):
  155. class Person(Base, fixtures.ComparableEntity):
  156. __tablename__ = 'people'
  157. id = Column('id', Integer, primary_key=True,
  158. test_needs_autoincrement=True)
  159. discriminator = Column('type', String(50))
  160. __mapper_args__ = {'polymorphic_on': discriminator}
  161. class Engineer(Person):
  162. __tablename__ = 'engineers'
  163. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  164. primary_language = Column(String(50))
  165. id = Column('id', Integer, ForeignKey('people.id'),
  166. primary_key=True)
  167. Person.name = Column('name', String(50))
  168. Base.metadata.create_all()
  169. sess = create_session()
  170. e1 = Engineer(primary_language='java', name='dilbert')
  171. sess.add(e1)
  172. sess.flush()
  173. sess.expunge_all()
  174. eq_(sess.query(Person).first(),
  175. Engineer(primary_language='java', name='dilbert'))
  176. def test_add_sub_parentcol_after_the_fact(self):
  177. class Person(Base, fixtures.ComparableEntity):
  178. __tablename__ = 'people'
  179. id = Column('id', Integer, primary_key=True,
  180. test_needs_autoincrement=True)
  181. discriminator = Column('type', String(50))
  182. __mapper_args__ = {'polymorphic_on': discriminator}
  183. class Engineer(Person):
  184. __tablename__ = 'engineers'
  185. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  186. primary_language = Column(String(50))
  187. id = Column('id', Integer, ForeignKey('people.id'),
  188. primary_key=True)
  189. class Admin(Engineer):
  190. __tablename__ = 'admins'
  191. __mapper_args__ = {'polymorphic_identity': 'admin'}
  192. workstation = Column(String(50))
  193. id = Column('id', Integer, ForeignKey('engineers.id'),
  194. primary_key=True)
  195. Person.name = Column('name', String(50))
  196. Base.metadata.create_all()
  197. sess = create_session()
  198. e1 = Admin(primary_language='java', name='dilbert',
  199. workstation='foo')
  200. sess.add(e1)
  201. sess.flush()
  202. sess.expunge_all()
  203. eq_(sess.query(Person).first(), Admin(primary_language='java',
  204. name='dilbert', workstation='foo'))
  205. def test_subclass_mixin(self):
  206. class Person(Base, fixtures.ComparableEntity):
  207. __tablename__ = 'people'
  208. id = Column('id', Integer, primary_key=True)
  209. name = Column('name', String(50))
  210. discriminator = Column('type', String(50))
  211. __mapper_args__ = {'polymorphic_on': discriminator}
  212. class MyMixin(object):
  213. pass
  214. class Engineer(MyMixin, Person):
  215. __tablename__ = 'engineers'
  216. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  217. id = Column('id', Integer, ForeignKey('people.id'),
  218. primary_key=True)
  219. primary_language = Column('primary_language', String(50))
  220. assert class_mapper(Engineer).inherits is class_mapper(Person)
  221. def test_with_undefined_foreignkey(self):
  222. class Parent(Base):
  223. __tablename__ = 'parent'
  224. id = Column('id', Integer, primary_key=True)
  225. tp = Column('type', String(50))
  226. __mapper_args__ = dict(polymorphic_on=tp)
  227. class Child1(Parent):
  228. __tablename__ = 'child1'
  229. id = Column('id', Integer, ForeignKey('parent.id'),
  230. primary_key=True)
  231. related_child2 = Column('c2', Integer,
  232. ForeignKey('child2.id'))
  233. __mapper_args__ = dict(polymorphic_identity='child1')
  234. # no exception is raised by the ForeignKey to "child2" even
  235. # though child2 doesn't exist yet
  236. class Child2(Parent):
  237. __tablename__ = 'child2'
  238. id = Column('id', Integer, ForeignKey('parent.id'),
  239. primary_key=True)
  240. related_child1 = Column('c1', Integer)
  241. __mapper_args__ = dict(polymorphic_identity='child2')
  242. sa.orm.configure_mappers() # no exceptions here
  243. def test_foreign_keys_with_col(self):
  244. """Test that foreign keys that reference a literal 'id' subclass
  245. 'id' attribute behave intuitively.
  246. See [ticket:1892].
  247. """
  248. class Booking(Base):
  249. __tablename__ = 'booking'
  250. id = Column(Integer, primary_key=True)
  251. class PlanBooking(Booking):
  252. __tablename__ = 'plan_booking'
  253. id = Column(Integer, ForeignKey(Booking.id),
  254. primary_key=True)
  255. # referencing PlanBooking.id gives us the column
  256. # on plan_booking, not booking
  257. class FeatureBooking(Booking):
  258. __tablename__ = 'feature_booking'
  259. id = Column(Integer, ForeignKey(Booking.id),
  260. primary_key=True)
  261. plan_booking_id = Column(Integer,
  262. ForeignKey(PlanBooking.id))
  263. plan_booking = relationship(PlanBooking,
  264. backref='feature_bookings')
  265. assert FeatureBooking.__table__.c.plan_booking_id.\
  266. references(PlanBooking.__table__.c.id)
  267. assert FeatureBooking.__table__.c.id.\
  268. references(Booking.__table__.c.id)
  269. def test_single_colsonbase(self):
  270. """test single inheritance where all the columns are on the base
  271. class."""
  272. class Company(Base, fixtures.ComparableEntity):
  273. __tablename__ = 'companies'
  274. id = Column('id', Integer, primary_key=True,
  275. test_needs_autoincrement=True)
  276. name = Column('name', String(50))
  277. employees = relationship('Person')
  278. class Person(Base, fixtures.ComparableEntity):
  279. __tablename__ = 'people'
  280. id = Column('id', Integer, primary_key=True,
  281. test_needs_autoincrement=True)
  282. company_id = Column('company_id', Integer,
  283. ForeignKey('companies.id'))
  284. name = Column('name', String(50))
  285. discriminator = Column('type', String(50))
  286. primary_language = Column('primary_language', String(50))
  287. golf_swing = Column('golf_swing', String(50))
  288. __mapper_args__ = {'polymorphic_on': discriminator}
  289. class Engineer(Person):
  290. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  291. class Manager(Person):
  292. __mapper_args__ = {'polymorphic_identity': 'manager'}
  293. Base.metadata.create_all()
  294. sess = create_session()
  295. c1 = Company(name='MegaCorp, Inc.',
  296. employees=[Engineer(name='dilbert',
  297. primary_language='java'), Engineer(name='wally',
  298. primary_language='c++'), Manager(name='dogbert',
  299. golf_swing='fore!')])
  300. c2 = Company(name='Elbonia, Inc.',
  301. employees=[Engineer(name='vlad',
  302. primary_language='cobol')])
  303. sess.add(c1)
  304. sess.add(c2)
  305. sess.flush()
  306. sess.expunge_all()
  307. eq_(sess.query(Person).filter(Engineer.primary_language
  308. == 'cobol').first(), Engineer(name='vlad'))
  309. eq_(sess.query(Company).filter(Company.employees.of_type(Engineer).
  310. any(Engineer.primary_language
  311. == 'cobol')).first(), c2)
  312. def test_single_colsonsub(self):
  313. """test single inheritance where the columns are local to their
  314. class.
  315. this is a newer usage.
  316. """
  317. class Company(Base, fixtures.ComparableEntity):
  318. __tablename__ = 'companies'
  319. id = Column('id', Integer, primary_key=True,
  320. test_needs_autoincrement=True)
  321. name = Column('name', String(50))
  322. employees = relationship('Person')
  323. class Person(Base, fixtures.ComparableEntity):
  324. __tablename__ = 'people'
  325. id = Column(Integer, primary_key=True,
  326. test_needs_autoincrement=True)
  327. company_id = Column(Integer, ForeignKey('companies.id'))
  328. name = Column(String(50))
  329. discriminator = Column('type', String(50))
  330. __mapper_args__ = {'polymorphic_on': discriminator}
  331. class Engineer(Person):
  332. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  333. primary_language = Column(String(50))
  334. class Manager(Person):
  335. __mapper_args__ = {'polymorphic_identity': 'manager'}
  336. golf_swing = Column(String(50))
  337. # we have here a situation that is somewhat unique. the Person
  338. # class is mapped to the "people" table, but it was mapped when
  339. # the table did not include the "primary_language" or
  340. # "golf_swing" columns. declarative will also manipulate the
  341. # exclude_properties collection so that sibling classes don't
  342. # cross-pollinate.
  343. assert Person.__table__.c.company_id is not None
  344. assert Person.__table__.c.golf_swing is not None
  345. assert Person.__table__.c.primary_language is not None
  346. assert Engineer.primary_language is not None
  347. assert Manager.golf_swing is not None
  348. assert not hasattr(Person, 'primary_language')
  349. assert not hasattr(Person, 'golf_swing')
  350. assert not hasattr(Engineer, 'golf_swing')
  351. assert not hasattr(Manager, 'primary_language')
  352. Base.metadata.create_all()
  353. sess = create_session()
  354. e1 = Engineer(name='dilbert', primary_language='java')
  355. e2 = Engineer(name='wally', primary_language='c++')
  356. m1 = Manager(name='dogbert', golf_swing='fore!')
  357. c1 = Company(name='MegaCorp, Inc.', employees=[e1, e2, m1])
  358. e3 = Engineer(name='vlad', primary_language='cobol')
  359. c2 = Company(name='Elbonia, Inc.', employees=[e3])
  360. sess.add(c1)
  361. sess.add(c2)
  362. sess.flush()
  363. sess.expunge_all()
  364. eq_(sess.query(Person).filter(Engineer.primary_language
  365. == 'cobol').first(), Engineer(name='vlad'))
  366. eq_(sess.query(Company).filter(Company.employees.of_type(Engineer).
  367. any(Engineer.primary_language
  368. == 'cobol')).first(), c2)
  369. eq_(sess.query(Engineer).filter_by(primary_language='cobol'
  370. ).one(), Engineer(name='vlad', primary_language='cobol'))
  371. def test_joined_from_single(self):
  372. class Company(Base, fixtures.ComparableEntity):
  373. __tablename__ = 'companies'
  374. id = Column('id', Integer, primary_key=True,
  375. test_needs_autoincrement=True)
  376. name = Column('name', String(50))
  377. employees = relationship('Person')
  378. class Person(Base, fixtures.ComparableEntity):
  379. __tablename__ = 'people'
  380. id = Column(Integer, primary_key=True,
  381. test_needs_autoincrement=True)
  382. company_id = Column(Integer, ForeignKey('companies.id'))
  383. name = Column(String(50))
  384. discriminator = Column('type', String(50))
  385. __mapper_args__ = {'polymorphic_on': discriminator}
  386. class Manager(Person):
  387. __mapper_args__ = {'polymorphic_identity': 'manager'}
  388. golf_swing = Column(String(50))
  389. class Engineer(Person):
  390. __tablename__ = 'engineers'
  391. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  392. id = Column(Integer, ForeignKey('people.id'),
  393. primary_key=True)
  394. primary_language = Column(String(50))
  395. assert Person.__table__.c.golf_swing is not None
  396. assert not Person.__table__.c.has_key('primary_language')
  397. assert Engineer.__table__.c.primary_language is not None
  398. assert Engineer.primary_language is not None
  399. assert Manager.golf_swing is not None
  400. assert not hasattr(Person, 'primary_language')
  401. assert not hasattr(Person, 'golf_swing')
  402. assert not hasattr(Engineer, 'golf_swing')
  403. assert not hasattr(Manager, 'primary_language')
  404. Base.metadata.create_all()
  405. sess = create_session()
  406. e1 = Engineer(name='dilbert', primary_language='java')
  407. e2 = Engineer(name='wally', primary_language='c++')
  408. m1 = Manager(name='dogbert', golf_swing='fore!')
  409. c1 = Company(name='MegaCorp, Inc.', employees=[e1, e2, m1])
  410. e3 = Engineer(name='vlad', primary_language='cobol')
  411. c2 = Company(name='Elbonia, Inc.', employees=[e3])
  412. sess.add(c1)
  413. sess.add(c2)
  414. sess.flush()
  415. sess.expunge_all()
  416. eq_(sess.query(Person).with_polymorphic(Engineer).
  417. filter(Engineer.primary_language
  418. == 'cobol').first(), Engineer(name='vlad'))
  419. eq_(sess.query(Company).filter(Company.employees.of_type(Engineer).
  420. any(Engineer.primary_language
  421. == 'cobol')).first(), c2)
  422. eq_(sess.query(Engineer).filter_by(primary_language='cobol'
  423. ).one(), Engineer(name='vlad', primary_language='cobol'))
  424. def test_single_from_joined_colsonsub(self):
  425. class Person(Base, fixtures.ComparableEntity):
  426. __tablename__ = 'people'
  427. id = Column(Integer, primary_key=True,
  428. test_needs_autoincrement=True)
  429. name = Column(String(50))
  430. discriminator = Column('type', String(50))
  431. __mapper_args__ = {'polymorphic_on': discriminator}
  432. class Manager(Person):
  433. __tablename__ = 'manager'
  434. __mapper_args__ = {'polymorphic_identity': 'manager'}
  435. id = Column(Integer, ForeignKey('people.id'), primary_key=True)
  436. golf_swing = Column(String(50))
  437. class Boss(Manager):
  438. boss_name = Column(String(50))
  439. is_(
  440. Boss.__mapper__.column_attrs['boss_name'].columns[0],
  441. Manager.__table__.c.boss_name
  442. )
  443. def test_polymorphic_on_converted_from_inst(self):
  444. class A(Base):
  445. __tablename__ = 'A'
  446. id = Column(Integer, primary_key=True)
  447. discriminator = Column(String)
  448. @declared_attr
  449. def __mapper_args__(cls):
  450. return {
  451. 'polymorphic_identity': cls.__name__,
  452. 'polymorphic_on': cls.discriminator
  453. }
  454. class B(A):
  455. pass
  456. is_(B.__mapper__.polymorphic_on, A.__table__.c.discriminator)
  457. def test_add_deferred(self):
  458. class Person(Base, fixtures.ComparableEntity):
  459. __tablename__ = 'people'
  460. id = Column('id', Integer, primary_key=True,
  461. test_needs_autoincrement=True)
  462. Person.name = deferred(Column(String(10)))
  463. Base.metadata.create_all()
  464. sess = create_session()
  465. p = Person(name='ratbert')
  466. sess.add(p)
  467. sess.flush()
  468. sess.expunge_all()
  469. eq_(sess.query(Person).all(), [Person(name='ratbert')])
  470. sess.expunge_all()
  471. person = sess.query(Person).filter(Person.name == 'ratbert'
  472. ).one()
  473. assert 'name' not in person.__dict__
  474. def test_single_fksonsub(self):
  475. """test single inheritance with a foreign key-holding column on
  476. a subclass.
  477. """
  478. class Person(Base, fixtures.ComparableEntity):
  479. __tablename__ = 'people'
  480. id = Column(Integer, primary_key=True,
  481. test_needs_autoincrement=True)
  482. name = Column(String(50))
  483. discriminator = Column('type', String(50))
  484. __mapper_args__ = {'polymorphic_on': discriminator}
  485. class Engineer(Person):
  486. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  487. primary_language_id = Column(Integer,
  488. ForeignKey('languages.id'))
  489. primary_language = relationship('Language')
  490. class Language(Base, fixtures.ComparableEntity):
  491. __tablename__ = 'languages'
  492. id = Column(Integer, primary_key=True,
  493. test_needs_autoincrement=True)
  494. name = Column(String(50))
  495. assert not hasattr(Person, 'primary_language_id')
  496. Base.metadata.create_all()
  497. sess = create_session()
  498. java, cpp, cobol = Language(name='java'), Language(name='cpp'), \
  499. Language(name='cobol')
  500. e1 = Engineer(name='dilbert', primary_language=java)
  501. e2 = Engineer(name='wally', primary_language=cpp)
  502. e3 = Engineer(name='vlad', primary_language=cobol)
  503. sess.add_all([e1, e2, e3])
  504. sess.flush()
  505. sess.expunge_all()
  506. eq_(sess.query(Person).filter(Engineer.primary_language.has(
  507. Language.name
  508. == 'cobol')).first(), Engineer(name='vlad',
  509. primary_language=Language(name='cobol')))
  510. eq_(sess.query(Engineer).filter(Engineer.primary_language.has(
  511. Language.name
  512. == 'cobol')).one(), Engineer(name='vlad',
  513. primary_language=Language(name='cobol')))
  514. eq_(sess.query(Person).join(Engineer.primary_language).order_by(
  515. Language.name).all(),
  516. [Engineer(name='vlad',
  517. primary_language=Language(name='cobol')),
  518. Engineer(name='wally', primary_language=Language(name='cpp'
  519. )), Engineer(name='dilbert',
  520. primary_language=Language(name='java'))])
  521. def test_single_three_levels(self):
  522. class Person(Base, fixtures.ComparableEntity):
  523. __tablename__ = 'people'
  524. id = Column(Integer, primary_key=True)
  525. name = Column(String(50))
  526. discriminator = Column('type', String(50))
  527. __mapper_args__ = {'polymorphic_on': discriminator}
  528. class Engineer(Person):
  529. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  530. primary_language = Column(String(50))
  531. class JuniorEngineer(Engineer):
  532. __mapper_args__ = \
  533. {'polymorphic_identity': 'junior_engineer'}
  534. nerf_gun = Column(String(50))
  535. class Manager(Person):
  536. __mapper_args__ = {'polymorphic_identity': 'manager'}
  537. golf_swing = Column(String(50))
  538. assert JuniorEngineer.nerf_gun
  539. assert JuniorEngineer.primary_language
  540. assert JuniorEngineer.name
  541. assert Manager.golf_swing
  542. assert Engineer.primary_language
  543. assert not hasattr(Engineer, 'golf_swing')
  544. assert not hasattr(Engineer, 'nerf_gun')
  545. assert not hasattr(Manager, 'nerf_gun')
  546. assert not hasattr(Manager, 'primary_language')
  547. def test_single_detects_conflict(self):
  548. class Person(Base):
  549. __tablename__ = 'people'
  550. id = Column(Integer, primary_key=True)
  551. name = Column(String(50))
  552. discriminator = Column('type', String(50))
  553. __mapper_args__ = {'polymorphic_on': discriminator}
  554. class Engineer(Person):
  555. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  556. primary_language = Column(String(50))
  557. # test sibling col conflict
  558. def go():
  559. class Manager(Person):
  560. __mapper_args__ = {'polymorphic_identity': 'manager'}
  561. golf_swing = Column(String(50))
  562. primary_language = Column(String(50))
  563. assert_raises(sa.exc.ArgumentError, go)
  564. # test parent col conflict
  565. def go():
  566. class Salesman(Person):
  567. __mapper_args__ = {'polymorphic_identity': 'manager'}
  568. name = Column(String(50))
  569. assert_raises(sa.exc.ArgumentError, go)
  570. def test_single_no_special_cols(self):
  571. class Person(Base, fixtures.ComparableEntity):
  572. __tablename__ = 'people'
  573. id = Column('id', Integer, primary_key=True)
  574. name = Column('name', String(50))
  575. discriminator = Column('type', String(50))
  576. __mapper_args__ = {'polymorphic_on': discriminator}
  577. def go():
  578. class Engineer(Person):
  579. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  580. primary_language = Column('primary_language',
  581. String(50))
  582. foo_bar = Column(Integer, primary_key=True)
  583. assert_raises_message(sa.exc.ArgumentError, 'place primary key'
  584. , go)
  585. def test_single_no_table_args(self):
  586. class Person(Base, fixtures.ComparableEntity):
  587. __tablename__ = 'people'
  588. id = Column('id', Integer, primary_key=True)
  589. name = Column('name', String(50))
  590. discriminator = Column('type', String(50))
  591. __mapper_args__ = {'polymorphic_on': discriminator}
  592. def go():
  593. class Engineer(Person):
  594. __mapper_args__ = {'polymorphic_identity': 'engineer'}
  595. primary_language = Column('primary_language',
  596. String(50))
  597. # this should be on the Person class, as this is single
  598. # table inheritance, which is why we test that this
  599. # throws an exception!
  600. __table_args__ = {'mysql_engine': 'InnoDB'}
  601. assert_raises_message(sa.exc.ArgumentError,
  602. 'place __table_args__', go)
  603. @testing.emits_warning("This declarative")
  604. def test_dupe_name_in_hierarchy(self):
  605. class A(Base):
  606. __tablename__ = "a"
  607. id = Column( Integer, primary_key=True)
  608. a_1 = A
  609. class A(a_1):
  610. __tablename__ = 'b'
  611. id = Column(Integer(),ForeignKey(a_1.id), primary_key = True)
  612. assert A.__mapper__.inherits is a_1.__mapper__
  613. class OverlapColPrecedenceTest(DeclarativeTestBase):
  614. """test #1892 cases when declarative does column precedence."""
  615. def _run_test(self, Engineer, e_id, p_id):
  616. p_table = Base.metadata.tables['person']
  617. e_table = Base.metadata.tables['engineer']
  618. assert Engineer.id.property.columns[0] is e_table.c[e_id]
  619. assert Engineer.id.property.columns[1] is p_table.c[p_id]
  620. def test_basic(self):
  621. class Person(Base):
  622. __tablename__ = 'person'
  623. id = Column(Integer, primary_key=True)
  624. class Engineer(Person):
  625. __tablename__ = 'engineer'
  626. id = Column(Integer, ForeignKey('person.id'), primary_key=True)
  627. self._run_test(Engineer, "id", "id")
  628. def test_alt_name_base(self):
  629. class Person(Base):
  630. __tablename__ = 'person'
  631. id = Column("pid", Integer, primary_key=True)
  632. class Engineer(Person):
  633. __tablename__ = 'engineer'
  634. id = Column(Integer, ForeignKey('person.pid'), primary_key=True)
  635. self._run_test(Engineer, "id", "pid")
  636. def test_alt_name_sub(self):
  637. class Person(Base):
  638. __tablename__ = 'person'
  639. id = Column(Integer, primary_key=True)
  640. class Engineer(Person):
  641. __tablename__ = 'engineer'
  642. id = Column("eid", Integer, ForeignKey('person.id'), primary_key=True)
  643. self._run_test(Engineer, "eid", "id")
  644. def test_alt_name_both(self):
  645. class Person(Base):
  646. __tablename__ = 'person'
  647. id = Column("pid", Integer, primary_key=True)
  648. class Engineer(Person):
  649. __tablename__ = 'engineer'
  650. id = Column("eid", Integer, ForeignKey('person.pid'), primary_key=True)
  651. self._run_test(Engineer, "eid", "pid")
  652. from test.orm.test_events import _RemoveListeners
  653. class ConcreteInhTest(_RemoveListeners, DeclarativeTestBase):
  654. def _roundtrip(self, Employee, Manager, Engineer, Boss,
  655. polymorphic=True, explicit_type=False):
  656. Base.metadata.create_all()
  657. sess = create_session()
  658. e1 = Engineer(name='dilbert', primary_language='java')
  659. e2 = Engineer(name='wally', primary_language='c++')
  660. m1 = Manager(name='dogbert', golf_swing='fore!')
  661. e3 = Engineer(name='vlad', primary_language='cobol')
  662. b1 = Boss(name="pointy haired")
  663. if polymorphic:
  664. for obj in [e1, e2, m1, e3, b1]:
  665. if explicit_type:
  666. eq_(obj.type, obj.__mapper__.polymorphic_identity)
  667. else:
  668. assert_raises_message(
  669. AttributeError,
  670. "does not implement attribute .?'type' "
  671. "at the instance level.",
  672. getattr, obj, "type"
  673. )
  674. else:
  675. assert "type" not in Engineer.__dict__
  676. assert "type" not in Manager.__dict__
  677. assert "type" not in Boss.__dict__
  678. sess.add_all([e1, e2, m1, e3, b1])
  679. sess.flush()
  680. sess.expunge_all()
  681. if polymorphic:
  682. eq_(sess.query(Employee).order_by(Employee.name).all(),
  683. [Engineer(name='dilbert'), Manager(name='dogbert'),
  684. Boss(name='pointy haired'), Engineer(name='vlad'), Engineer(name='wally')])
  685. else:
  686. eq_(sess.query(Engineer).order_by(Engineer.name).all(),
  687. [Engineer(name='dilbert'), Engineer(name='vlad'),
  688. Engineer(name='wally')])
  689. eq_(sess.query(Manager).all(), [Manager(name='dogbert')])
  690. eq_(sess.query(Boss).all(), [Boss(name='pointy haired')])
  691. def test_explicit(self):
  692. engineers = Table('engineers', Base.metadata, Column('id',
  693. Integer, primary_key=True,
  694. test_needs_autoincrement=True), Column('name'
  695. , String(50)), Column('primary_language',
  696. String(50)))
  697. managers = Table('managers', Base.metadata,
  698. Column('id',Integer, primary_key=True, test_needs_autoincrement=True),
  699. Column('name', String(50)),
  700. Column('golf_swing', String(50))
  701. )
  702. boss = Table('boss', Base.metadata,
  703. Column('id',Integer, primary_key=True, test_needs_autoincrement=True),
  704. Column('name', String(50)),
  705. Column('golf_swing', String(50))
  706. )
  707. punion = polymorphic_union({
  708. 'engineer': engineers,
  709. 'manager' : managers,
  710. 'boss': boss}, 'type', 'punion')
  711. class Employee(Base, fixtures.ComparableEntity):
  712. __table__ = punion
  713. __mapper_args__ = {'polymorphic_on': punion.c.type}
  714. class Engineer(Employee):
  715. __table__ = engineers
  716. __mapper_args__ = {'polymorphic_identity': 'engineer',
  717. 'concrete': True}
  718. class Manager(Employee):
  719. __table__ = managers
  720. __mapper_args__ = {'polymorphic_identity': 'manager',
  721. 'concrete': True}
  722. class Boss(Manager):
  723. __table__ = boss
  724. __mapper_args__ = {'polymorphic_identity': 'boss',
  725. 'concrete': True}
  726. self._roundtrip(Employee, Manager, Engineer, Boss)
  727. def test_concrete_inline_non_polymorphic(self):
  728. """test the example from the declarative docs."""
  729. class Employee(Base, fixtures.ComparableEntity):
  730. __tablename__ = 'people'
  731. id = Column(Integer, primary_key=True,
  732. test_needs_autoincrement=True)
  733. name = Column(String(50))
  734. class Engineer(Employee):
  735. __tablename__ = 'engineers'
  736. __mapper_args__ = {'concrete': True}
  737. id = Column(Integer, primary_key=True,
  738. test_needs_autoincrement=True)
  739. primary_language = Column(String(50))
  740. name = Column(String(50))
  741. class Manager(Employee):
  742. __tablename__ = 'manager'
  743. __mapper_args__ = {'concrete': True}
  744. id = Column(Integer, primary_key=True,
  745. test_needs_autoincrement=True)
  746. golf_swing = Column(String(50))
  747. name = Column(String(50))
  748. class Boss(Manager):
  749. __tablename__ = 'boss'
  750. __mapper_args__ = {'concrete': True}
  751. id = Column(Integer, primary_key=True,
  752. test_needs_autoincrement=True)
  753. golf_swing = Column(String(50))
  754. name = Column(String(50))
  755. self._roundtrip(Employee, Manager, Engineer, Boss, polymorphic=False)
  756. def test_abstract_concrete_extension(self):
  757. class Employee(AbstractConcreteBase, Base, fixtures.ComparableEntity):
  758. pass
  759. class Manager(Employee):
  760. __tablename__ = 'manager'
  761. employee_id = Column(Integer, primary_key=True,
  762. test_needs_autoincrement=True)
  763. name = Column(String(50))
  764. golf_swing = Column(String(40))
  765. __mapper_args__ = {
  766. 'polymorphic_identity':'manager',
  767. 'concrete':True}
  768. class Boss(Manager):
  769. __tablename__ = 'boss'
  770. employee_id = Column(Integer, primary_key=True,
  771. test_needs_autoincrement=True)
  772. name = Column(String(50))
  773. golf_swing = Column(String(40))
  774. __mapper_args__ = {
  775. 'polymorphic_identity':'boss',
  776. 'concrete':True}
  777. class Engineer(Employee):
  778. __tablename__ = 'engineer'
  779. employee_id = Column(Integer, primary_key=True,
  780. test_needs_autoincrement=True)
  781. name = Column(String(50))
  782. primary_language = Column(String(40))
  783. __mapper_args__ = {'polymorphic_identity':'engineer',
  784. 'concrete':True}
  785. self._roundtrip(Employee, Manager, Engineer, Boss)
  786. def test_concrete_extension(self):
  787. class Employee(ConcreteBase, Base, fixtures.ComparableEntity):
  788. __tablename__ = 'employee'
  789. employee_id = Column(Integer, primary_key=True,
  790. test_needs_autoincrement=True)
  791. name = Column(String(50))
  792. __mapper_args__ = {
  793. 'polymorphic_identity':'employee',
  794. 'concrete':True}
  795. class Manager(Employee):
  796. __tablename__ = 'manager'
  797. employee_id = Column(Integer, primary_key=True,
  798. test_needs_autoincrement=True)
  799. name = Column(String(50))
  800. golf_swing = Column(String(40))
  801. __mapper_args__ = {
  802. 'polymorphic_identity':'manager',
  803. 'concrete':True}
  804. class Boss(Manager):
  805. __tablename__ = 'boss'
  806. employee_id = Column(Integer, primary_key=True,
  807. test_needs_autoincrement=True)
  808. name = Column(String(50))
  809. golf_swing = Column(String(40))
  810. __mapper_args__ = {
  811. 'polymorphic_identity':'boss',
  812. 'concrete':True}
  813. class Engineer(Employee):
  814. __tablename__ = 'engineer'
  815. employee_id = Column(Integer, primary_key=True,
  816. test_needs_autoincrement=True)
  817. name = Column(String(50))
  818. primary_language = Column(String(40))
  819. __mapper_args__ = {'polymorphic_identity':'engineer',
  820. 'concrete':True}
  821. self._roundtrip(Employee, Manager, Engineer, Boss)
  822. def test_ok_to_override_type_from_abstract(self):
  823. class Employee(AbstractConcreteBase, Base, fixtures.ComparableEntity):
  824. pass
  825. class Manager(Employee):
  826. __tablename__ = 'manager'
  827. employee_id = Column(Integer, primary_key=True,
  828. test_needs_autoincrement=True)
  829. name = Column(String(50))
  830. golf_swing = Column(String(40))
  831. @property
  832. def type(self):
  833. return "manager"
  834. __mapper_args__ = {
  835. 'polymorphic_identity': "manager",
  836. 'concrete':True}
  837. class Boss(Manager):
  838. __tablename__ = 'boss'
  839. employee_id = Column(Integer, primary_key=True,
  840. test_needs_autoincrement=True)
  841. name = Column(String(50))
  842. golf_swing = Column(String(40))
  843. @property
  844. def type(self):
  845. return "boss"
  846. __mapper_args__ = {
  847. 'polymorphic_identity': "boss",
  848. 'concrete':True}
  849. class Engineer(Employee):
  850. __tablename__ = 'engineer'
  851. employee_id = Column(Integer, primary_key=True,
  852. test_needs_autoincrement=True)
  853. name = Column(String(50))
  854. primary_language = Column(String(40))
  855. @property
  856. def type(self):
  857. return "engineer"
  858. __mapper_args__ = {'polymorphic_identity': "engineer",
  859. 'concrete':True}
  860. self._roundtrip(Employee, Manager, Engineer, Boss, explicit_type=True)