mirror of
https://github.com/Hopiu/django-model-utils.git
synced 2026-03-17 04:10:24 +00:00
02b2082e90
- remove __getitem__, no need for it anymore - remove implicit lowercasing (principle of least surprise: strings are usually case sensitive)
98 lines
2.9 KiB
Python
98 lines
2.9 KiB
Python
class ChoiceEnum(object):
|
|
"""
|
|
A class to encapsulate handy functionality for lists of choices
|
|
for a Django model field.
|
|
|
|
Accepts verbose choice names as arguments, and automatically
|
|
assigns numeric keys to them. When iterated over, behaves as the
|
|
standard Django choices tuple of two-tuples.
|
|
|
|
Attribute access allows conversion of verbose choice name to
|
|
choice key, dictionary access the reverse.
|
|
|
|
Example:
|
|
|
|
>>> STATUS = ChoiceEnum('DRAFT', 'PUBLISHED')
|
|
>>> STATUS.DRAFT
|
|
0
|
|
>>> STATUS[1]
|
|
'PUBLISHED'
|
|
>>> tuple(STATUS)
|
|
((0, 'DRAFT'), (1, 'PUBLISHED'))
|
|
|
|
"""
|
|
def __init__(self, *choices):
|
|
self._choices = tuple(enumerate(choices))
|
|
self._choice_dict = dict(self._choices)
|
|
self._reverse_dict = dict(((i[1], i[0]) for i in self._choices))
|
|
|
|
def __iter__(self):
|
|
return iter(self._choices)
|
|
|
|
def __getattr__(self, attname):
|
|
try:
|
|
return self._reverse_dict[attname]
|
|
except KeyError:
|
|
raise AttributeError(attname)
|
|
|
|
def __getitem__(self, key):
|
|
return self._choice_dict[key]
|
|
|
|
def __repr__(self):
|
|
return '%s(%s)' % (self.__class__.__name__,
|
|
', '.join(("'%s'" % i[1] for i in self._choices)))
|
|
|
|
|
|
class Choices(object):
|
|
"""
|
|
A class to encapsulate handy functionality for lists of choices
|
|
for a Django model field.
|
|
|
|
Accepts as arguments either tuples mapping choice IDs (numeric or
|
|
text) to human-readable names, or simply choice IDs (in which case
|
|
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 choice ID to human-readable
|
|
name.
|
|
|
|
Example:
|
|
|
|
>>> STATUS = Choices('DRAFT', 'PUBLISHED')
|
|
>>> STATUS.draft
|
|
DRAFT
|
|
>>> tuple(STATUS)
|
|
(('DRAFT', 'DRAFT'), ('PUBLISHED', 'PUBLISHED'))
|
|
|
|
>>> STATUS = Choices(('DRAFT', 'is a draft'), ('PUBLISHED', 'is published'))
|
|
>>> STATUS.draft
|
|
is a draft
|
|
>>> tuple(STATUS)
|
|
(('DRAFT', 'is a draft'), ('PUBLISHED', 'is published'))
|
|
|
|
"""
|
|
|
|
def __init__(self, *choices):
|
|
self._choices = tuple(self.equalize(choices))
|
|
self._choice_dict = dict(self._choices)
|
|
self._reverse_dict = dict(((i[0], i[0]) for i in self._choices))
|
|
|
|
def equalize(self, choices):
|
|
for choice in choices:
|
|
if isinstance(choice, (list, tuple)):
|
|
yield choice
|
|
else:
|
|
yield (choice, choice)
|
|
|
|
def __iter__(self):
|
|
return iter(self._choices)
|
|
|
|
def __getattr__(self, attname):
|
|
try:
|
|
return self._reverse_dict[attname]
|
|
except KeyError:
|
|
raise AttributeError(attname)
|
|
|
|
def __repr__(self):
|
|
return '%s(%s)' % (self.__class__.__name__,
|
|
', '.join(("'%s'" % i[0] for i in self._choices)))
|