allow field choices to be specified as a set

docs/changelog.rst

@@ -4,8 +4,7 @@ Changelog
 
 Development
 ===========
-- (Fill this out as you fix issues and develop your features).
+- (Fill this out as you fix issues and develop you features).
-- Fixed using sets in field choices #1481
 - POTENTIAL BREAKING CHANGE: Fixed limit/skip/hint/batch_size chaining #1476
 - POTENTIAL BREAKING CHANGE: Changed a public `QuerySet.clone_into` method to a private `QuerySet._clone_into` #1476
 - Fixed connecting to a replica set with PyMongo 2.x #1436

docs/guide/defining-documents.rst

@@ -150,7 +150,7 @@ arguments can be set on all fields:
     .. note:: If set, this field is also accessible through the `pk` field.
 
 :attr:`choices` (Default: None)
-    An iterable (e.g. list, tuple or set) of choices to which the value of this
+    An iterable (e.g. a list or tuple) of choices to which the value of this
     field should be limited.
 
     Can be either be a nested tuples of value (stored in mongo) and a
@@ -214,8 +214,8 @@ document class as the first argument::
 
 Dictionary Fields
 -----------------
-Often, an embedded document may be used instead of a dictionary – generally
+Often, an embedded document may be used instead of a dictionary – generally 
-embedded documents are recommended as dictionaries don’t support validation
+embedded documents are recommended as dictionaries don’t support validation 
 or custom field types. However, sometimes you will not know the structure of what you want to
 store; in this situation a :class:`~mongoengine.fields.DictField` is appropriate::
 

mongoengine/base/fields.py

@@ -189,15 +189,18 @@ class BaseField(object):
         pass
 
     def _validate_choices(self, value):
+        """Validate that value is a valid choice for this field."""
         Document = _import_class('Document')
         EmbeddedDocument = _import_class('EmbeddedDocument')
 
+        # Field choices can be given as an iterable (e.g. tuple/list/set) of
+        # values or an iterable of value-label pairs, e.g. ('XS', 'Extra Small').
+        # It the latter case, extract just the values for comparison.
         choice_list = self.choices
         if isinstance(next(iter(choice_list)), (list, tuple)):
-            # next(iter) is useful for sets
+            choice_list = [val for val, label in choice_list]
-            choice_list = [k for k, _ in choice_list]
 
-        # Choices which are other types of Documents
+        # Validate Document/EmbeddedDocument choices
         if isinstance(value, (Document, EmbeddedDocument)):
             if not any(isinstance(value, c) for c in choice_list):
                 self.error(
@@ -205,7 +208,8 @@ class BaseField(object):
                         six.text_type(choice_list)
                     )
                 )
-        # Choices which are types other than Documents
+
+        # Validate any other type of choices
         elif value not in choice_list:
             self.error('Value must be one of %s' % six.text_type(choice_list))
 

mongoengine/fields.py

@@ -139,12 +139,12 @@ class URLField(StringField):
         # Check first if the scheme is valid
         scheme = value.split('://')[0].lower()
         if scheme not in self.schemes:
-            self.error(u'Invalid scheme {} in URL: {}'.format(scheme, value))
+            self.error('Invalid scheme {} in URL: {}'.format(scheme, value))
             return
 
         # Then check full URL
         if not self.url_regex.match(value):
-            self.error(u'Invalid URL: {}'.format(value))
+            self.error('Invalid URL: {}'.format(value))
             return
 
 

tests/fields/fields.py

@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
+import six
+from nose.plugins.skip import SkipTest
+
 import datetime
 import unittest
 import uuid
 import math
 import itertools
 import re
-
-from nose.plugins.skip import SkipTest
 import six
 
 try:
@@ -26,13 +27,21 @@ from mongoengine import *
 from mongoengine.connection import get_db
 from mongoengine.base import (BaseDict, BaseField, EmbeddedDocumentList,
                               _document_registry)
-
+from mongoengine.errors import NotRegistered, DoesNotExist
-from tests.utils import MongoDBTestCase
 
 __all__ = ("FieldTest", "EmbeddedDocumentListFieldTestCase")
 
 
