Changeset 403

Timestamp:

09/15/08 15:39:23 (5 years ago)

Author:

ged

Message:

- Moved all methods of the "Entity" base class, to the "EntityBase" class, so

that people who want to provide their own base class but don't want to loose
all the methods provided by "Entity" can simply inherit from EntityBase
instead of copy-pasting the code for all its methods.

- Removed unused imports
- Fixed bug which broke the "identity" option

Files:

• elixir/trunk/elixir/entity.py (modified) (6 diffs)

elixir/trunk/elixir/entity.py

@@ -4 +4 @@
 '''
 
-from py23compat import set, rsplit, sorted
+from py23compat import sorted
 
 import sys
 import inspect
-import warnings
 from copy import copy
 
@@ -14 +13 @@
 from sqlalchemy     import Table, Column, Integer, desc, ForeignKey, and_, \
                            ForeignKeyConstraint
-from sqlalchemy.orm import Query, MapperExtension, mapper, object_session, \
+from sqlalchemy.orm import MapperExtension, mapper, object_session, \
                            EXT_CONTINUE, polymorphic_union, ScopedSession, \
                            ColumnProperty
@@ -131 +130 @@
                 #TODO: include module name
                 self.identity = entity.__name__.lower()
-        elif 'polymorphic_identity' in kwargs:
+        elif 'polymorphic_identity' in self.mapper_options:
             raise Exception('You cannot use the "identity" option and the '
                             'polymorphic_identity mapper option at the same '
@@ -424 +423 @@
         else:
             raise Exception("Failed to map entity '%s' with its table or "
-                            "selectable" % self.entity.__name__)
+                            "selectable. You can only bind an Entity to a "
+                            "ScopedSession object or None."
+                            % self.entity.__name__)
 
     def after_mapper(self):
@@ -875 +876 @@
         desc.properties = {}
 
-
-class Entity(object):
-    '''
-    The base class for all entities
-
-    All Elixir model objects should inherit from this class. Statements can
-    appear within the body of the definition of an entity to define its
-    fields, relationships, and other options.
-
-    Here is an example:
+class EntityBase(object):
+    """
+    This class holds all methods of the "Entity" base class, but does not act
+    as a base class itself (it does not use the EntityMeta metaclass), but
+    rather as a parent class for Entity. This is meant so that people who want
+    to provide their own base class but don't want to loose or copy-paste all
+    the methods of Entity can do so by inheriting from EntityBase:
 
     .. sourcecode:: python
 
-        class Person(Entity):
-            name = Field(Unicode(128))
-            birthdate = Field(DateTime, default=datetime.now)
-
-    Please note, that if you don't specify any primary keys, Elixir will
-    automatically create one called ``id``.
-
-    For further information, please refer to the provided examples or
-    tutorial.
-    '''
-    __metaclass__ = EntityMeta
+        class MyBase(EntityBase):
+            __metaclass__ = EntityMeta
+
+            def myCustomMethod(self):
+                # do something great
+    """
 
     def __init__(self, **kwargs):
@@ -1032 +1025 @@
     get = classmethod(get)
 
+
+class Entity(EntityBase):
+    '''
+    The base class for all entities
+
+    All Elixir model objects should inherit from this class. Statements can
+    appear within the body of the definition of an entity to define its
+    fields, relationships, and other options.
+
+    Here is an example:
+
+    .. sourcecode:: python
+
+        class Person(Entity):
+            name = Field(Unicode(128))
+            birthdate = Field(DateTime, default=datetime.now)
+
+    Please note, that if you don't specify any primary keys, Elixir will
+    automatically create one called ``id``.
+
+    For further information, please refer to the provided examples or
+    tutorial.
+    '''
+    __metaclass__ = EntityMeta
+
+