py_tasks_melange: comparison app/soc/models/answer.py

equal deleted inserted replaced

-:0d78f41dde9b
+:b9be44e09530
 # 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.
-"""This module contains the Answer Model."""
+"""This module contains the Answer Model"""
 __authors__ = [
 '"Todd Larsen" <tlarsen@google.com>',
 '"Sverre Rabbelier" <sverre@rabbelier.nl>',
 ]
+import polymodel
 from google.appengine.ext import db
-from soc import models
-from soc.models import base
 import soc.models.question
-import soc.models.review
+import soc.models.quiz
+import soc.models.response
-class Answer(base.ModelWithFieldAttributes):
+class Answer(polymodel.PolyModel):
-"""Model of a specific Answer to a Question in a specific Review."""
+"""Model of a specific Answer to a Question in a specific Response.
+The properties in this Model do not have verbose_name or help_text,
+because the dynamic nature of the forms required to create, edit, and
+use entities of this Model make them pretty useless.
+"""
 #: A required many:1 relationship, where each of many Answers is
 #: a specific answer to a single Question.  An Answer must always
 #: be associated with a Question in order to be interpreted.
 #: It is currently unclear how useful this back-reference will be,
-#: since the same question could be used in multiple different
+#: since the same Question could be used in multiple different
-#: Review "templates". Given this, 'answers' currently only exists
+#: Quizzes. Given this, 'answers' currently only exists for
-#: for completeness.
+#: completeness.
-# TODO: Uncomment when Question model is committed
+question = db.ReferenceProperty(
-#question = db.ReferenceProperty(reference_class=models.question.Question,
+reference_class=soc.models.question.Question, required=True,
-#                                required=True, collection_name="answers")
+collection_name="answers")
-#: A required many:1 relationship, where each of many Answers to
+#: A many:1 relationship, where each of many Answers to different
-#: different Questions represents the answer set of a specific
+#: Questions represents the answer set of a specific Response to a Quiz.
-#: Review. The back-reference in the Review model is a Query named
+#: The back-reference in the Response model is a Query named 'answers'
-#: 'answers' which represents all of the specific answers to
+#: which represents all of the specific Answers to Questions in that
-#: questions in that Review.
+#: Response.
-review = db.ReferenceProperty(reference_class=models.review.Review,
+#:
-required=True, collection_name="answers")
+#: One and only one of the response or quiz ReferenceProperties *must*
+#: be defined for an Answer entity.
+response = db.ReferenceProperty(
+reference_class=soc.models.response.Response, required=False,
+collection_name="answers")
-#: db.StringProperty storing the "short" answer to the question;
+#: A many:1 relationship, where each of many Answers to different
-#: the interpretation of this value depends on the Question entity
+#: Questions represents the solution set for the Questions in a Quiz.
-#: referred to by 'question'. Answers can be indexed, filtered, and
+#: The back-reference in the Quiz model is a Query named 'solutions'
-#: sorted by their "short" answer. Depending on the Question type,
+#: which represents all of the solutions to Questions in that Quiz.
-#: some Answers will use only 'short', some only 'long', some both.
+#:
-short = db.StringProperty()
+#: One and only one of the response or quiz ReferenceProperties *must*
+#: be defined for an Answer entity.
+quiz = db.ReferenceProperty(
+reference_class=soc.models.quiz.Quiz, required=False,
+collection_name="solutions")
-#: db.TextProperty storing the "long" answer to the question;
+#: db.ListProperty of strings representing the answer value or values.
-#: the interpretation of this value depends on the Question entity
+#:
-#: referred to by 'question'.
+#: For Questions that are not multiple-choice (see the choice_ids and
-long = db.TextProperty()
+#: choices properties of soc.models.question.Question), this list will
+#: contain a single string that is a free-form text answer.
-#: db.ListProperty of short strings from the list of possible
+#:
-#: picks in the question.pick_choices list.
+#: For Questions that *are* multiple-choice, this list will contain one
-picks = db.ListProperty(item_type=str)
+#: or more short, plain-text, "link_name-like" strings representing the
+#: "encoded" answer choices (see the choice_ids property in
+#: soc.models.question.Question).  For such multiple-choice Questions,
+#: how many strings are stored depends on the max_answers property of
+#: the soc.models.question.Question entity for which this is an Answer.
+#:
+#: If question.is_optional is True, 'answers' may even be None or an
+#: empty list if no answers were provided.
+#:
+#: Answers can be indexed, filtered, and sorted by this list, but only in
+#: the way that query operators work with a db.ListProperty.
+answers = db.ListProperty(item_type=str)

changeset 339	b9be44e09530
parent 316	9efdc7bc3565
child 512	aae25d2b4464