dynamicforms 0.76.14__py3-none-any.whl

dynamicforms/filters.py

@@ -0,0 +1,44 @@
+import django_filters.rest_framework as filters
+
+
+class ListWithFields(list):
+    def __init__(self, fields, lst) -> None:
+        super().__init__()
+        self.fields = fields
+        self.extend(lst)
+
+
+class FilterBackend(filters.DjangoFilterBackend):
+    """
+    Our own FilterBackend that also tries to read order from the pagination class's ordering field
+    """
+
+    def get_filterset_class(self, view, queryset=None):
+        # here we look for any pagination class and its ordering attribute. if there is none, we sort by id
+        __paginator_ordering = getattr(getattr(view, "pagination_class", 0), "ordering", ["id"])
+        if isinstance(__paginator_ordering, str):
+            __paginator_ordering = [__paginator_ordering]
+
+        ordering_excluded_fields = getattr(view, "filterset_ordering_exclude", [])
+        ordering_default = getattr(view, "filterset_ordering_default", __paginator_ordering)
+
+        class MyOrderingFilter(filters.OrderingFilter):
+            def get_ordering(self, value):
+                if not value:
+                    return ListWithFields(list(self.param_map.keys()), ordering_default)
+                return ListWithFields(list(self.param_map.keys()), [self.get_ordering_value(param) for param in value])
+
+        class FilterSetApplied(filters.FilterSet):
+            locals()[view.ordering_parameter] = MyOrderingFilter(
+                fields=[f.name for f in queryset.model._meta.fields if f.name not in ordering_excluded_fields]
+            )
+
+        return FilterSetApplied
+
+    def get_ordering(self, request, queryset, view):
+        filterset = self.get_filterset(request, queryset, view)
+        filterset.is_valid()
+        ordering_filters = {k: v for k, v in filterset.filters.items() if isinstance(v, filters.OrderingFilter)}
+        for name, value in filterset.form.cleaned_data.items():
+            if name in ordering_filters:
+                return ordering_filters[name].get_ordering(value)

dynamicforms/locale/en/LC_MESSAGES/django.po

@@ -0,0 +1,67 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-02-27 08:03+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: dynamicforms/action.py:287
+msgid "Cancel"
+msgstr ""
+
+#: dynamicforms/action.py:288
+msgid "Save changes"
+msgstr ""
+
+#: dynamicforms/action.py:359
+msgid "Add"
+msgstr ""
+
+#: dynamicforms/action.py:359
+msgid "Add new record"
+msgstr ""
+
+#: dynamicforms/action.py:364
+msgid "Edit"
+msgstr ""
+
+#: dynamicforms/action.py:364
+msgid "Edit record"
+msgstr ""
+
+#: dynamicforms/action.py:370
+msgid "Delete"
+msgstr ""
+
+#: dynamicforms/action.py:371
+msgid "Delete record"
+msgstr ""
+
+#: dynamicforms/action.py:376
+msgid "Sort"
+msgstr ""
+
+#: dynamicforms/action.py:376
+msgid "Sort by column"
+msgstr ""
+
+#: dynamicforms/action.py:380
+msgid "Filter"
+msgstr ""
+
+#: dynamicforms/template_render/mixins/serializer_render_fields.py:34
+msgid "Actions"
+msgstr ""

dynamicforms/locale/en/LC_MESSAGES/djangojs.po

@@ -0,0 +1,31 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-07-20 13:48+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:8
+msgid "Ok"
+msgstr ""
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:8
+msgid "Cancel"
+msgstr ""
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:48
+msgid "No data"
+msgstr ""

dynamicforms/locale/sl/LC_MESSAGES/django.po

