soc/models/user.py
changeset 7 5c72db822ebb
equal deleted inserted replaced
6:466837359a1c 7:5c72db822ebb
       
     1 #!/usr/bin/python2.5
       
     2 #
       
     3 # Copyright 2008 the Melange authors.
       
     4 #
       
     5 # Licensed under the Apache License, Version 2.0 (the "License");
       
     6 # you may not use this file except in compliance with the License.
       
     7 # You may obtain a copy of the License at
       
     8 # 
       
     9 #   http://www.apache.org/licenses/LICENSE-2.0
       
    10 # 
       
    11 # Unless required by applicable law or agreed to in writing, software
       
    12 # distributed under the License is distributed on an "AS IS" BASIS,
       
    13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       
    14 # See the License for the specific language governing permissions and
       
    15 # limitations under the License.
       
    16 
       
    17 """This module contains the User Model."""
       
    18 
       
    19 __authors__ = [
       
    20   '"Todd Larsen" <tlarsen@google.com>',
       
    21   '"Sverre Rabbelier" <sverre@rabbelier.nl>',
       
    22 ]
       
    23 
       
    24 from google.appengine.ext import db
       
    25 
       
    26 
       
    27 class User(db.Model):
       
    28   """A user and associated login credentials, the fundamental identity entity.
       
    29 
       
    30   User is a separate Model class from Person because the same login 
       
    31   ID may be used to, for example, serve as Contributor in one Program 
       
    32   and a Reviewer in another.
       
    33 
       
    34   Also, this allows a Person to, in the future, re-associate that 
       
    35   Person entity with a different Google Account if necessary.
       
    36 
       
    37   A User entity participates in the following relationships implemented 
       
    38   as a db.ReferenceProperty elsewhere in another db.Model:
       
    39 
       
    40    persons)  a 1:many relationship of Person entities identified by the
       
    41      User.  This relation is implemented as the 'persons' back-reference
       
    42      Query of the Person model 'user' reference.
       
    43 
       
    44   """
       
    45 
       
    46   #: A Google Account, which also provides a "private" email address.
       
    47   #: This email address is only used in an automated fashion by 
       
    48   #: Melange web applications and is not made visible to other users 
       
    49   #: of any Melange application.
       
    50   id = db.UserProperty(required=True)
       
    51