Changeset 18 for elixir/trunk/elixir/relationships.py

Timestamp:

02/01/07 23:30:27 (6 years ago)

Author:

cleverdevil

Message:

A bunch of docstring updates, representing a good chunk of documentation.
The docstring on relationships is only partially done, as I ran out of
gas after describing the 'belongs_to' relationship type.

Files:

• elixir/trunk/elixir/relationships.py (modified) (3 diffs)

elixir/trunk/elixir/relationships.py

@@ +1 @@
+'''
+This module provides support for defining relationships between your Elixir 
+entities.  The supported relationship types are as follows:
+
+    `belongs_to`
+    ------------
+    Describes the child's side of a parent-child relationship.  For example, 
+    a `Pet` object may belong to its owner, who is a `Person.`  This could be
+    expressed like so:
+                
+        class Pet(Entity):
+            belongs_to('owner', of_kind='Person', inverse='pets')
+    
+    You must specify the 'kind' of object that you are relating to using the
+    of_kind keyword argument.  Additionally, if you plan on defining the other
+    side of the relationship, you should specify the name of the relationship
+    on the other side using the 'inverse' keyword argument.
+
+
+    `has_one`
+    ---------
+    TODO.
+    
+
+    `has_many`
+    ----------
+    TODO.
+
+
+    `has_and_belongs_to_many`
+    -------------------------
+    TODO.
+'''
+
 from sqlalchemy         import relation, ForeignKeyConstraint, Column, \
                                Table, and_
@@ -18 +52 @@
 class Relationship(object):
     '''
-    Base class for relationships
+    Base class for relationships.
     '''
     
@@ -151 +185 @@
 
 class BelongsTo(Relationship):
+    '''
+    
+    '''
+    
     
     def create_keys(self):