panel.util Package

---

util Package

Various general utilities used in the panel codebase.

class panel.util.LazyHTMLSanitizer(**kwargs)

Bases: object

Wraps bleach.sanitizer.Cleaner lazily importing it on the first call to the clean method.

panel.util.abbreviated_repr(value, max_length=25, natural_breaks=(',', ' '))

Returns an abbreviated repr for the supplied object. Attempts to find a natural break point while adhering to the maximum length.

panel.util.base_version(version: str) → str

Extract the final release and if available pre-release (alpha, beta, release candidate) segments of a PEP440 version, defined with three components (major.minor.micro).

Useful to avoid nbsite/sphinx to display the documentation HTML title with a not so informative and rather ugly long version (e.g. 0.13.0a19.post4+g0695e214). Use it in conf.py:

version = release = base_version(package.__version__)

Return the version passed as input if no match is found with the pattern.

panel.util.datetime_as_utctimestamp(value)

Converts a datetime to a UTC timestamp used by Bokeh internally.

panel.util.decode_token(token: str, signed: bool = True) → dict[str, Any]

Decodes a signed or unsigned JWT token.

panel.util.flatten(line)

Flatten an arbitrarily nested sequence.

Inspired by: pd.core.common.flatten

Parameters

linesequence

The sequence to flatten

Notes

This only flattens list, tuple, and dict sequences.

Returns

flattened : generator

panel.util.full_groupby(l, key=<function <lambda>>)

Groupby implementation which does not require a prior sort

panel.util.fullpath(path: AnyStr | PathLike) → AnyStr | PathLike

Expanduser and then abspath for a given path

panel.util.function_name(func) → str

Returns the name of a function (or its string repr)

panel.util.indexOf(obj, objs)

Returns the index of an object in a list of objects. Unlike the list.index method this function only checks for identity not equality.

panel.util.param_name(name: str) → str

Removes the integer id from a Parameterized class name.

panel.util.param_reprs(parameterized, skip=None)

Returns a list of reprs for parameters on the parameterized object. Skips default and empty values.

panel.util.parse_query(query: str) → dict[str, Any]

Parses a url query string, e.g. ?a=1&b=2.1&c=string, converting numeric strings to int or float types.

panel.util.prefix_length(a: str, b: str) → int

Searches for the length of overlap in the starting characters of string b in a. Uses binary search if b is not already a prefix of a.

panel.util.styler_update(styler, new_df)

Updates the todo items on a pandas Styler object to apply to a new DataFrame.

Arguments

styler: pandas.io.formats.style.Styler

Styler objects

new_df: pd.DataFrame

New DataFrame to update the styler to do items

Returns

todos: list

panel.util.url_path(url: str) → str

Strips the protocol and domain from a URL returning just the path.

panel.util.value_as_datetime(value)

Retrieve the value tuple as a tuple of datetime objects.

---

checks Module

panel.util.checks.isIn(obj, objs)

Checks if the object is in the list of objects safely.

panel.util.checks.is_holoviews(obj: Any) → bool

Whether the object is a HoloViews type that can be rendered.

panel.util.checks.is_parameterized(obj) → bool

Whether an object is a Parameterized class or instance.

panel.util.checks.isdatetime(value) → bool

Whether the array or scalar is recognized datetime type.

panel.util.checks.isfile(path: str) → bool

Safe version of os.path.isfile robust to path length issues on Windows

---

parameters Module

panel.util.parameters.edit_readonly(parameterized: Parameterized) → Iterator

Temporarily set parameters on Parameterized object to readonly=False to allow editing them.

panel.util.parameters.extract_dependencies(function)

Extract references from a method or function that declares the references.

panel.util.parameters.get_method_owner(meth)

Returns the instance owning the supplied instancemethod or the class owning the supplied classmethod.

panel.util.parameters.recursive_parameterized(parameterized: Parameterized, objects=None) → list[Parameterized]

Recursively searches a Parameterized object for other Parmeterized objects.

---

warnings Module

exception panel.util.warnings.PanelDeprecationWarning

Bases: DeprecationWarning

A Panel-specific DeprecationWarning subclass. Used to selectively filter Panel deprecations for unconditional display.

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception panel.util.warnings.PanelUserWarning

Bases: UserWarning

A Panel-specific UserWarning subclass. Used to selectively filter Panel warnings for unconditional display.

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

panel.util.warnings.find_stack_level() → int

Find the first place in the stack that is not inside Panel and Param. Inspired by: pandas.util._exceptions.find_stack_level

---