Source code for bokeh.models.selectors
#-----------------------------------------------------------------------------
# Copyright (c) Anaconda, Inc., and Bokeh Contributors.
# All rights reserved.
#
# The full license is in the file LICENSE.txt, distributed with this software.
#-----------------------------------------------------------------------------
"""
Models representing selector queries for UI components.
"""
#-----------------------------------------------------------------------------
# Boilerplate
#-----------------------------------------------------------------------------
from __future__ import annotations
import logging # isort:skip
log = logging.getLogger(__name__)
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Bokeh imports
from ..core.has_props import abstract
from ..core.properties import Required, String
from ..core.property.bases import Init
from ..core.property.singletons import Intrinsic
from ..model import Model
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
__all__ = (
"ByID",
"ByClass",
"ByCSS",
"ByXPath",
)
#-----------------------------------------------------------------------------
# General API
#-----------------------------------------------------------------------------
@abstract
class Selector(Model):
""" Base class for selector queries. """
# explicit __init__ to support Init signatures
def __init__(self, *args, **kwargs) -> None:
super().__init__(*args, **kwargs)
[docs]
class ByID(Selector):
""" Represents a CSS ID selector query. """
# explicit __init__ to support Init signatures
def __init__(self, query: Init[str] = Intrinsic, **kwargs) -> None:
super().__init__(query=query, **kwargs)
query = Required(String, help="""
Element CSS ID without ``#`` prefix. Alternatively use ``ByCSS("#id")``.
""")
[docs]
class ByClass(Selector):
""" Represents a CSS class selector query. """
# explicit __init__ to support Init signatures
def __init__(self, query: Init[str] = Intrinsic, **kwargs) -> None:
super().__init__(query=query, **kwargs)
query = Required(String, help="""
CSS class name without ``.`` prefix. Alternatively use ``ByCSS(".class")``.
""")
[docs]
class ByCSS(Selector):
""" Represents a CSS selector query. """
# explicit __init__ to support Init signatures
def __init__(self, query: Init[str] = Intrinsic, **kwargs) -> None:
super().__init__(query=query, **kwargs)
query = Required(String, help="""
CSS selector query (see https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors).
""")
[docs]
class ByXPath(Selector):
""" Represents an XPath selector query. """
# explicit __init__ to support Init signatures
def __init__(self, query: Init[str] = Intrinsic, **kwargs) -> None:
super().__init__(query=query, **kwargs)
query = Required(String, help="""
XPath selector query (see https://developer.mozilla.org/en-US/docs/Web/XPath).
""")
#-----------------------------------------------------------------------------
# Dev API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Private API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------