diff options
Diffstat (limited to 'django/engagementmanager/utils/choice_enum.py')
-rwxr-xr-x | django/engagementmanager/utils/choice_enum.py | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/django/engagementmanager/utils/choice_enum.py b/django/engagementmanager/utils/choice_enum.py new file mode 100755 index 0000000..ef19de2 --- /dev/null +++ b/django/engagementmanager/utils/choice_enum.py @@ -0,0 +1,56 @@ +# +# ============LICENSE_START========================================== +# org.onap.vvp/engagementmgr +# =================================================================== +# Copyright © 2017 AT&T Intellectual Property. All rights reserved. +# =================================================================== +# +# Unless otherwise specified, all software contained herein is licensed +# under the Apache License, Version 2.0 (the “License”); +# you may not use this software except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# +# +# Unless otherwise specified, all documentation contained herein is licensed +# under the Creative Commons License, Attribution 4.0 Intl. (the “License”); +# you may not use this documentation except in compliance with the License. +# You may obtain a copy of the License at +# +# https://creativecommons.org/licenses/by/4.0/ +# +# Unless required by applicable law or agreed to in writing, documentation +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ============LICENSE_END============================================ +# +# ECOMP is a trademark and service mark of AT&T Intellectual Property. +from enum import Enum + + +class ChoiceEnum(Enum): + """An Enumeration with an added choices() method useful in Django""" + + @classmethod + def choices(cls): + """Return this Enum's values in a format suitable for use as Django Field.choices param. + + https://docs.python.org/3/library/enum.html + https://docs.djangoproject.com/en/1.10/ref/models/fields/#choices + + """ + # FIXME it might be more useful in some situations to return (x.value, x.name), but we do + # this way is for compatibility with older versions of this code. Changing would require a + # data migration.` + return [(x.name, x.name) for x in cls] |