Changeset 401

Timestamp:

09/15/08 15:32:51 (5 years ago)

Author:

ged

Message:

- fixed bug with the new "schema" argument on ManyToMany relationships (I

introduced it in my modification of the original patch).

- added some more documentation on Relationships
- removed unused imports

Location:

elixir/trunk/elixir

Files:

• fields.py (modified) (1 diff)
• options.py (modified) (1 diff)
• relationships.py (modified) (7 diffs)

elixir/trunk/elixir/fields.py

@@ -105 +105 @@
         has_field('name', String(50))
 '''
-import sys
-
 from sqlalchemy import Column
 from sqlalchemy.orm import deferred, synonym

elixir/trunk/elixir/options.py

@@ -174 +174 @@
 '''
 
-import sqlalchemy
-import sqlalchemy.orm
 from sqlalchemy import Integer, String
 

elixir/trunk/elixir/relationships.py

@@ -64 +64 @@
 | Option Name          | Description                                          |
 +======================+======================================================+
-| ``colname``          | Specify a custom column name.                        |
+| ``colname``          | Specify a custom name for the foreign key column(s). |
+|                      | This argument accepts either a single string or a    |
+|                      | list of strings. The number of strings passed must   |
+|                      | match the number of primary key columns of the target|
+|                      | entity. If this argument is not used, the name of the|
+|                      | column(s) is generated with the pattern              |
+|                      | defined in options.FKCOL_NAMEFORMAT, which is, by    |
+|                      | default: "%(relname)s_%(key)s", where relname is the |
+|                      | name of the ManyToOne relationship, and 'key' is the |
+|                      | name (key) of the primary column in the target       |
+|                      | entity. That's with, in the above Pet/owner example, |
+|                      | the name of the column would be: "owner_id".         |
 +----------------------+------------------------------------------------------+
 | ``required``         | Specify whether or not this field can be set to None |
@@ -124 +135 @@
 +======================+======================================================+
 | ``field``            | Specify the previously-declared field to be used for |
-|                      | the foreign key                                      |
-|                      | column. Use of this parameter is mutually exclusive  |
-|                      | with the colname and column_kwargs arguments.        |
+|                      | the foreign key column. Use of this parameter is     |
+|                      | mutually exclusive with the colname and column_kwargs|
+|                      | arguments.                                           |
 +----------------------+------------------------------------------------------+
 
@@ -216 +227 @@
         articles = ManyToMany('Article')
 
-Behind the scene, the ``ManyToMany`` relationship will
-automatically create an intermediate table to host its data.
+Behind the scene, the ``ManyToMany`` relationship will automatically create an
+intermediate table to host its data.
 
 Note that you don't necessarily need to define the inverse relationship.  In
@@ -237 +248 @@
 |                    | can be used both when the tables needs to be created   |
 |                    | and when the table is autoloaded/reflected from the    |
-|                    | database.                                              |
+|                    | database. If this argument is not used, a name will be |
+|                    | automatically generated by Elixir depending on the name|
+|                    | of the tables of the two entities of the relationship, |
+|                    | the name of the relationship, and, if present, the name|
+|                    | of its inverse. Even though this argument is optional, |
+|                    | it is wise to use it if you are not sure what are the  |
+|                    | exact consequence of using a generated table name.     |
 +--------------------+--------------------------------------------------------+
 | ``schema``         | Specify a custom schema for the intermediate table.    |
@@ -374 +391 @@
 '''
 
-import sys
 import warnings
 
@@ -383 +399 @@
 import options
 from elixir.statements import ClassMutator
-from elixir.fields import Field
 from elixir.properties import Property
-from elixir.entity import EntityDescriptor, EntityMeta, DEBUG
+from elixir.entity import EntityMeta, DEBUG
 
 __doc_all__ = []
@@ -823 +838 @@
         e1_schema = e1_desc.table_options.get('schema', None)
         e2_schema = e2_desc.table_options.get('schema', None)
-        schema = (self.schema is not None) and schema or e1_schema
+        schema = (self.schema is not None) and self.schema or e1_schema
 
         assert e1_schema == e2_schema or self.schema, \