yafowil.widget.array 2.0.0__py2.py3-none-any.whl

yafowil/widget/array/widget.py

@@ -0,0 +1,341 @@
+from node.utils import UNSET
+from yafowil.base import factory
+from yafowil.base import fetch_value
+from yafowil.common import generic_extractor
+from yafowil.common import generic_required_extractor
+from yafowil.compat import ITER_TYPES
+from yafowil.compound import compound_renderer
+from yafowil.utils import attr_value
+from yafowil.utils import css_managed_props
+from yafowil.utils import cssclasses
+from yafowil.utils import cssid
+from yafowil.utils import managedprops
+from yafowil.base import factory
+
+@managedprops(*css_managed_props)
+def array_display_proxy_renderer(widget, data):
+    """B/C. Use ``display_proxy`` widget attribute.
+    """
+    input_attrs = {
+        'type': 'hidden',
+        'value': fetch_value(widget, data),
+        'name_': widget.dottedpath,
+        'id': cssid(widget, 'input'),
+        'class_': cssclasses(widget, data),
+        'required': attr_value('required', widget, data) and 'required' or None
+    }
+    return data.tag('input', **input_attrs) + data.rendered
+
+
+factory.register(
+    'array_display_proxy',
+    extractors=[generic_extractor],
+    edit_renderers=[array_display_proxy_renderer],
+    display_renderers=[array_display_proxy_renderer]
+)
+
+# do not document internal widget
+factory.doc['blueprint']['array_display_proxy'] = UNSET
+
+
+ICON_CSS = {
+    'add': 'icon-plus-sign',
+    'remove': 'icon-minus-sign',
+    'up': 'icon-circle-arrow-up',
+    'down': 'icon-circle-arrow-down',
+}
+BS_ICON = {
+    'add': 'bi-plus-circle-fill',
+    'remove': 'bi-dash-circle-fill',
+    'up': 'bi-arrow-up-circle-fill',
+    'down': 'bi-arrow-down-circle-fill',
+}
+
+
+def actions_renderer(widget, data):
+    tag = data.tag
+    actions = list()
+    icons = BS_ICON if factory.theme == 'bootstrap5' else ICON_CSS
+    for key in ['add', 'remove', 'up', 'down']:
+        if widget.attrs.get(key):
+            class_ = 'array_row_%s' % key
+            icon = tag('span', ' ', class_=icons[key])
+            action = tag('a', icon, href='#', class_=class_)
+            actions.append(action)
+    kw = dict(class_='array_actions')
+    return tag('div', *actions, **kw)
+
+
+factory.register(
+    'array_actions',
+    edit_renderers=[actions_renderer]
+)
+
+# do not document internal widget
+factory.doc['blueprint']['array_actions'] = UNSET
+
+
+def array_builder(widget, factory):
+    table = widget['table'] = factory('table', props={
+        'structural': True,
+        'class': widget.attrs['table_class'],
+    })
+    head = table['head'] = factory('thead', props={
+        'structural': True,
+    })
+    row = head['row'] = factory('tr', props={
+        'structural': True,
+    })
+    label = widget.attrs.get('label', u' ')
+    if callable(label):
+        label = label()
+    row['label'] = factory('th', props={
+        'structural': True,
+        'label': label,
+    })
+    if not widget.attrs['static']:
+        props = dict()
+        props['structural'] = True
+        props['th.class'] = 'head_actions'
+        if widget.attrs['add']:
+            props['add'] = True
+        row['actions'] = factory('th:array_actions', props=props)
+    table['body'] = factory('tbody', props={
+        'structural': True,
+    })
+
+
+@managedprops('add', 'remove', 'sort', 'static', 'table_class', *css_managed_props)
+def array_wrapper_renderer(widget, data):
+    add_css = ''
+    if not widget.attrs['static']:
+        for attr in ['add', 'remove', 'sort']:
+            if widget.attrs[attr]:
+                add_css += ' array-%s' % attr
+    else:
+        add_css += ' array-static'
+    kw = {
+        'id': cssid(widget, 'array'),
+        'class': cssclasses(widget, data) + add_css,
+    }
+    if 'array' not in kw['class'].split(' '):
+        kw['class'] = 'array %s' % kw['class']
+    rendered = data.rendered
+    return data.tag('div', rendered, **kw)
+
+
+CONTAINER = 'TEMPLATE_CONTAINER'
+TEMPLATE = 'TEMPLATE'
+
+
+def array_edit_renderer(widget, data):
+    if len(widget) == 1 and CONTAINER not in widget:
+        raise Exception(u"Empty array widget defined")
+    if CONTAINER not in widget:
+        template = widget.detach(widget.keys()[1])
+        hook_array_template(widget, template)
+    value = fetch_value(widget, data)
+    # XXX: reset table body if already filled -> case form in memory.
+    if value:
+        widget.getter = UNSET
+        data.value = UNSET
+        template = widget[CONTAINER][TEMPLATE]
+        create_array_children(widget, template, value)
+    if not widget.attrs['add'] or widget.attrs['static']:
+        del widget[CONTAINER]
+
+
+def create_array_children(widget, template, value):
+    if isinstance(value, dict):
+        try:
+            indices = [int(_) for _ in value.keys()]
+        except ValueError as e:
+            raise Exception(u"Array value error. %s" % str(e))
+        indices = sorted(indices)
+        for i in indices:
+            create_array_entry(str(i), widget, template, value[str(i)])
+    elif type(value) in ITER_TYPES:
+        indices = range(len(value))
+        for i in indices:
+            create_array_entry(str(i), widget, template, value[i])
+    else:
+        raise ValueError(u"Expected list or dict as value. Got '{}'".format(
+            str(type(value)))
+        )
+
+
+def create_array_entry(idx, widget, template, value):
+    tbody = widget['table']['body']
+    row = tbody['row_%s' % idx] = factory('tr', props={'structural': True})
+    props = dict()
+    props['structural'] = True
+    props['class'] = 'widget'
+    widget_col = row['widget_col'] = factory('td', props=props)
+    if not widget.attrs['static']:
+        props = dict()
+        props['structural'] = True
+        props['class'] = 'actions'
+        actions_col = row['actions_col'] = factory('td', props=props)
+        props = dict()
+        props['structural'] = True
+        if widget.attrs['add']:
+            props['add'] = True
+        if widget.attrs['remove']:
+            props['remove'] = True
+        if widget.attrs['sort']:
+            props['up'] = True
+            props['down'] = True
+        actions_col['actions'] = factory('array_actions', props=props)
+    child_widget = widget_col[idx] = duplicate_widget(template, value)
+    if 'array' in template.blueprints:
+        if len(template):
+            create_array_entry_children(child_widget, template)
+        orgin = template[template.keys()[-1]]
+        template = duplicate_recursiv(orgin)
+        hook_array_template(child_widget, template)
+        # If array in array with compound. Compound template children get
+        # hooked to array widget. Remove them.
+        for key in child_widget.keys():
+            if key not in ['table', CONTAINER]:
+                del child_widget[key]
+        return
+    create_array_entry_children(child_widget, template)
+
+
+def create_array_entry_children(widget, template):
+    for name, child_template in template.items():
+        child_widget = widget[name] = duplicate_recursiv(child_template)
+        create_array_entry_children(child_widget, child_template)
+
+
+def hook_array_template(widget, template):
+    props = dict()
+    props['structural'] = True
+    props['class'] = 'arraytemplate'
+    container = widget[CONTAINER] = factory('div', props=props)
+    if template.attrs.get('structural'):
+        raise Exception(
+            u"Compound templates for arrays must not be structural.")
+    container[TEMPLATE] = template
+
+
+def duplicate_widget(widget, value=UNSET):
+    blueprints = widget.blueprints
+    leaf = len(widget) == 0
+    # B/C: use display_property widget attribute!
+    if leaf and (widget.mode == 'display' or widget.attrs.get('disabled')) \
+            and 'array_display_proxy' not in blueprints:
+        if not widget.attrs.get('display_proxy'):
+            blueprints.insert(0, 'array_display_proxy')
+    return factory(
+        blueprints,
+        value=value,
+        props=widget.properties,
+        custom=widget.custom,
+        mode=widget.mode)
+
+
+def duplicate_recursiv(widget):
+    node = duplicate_widget(widget)
+    for k, v in widget.items():
+        node[k] = duplicate_recursiv(v)
+    return node
+
+
+def array_extractor(widget, data):
+    template = widget[widget.keys()[-1]]
+    helper = duplicate_recursiv(template)
+    request = data.request
+    ret = list()
+    index = 0
+    while True:
+        helper.__parent__ = widget
+        helper.__name__ = str(index)
+        if not check_base_name_in_request(helper, request):
+            break
+        entry_data = helper.extract(request, parent=data)
+        ret.append(entry_data.extracted)
+        data[str(index)] = entry_data
+        index += 1
+    return ret
+
+
+def check_base_name_in_request(widget, request):
+    basename = widget.dottedpath
+    for key in request.keys():
+        if key.startswith(basename):
+            return True
+    return False
+
+
+def set_display_mode(widget):
+    for child in widget.values():
+        child.mode = 'display'
+        set_display_mode(child)
+
+
+def array_display_renderer(widget, data):
+    array_edit_renderer(widget, data)
+    del widget['table']['head']['row']['actions']
+    for row in widget['table']['body'].values():
+        del row['actions_col']
+    del widget[CONTAINER]
+    set_display_mode(widget)
+
+
+factory.register(
+    'array',
+    extractors=[
+        array_extractor,
+        generic_required_extractor
+    ],
+    edit_renderers=[
+        array_edit_renderer,
+        compound_renderer,
+        array_wrapper_renderer
+    ],
+    display_renderers=[
+        array_display_renderer,
+        compound_renderer
+    ],
+    builders=[array_builder]
+)
+
+factory.doc['blueprint']['array'] = """\
+Add-on widget `yafowil.widget.array
+<http://github.com/conestack/yafowil.widget.array/>`_.
+"""
+
+factory.defaults['array.class'] = 'array card'
+
+factory.defaults['array.required'] = False
+
+factory.defaults['array.error_class'] = 'error'
+
+factory.defaults['array.message_class'] = 'errormessage'
+
+factory.defaults['array.table_class'] = None
+factory.doc['props']['array.table_class'] = """\
+CSS classes rendered on array table.
+"""
+
+factory.defaults['array.static'] = False
+factory.doc['props']['array.static'] = """\
+Array is immutable. No Array actions are rendered. If True, ``add``,
+``remove`` and ``sort`` properties are ignored.
+"""
+
+factory.defaults['array.add'] = True
+factory.doc['props']['array.add'] = """\
+Render ``add`` action.
+"""
+
+factory.defaults['array.remove'] = True
+factory.doc['props']['array.remove'] = """\
+Render ``remove`` action.
+"""
+
+factory.defaults['array.sort'] = True
+factory.doc['props']['array.sort'] = """\
+Render ``move up`` and ``move down`` actions.
+"""