@@ -0,0 +1,71 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-02-27 08:03+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || "
+"n%100==4 ? 2 : 3);\n"
+
+#: dynamicforms/action.py:287
+msgid "Cancel"
+msgstr "Prekliči"
+
+#: dynamicforms/action.py:288
+msgid "Save changes"
+msgstr "Shrani"
+
+#: dynamicforms/action.py:359
+msgid "Add"
+msgstr "Dodaj"
+
+#: dynamicforms/action.py:359
+msgid "Add new record"
+msgstr "Dodaj nov zapis"
+
+#: dynamicforms/action.py:364
+msgid "Edit"
+msgstr "Uredi"
+
+#: dynamicforms/action.py:364
+msgid "Edit record"
+msgstr "Uredi zapis"
+
+#: dynamicforms/action.py:370
+msgid "Delete"
+msgstr "Briši"
+
+#: dynamicforms/action.py:371
+msgid "Delete record"
+msgstr "Briši zapis"
+
+#: dynamicforms/action.py:376
+msgid "Sort"
+msgstr "Sortiraj"
+
+#: dynamicforms/action.py:376
+msgid "Sort by column"
+msgstr "Uredi po stolpcu"
+
+#: dynamicforms/action.py:380
+msgid "Filter"
+msgstr "Filtriraj"
+
+#: dynamicforms/template_render/mixins/serializer_render_fields.py:34
+msgid "Actions"
+msgstr "Akcije"
+
+#~ msgid "Performing operation..."
+#~ msgstr "Izvajam obdelavo..."

dynamicforms/locale/sl/LC_MESSAGES/djangojs.po

@@ -0,0 +1,36 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-07-20 13:48+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || "
+"n%100==4 ? 2 : 3);\n"
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:8
+msgid "Ok"
+msgstr "V redu"
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:8
+msgid "Cancel"
+msgstr "Prekliči"
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:48
+msgid "No data"
+msgstr "Ni podatkov"
+
+#: vue/dynamicforms/dist/dynamicforms.umd.js:48
+msgid "Performing operation..."
+msgstr "Izvajam obdelavo..."

dynamicforms/management/commands/clean_dfpreuploaded_files.py

@@ -0,0 +1,26 @@
+import glob
+import os
+import pathlib
+import time
+
+from django.core.management.base import BaseCommand
+
+from dynamicforms.preupload_files import preuploaded_fs, UPLOADED_FILE_NAME_TIMESTAMP_SEPARATOR
+
+
+class Command(BaseCommand):
+    # TODO: this is redundant: the files should not be uploaded to any persistent storage, but instead to cache
+    #  with a really short timeout, max a few hours. After that, they're gone automatically. No need for a clean up
+    #  script nobody ever thought to setup to run in the first place. Task DF:#873
+    help = "Clean old temporary files which are generated when preloading files for df preloaded file field"
+
+    def handle(self, *args, **options):
+        current_timestamp: int = int(time.time())
+        margins_for_file_deletion: int = 86400  # one day od uploaded file retention
+        for file in glob.glob(f"{preuploaded_fs.location}/*"):
+            file_components: list = file.split(UPLOADED_FILE_NAME_TIMESTAMP_SEPARATOR)
+            if len(file_components) > 1:
+                file_path: pathlib.Path = pathlib.Path(file_components[1])
+                timestamp: int = int(file_path.stem)
+                if current_timestamp - timestamp > margins_for_file_deletion:
+                    os.remove(file)

dynamicforms/mixins/__init__.py

@@ -0,0 +1,27 @@
+# flake8: noqa
+import abc
+
+from rest_framework.fields import Field as DRFField
+
+from .action import ActionMixin
+from .choice import ChoiceMixin
+from .color_field import ColorFieldMixin
+from .conditional_visibility import ConditionalVisibilityMixin, F, FieldType, S, Statement
+from .enable_copy import EnableCopyMixin
+from .field_render import DisplayMode, FieldAlignment, FieldRenderMixin
+from .file_field import FileFieldMixin
+from .help_text import FieldHelpTextMixin
+from .implicit_hidden import HiddenFieldMixin
+from .implicit_natural_date import DateFieldMixin, DateTimeFieldMixin, TimeFieldMixin
+from .null_value import NullValueMixin
+from .password_field import PasswordFieldMixin
+from .related_field_ajax import RelatedFieldAJAXMixin
+from .rtf_field import RTFFieldMixin
+
+
+class DFField(FieldRenderMixin, ActionMixin, FieldHelpTextMixin, ConditionalVisibilityMixin, DRFField, abc.ABC):
+    """
+    Class only for type hinting
+    """
+
+    pass

dynamicforms/mixins/action.py

@@ -0,0 +1,14 @@
+from dynamicforms.action import Actions
+
+
+class ActionMixin(object):
+    """
+    Used in fields allowing declaration of actions that happen when field values change
+    """
+
+    def __init__(self, *args, actions: Actions = None, **kwargs):
+        super().__init__(*args, **kwargs)
+        act = actions or Actions(None)
+        act.actions.extend(getattr(self, "actions", Actions()).actions)
+        # Obtain a personalised list of actions
+        self.actions = act.get_resolved_copy(self)

