ul-api-utils 7.7.10__tar.gz → 7.8.0__tar.gz

{ul-api-utils-7.7.10 → ul-api-utils-7.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 7.7.10
+Version: 7.8.0
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul-api-utils-7.7.10 → ul-api-utils-7.8.0}/setup.py

@@ -9,7 +9,7 @@ with open(path.join(HERE, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='ul-api-utils',
-    version='7.7.10',
+    version='7.8.0',
     description='Python api utils',
     author='Unic-lab',
     long_description=long_description,

ul-api-utils-7.8.0/ul_api_utils/resources/web_forms/custom_fields/custom_checkbox_select.py

@@ -0,0 +1,5 @@
+from wtforms import SelectMultipleField, widgets  # type: ignore
+
+
+class MultiCheckboxField(SelectMultipleField):
+    option_widget = widgets.CheckboxInput()

ul-api-utils-7.8.0/ul_api_utils/resources/web_forms/custom_widgets/custom_select_widget.py

@@ -0,0 +1,86 @@
+from typing import Any
+
+from markupsafe import Markup
+from wtforms import SelectField  # type: ignore
+from wtforms.widgets.core import html_params, Select  # type: ignore
+
+
+class CustomLiveSearchPlaceholderSelect(Select):
+    """
+    Renders a CUSTOM select field.
+
+    If `multiple` is True, then the `size` property should be specified on
+    rendering to make the field useful.
+
+    The field must provide an `iter_choices()` method which the widget will
+    call on rendering; this method must yield tuples of
+    `(value, label, selected)`.
+    It also must provide a `has_groups()` method which tells whether choices
+    are divided into groups, and if they do, the field must have an
+    `iter_groups()` method that yields tuples of `(label, choices)`, where
+    `choices` is an iterable of `(value, label, selected)` tuples.
+    Otherwise, `selected` is False for any option field in select item group.
+    """
+    def __call__(self, field: SelectField, **kwargs: Any) -> Markup:
+        kwargs.setdefault("id", field.id)
+        if self.multiple:
+            kwargs["multiple"] = True
+        flags = getattr(field, "flags", {})
+        for k in dir(flags):
+            if k in self.validation_attrs and k not in kwargs:
+                kwargs[k] = getattr(flags, k)
+
+        html = ["<select data-live-search='true' data-show-subtext='true' %s>" % html_params(name=field.name, **kwargs),
+                "<option value='' disabled selected>Select something...</option>"]
+
+        if field.has_groups():
+            for group, choices in field.iter_groups():
+                html.append("<optgroup %s>" % html_params(label=group))
+                for val, label, selected in choices:
+                    html.append(self.render_option(val, label, selected))
+                html.append("</optgroup>")
+        else:
+            for val, label, _ in field.iter_choices():
+                html.append(self.render_option(val, label, False))
+        html.append("</select>")
+        return Markup("".join(html))
+
+
+class CustomLiveSearchSelect(Select):
+    """
+    Renders a CUSTOM select field.
+
+    If `multiple` is True, then the `size` property should be specified on
+    rendering to make the field useful.
+
+    The field must provide an `iter_choices()` method which the widget will
+    call on rendering; this method must yield tuples of
+    `(value, label, selected)`.
+    It also must provide a `has_groups()` method which tells whether choices
+    are divided into groups, and if they do, the field must have an
+    `iter_groups()` method that yields tuples of `(label, choices)`, where
+    `choices` is an iterable of `(value, label, selected)` tuples.
+    Otherwise, `selected` is False for any option field in select item group.
+    """
+    def __call__(self, field: SelectField, **kwargs: Any) -> Markup:
+        kwargs.setdefault("id", field.id)
+        if self.multiple:
+            kwargs["multiple"] = True
+        flags = getattr(field, "flags", {})
+        for k in dir(flags):
+            if k in self.validation_attrs and k not in kwargs:
+                kwargs[k] = getattr(flags, k)
+
+        html = ["<select data-live-search='true' data-show-subtext='true' %s>" % html_params(name=field.name, **kwargs)]
+
+        if field.has_groups():
+            for group, choices in field.iter_groups():
+                html.append("<optgroup %s>" % html_params(label=group))
+                for val, label, selected in choices:
+                    html.append(self.render_option(val, label, selected))
+                html.append("</optgroup>")
+        else:
+            for val, label, selected in field.iter_choices():
+                html.append(self.render_option(val, label, selected))
+        html.append("</select>")
+        return Markup("".join(html))

ul-api-utils-7.8.0/ul_api_utils/resources/web_forms/custom_widgets/custom_text_input_widget.py

@@ -0,0 +1,42 @@
+from typing import Optional, Any
+
+from wtforms import StringField   # type: ignore
+from wtforms.widgets import TextInput   # type: ignore
+from markupsafe import Markup
+
+
+class CustomTextInput(TextInput):
+    """
+    Render a single-line text input with optional input attributes ("required", "maxlength", "minlength", "pattern").
+
+    examples: TextInputCustom(required=True, min_length=5, max_length=255, pattern=r"^(d+(,d+)*)?$")
+              TextInputCustom(max_length=255, pattern=r"^(d+(,d+)*)?$")
+              TextInputCustom(required=True, pattern=r"^(d+(,d+)*)?$")
+              TextInputCustom(max_length=255)
+    In model usage: ... info={"label": "LABEL:", "widget": TextInputCustom(pattern=r"^(d+(,d+)*)?$")}
+    """
+    validation_attrs = ["required", "maxlength", "minlength", "pattern"]
+
+    def __init__(self, required: Optional[bool] = None, max_length: Optional[int] = None, min_length: Optional[int] = None, pattern: Optional[str] = None):
+        super().__init__()
+        self.required = required
+        self.max_length = max_length
+        self.min_length = min_length
+        self.pattern = pattern
+
+    def __call__(self, field: StringField, **kwargs: Any) -> Markup:
+        kwargs.setdefault("id", field.id)
+        kwargs.setdefault("type", self.input_type)
+        if self.min_length:
+            kwargs.setdefault("minlength", self.min_length)
+        if self.max_length:
+            kwargs.setdefault("maxlength", self.max_length)
+        if self.pattern:
+            kwargs.setdefault("pattern", self.pattern)
+        if "value" not in kwargs:
+            kwargs["value"] = field._value()
+        flags = getattr(field, "flags", {})
+        for k in dir(flags):
+            if k in self.validation_attrs and k not in kwargs:
+                kwargs[k] = getattr(flags, k)
+        return Markup("<input %s>" % self.html_params(name=field.name, **kwargs))

ul-api-utils-7.8.0/ul_api_utils/resources/web_forms/uni_form.py

@@ -0,0 +1,75 @@
+from typing import Type, Any, Dict, Optional, Tuple
+
+from ul_db_utils.modules.db import db
+from sqlalchemy.dialects import postgresql
+from sqlalchemy.dialects.postgresql import ARRAY
+from wtforms_alchemy import ModelForm, ClassMap, FormGenerator  # type: ignore
+from wtforms.fields import SelectField  # type: ignore
+
+from ul_db_utils.model.base_model import BaseModel
+
+from ul_api_utils.resources.web_forms.custom_fields.custom_checkbox_select import MultiCheckboxField
+
+
+def form_factory(model_obj: Type[BaseModel], edition: bool = False, *, extra_fields: Optional[Dict[str, Any]] = None) -> Type[ModelForm]:
+    """
+    Returns generated model form.
+
+            Parameters:
+                    model_obj (type_of(BaseModel)): model object which will use for form generation
+                    edition (bool): flag to indicate creation or edition form will be generated
+                    extra_fields (optional(dict(str, any))): additional fields for generated form
+
+            Returns:
+                    Form (type_of(ModelForm)): web model form
+    """
+
+    class ExtraFieldsFormGenerator(FormGenerator):
+        def create_fields(self, form: Any, properties: Dict[str, Any]) -> None:
+            """
+            Creates fields for given form based on given model attributes.
+
+            :param form: form to attach the generated fields into
+            :param properties: model attributes to generate the form fields from
+            """
+            super(ExtraFieldsFormGenerator, self).create_fields(form, properties)
+
+            if extra_fields:
+                for field_name, field in extra_fields.items():
+                    setattr(form, field_name, field)
+
+    class Form(ModelForm):
+        """
+        A class for representing a web form.
+
+        ...
+
+        Attributes
+        ----------
+        property_columns : dict(str, any)
+            Model property columns such as ID, USER_CREATED etc.
+
+        Methods
+        -------
+
+        """
+
+        property_columns: Dict[str, Any] = {}
+
+        def __init__(self, *args: Tuple[Any], **kwargs: Dict[str, Any]) -> None:
+            super(Form, self).__init__(*args, **kwargs)
+            self.property_columns = model_obj.get_property_columns(self._obj) if self._obj else {}
+
+        class Meta:
+            model = model_obj
+            type_map = ClassMap({postgresql.UUID: SelectField, ARRAY: MultiCheckboxField})
+            only = model_obj.get_edit_columns() if edition else model_obj.get_create_columns()
+            form_generator = ExtraFieldsFormGenerator
+
+        @classmethod
+        def get_session(cls) -> Any:
+            return db.session
+
+    Form.__name__ = f"{model_obj.__name__}Form"
+
+    return Form

{ul-api-utils-7.7.10 → ul-api-utils-7.8.0}/ul_api_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ul-api-utils
-Version: 7.7.10
+Version: 7.8.0
 Summary: Python api utils
 Author: Unic-lab
 Author-email: 

{ul-api-utils-7.7.10 → ul-api-utils-7.8.0}/ul_api_utils.egg-info/SOURCES.txt

@@ -86,6 +86,13 @@ ul_api_utils/resources/health_check/const.py
 ul_api_utils/resources/health_check/health_check.py
 ul_api_utils/resources/health_check/health_check_template.py
 ul_api_utils/resources/health_check/resource.py
+ul_api_utils/resources/web_forms/__init__.py
+ul_api_utils/resources/web_forms/uni_form.py
+ul_api_utils/resources/web_forms/custom_fields/__init__.py
+ul_api_utils/resources/web_forms/custom_fields/custom_checkbox_select.py
+ul_api_utils/resources/web_forms/custom_widgets/__init__.py
+ul_api_utils/resources/web_forms/custom_widgets/custom_select_widget.py
+ul_api_utils/resources/web_forms/custom_widgets/custom_text_input_widget.py
 ul_api_utils/utils/__init__.py
 ul_api_utils/utils/api_encoding.py
 ul_api_utils/utils/api_format.py