yafowil_widget_array-2.0.0.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: yafowil.widget.array
+Version: 2.0.0
+Summary: Array Widget for YAFOWIL
+Author-email: Yafowil Contributors <dev@conestack.org>
+License: Simplified BSD
+License-File: LICENSE.rst
+Classifier: Environment :: Web Environment
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Dist: yafowil>3.99
+Provides-Extra: test
+Requires-Dist: lxml; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/pypi/v/yafowil.widget.array.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.array
+    :alt: Latest PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/yafowil.widget.array.svg
+    :target: https://pypi.python.org/pypi/yafowil.widget.array
+    :alt: Number of PyPI downloads
+
+.. image:: https://github.com/conestack/yafowil.widget.array/actions/workflows/test_py.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.array/actions/workflows/test_py.yaml
+    :alt: Test yafowil.widget.array Python
+
+.. image:: https://github.com/conestack/yafowil.widget.array/actions/workflows/test_js.yaml/badge.svg
+    :target: https://github.com/conestack/yafowil.widget.array/actions/workflows/test_js.yaml
+    :alt: Test yafowil.widget.array JS
+
+This is an **array widget** for for `YAFOWIL
+<http://pypi.python.org/pypi/yafowil>`_.
+
+- `Documentation <http://docs.yafowil.info/en/latest/blueprints.html#array>`_
+- `DEMO - see it Live <http://demo.yafowil.info/++widget++yafowil.widget.array/index.html>`_
+
+Source Code
+===========
+
+The sources are in a GIT DVCS with its main branches at
+`github <http://github.com/conestack/yafowil.widget.array>`_.
+
+We'd be happy to see many forks and pull-requests to make YAFOWIL even better.
+
+
+Contributors
+============
+
+- Robert Niederreiter
+
+- Georg Bernhard
+
+- Lena Daxenbichler

