Choices on steroids


Keywords
choices, django, django-choices
License
BSD-3-Clause
Install
pip install choose==2.0.0

Documentation

choose

Choices on steroids

Supported versions

  • Python 2 and 3 support

How to install

pip install choose

Basic usage:

>>> class Types(choose.Choices):
>>>     BAR = choose.Choice('foo_bar', 'Foo Bar')
>>>     BAZ = choose.Choice('foo_baz', 'Foo Baz')
>>> Types.BAR
'foo_bar'
>>> Types.BAR.text
'Foo Bar'
>>> Types.items()
(('foo_bar', 'Foo Bar'), ('foo_baz', 'Foo Baz'))
>>> Types.keys()
('foo_bar', 'foo_baz')
>>> Types.values()
('Foo Bar', 'Foo Baz')
>>> 'foo_bar' in Types
True

Extended usage:

>>> class Types2(choose.Choices):
>>>     BAR = choose.Choice('foo_bar', 'Foo Bar', default=False)
>>>     BAZ = choose.Choice('foo_baz', 'Foo Baz', default=False)
>>>     FOO = choose.Choice('foo_foo', 'Foo Foo', default=True)
>>>
>>>     @classmethod
>>>     def get_default(cls):
>>>         return next(
>>>             (item for item in cls.keys() if item.opts.default is True),
>>>             None,
>>>         )
>>>
>>> Types2.BAR.opts.default
False
>>> Types2.BAR.opts.not_existing_attr is None
True
>>> 'foo_bar' == Types2.get_default()
False
>>> Types2.BAR == Types2.get_default()
False
>>> 'foo_foo' == Types2.get_default()
True
>>> Types2.FOO == Types2.get_default()
True

Usage in Django:

class AModel(models.Model):
    class AChoices(choose.Choices):
        X = choose.Choice('x', 'X')
        Y = choose.Choice('y', 'Y')

    choice = models.CharField(max_length=63, choices=AChoices.items())