chasefinch / data-enum Goto Github PK

As an unfortunate side effect of the design, it is easy to create a new Enum member by accident in the global namespace without realizing it. It would be good for a design improvement or some kind of safety net to prevent users from accidentally monkeypatching a DataEnum.

Cool project, thank you for doing this. It is incredibly useful.

In the readme, all the examples look bland, like for e.g

Minimal usage:

from data_enum import DataEnum

class Currency(DataEnum):
    data_attributes = ('symbol', 'name')

Currency('CAD', symbol='$', name='Canadian dollar')
Currency('USD', symbol='$', name='United States dollar')
Currency('EUR', symbol='€', name='Euro')  

Using the github markdown code tags, specifically,

\``` py
code_here
\``` 

it could look like this

from data_enum import DataEnum

class Currency(DataEnum):
    data_attributes = ('symbol', 'name')

Currency('CAD', symbol='$', name='Canadian dollar')
Currency('USD', symbol='$', name='United States dollar')
Currency('EUR', symbol='€', name='Euro')

Just a quick suggestion, it works for other languages too

Would be good to have some attributes allow a default value that's set when the attribute name is omitted. This might mean that the syntax for "is_unique" needs to be more explicit. For example:

class Currency(DataEnum)
    data_attributes = (
        ('code', dict(is_unique=True)),  # Simple syntax ('code', True) would also still be allowed
        ('symbol', dict(default='$')),
    )

Currency.CAD = Currency(code='CAD')  # Uses default symbol '$'