yafowil_widget_array-2.0.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+yafowil/widget/array/__init__.py,sha256=ed-QB1XiTIllllK-H3yLPXyT3xFW8x2hFPmUiRpAkIE,5687
+yafowil/widget/array/example.py,sha256=zCOm5BRVUsZKJmd0LcNiOXU87kqoCmB-6P8QvlEUPE4,12219
+yafowil/widget/array/widget.py,sha256=pR2MdPgHCE_vmuL5A8iQS4O5AvaZGRbNCBl7ZVxB5V4,10472
+yafowil/widget/array/resources/bootstrap/widget.min.css,sha256=Ud2Wu5-68ZQEAuLPmIvQTAze8H-la_upQCCPX-a1LsA,1090
+yafowil/widget/array/resources/bootstrap5/widget.js,sha256=h9sXU_QtHMe7MnQ1_kI7fliw8h4RVWGvsWLI9_P_s88,10271
+yafowil/widget/array/resources/bootstrap5/widget.min.css,sha256=gj4nryz0kZtfjtIKE5NyGlFJZd9SlNrMemxBPp_yAso,1066
+yafowil/widget/array/resources/bootstrap5/widget.min.js,sha256=nIbxATqBgDJJtTlnVc8LLR3JUArmLmd39AsA6qaCtIA,4989
+yafowil/widget/array/resources/default/widget.js,sha256=SZJN2GQSlTKtX76tohHO0jnp61-pgI6oN5kab5tipM8,9627
+yafowil/widget/array/resources/default/widget.min.css,sha256=CPrc0q9Fn9KCKEaZwrLAroj-rk20lKPQJI69SCn9zyQ,1268
+yafowil/widget/array/resources/default/widget.min.js,sha256=geahGtiyMFF1PQZG4NXP2jflSkThLiCtqc7vfjoImj8,4641
+yafowil/widget/array/resources/default/images/icon_add.png,sha256=fMDUpDyadrUFZKi1tmg8MewGlNtE7i95Z29F1f_lkWU,403
+yafowil/widget/array/resources/default/images/icon_down.png,sha256=lZaOHin1R-mRJDIgogM3Xa-Ky4fjyyGKucENmCzQIQE,584
+yafowil/widget/array/resources/default/images/icon_down_disabled.png,sha256=r9rzJce1ZcBN4uTxd18uu4u5RFqApQ9p7Pb7WAj3ajI,392
+yafowil/widget/array/resources/default/images/icon_remove.png,sha256=SRk6RKB2VXAYmigvv0EY9V6ENeRfjM0aNw58ab-1wcI,221
+yafowil/widget/array/resources/default/images/icon_up.png,sha256=Fh7PTO6ZQ0tpb0rQ3HkHaUS-jIfyY34m0JLT5AEVPPw,560
+yafowil/widget/array/resources/default/images/icon_up_disabled.png,sha256=-MonqfrQOPIv1u9x0GMbU4UgCrjZ3mh-OKQUv2WjjZ8,382
+yafowil/widget/array/resources/plone5/widget.min.css,sha256=gvJ738oMgW1uuOHx8N_aOz9Uv_OenNorotVgS-2LNQ0,1523
+yafowil/widget/array/tests/test_widget.py,sha256=JWfTcZq0BufrYUzubNMxci-_WZnd0QfmSMwe7ucOQyc,83771
+yafowil_widget_array-2.0.0.dist-info/METADATA,sha256=qion7oUj36wLU7-uCbhft2arwq9kWVtd9jWrs8pTx8A,2240
+yafowil_widget_array-2.0.0.dist-info/WHEEL,sha256=aha0VrrYvgDJ3Xxl3db_g_MDIW-ZexDdrc_m-Hk8YY4,105
+yafowil_widget_array-2.0.0.dist-info/entry_points.txt,sha256=7dISa7epdwrzzAMjYpE4TgHTd5398sa7VxVnL2AmYFo,109
+yafowil_widget_array-2.0.0.dist-info/licenses/LICENSE.rst,sha256=F-rGZAUY0JHMT0A0X81pC1v3QlzPgNUUntZLhOAdPAs,1403
+yafowil_widget_array-2.0.0.dist-info/RECORD,,

yafowil_widget_array-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

yafowil_widget_array-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[yafowil.plugin]
+example = yafowil.widget.array.example:get_example
+register = yafowil.widget.array:register

yafowil_widget_array-2.0.0.dist-info/licenses/LICENSE.rst

@@ -0,0 +1,27 @@
+License
+=======
+
+Copyright (c) 2011-2021, BlueDynamics Alliance, Austria, Germany, Switzerland
+Copyright (c) 2021-2025, Yafowil Contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.