-class FieldTest(MongoDBTestCase):
+class FieldTest(unittest.TestCase):
+
+    def setUp(self):
+        connect(db='mongoenginetest')
+        self.db = get_db()
+
+    def tearDown(self):
+        self.db.drop_collection('fs.files')
+        self.db.drop_collection('fs.chunks')
+        self.db.drop_collection('mongoengine.counters')
 
     def test_default_values_nothing_set(self):
         """Ensure that default field values are used when creating a document.
@@ -218,9 +227,9 @@ class FieldTest(MongoDBTestCase):
         self.assertTrue(isinstance(ret.comp_dt_fld, datetime.datetime))
 
     def test_not_required_handles_none_from_database(self):
-        """Ensure that every field can handle null values from the
+        """Ensure that every fields can handle null values from the database.
-        database.
         """
+
         class HandleNoneFields(Document):
             str_fld = StringField(required=True)
             int_fld = IntField(required=True)
@@ -341,12 +350,11 @@ class FieldTest(MongoDBTestCase):
         person.validate()
 
     def test_url_validation(self):
-        """Ensure that URLFields validate urls properly."""
+        """Ensure that URLFields validate urls properly.
+        """
         class Link(Document):
             url = URLField()
 
-        Link.drop_collection()
-
         link = Link()
         link.url = 'google'
         self.assertRaises(ValidationError, link.validate)
@@ -354,27 +362,6 @@ class FieldTest(MongoDBTestCase):
         link.url = 'http://www.google.com:8080'
         link.validate()
 
-    def test_unicode_url_validation(self):
-        """Ensure unicode URLs are validated properly."""
-        class Link(Document):
-            url = URLField()
-
-        Link.drop_collection()
-
-        link = Link()
-        link.url = u'http://привет.com'
-
-        # TODO fix URL validation - this *IS* a valid URL
-        # For now we just want to make sure that the error message is correct
-        try:
-            link.validate()
-            self.assertTrue(False)
-        except ValidationError as e:
-            self.assertEqual(
-                unicode(e),
-                u"ValidationError (Link:None) (Invalid URL: http://\u043f\u0440\u0438\u0432\u0435\u0442.com: ['url'])"
-            )
-
     def test_url_scheme_validation(self):
         """Ensure that URLFields validate urls with specific schemes properly.
         """
@@ -3199,42 +3186,40 @@ class FieldTest(MongoDBTestCase):
         att.delete()
         self.assertEqual(0, Attachment.objects.count())
 
-    def test_choices_allow_using_sets_as_choices(self):
+    def test_choices_validation(self):
-        """Ensure that sets can be used when setting choices
+        """Ensure that value is in a container of allowed values.
         """
         class Shirt(Document):
-            size = StringField(choices={'M', 'L'})
+            size = StringField(max_length=3, choices=(
+                ('S', 'Small'), ('M', 'Medium'), ('L', 'Large'),
+                ('XL', 'Extra Large'), ('XXL', 'Extra Extra Large')))
 
-        Shirt(size='M').validate()
+        Shirt.drop_collection()
-
-    def test_choices_validation_allow_no_value(self):
-        """Ensure that .validate passes and no value was provided
-        for a field setup with choices
-        """
-        class Shirt(Document):
-            size = StringField(choices=('S', 'M'))
 
         shirt = Shirt()
         shirt.validate()
 
-    def test_choices_validation_accept_possible_value(self):
+        shirt.size = "S"
-        """Ensure that value is in a container of allowed values.
-        """
-        class Shirt(Document):
-            size = StringField(choices=('S', 'M'))
-
-        shirt = Shirt(size='S')
         shirt.validate()
 
-    def test_choices_validation_reject_unknown_value(self):
+        shirt.size = "XS"
-        """Ensure that unallowed value are rejected upon validation
+        self.assertRaises(ValidationError, shirt.validate)
-        """
-        class Shirt(Document):
-            size = StringField(choices=('S', 'M'))
 
-        shirt = Shirt(size="XS")
+    def test_choices_as_set(self):
-        with self.assertRaises(ValidationError):
+        """Ensure that sets can be used as field choices"""
-            shirt.validate()
+        class Shirt(Document):
+            size = StringField(choices={'S', 'M', 'L', 'XL', 'XXL'})
+
+        Shirt.drop_collection()
+
+        shirt = Shirt()
+        shirt.validate()
+
+        shirt.size = "S"
+        shirt.validate()
+
+        shirt.size = "XS"
+        self.assertRaises(ValidationError, shirt.validate)
 
     def test_choices_validation_documents(self):
         """
@@ -4053,13 +4038,12 @@ class FieldTest(MongoDBTestCase):
         self.assertTrue(isinstance(doc.some_long, six.integer_types))
 
 
