2010-06-11 51 views
5

我想弄清楚如何映射一個簡單的只讀屬性,並保存到數據庫時,該屬性觸發。SQLAlchemy - 如何映射一個只讀(或計算)的屬性

一個人爲的例子應該使這個更清楚。首先,一個簡單的表:

meta = MetaData() 
foo_table = Table('foo', meta, 
    Column('id', String(3), primary_key=True), 
    Column('description', String(64), nullable=False), 
    Column('calculated_value', Integer, nullable=False), 
    ) 

我想要做的是建立一個只讀屬性的類時,我打電話session.commit(將插入calculated_value柱對我來說)...

import datetime 
def Foo(object): 
    def __init__(self, id, description): 
     self.id = id 
     self.description = description 

    @property 
    def calculated_value(self): 
     self._calculated_value = datetime.datetime.now().second + 10 
     return self._calculated_value 

按照SQLAlchemy的文檔,我覺得我應該映射此像這樣:

mapper(Foo, foo_table, properties = { 
    'calculated_value' : synonym('_calculated_value', map_column=True) 
    }) 

的問題,這是_calculated_在您訪問calculated_value屬性之前,值爲None。看來SQLAlchemy在插入到數據庫時沒有調用該屬性,所以我得到一個None值。映射它的正確方法是什麼,以便「calculate_value」屬性的結果插入到foo表的「calculated_value」列中?

好的 - 我在編輯這篇文章,以防其他人有相同的問題。我最終做的是使用MapperExtension。讓我給你一個更好的例子以及擴展的用法:

class UpdatePropertiesExtension(MapperExtension): 
    def __init__(self, properties): 
     self.properties = properties 

    def _update_properties(self, instance): 
     # We simply need to access our read only property one time before it gets 
     # inserted into the database. 
     for property in self.properties: 
      getattr(instance, property) 

    def before_insert(self, mapper, connection, instance): 
     self._update_properties(instance) 

    def before_update(self, mapper, connection, instance): 
     self._update_properties(instance) 

這就是你如何使用這個。比方說,你有一個只有幾個只讀屬性的類,它必須在插入到數據庫之前觸發。我在這裏假設,對於這些只讀屬性中的每一個,都需要在數據庫中有一個相應的列,用於填充屬性的值。你還是要建立一個代名詞每個屬性,但您使用映射擴展名,當你映射對象上面:

class Foo(object): 
    def __init__(self, id, description): 
     self.id = id 
     self.description = description 
     self.items = [] 
     self.some_other_items = [] 

    @property 
    def item_sum(self): 
     self._item_sum = 0 
     for item in self.items: 
      self._item_sum += item.some_value 
     return self._item_sum 

    @property 
    def some_other_property(self): 
     self._some_other_property = 0 
     .... code to generate _some_other_property on the fly.... 
     return self._some_other_property 

mapper(Foo, metadata, 
    extension = UpdatePropertiesExtension(['item_sum', 'some_other_property']), 
    properties = { 
     'item_sum' : synonym('_item_sum', map_column=True), 
     'some_other_property' : synonym('_some_other_property', map_column = True) 
    }) 

回答

1

我不知道這是可能實現你想要使用sqlalchemy.orm什麼。代名詞。可能沒有給出sqlalchemy如何跟蹤哪些實例很髒並需要在刷新期間更新的事實。

但是還有其他的方式,你如何能得到這個功能 - SessionExtensions(注意在那個需要填補頂部的engine_string變量):

(env)[email protected]:~/stackoverflow$ cat stackoverflow.py 

engine_string = '' 

from sqlalchemy import Table, Column, String, Integer, MetaData, create_engine 
import sqlalchemy.orm as orm 
import datetime 

engine = create_engine(engine_string, echo = True) 
meta = MetaData(bind = engine) 

foo_table = Table('foo', meta, 
    Column('id', String(3), primary_key=True), 
    Column('description', String(64), nullable=False), 
    Column('calculated_value', Integer, nullable=False), 
) 

meta.drop_all() 
meta.create_all() 

class MyExt(orm.interfaces.SessionExtension): 
    def before_commit(self, session): 
     for obj in session: 
      if isinstance(obj, Foo): 
       obj.calculated_value = datetime.datetime.now().second + 10 

Session = orm.sessionmaker(extension = MyExt())() 
Session.configure(bind = engine) 

class Foo(object): 
    def __init__(self, id, description): 
     self.id = id 
     self.description = description 

orm.mapper(Foo, foo_table) 

(env)[email protected]:~/stackoverflow$ ipython 
Python 2.5.2 (r252:60911, Jan 4 2009, 17:40:26) 
Type "copyright", "credits" or "license" for more information. 

IPython 0.10 -- An enhanced Interactive Python. 
?   -> Introduction and overview of IPython's features. 
%quickref -> Quick reference. 
help  -> Python's own help system. 
object? -> Details about 'object'. ?object also works, ?? prints more. 

