mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-02-25 18:55:28 -06:00
Added example to StrEnum docstring
This commit is contained in:
parent
364e05def1
commit
bae9dd7c07
@ -934,6 +934,16 @@ class BytesEnum(Enum):
|
|||||||
class StrEnum(Enum):
|
class StrEnum(Enum):
|
||||||
"""
|
"""
|
||||||
Enumerable for Unicode text (stored in the ``unicode`` type).
|
Enumerable for Unicode text (stored in the ``unicode`` type).
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
>>> enum = StrEnum('my_enum', values=(u'One', u'Two', u'Three'))
|
||||||
|
>>> enum.validate(u'Two') is None
|
||||||
|
True
|
||||||
|
>>> enum.validate(u'Four')
|
||||||
|
Traceback (most recent call last):
|
||||||
|
...
|
||||||
|
ValidationError: invalid 'my_enum': must be one of (u'One', u'Two', u'Three')
|
||||||
"""
|
"""
|
||||||
|
|
||||||
type = unicode
|
type = unicode
|
||||||
|
Loading…
Reference in New Issue
Block a user