A key_name controller module to collect all of the name...() functions that
compose Model entity key names, plus some minor changes to other controller
modules to illustrate the proposed use.
Patch by: Todd Larsen
Review by: Pawel Solyga
Review URL: http://codereviews.googleopensourceprograms.com/804
Review URL: http://codereviews.googleopensourceprograms.com/804
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/app/soc/logic/key_name.py Thu Sep 25 17:17:11 2008 +0000
@@ -0,0 +1,36 @@
+#!/usr/bin/python2.5
+#
+# Copyright 2008 the Melange authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Functions for composing Model entity key names.
+"""
+
+__authors__ = [
+ '"Todd Larsen" <tlarsen@google.com>',
+ ]
+
+
+import soc.models.site_settings
+import soc.models.user
+
+
+def nameSiteSettings(path):
+ """Returns a SiteSettings key name constructed from a supplied path."""
+ return '%s:%s' % (soc.models.site_settings.SiteSettings.__name__, path)
+
+
+def nameUser(email):
+ """Returns a User key name constructed from a supplied email address."""
+ return '%s:%s' % (soc.models.user.User.__name__, email)
--- a/app/soc/logic/site/id_user.py Wed Sep 24 21:23:42 2008 +0000
+++ b/app/soc/logic/site/id_user.py Thu Sep 25 17:17:11 2008 +0000
@@ -27,6 +27,7 @@
from google.appengine.api import users
from google.appengine.ext import db
+from soc.logic import key_name
from soc.logic import out_of_band
import soc.models.user
@@ -41,7 +42,7 @@
if not id:
return None
- return 'User:%s' % id.email()
+ return key_name.nameUser(id.email())
def getIdIfMissing(id=None):
--- a/app/soc/logic/site/settings.py Wed Sep 24 21:23:42 2008 +0000
+++ b/app/soc/logic/site/settings.py Thu Sep 25 17:17:11 2008 +0000
@@ -23,9 +23,12 @@
from google.appengine.ext import db
+from soc.logic import key_name
+
import soc.models.site_settings
import soc.logic.model
+
def getSiteSettingsFromPath(path):
"""Returns SiteSettings entity for a given path, or None if not found.
@@ -42,6 +45,7 @@
return site_settings
+
def getSiteSettingsKeyNameForPath(path):
"""Return a Datastore key_name for a SiteSettings from the path.
@@ -51,7 +55,7 @@
if not path:
return None
- return 'Settings:%s' % path
+ return key_name.nameSiteSettings(path)
def updateOrCreateSiteSettingsFromPath(path, **site_settings_properties):