#-----------------------------------------------------------------------------
# Copyright (c) 2012 - 2021, Anaconda, Inc., and Bokeh Contributors.
# All rights reserved.
#
# The full license is in the file LICENSE.txt, distributed with this software.
#-----------------------------------------------------------------------------
""" Provide the Enum property.
"""
#-----------------------------------------------------------------------------
# Boilerplate
#-----------------------------------------------------------------------------
from __future__ import annotations
import logging # isort:skip
log = logging.getLogger(__name__)
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Bokeh imports
from ...util.string import nice_join
from .. import enums
from ._sphinx import model_link, property_link, register_type_link
from .primitive import String
from .singletons import Intrinsic
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
__all__ = (
'Enum',
)
#-----------------------------------------------------------------------------
# General API
#-----------------------------------------------------------------------------
[docs]class Enum(String):
""" Accept values from enumerations.
The first value in enumeration is used as the default value, unless the
``default`` keyword argument is used.
See :ref:`bokeh.core.enums` for more information.
"""
def __init__(self, enum, *values, default=Intrinsic, help=None, serialized=None, readonly=False) -> None:
if not (not values and isinstance(enum, enums.Enumeration)):
enum = enums.enumeration(enum, *values)
self._enum = enum
default = default if default is not Intrinsic else enum._default
super().__init__(default=default, help=help, serialized=serialized, readonly=readonly)
def __str__(self) -> str:
class_name = self.__class__.__name__
allowed_values = ", ".join(repr(x) for x in self.allowed_values)
return f"{class_name}({allowed_values})"
@property
def allowed_values(self):
return self._enum._values
def validate(self, value, detail=True):
super().validate(value, detail)
if value in self._enum:
return
msg = "" if not detail else f"invalid value: {value!r}; allowed values are {nice_join(self.allowed_values)}"
raise ValueError(msg)
#-----------------------------------------------------------------------------
# Dev API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Private API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------
@register_type_link(Enum)
def _sphinx_type(obj):
# try to return a link to a proper enum in bokeh.core.enums if possible
if obj._enum in enums.__dict__.values():
for name, value in enums.__dict__.items():
if obj._enum is value:
fullname = f"{obj._enum.__module__}.{name}"
return f"{property_link(obj)}({model_link(fullname)})"
# otherwise just a basic str name format
return f"{property_link(obj)}({obj._enum})"