Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Factor out NamedListLike baseclass #2127

Merged
merged 3 commits into from
Mar 29, 2021
Merged

Factor out NamedListLike baseclass #2127

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72a833e
Factor out NamedListLike baseclass
philippjfr Mar 29, 2021
0e07361
Add missing methods
philippjfr Mar 29, 2021
692b2be
Add missing getitem
philippjfr Mar 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 100 additions & 57 deletions panel/layout/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,6 @@ def select(self, selector=None):
return objects



class ListLike(param.Parameterized):

objects = param.List(default=[], doc="""
Expand Down Expand Up @@ -331,72 +330,21 @@ def reverse(self):
new_objects.reverse()
self.objects = new_objects



class ListPanel(ListLike, Panel):
"""
An abstract baseclass for Panel objects with list-like children.
"""

margin = param.Parameter(default=0, doc="""
Allows to create additional space around the component. May
be specified as a two-tuple of the form (vertical, horizontal)
or a four-tuple (top, right, bottom, left).""")

scroll = param.Boolean(default=False, doc="""
Whether to add scrollbars if the content overflows the size
of the container.""")

_source_transforms = {'scroll': None}

__abstract = True

def __init__(self, *objects, **params):
from ..pane import panel
if objects:
if 'objects' in params:
raise ValueError("A %s's objects should be supplied either "
"as positional arguments or as a keyword, "
"not both." % type(self).__name__)
params['objects'] = [panel(pane) for pane in objects]
elif 'objects' in params:
params['objects'] = [panel(pane) for pane in params['objects']]
super(Panel, self).__init__(**params)

def _process_param_change(self, params):
scroll = params.pop('scroll', None)
css_classes = self.css_classes or []
if scroll:
params['css_classes'] = css_classes + ['scrollable']
elif scroll == False:
params['css_classes'] = css_classes
return super()._process_param_change(params)

def _cleanup(self, root):
if root.ref['id'] in state._fake_roots:
state._fake_roots.remove(root.ref['id'])
super()._cleanup(root)
for p in self.objects:
p._cleanup(root)


class NamedListPanel(ListPanel):

active = param.Integer(default=0, bounds=(0, None), doc="""
Index of the currently displayed objects.""")
class NamedListLike(param.Parameterized):

objects = param.List(default=[], doc="""
The list of child objects that make up the tabs.""")
The list of child objects that make up the layout.""")

def __init__(self, *items, **params):
if 'objects' in params:
if items:
raise ValueError('%s objects should be supplied either '
'as positional arguments or as a keyword, '
'not both.' % type(self).__name__)
items = params['objects']
objects, self._names = self._to_objects_and_names(items)
super().__init__(*objects, **params)
items = params.pop('objects')
params['objects'], self._names = self._to_objects_and_names(items)
super().__init__(**params)
self._panels = defaultdict(dict)
self.param.watch(self._update_names, 'objects')
# ALERT: Ensure that name update happens first, should be
Expand Down Expand Up @@ -441,6 +389,20 @@ def _update_active(self, *events):
# Public API
#----------------------------------------------------------------

def __getitem__(self, index):
return self.objects[index]

def __len__(self):
return len(self.objects)

def __iter__(self):
for obj in self.objects:
yield obj

def __iadd__(self, other):
self.extend(other)
return self

def __add__(self, other):
if isinstance(other, NamedListPanel):
other = list(zip(other._names, other.objects))
Expand Down Expand Up @@ -621,6 +583,87 @@ def reverse(self):
self.objects = new_objects


class ListPanel(ListLike, Panel):
"""
An abstract baseclass for Panel objects with list-like children.
"""

margin = param.Parameter(default=0, doc="""
Allows to create additional space around the component. May
be specified as a two-tuple of the form (vertical, horizontal)
or a four-tuple (top, right, bottom, left).""")

scroll = param.Boolean(default=False, doc="""
Whether to add scrollbars if the content overflows the size
of the container.""")

_source_transforms = {'scroll': None}

__abstract = True

def __init__(self, *objects, **params):
from ..pane import panel
if objects:
if 'objects' in params:
raise ValueError("A %s's objects should be supplied either "
"as positional arguments or as a keyword, "
"not both." % type(self).__name__)
params['objects'] = [panel(pane) for pane in objects]
elif 'objects' in params:
params['objects'] = [panel(pane) for pane in params['objects']]
super(Panel, self).__init__(**params)

def _process_param_change(self, params):
scroll = params.pop('scroll', None)
css_classes = self.css_classes or []
if scroll:
params['css_classes'] = css_classes + ['scrollable']
elif scroll == False:
params['css_classes'] = css_classes
return super()._process_param_change(params)

def _cleanup(self, root):
if root.ref['id'] in state._fake_roots:
state._fake_roots.remove(root.ref['id'])
super()._cleanup(root)
for p in self.objects:
p._cleanup(root)


class NamedListPanel(NamedListLike, Panel):

active = param.Integer(default=0, bounds=(0, None), doc="""
Index of the currently displayed objects.""")

margin = param.Parameter(default=0, doc="""
Allows to create additional space around the component. May
be specified as a two-tuple of the form (vertical, horizontal)
or a four-tuple (top, right, bottom, left).""")

scroll = param.Boolean(default=False, doc="""
Whether to add scrollbars if the content overflows the size
of the container.""")

_source_transforms = {'scroll': None}

__abstract = True

def _process_param_change(self, params):
scroll = params.pop('scroll', None)
css_classes = self.css_classes or []
if scroll:
params['css_classes'] = css_classes + ['scrollable']
elif scroll == False:
params['css_classes'] = css_classes
return super()._process_param_change(params)

def _cleanup(self, root):
if root.ref['id'] in state._fake_roots:
state._fake_roots.remove(root.ref['id'])
super()._cleanup(root)
for p in self.objects:
p._cleanup(root)


class Row(ListPanel):
"""
Expand Down