Il controllo delle versioni di SQLAlchemy si preoccupa dell'ordine di importazione delle classi


111

Stavo seguendo la guida qui:

http://www.sqlalchemy.org/docs/orm/examples.html?highlight=versioning#versioned-objects

e si sono imbattuti in un problema. Ho definito le mie relazioni come:

generic_ticker = relation('MyClass', backref=backref("stuffs"))

con le stringhe in modo che non si preoccupi dell'ordine di importazione dei moduli del mio modello. Tutto funziona normalmente, ma quando uso il meta di versioning ottengo il seguente errore:

sqlalchemy.exc.InvalidRequestError: durante l'inizializzazione del mapping Mapper | MyClass | stuffs, l'espressione "Trader" non è riuscita a individuare un nome ("nome" MyClass "non è definito"). Se questo è il nome di una classe, considerare l'aggiunta di questa relazione () alla classe dopo che entrambe le classi dipendenti sono state definite.

Ho rintracciato l'errore in:

  File "/home/nick/workspace/gm3/gm3/lib/history_meta.py", line 90, in __init__
    mapper = class_mapper(cls)
  File "/home/nick/venv/tg2env/lib/python2.6/site-packages/sqlalchemy/orm/util.py", line 622, in class_mapper
    mapper = mapper.compile()

class VersionedMeta(DeclarativeMeta):
    def __init__(cls, classname, bases, dict_):
        DeclarativeMeta.__init__(cls, classname, bases, dict_)

        try:
            mapper = class_mapper(cls)
            _history_mapper(mapper)
        except UnmappedClassError:
            pass

Ho risolto il problema mettendo la prova: tranne le cose in un lambda e eseguendole tutte dopo che tutte le importazioni sono avvenute. Funziona ma sembra un po 'spazzatura, qualche idea su come risolvere questo problema è un modo migliore?

Grazie!

Aggiornare

Il problema non riguarda effettivamente l'ordine di importazione. L'esempio di controllo delle versioni è progettato in modo tale che il mappatore richieda la compilazione nel costruttore di ogni classe con versione. E la compilazione fallisce quando le classi correlate non sono ancora definite. In caso di relazioni circolari non c'è modo di farlo funzionare cambiando l'ordine di definizione delle classi mappate.

Aggiorna 2

Come afferma l'aggiornamento sopra (non sapevo che potessi modificare i post di altre persone qui :)), ciò è probabilmente dovuto a riferimenti circolari. In questo caso qualcuno potrebbe trovare utile il mio hack (lo sto usando con turbogears) (Sostituisci VersionedMeta e aggiungi create_mappers global in history_meta)

create_mappers = []
class VersionedMeta(DeclarativeMeta):
    def __init__(cls, classname, bases, dict_):
        DeclarativeMeta.__init__(cls, classname, bases, dict_)
        #I added this code in as it was crashing otherwise
        def make_mapper():
            try:
                mapper = class_mapper(cls)
                _history_mapper(mapper)
            except UnmappedClassError:
                pass

        create_mappers.append(lambda: make_mapper())

Quindi puoi fare qualcosa come quanto segue nei tuoi modelli __init__.py

# Import your model modules here.
from myproj.lib.history_meta import create_mappers

from myproj.model.misc import *
from myproj.model.actor import *
from myproj.model.stuff1 import *
from myproj.model.instrument import *
from myproj.model.stuff import *

#setup the history
[func() for func in create_mappers]

In questo modo crea i mappatori solo dopo che tutte le classi sono state definite.

Aggiornamento 3 Leggermente non correlato, ma in alcune circostanze mi sono imbattuto in un errore di chiave primaria duplicato (eseguendo 2 modifiche allo stesso oggetto in una volta sola). La mia soluzione alternativa è stata quella di aggiungere una nuova chiave di incremento automatico primaria. Ovviamente non puoi averne più di 1 con mysql, quindi ho dovuto rimuovere la chiave primaria dal materiale esistente utilizzato per creare la tabella della cronologia. Controlla il mio codice generale (incluso un hist_id e sbarazzarsi del vincolo di chiave esterna):

"""Stolen from the offical sqlalchemy recpies
"""
from sqlalchemy.ext.declarative import DeclarativeMeta
from sqlalchemy.orm import mapper, class_mapper, attributes, object_mapper
from sqlalchemy.orm.exc import UnmappedClassError, UnmappedColumnError
from sqlalchemy import Table, Column, ForeignKeyConstraint, Integer
from sqlalchemy.orm.interfaces import SessionExtension
from sqlalchemy.orm.properties import RelationshipProperty
from sqlalchemy.types import DateTime
import datetime
from sqlalchemy.orm.session import Session

def col_references_table(col, table):
    for fk in col.foreign_keys:
        if fk.references(table):
            return True
    return False