In [1]: from stackoverflow import * 
2010-06-11 13:19:30,925 INFO sqlalchemy.engine.base.Engine.0x...11cc select version() 
2010-06-11 13:19:30,927 INFO sqlalchemy.engine.base.Engine.0x...11cc {} 
2010-06-11 13:19:30,935 INFO sqlalchemy.engine.base.Engine.0x...11cc select current_schema() 
2010-06-11 13:19:30,936 INFO sqlalchemy.engine.base.Engine.0x...11cc {} 
2010-06-11 13:19:30,965 INFO sqlalchemy.engine.base.Engine.0x...11cc select relname from pg_class c join pg_namespace n on n.oid=c.relnamespace where n.nspname=current_schema() and lower(relname)=%(name)s 
2010-06-11 13:19:30,966 INFO sqlalchemy.engine.base.Engine.0x...11cc {'name': u'foo'} 
2010-06-11 13:19:30,979 INFO sqlalchemy.engine.base.Engine.0x...11cc 
DROP TABLE foo 
2010-06-11 13:19:30,980 INFO sqlalchemy.engine.base.Engine.0x...11cc {} 
2010-06-11 13:19:30,988 INFO sqlalchemy.engine.base.Engine.0x...11cc COMMIT 
2010-06-11 13:19:30,997 INFO sqlalchemy.engine.base.Engine.0x...11cc select relname from pg_class c join pg_namespace n on n.oid=c.relnamespace where n.nspname=current_schema() and lower(relname)=%(name)s 
2010-06-11 13:19:30,999 INFO sqlalchemy.engine.base.Engine.0x...11cc {'name': u'foo'} 
2010-06-11 13:19:31,007 INFO sqlalchemy.engine.base.Engine.0x...11cc 
CREATE TABLE foo (
     id VARCHAR(3) NOT NULL, 
     description VARCHAR(64) NOT NULL, 
     calculated_value INTEGER NOT NULL, 
     PRIMARY KEY (id) 
) 


2010-06-11 13:19:31,009 INFO sqlalchemy.engine.base.Engine.0x...11cc {} 
2010-06-11 13:19:31,025 INFO sqlalchemy.engine.base.Engine.0x...11cc COMMIT 

In [2]: f = Foo('idx', 'foo') 

In [3]: f.calculated_value 

In [4]: Session.add(f) 

In [5]: f.calculated_value 

In [6]: Session.commit() 
2010-06-11 13:19:57,668 INFO sqlalchemy.engine.base.Engine.0x...11cc BEGIN 
2010-06-11 13:19:57,674 INFO sqlalchemy.engine.base.Engine.0x...11cc INSERT INTO foo (id, description, calculated_value) VALUES (%(id)s, %(description)s, %(calculated_value)s) 
2010-06-11 13:19:57,675 INFO sqlalchemy.engine.base.Engine.0x...11cc {'description': 'foo', 'calculated_value': 67, 'id': 'idx'} 
2010-06-11 13:19:57,683 INFO sqlalchemy.engine.base.Engine.0x...11cc COMMIT 

In [7]: f.calculated_value 
2010-06-11 13:20:00,755 INFO sqlalchemy.engine.base.Engine.0x...11cc BEGIN 
2010-06-11 13:20:00,759 INFO sqlalchemy.engine.base.Engine.0x...11cc SELECT foo.id AS foo_id, foo.description AS foo_description, foo.calculated_value AS foo_calculated_value 
FROM foo 
WHERE foo.id = %(param_1)s 
2010-06-11 13:20:00,761 INFO sqlalchemy.engine.base.Engine.0x...11cc {'param_1': 'idx'} 
Out[7]: 67 

In [8]: f.calculated_value 
Out[8]: 67 

In [9]: Session.commit() 
2010-06-11 13:20:08,366 INFO sqlalchemy.engine.base.Engine.0x...11cc UPDATE foo SET calculated_value=%(calculated_value)s WHERE foo.id = %(foo_id)s 
2010-06-11 13:20:08,367 INFO sqlalchemy.engine.base.Engine.0x...11cc {'foo_id': u'idx', 'calculated_value': 18} 
2010-06-11 13:20:08,373 INFO sqlalchemy.engine.base.Engine.0x...11cc COMMIT 

In [10]: f.calculated_value 
2010-06-11 13:20:10,475 INFO sqlalchemy.engine.base.Engine.0x...11cc BEGIN 
2010-06-11 13:20:10,479 INFO sqlalchemy.engine.base.Engine.0x...11cc SELECT foo.id AS foo_id, foo.description AS foo_description, foo.calculated_value AS foo_calculated_value 
FROM foo 
WHERE foo.id = %(param_1)s 
2010-06-11 13:20:10,481 INFO sqlalchemy.engine.base.Engine.0x...11cc {'param_1': 'idx'} 
Out[10]: 18 

更多SessionExtensions:sqlalchemy.orm.interfaces.SessionExtension

+1

有趣。儘管我用稍微不同的方式解決了這個問題,但我將其標記爲答案,因爲它應該起作用。我越瞭解SQLAlchemy,我越喜歡它! – 2010-06-11 18:58:39

5

謝謝你的回答編輯,傑夫。我有完全相同的問題,並使用你的代碼解決了這個問題,對於那些使用聲明基礎的人來說,這裏有些類似。可爲您節約幾分鐘仰視如何指定映射器參數和同義詞:

from sqlalchemy.ext.declarative import declarative_base 

class Users(Base): 
    __tablename__ = 'users' 

    id = Column(Integer, primary_key=True) 
    name = Column(String) 
    _calculated_value = Column('calculated_value', String) 

    __mapper_args__ = {'extension': UpdatePropertiesExtension(['calculated_value'])} 

    def __init__(self, name): 
    self.name = name 

    @property 
    def calculated_value(self): 
    self._calculated_value = "foobar" 
    return self._calculated_value 

    calculated_value = synonym('_calculated_value', descriptor=calculated_value) 
+0

謝謝!確實爲我節省了一些時間。 – 2012-04-30 20:23:26

0

較新版本的SQLAlchemy的支持一種叫做混合屬性,它讓你定義的方法作爲制定者保存計算值到數據庫。

我不確定我是否理解你想解決問題的問題,以便給出示例代碼,但在此處發佈的任何人都會通過Google找到這個問題。