-class EmbeddedDocumentListFieldTestCase(MongoDBTestCase):
+class EmbeddedDocumentListFieldTestCase(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.db = connect(db='EmbeddedDocumentListFieldTestCase')
 
-    def setUp(self):
-        """
-        Create two BlogPost entries in the database, each with
-        several EmbeddedDocuments.
-        """
         class Comments(EmbeddedDocument):
             author = StringField()
             message = StringField()
@@ -4067,11 +4051,14 @@ class EmbeddedDocumentListFieldTestCase(MongoDBTestCase):
         class BlogPost(Document):
             comments = EmbeddedDocumentListField(Comments)
 
-        BlogPost.drop_collection()
+        cls.Comments = Comments
-
+        cls.BlogPost = BlogPost
-        self.Comments = Comments
-        self.BlogPost = BlogPost
 
+    def setUp(self):
+        """
+        Create two BlogPost entries in the database, each with
+        several EmbeddedDocuments.
+        """
         self.post1 = self.BlogPost(comments=[
             self.Comments(author='user1', message='message1'),
             self.Comments(author='user2', message='message1')
@@ -4083,6 +4070,13 @@ class EmbeddedDocumentListFieldTestCase(MongoDBTestCase):
             self.Comments(author='user3', message='message1')
         ]).save()
 
+    def tearDown(self):
+        self.BlogPost.drop_collection()
+
+    @classmethod
+    def tearDownClass(cls):
+        cls.db.drop_database('EmbeddedDocumentListFieldTestCase')
+
     def test_no_keyword_filter(self):
         """
         Tests the filter method of a List of Embedded Documents
@@ -4440,8 +4434,7 @@ class EmbeddedDocumentListFieldTestCase(MongoDBTestCase):
             my_list = ListField(EmbeddedDocumentField(EmbeddedWithUnique))
 
         A(my_list=[]).save()
-        with self.assertRaises(NotUniqueError):
+        self.assertRaises(NotUniqueError, lambda: A(my_list=[]).save())
-            A(my_list=[]).save()
 
         class EmbeddedWithSparseUnique(EmbeddedDocument):
             number = IntField(unique=True, sparse=True)
@@ -4449,9 +4442,6 @@ class EmbeddedDocumentListFieldTestCase(MongoDBTestCase):
         class B(Document):
             my_list = ListField(EmbeddedDocumentField(EmbeddedWithSparseUnique))
 
-        A.drop_collection()
-        B.drop_collection()
-
         B(my_list=[]).save()
         B(my_list=[]).save()
 
@@ -4491,8 +4481,6 @@ class EmbeddedDocumentListFieldTestCase(MongoDBTestCase):
             a_field = IntField()
             c_field = IntField(custom_data=custom_data)
 
-        CustomData.drop_collection()
-
         a1 = CustomData(a_field=1, c_field=2).save()
         self.assertEqual(2, a1.c_field)
         self.assertFalse(hasattr(a1.c_field, 'custom_data'))

tests/fields/file_tests.py

@@ -18,13 +18,15 @@ try:
 except ImportError:
     HAS_PIL = False
 
-from tests.utils import MongoDBTestCase
-
 TEST_IMAGE_PATH = os.path.join(os.path.dirname(__file__), 'mongoengine.png')
 TEST_IMAGE2_PATH = os.path.join(os.path.dirname(__file__), 'mongodb_leaf.png')
 
 
-class FileTest(MongoDBTestCase):
+class FileTest(unittest.TestCase):
+
+    def setUp(self):
+        connect(db='mongoenginetest')
+        self.db = get_db()
 
     def tearDown(self):
         self.db.drop_collection('fs.files')

tests/utils.py

@@ -1,22 +0,0 @@
-import unittest
-
-from mongoengine import connect
-from mongoengine.connection import get_db
-
-MONGO_TEST_DB = 'mongoenginetest'
-
-
-class MongoDBTestCase(unittest.TestCase):
-    """Base class for tests that need a mongodb connection
-    db is being dropped automatically
-    """
-
-    @classmethod
-    def setUpClass(cls):
-        cls._connection = connect(db=MONGO_TEST_DB)
-        cls._connection.drop_database(MONGO_TEST_DB)
-        cls.db = get_db()
-
-    @classmethod
-    def tearDownClass(cls):
-        cls._connection.drop_database(MONGO_TEST_DB)