Changeset 268

Timestamp:

11/16/07 10:45:36 (6 years ago)

Author:

ged

Message:

allow overriding primary_key columns on autoloaded entities (closes tickets
#20 and #22)

Location:

elixir/trunk

Files:

• elixir/entity.py (modified) (1 diff)
• tests/test_autoload.py (modified) (5 diffs)

elixir/trunk/elixir/entity.py

@@ -179 +179 @@
     def create_pk_cols(self):
         """
-        Create primary_key columns. That is, add columns from belongs_to
-        relationships marked as being a primary_key and then add a primary 
-        key to the table if it hasn't already got one and needs one. 
-        
-        This method is "semi-recursive" in that it calls the create_keys 
-        method on BelongsTo relationships and those in turn call create_pk_cols
-        on their target. It shouldn't be possible to have an infinite loop 
-        since a loop of primary_keys is not a valid situation.
+        Create primary_key columns. That is, call the 'create_pk_cols' 
+        builders then add a primary key to the table if it hasn't already got 
+        one and needs one. 
+        
+        This method is "semi-recursive" in some cases: it calls the 
+        create_keys method on ManyToOne relationships and those in turn call
+        create_pk_cols on their target. It shouldn't be possible to have an 
+        infinite loop since a loop of primary_keys is not a valid situation.
         """
         if self._pk_col_done:
             return
 
-        if self.autoload:
-            return
-
         self.call_builders('create_pk_cols')
 
-        if self.parent:
-            if self.inheritance == 'multi':
-                # add columns with foreign keys to the parent's primary key 
-                # columns 
-                parent_desc = self.parent._descriptor
-                for pk_col in parent_desc.primary_keys:
-                    colname = "%s_%s" % (self.parent.__name__.lower(),
-                                         pk_col.key)
-
-                    # it seems like SA ForeignKey is not happy being given a 
-                    # real column object when said column is not yet attached 
-                    # to a table
-                    pk_col_name = "%s.%s" % (parent_desc.tablename, pk_col.key)
-                    col = Column(colname, pk_col.type, 
-                                 ForeignKey(pk_col_name), primary_key=True)
-                    self.add_column(col)
-        elif not self.has_pk and self.auto_primarykey:
-            if isinstance(self.auto_primarykey, basestring):
-                colname = self.auto_primarykey
-            else:
-                colname = options.DEFAULT_AUTO_PRIMARYKEY_NAME
-            
-            self.add_column(
-                Column(colname, options.DEFAULT_AUTO_PRIMARYKEY_TYPE, 
-                       primary_key=True))
+        if not self.autoload:
+            if self.parent:
+                if self.inheritance == 'multi':
+                    # add columns with foreign keys to the parent's primary 
+                    # key columns 
+                    parent_desc = self.parent._descriptor
+                    for pk_col in parent_desc.primary_keys:
+                        colname = "%s_%s" % (self.parent.__name__.lower(),
+                                             pk_col.key)
+
+                        # it seems like SA ForeignKey is not happy being given
+                        # a real column object when said column is not yet 
+                        # attached to a table
+                        pk_col_name = "%s.%s" % (parent_desc.tablename, 
+                                                 pk_col.key)
+                        col = Column(colname, pk_col.type, 
+                                     ForeignKey(pk_col_name), primary_key=True)
+                        self.add_column(col)
+            elif not self.has_pk and self.auto_primarykey:
+                if isinstance(self.auto_primarykey, basestring):
+                    colname = self.auto_primarykey
+                else:
+                    colname = options.DEFAULT_AUTO_PRIMARYKEY_NAME
+                
+                self.add_column(
+                    Column(colname, options.DEFAULT_AUTO_PRIMARYKEY_TYPE, 
+                           primary_key=True))
         self._pk_col_done = True
 

elixir/trunk/tests/test_autoload.py

@@ -19 +19 @@
         Column('id', Integer, primary_key=True),
         Column('name', String(30)),
-        Column('color', String(15)),
         Column('owner_id', Integer, ForeignKey('person.id')),
         Column('feeder_id', Integer, ForeignKey('person.id')))
@@ -66 +65 @@
                                 tablename='person_category')
 
-    elixir.options_defaults.update(dict(autoload=False, shortnames=False))
-
     metadata.bind = meta.bind
     setup_all()
@@ -74 +71 @@
 def teardown():
     cleanup_all()
+    elixir.options_defaults.update(dict(autoload=False, shortnames=False))
 
 #-----------
@@ -86 +84 @@
     
     def test_autoload(self):
-        snowball = Animal(name="Snowball II", color="grey")
+        snowball = Animal(name="Snowball II")
         slh = Animal(name="Santa's Little Helper")
         homer = Person(name="Homer", animals=[snowball, slh], pets=[slh])
@@ -160 +158 @@
         assert homer in barney.isappreciatedby
 
+
+def setup_entity_raise(cls):
+    try:
+        setup_entities([cls])
+    except Exception, e:
+        pass
+    else:
+        assert False, "Exception did not occur setting up %s" % cls.__name__
+
+class TestAutoloadOverrideColumn(object):
+    def setup(self):
+        create_all()
+
+    def teardown(self):
+        drop_all()
+
+    def test_override_pk_fails(self):
+        class Person(Entity):
+            id = Field(Integer, primary_key=True)
+
+        setup_entity_raise(Person)
+
+    def test_override_non_pk_fails(self):
+        class Animal(Entity):
+            name = Field(Unicode(30))
+
+        setup_entity_raise(Animal)
+
+    def test_override_pk(self):
+        class Person(Entity):
+            using_options(allowcoloverride=True)
+
+            id = Field(Integer, primary_key=True)
+
+        setup_entities([Person])
+
+    def test_override_non_pk(self):
+        class Animal(Entity):
+            using_options(allowcoloverride=True)
+
+            name = Field(Unicode(30))
+
+        setup_entities([Animal])
+        assert isinstance(Animal.table.columns['name'].type, Unicode)
+
+