dynamicforms/mixins/choice/__init__.py

@@ -0,0 +1,94 @@
+from typing import Hashable
+
+from rest_framework.fields import MultipleChoiceField
+from rest_framework.relations import ManyRelatedField, PKOnlyObject, RelatedField
+from rest_framework.serializers import ListSerializer
+
+from .allow_tags import AllowTagsMixin, DenormalisedArray
+from .null_choice import NullChoiceMixin
+from .single_choice import SingleChoiceMixin
+
+
+class ChoiceMixin(AllowTagsMixin, NullChoiceMixin, SingleChoiceMixin):
+    def __init__(self, *args, **kwargs):
+        choices = kwargs.get("choices", [])
+        kwargs["choices"] = [choice[:2] for choice in choices]
+        self.choice_icons = {choice[0]: choice[2] for choice in choices if len(choice) > 2}
+        super().__init__(*args, **kwargs)
+        if len(choices) > 100:
+            from dynamicforms.utils import print_field_declaration_line
+            print_field_declaration_line()
+
+
+    def as_component_def(self) -> dict:
+        try:
+            res = super().as_component_def()  # noqa
+        except AttributeError:
+            res = dict()
+
+        res.update(
+            dict(
+                choices=self.__to_list_of_dicts(self.choices),
+                allow_tags=self.allow_tags,  # noqa
+                allow_null=self.allow_null or self.allow_blank or self.allow_tags,  # noqa
+            )
+        )
+        return res
+
+    def __to_list_of_dicts(self, choices_dict: dict) -> list:
+        return [dict(id=k, text=v, icon=self.choice_icons.get(k, None)) for k, v in choices_dict.items()]
+
+    # noinspection PyUnusedLocal, PyUnresolvedReferences
+    def render_to_table(self, value, row_data):
+        """
+        Renders field value for table view :if rendering to html table, let's try to resolve any lookups
+        hidden fields will render to tr data-field_name attributes, so we maybe want to have ids, not text there,
+          but that's up to front end to decide
+
+        :param value: field value
+        :param row_data: data for entire row (for more complex renderers)
+        :return: rendered value for table view
+        """
+        if isinstance(self, MultipleChoiceField):
+            res = DenormalisedArray(value, self)
+            return str(res)
+
+        get_queryset = getattr(self, "get_queryset", None)
+
+        if isinstance(self, ManyRelatedField):
+            # Hm, not sure if this is the final thing to do: an example of this field is in
+            # ALC plane editor (modes of takeoff). However, value is a queryset here. There seem to still be DB queries
+            # However, in the example I have, the problem is solved by doing prefetch_related on the m2m relation
+            cr = self.child_relation
+            return ", ".join((cr.display_value(item) for item in value))
+            # return ', '.join((cr.display_value(item) for item in cr.get_queryset().filter(pk__in=value)))
+        elif isinstance(self, RelatedField) or get_queryset:
+            return self.display_value(value)
+        else:
+            choices = getattr(self, "choices", {})
+
+        # Now that we got our choices for related & choice fields, let's first get the value as it would be by DRF
+        check_for_none = value.pk if isinstance(value, PKOnlyObject) else value
+        if check_for_none is None:
+            value = None
+
+        if isinstance(value, Hashable) and value in choices:
+            # choice field: let's render display names, not values
+            value = choices[value]
+
+        return value
+
+    # noinspection PyUnresolvedReferences
+    def to_internal_value(self, data):
+        """
+        Reverse of to_representation: if data coming in is a tuple, use just the "id/code/key" part, not entire tuple
+        """
+        if (
+            self.field_name not in ("df_control_data", "df_prev_id", "row_css_style")
+            and not isinstance(self, (ListSerializer, MultipleChoiceField))
+            and isinstance(data, list)
+            and len(data)
+        ):
+            data = data[0]
+
+        return super().to_internal_value(data)

dynamicforms/mixins/choice/allow_tags.py