def _history_mapper(local_mapper):
    cls = local_mapper.class_

    # set the "active_history" flag
    # on on column-mapped attributes so that the old version
    # of the info is always loaded (currently sets it on all attributes)
    for prop in local_mapper.iterate_properties:
        getattr(local_mapper.class_, prop.key).impl.active_history = True

    super_mapper = local_mapper.inherits
    super_history_mapper = getattr(cls, '__history_mapper__', None)

    polymorphic_on = None
    super_fks = []
    if not super_mapper or local_mapper.local_table is not super_mapper.local_table:
        cols = []
        for column in local_mapper.local_table.c:
            if column.name == 'version':
                continue

            col = column.copy()
            col.unique = False

            #don't auto increment stuff from the normal db
            if col.autoincrement:
                col.autoincrement = False
            #sqllite falls over with auto incrementing keys if we have a composite key
            if col.primary_key:
                col.primary_key = False

            if super_mapper and col_references_table(column, super_mapper.local_table):
                super_fks.append((col.key, list(super_history_mapper.base_mapper.local_table.primary_key)[0]))

            cols.append(col)

            if column is local_mapper.polymorphic_on:
                polymorphic_on = col

        #if super_mapper:
        #    super_fks.append(('version', super_history_mapper.base_mapper.local_table.c.version))

        cols.append(Column('hist_id', Integer, primary_key=True, autoincrement=True))
        cols.append(Column('version', Integer))
        cols.append(Column('changed', DateTime, default=datetime.datetime.now))

        if super_fks:
            cols.append(ForeignKeyConstraint(*zip(*super_fks)))

        table = Table(local_mapper.local_table.name + '_history', local_mapper.local_table.metadata,
                      *cols, mysql_engine='InnoDB')
    else:
        # single table inheritance.  take any additional columns that may have
        # been added and add them to the history table.
        for column in local_mapper.local_table.c:
            if column.key not in super_history_mapper.local_table.c:
                col = column.copy()
                super_history_mapper.local_table.append_column(col)
        table = None

    if super_history_mapper:
        bases = (super_history_mapper.class_,)
    else:
        bases = local_mapper.base_mapper.class_.__bases__
    versioned_cls = type.__new__(type, "%sHistory" % cls.__name__, bases, {})

    m = mapper(
            versioned_cls, 
            table, 
            inherits=super_history_mapper, 
            polymorphic_on=polymorphic_on,
            polymorphic_identity=local_mapper.polymorphic_identity
            )
    cls.__history_mapper__ = m

    if not super_history_mapper:
        cls.version = Column('version', Integer, default=1, nullable=False)

create_mappers = []

class VersionedMeta(DeclarativeMeta):
    def __init__(cls, classname, bases, dict_):
        DeclarativeMeta.__init__(cls, classname, bases, dict_)
        #I added this code in as it was crashing otherwise
        def make_mapper():
            try:
                mapper = class_mapper(cls)
                _history_mapper(mapper)
            except UnmappedClassError:
                pass

        create_mappers.append(lambda: make_mapper())

def versioned_objects(iter):
    for obj in iter:
        if hasattr(obj, '__history_mapper__'):
            yield obj

def create_version(obj, session, deleted = False):
    obj_mapper = object_mapper(obj)
    history_mapper = obj.__history_mapper__
    history_cls = history_mapper.class_

    obj_state = attributes.instance_state(obj)

    attr = {}

    obj_changed = False

    for om, hm in zip(obj_mapper.iterate_to_root(), history_mapper.iterate_to_root()):
        if hm.single:
            continue

        for hist_col in hm.local_table.c:
            if hist_col.key == 'version' or hist_col.key == 'changed' or hist_col.key == 'hist_id':
                continue

            obj_col = om.local_table.c[hist_col.key]

            # get the value of the
            # attribute based on the MapperProperty related to the
            # mapped column.  this will allow usage of MapperProperties
            # that have a different keyname than that of the mapped column.
            try:
                prop = obj_mapper.get_property_by_column(obj_col)
            except UnmappedColumnError:
                # in the case of single table inheritance, there may be 
                # columns on the mapped table intended for the subclass only.
                # the "unmapped" status of the subclass column on the 
                # base class is a feature of the declarative module as of sqla 0.5.2.
                continue

            # expired object attributes and also deferred cols might not be in the
            # dict.  force it to load no matter what by using getattr().
            if prop.key not in obj_state.dict:
                getattr(obj, prop.key)

            a, u, d = attributes.get_history(obj, prop.key)

            if d:
                attr[hist_col.key] = d[0]
                obj_changed = True
            elif u:
                attr[hist_col.key] = u[0]
            else:
                # if the attribute had no value.
                attr[hist_col.key] = a[0]
                obj_changed = True

    if not obj_changed:
        # not changed, but we have relationships.  OK
        # check those too
        for prop in obj_mapper.iterate_properties:
            if isinstance(prop, RelationshipProperty) and \
                attributes.get_history(obj, prop.key).has_changes():
                obj_changed = True
                break

    if not obj_changed and not deleted:
        return

    attr['version'] = obj.version
    hist = history_cls()
    for key, value in attr.iteritems():
        setattr(hist, key, value)

    obj.version += 1
    session.add(hist)

class VersionedListener(SessionExtension):
    def before_flush(self, session, flush_context, instances):
        for obj in versioned_objects(session.dirty):
            create_version(obj, session)
        for obj in versioned_objects(session.deleted):
            create_version(obj, session, deleted = True)

6
Non utilizzare nomi obsoleti; relation()dovrebbe essererelationship()
ThiefMaster

25
Sentiti libero di spostare parte di questo in una risposta e accettalo.
Tobu

54
Qualcuno può spiegare perché questa domanda senza risposta ha ottenuto 48 voti positivi? Solo per interesse perché non mi è chiaro cosa stia succedendo qui (non uno sviluppatore di Python)
Moak

4
@ Moak - Sono sicuro che sia perché ci sono molte persone che hanno seguito la stessa guida. Qualcuno può spiegare perché il tuo commento ha ottenuto 36? Questa è la magia di SO :)
alf

2
@alfonso e perché il tuo ha ottenuto 1 :), questo sta iniziando ad essere come il pollice in su di YouTube :-)
Mouna Cheikhna

Risposte:


Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.