Hopiu/django-model-utils
1
0
Fork 0
mirror of https://github.com/Hopiu/django-model-utils.git synced 2026-05-23 00:55:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix Choices docstring, minor code changes:

Browse source 
- remove __getitem__, no need for it anymore
- remove implicit lowercasing (principle of least surprise: strings are usually case sensitive)
This commit is contained in:
Carl Meyer 2010-04-15 22:32:33 -04:00
parent cb46293b0a
commit 02b2082e90
2 changed files with 10 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
model_utils/__init__.py
View file

@ -48,26 +48,25 @@ class Choices(object):
A class to encapsulate handy functionality for lists of choices A class to encapsulate handy functionality for lists of choices
for a Django model field. for a Django model field.
Accepts verbose choice names as arguments, and automatically Accepts as arguments either tuples mapping choice IDs (numeric or
assigns numeric keys to them. When iterated over, behaves as the text) to human-readable names, or simply choice IDs (in which case
standard Django choices tuple of two-tuples. the ID is also used as the human-readable name). When iterated
over, behaves as the standard Django choices tuple of two-tuples.
Attribute access allows conversion of verbose choice name to Attribute access allows conversion of choice ID to human-readable
choice key, dictionary access the reverse. name.
Example: Example:
>>> STATUS = Choices('DRAFT', 'PUBLISHED') >>> STATUS = Choices('DRAFT', 'PUBLISHED')
>>> STATUS.draft >>> STATUS.draft
DRAFT DRAFT
>>> STATUS[1]
'PUBLISHED'
>>> tuple(STATUS) >>> tuple(STATUS)
(('DRAFT', 'DRAFT'), ('PUBLISHED', 'PUBLISHED')) (('DRAFT', 'DRAFT'), ('PUBLISHED', 'PUBLISHED'))
>>> STATUS = Choices(('DRAFT', 'is a draft'), ('PUBLISHED', 'is published')) >>> STATUS = Choices(('DRAFT', 'is a draft'), ('PUBLISHED', 'is published'))
>>> STATUS.draft >>> STATUS.draft
DRAFT is a draft
>>> tuple(STATUS) >>> tuple(STATUS)
(('DRAFT', 'is a draft'), ('PUBLISHED', 'is published')) (('DRAFT', 'is a draft'), ('PUBLISHED', 'is published'))
@ -76,7 +75,7 @@ class Choices(object):
def __init__(self, *choices): def __init__(self, *choices):
self._choices = tuple(self.equalize(choices)) self._choices = tuple(self.equalize(choices))
self._choice_dict = dict(self._choices) self._choice_dict = dict(self._choices)
self._reverse_dict = dict(((i[0].lower(), i[0]) for i in self._choices)) self._reverse_dict = dict(((i[0], i[0]) for i in self._choices))
def equalize(self, choices): def equalize(self, choices):
for choice in choices: for choice in choices:
@ -94,9 +93,6 @@ class Choices(object):
except KeyError: except KeyError:
raise AttributeError(attname) raise AttributeError(attname)
def __getitem__(self, key):
return self._choices[key][0]
def __repr__(self): def __repr__(self):
return '%s(%s)' % (self.__class__.__name__, return '%s(%s)' % (self.__class__.__name__,
', '.join(("'%s'" % i[0] for i in self._choices))) ', '.join(("'%s'" % i[0] for i in self._choices)))

10
model_utils/tests/tests.py
View file

@ -95,17 +95,11 @@ class ChoicesTests(TestCase):
self.STATUS = Choices('DRAFT', 'PUBLISHED') self.STATUS = Choices('DRAFT', 'PUBLISHED')
def test_getattr(self): def test_getattr(self):
self.assertEquals(self.STATUS.draft, 'DRAFT') self.assertEquals(self.STATUS.DRAFT, 'DRAFT')
def test_getitem(self):
self.assertEquals(self.STATUS[1], 'PUBLISHED')
def test_iteration(self): def test_iteration(self):
self.assertEquals(tuple(self.STATUS), (('DRAFT', 'DRAFT'), ('PUBLISHED', 'PUBLISHED'))) self.assertEquals(tuple(self.STATUS), (('DRAFT', 'DRAFT'), ('PUBLISHED', 'PUBLISHED')))
def test_display(self):
self.assertEquals(self.STATUS.draft, 'DRAFT')
class LabelChoicesTests(ChoicesTests): class LabelChoicesTests(ChoicesTests):
def setUp(self): def setUp(self):
self.STATUS = Choices( self.STATUS = Choices(
@ -122,7 +116,7 @@ class LabelChoicesTests(ChoicesTests):
) )
def test_display(self): def test_display(self):
self.assertEquals(self.STATUS.deleted, 'DELETED') self.assertEquals(self.STATUS.DELETED, 'DELETED')
class InheritanceCastModelTests(TestCase): class InheritanceCastModelTests(TestCase):