@@ -0,0 +1,79 @@
+# TODO: Implementation of this mixin is wrong for ChoiceField (single choice variant):
+#  The ChoiceField will return data in an array even for (Single)ChoiceField. Select2 handles this, maybe even requires
+#  this, but some other component might not
+import ast
+
+from rest_framework.fields import ChoiceField, MultipleChoiceField
+
+
+class DenormalisedArray(list):
+    def __init__(self, lst, field):
+        self.field = field
+        if lst is not None and isinstance(lst, str) and isinstance(field, MultipleChoiceField):
+            for itm in ast.literal_eval(lst):
+                self.append(itm)
+
+        elif lst is not None and isinstance(lst, list):
+            for itm in lst:
+                self.append(itm)
+
+        elif lst is not None:
+            self.append(lst)
+
+    def __str__(self):
+        choices = self.field.choices
+        ret = ""
+        count = 0
+        for item in self:
+            ret += ", " if count else ""
+            if item in choices:
+                ret += choices[item]
+            else:
+                ret += item
+            count += 1
+        return ret
+
+
+class AllowTagsMixin(object):
+    def __init__(self, *args, allow_tags=False, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.allow_tags = allow_tags or False
+
+    def to_internal_value(self, data):
+        """
+        Validator is taken directly from DRF and updated, to check for allow_tags.
+        Option allow_tags enables adding value that is not on the options list.
+        """
+        if not self.allow_tags:
+            data = super().to_internal_value(data)
+
+        if isinstance(self, MultipleChoiceField):
+            if isinstance(data, str) or not hasattr(data, "__iter__"):
+                self.fail("not_a_list", input_type=type(data).__name__)
+            if not self.allow_empty and len(data) == 0:
+                self.fail("empty")
+
+            return data
+
+        elif isinstance(self, ChoiceField) and not isinstance(self, MultipleChoiceField):
+            if data == "" and self.allow_blank:
+                return ""
+
+            try:
+                if not self.allow_tags:
+                    return self.choice_strings_to_values[str(data)]
+
+                return data
+            except KeyError:
+                self.fail("invalid_choice", input=data)
+
+    def iter_options_bound(self, value):
+        # noinspection PyUnresolvedReferences
+        if isinstance(value, list):
+            for item in value:
+                if item not in self.choices.keys():
+                    self.grouped_choices[item] = item
+        elif isinstance(value, str) and self.allow_tags and value not in self.choices.keys():
+            self.grouped_choices[value] = value
+
+        return super().iter_options_bound(value)

dynamicforms/mixins/choice/null_choice.py

@@ -0,0 +1,26 @@
+from rest_framework.fields import ChoiceField
+
+
+class NullChoiceMixin(object):
+    """
+    Declaring ChoiceField's null_choice_text
+      (what should be rendered for "no selection"; DRF's default is ---------)
+      We also support user declaring a choice with None value and a different text (see hidden fields example)
+    """
+
+    @property
+    def null_choice_text(self):
+        res = "--------"
+        if isinstance(self, ChoiceField) and not getattr(self, "get_queryset", None):
+            # Only do this for true ChoiceFields. RelatedFields would run a query here
+            # Possibly we will at some point have to enable this for relatedfields too
+            for opt in self.iter_options():
+                if opt.start_option_group or opt.end_option_group:
+                    pass
+                elif opt.value is None:
+                    res = opt.display_text
+        return res
+
+    def iter_options_bound(self, value):
+        # noinspection PyUnresolvedReferences
+        return super().iter_options()

dynamicforms/mixins/choice/single_choice.py

@@ -0,0 +1,21 @@
+from ..field_render import DisplayMode
+
+
+class SingleChoiceMixin:
+    def __init__(self, *args, single_choice_hide=False, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.single_choice_hide = single_choice_hide
+
+    def to_internal_value(self, data):
+        if self.single_choice_hide and len(self.choices) == 1:
+            data = list(self.choices)[0]
+        elif self.single_choice_hide and len(self.choices) < 1:
+            data = None
+        return super().to_internal_value(data)
+
+    def set_single_choice_hide(self, value):
+        self._single_choice_hide = value
+        if value and len(self.choices) <= 1:
+            self.display_form = DisplayMode.HIDDEN
+
+    single_choice_hide = property(lambda self: self._single_choice_hide, set_single_choice_hide)

dynamicforms/mixins/color_field.py

@@ -0,0 +1,4 @@
+class ColorFieldMixin(object):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.render_params["form_component_name"] = "DColor"