summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/ext/declarative.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2008-05-13 20:35:41 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2008-05-13 20:35:41 +0000
commitac934fc5330fad7ba971478d3d21fc5535fc848a (patch)
tree0c91ae4ece2c02dd7d1d74622e88edabd512fdfa /lib/sqlalchemy/ext/declarative.py
parent17684a1b81b63a436fcf4f8426bcd822bdb8d463 (diff)
downloadsqlalchemy-ac934fc5330fad7ba971478d3d21fc5535fc848a.tar.gz
- renamed query.slice_() to query.slice()
- pulled out DeclarativeMeta.__init__ into its own function, added instrument_declarative() which will do the "declarative" thing to any class independent of its lineage (for ctheune) - added "cls" kwarg to declarative_base() allowing user-defined base class for declarative base [ticket:1042]
Diffstat (limited to 'lib/sqlalchemy/ext/declarative.py')
-rw-r--r--lib/sqlalchemy/ext/declarative.py152
1 files changed, 83 insertions, 69 deletions
diff --git a/lib/sqlalchemy/ext/declarative.py b/lib/sqlalchemy/ext/declarative.py
index 4778b9eba..b29f051b1 100644
--- a/lib/sqlalchemy/ext/declarative.py
+++ b/lib/sqlalchemy/ext/declarative.py
@@ -188,79 +188,93 @@ from sqlalchemy import util, exceptions
from sqlalchemy.sql import util as sql_util
-__all__ = 'declarative_base', 'synonym_for', 'comparable_using'
+__all__ = 'declarative_base', 'synonym_for', 'comparable_using', 'instrument_declarative'
+def instrument_declarative(cls, registry, metadata):
+ """Given a class, configure the class declaratively,
+ using the given registry (any dictionary) and MetaData object.
+ This operation does not assume any kind of class hierarchy.
+
+ """
+ if '_decl_class_registry' in cls.__dict__:
+ raise exceptions.InvalidRequestError("Class %r already has been instrumented declaratively" % cls)
+ cls._decl_class_registry = registry
+ cls.metadata = metadata
+ _as_declarative(cls, cls.__name__, cls.__dict__)
+
+def _as_declarative(cls, classname, dict_):
+ cls._decl_class_registry[classname] = cls
+ our_stuff = util.OrderedDict()
+ for k in dict_:
+ value = dict_[k]
+ if (isinstance(value, tuple) and len(value) == 1 and
+ isinstance(value[0], (Column, MapperProperty))):
+ util.warn("Ignoring declarative-like tuple value of attribute "
+ "%s: possibly a copy-and-paste error with a comma "
+ "left at the end of the line?" % k)
+ continue
+ if not isinstance(value, (Column, MapperProperty)):
+ continue
+ prop = _deferred_relation(cls, value)
+ our_stuff[k] = prop
+
+ # set up attributes in the order they were created
+ our_stuff.sort(lambda x, y: cmp(our_stuff[x]._creation_order,
+ our_stuff[y]._creation_order))
+
+ table = None
+ if '__table__' not in cls.__dict__:
+ if '__tablename__' in cls.__dict__:
+ tablename = cls.__tablename__
+ autoload = cls.__dict__.get('__autoload__')
+ if autoload:
+ table_kw = {'autoload': True}
+ else:
+ table_kw = {}
+ cols = []
+ for key, c in our_stuff.iteritems():
+ if isinstance(c, ColumnProperty):
+ for col in c.columns:
+ if isinstance(col, Column) and col.table is None:
+ _undefer_column_name(key, col)
+ cols.append(col)
+ elif isinstance(c, Column):
+ _undefer_column_name(key, c)
+ cols.append(c)
+ cls.__table__ = table = Table(tablename, cls.metadata,
+ *cols, **table_kw)
+ else:
+ table = cls.__table__
+
+ mapper_args = getattr(cls, '__mapper_args__', {})
+ if 'inherits' not in mapper_args:
+ inherits = cls.__mro__[1]
+ inherits = cls._decl_class_registry.get(inherits.__name__, None)
+ if inherits:
+ mapper_args['inherits'] = inherits
+ if not mapper_args.get('concrete', False) and table:
+ # figure out the inherit condition with relaxed rules
+ # about nonexistent tables, to allow for ForeignKeys to
+ # not-yet-defined tables (since we know for sure that our
+ # parent table is defined within the same MetaData)
+ mapper_args['inherit_condition'] = sql_util.join_condition(
+ inherits.__table__, table,
+ ignore_nonexistent_tables=True)
+
+ if hasattr(cls, '__mapper_cls__'):
+ mapper_cls = util.unbound_method_to_callable(cls.__mapper_cls__)
+ else:
+ mapper_cls = mapper
+
+ cls.__mapper__ = mapper_cls(cls, table, properties=our_stuff,
+ **mapper_args)
class DeclarativeMeta(type):
def __init__(cls, classname, bases, dict_):
if '_decl_class_registry' in cls.__dict__:
return type.__init__(cls, classname, bases, dict_)
-
- cls._decl_class_registry[classname] = cls
- our_stuff = util.OrderedDict()
- for k in dict_:
- value = dict_[k]
- if (isinstance(value, tuple) and len(value) == 1 and
- isinstance(value[0], (Column, MapperProperty))):
- util.warn("Ignoring declarative-like tuple value of attribute "
- "%s: possibly a copy-and-paste error with a comma "
- "left at the end of the line?" % k)
- continue
- if not isinstance(value, (Column, MapperProperty)):
- continue
- prop = _deferred_relation(cls, value)
- our_stuff[k] = prop
-
- # set up attributes in the order they were created
- our_stuff.sort(lambda x, y: cmp(our_stuff[x]._creation_order,
- our_stuff[y]._creation_order))
-
- table = None
- if '__table__' not in cls.__dict__:
- if '__tablename__' in cls.__dict__:
- tablename = cls.__tablename__
- autoload = cls.__dict__.get('__autoload__')
- if autoload:
- table_kw = {'autoload': True}
- else:
- table_kw = {}
- cols = []
- for key, c in our_stuff.iteritems():
- if isinstance(c, ColumnProperty):
- for col in c.columns:
- if isinstance(col, Column) and col.table is None:
- _undefer_column_name(key, col)
- cols.append(col)
- elif isinstance(c, Column):
- _undefer_column_name(key, c)
- cols.append(c)
- cls.__table__ = table = Table(tablename, cls.metadata,
- *cols, **table_kw)
- else:
- table = cls.__table__
-
- mapper_args = getattr(cls, '__mapper_args__', {})
- if 'inherits' not in mapper_args:
- inherits = cls.__mro__[1]
- inherits = cls._decl_class_registry.get(inherits.__name__, None)
- if inherits:
- mapper_args['inherits'] = inherits
- if not mapper_args.get('concrete', False) and table:
- # figure out the inherit condition with relaxed rules
- # about nonexistent tables, to allow for ForeignKeys to
- # not-yet-defined tables (since we know for sure that our
- # parent table is defined within the same MetaData)
- mapper_args['inherit_condition'] = sql_util.join_condition(
- inherits.__table__, table,
- ignore_nonexistent_tables=True)
-
- if hasattr(cls, '__mapper_cls__'):
- mapper_cls = util.unbound_method_to_callable(cls.__mapper_cls__)
- else:
- mapper_cls = mapper
-
- cls.__mapper__ = mapper_cls(cls, table, properties=our_stuff,
- **mapper_args)
+
+ _as_declarative(cls, classname, dict_)
return type.__init__(cls, classname, bases, dict_)
def __setattr__(cls, key, value):
@@ -337,11 +351,11 @@ def comparable_using(comparator_factory):
return comparable_property(comparator_factory, fn)
return decorate
-def declarative_base(engine=None, metadata=None, mapper=None):
+def declarative_base(engine=None, metadata=None, mapper=None, cls=object):
lcl_metadata = metadata or MetaData()
if engine:
lcl_metadata.bind = engine
- class Base(object):
+ class Base(cls):
__metaclass__ = DeclarativeMeta
metadata = lcl_metadata
if mapper: