SimpleDomControl 0.56.0__tar.gz → 0.56.2__tar.gz

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SimpleDomControl
-Version: 0.56.0
+Version: 0.56.2
 Summary: Simple DOM control -> a django MVC framework
 Home-page: https://github.com/StarmanMartin/sdc
 License: Apache-2.0
@@ -17,13 +17,14 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Dist: attrs (>=23.2.0,<24.0.0)
+Requires-Dist: attrs (>=24.2.0,<25.0.0)
 Requires-Dist: channels (>=4.1.0,<5.0.0)
 Requires-Dist: channels-redis (>=4.2.0,<5.0.0)
+Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: daphne (>=4.1.2,<5.0.0)
-Requires-Dist: django (>=5.0.6,<6.0.0)
+Requires-Dist: django (>=5.1.2,<6.0.0)
 Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
-Requires-Dist: regex (>=2024.5.15,<2025.0.0)
+Requires-Dist: regex (>=2024.7.24,<2025.0.0)
 Description-Content-Type: text/markdown
 
 # Simple Dom Control (SDC)

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "SimpleDomControl"
-version = "0.56.0"
+version = "0.56.2"
 authors = [ "Martin Starman <private@martin-starman.com>", ]
 description = "Simple DOM control -> a django MVC framework"
 readme = "README.md"
@@ -22,10 +22,11 @@ python = "^3.10"
 daphne = "^4.1.2"
 channels = "^4.1.0"
 channels-redis = "^4.2.0"
-django = "^5.0.6"
+django = "^5.1.2"
 psycopg2-binary = "^2.9.9"
-attrs = "^23.2.0"
-regex = "^2024.5.15"
+attrs = "^24.2.0"
+regex = "^2024.7.24"
+click = "^8.1.7"
 
 [tool.pytest.ini_options]
 pythonpath = [

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/consumers.py

@@ -14,7 +14,7 @@ from asgiref.sync import async_to_sync
 import importlib
 import json
 
-from sdc_core.sdc_extentions.models import SdcModel, ConsumerSerializer, all_models
+from sdc_core.sdc_extentions.models import SdcModel, SDCSerializer, all_models
 from sdc_core.sdc_extentions.response import sdc_link_factory, sdc_link_obj_factory
 from sdc_core.sdc_extentions.import_manager import import_function
 from sdc_core.sdc_extentions.views import SdcAccessMixin
@@ -179,9 +179,9 @@ class SDCModelConsumer(WebsocketConsumer):
         self.queryset = {}
         self.model_id_list = []
         self._upload_handler = {}
+        self._group_names = []
 
     def connect(self):
-
         self.model_name = self.scope['url_route']['kwargs']['model_name']
         self.model = ALL_MODELS.get(self.model_name)
         if self.model is None or not hasattr(self.model, '__is_sdc_model__'):
@@ -191,7 +191,8 @@ class SDCModelConsumer(WebsocketConsumer):
         self.accept()
 
     def disconnect(self, close_code):
-        pass
+        for group in self._group_names:
+            async_to_sync(self.channel_layer.group_discard( group, self.channel_name ))
 
     def on_update(self, data):
         if data['pk'] in self.ids:
@@ -248,7 +249,7 @@ class SDCModelConsumer(WebsocketConsumer):
             elif event_type == 'model_delete':
                 self._delete_element(json_data)
             elif event_type == 'model_load':
-                model_data = ConsumerSerializer().serialize(self._load_model())
+                model_data = SDCSerializer().serialize(self._load_model())
                 self.send(text_data=json.dumps({
                     'type': json_data['event_type'],
                     'event_id': json_data['event_id'],
@@ -406,7 +407,7 @@ class SDCModelConsumer(WebsocketConsumer):
 
         if is_valid:
             form_instance.save()
-            new_instance = ConsumerSerializer().serialize(self._load_model().filter(pk=form_instance.instance.pk))
+            new_instance = SDCSerializer().serialize(self._load_model().filter(pk=form_instance.instance.pk))
             msg = self.msg_manager.get_msg(form_instance.instance, json_data['event_type'])
         else:
             msg = {'header': 'Upss!',

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/management/commands/init_add/settings_manager.py

@@ -77,8 +77,8 @@ class SettingsManager:
 
         data = fin.read()
         fin.close()
-        data = re.sub(r'(from[^\n]*)', '\g<1>\nimport os\nfrom urllib.parse import urlparse, urlunparse', data)
-        data = re.sub(r'(ALLOWED_HOSTS[^\n]*)', '# \g<1>', data)
+        data = re.sub(r'(from[^\n]*)', r'\g<1>\nimport os\nfrom urllib.parse import urlparse, urlunparse', data)
+        data = re.sub(r'(ALLOWED_HOSTS[^\n]*)', r'# \g<1>', data)
         data = re.sub(r'INSTALLED_APPS\s*=\s*\[[^\]]+\]', new_val, data)
 
         new_val = f"DATABASES_AVAILABLE = {{\n{sep}'jest': {{'ENGINE': 'django.db.backends.sqlite3', 'NAME': BASE_DIR / 'test_db.sqlite3', }},"

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/management/commands/sdc_new_model.py

@@ -46,7 +46,7 @@ class Command(BaseCommand):
             app_name = all_apps[idx]
         model_name = ops.get('model_name')
         if model_name is None:
-            text = "Enter the name of the new Model class name (use camel-case):"
+            text = "Enter the name of the new Model class name (use CamelCase):"
             model_name = str(input(text))
 
         if model_name in [model.__name__ for model in apps.get_app_config(app_name).get_models()]:

simpledomcontrol-0.56.2/sdc_core/sdc_extentions/forms.py

@@ -0,0 +1,48 @@
+"""
+The SDC package 'sdc_extentions' houses a form called 'AbstractSearchForm' to simplify search implementations.
+"""
+
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+
+class AbstractSearchForm(forms.Form):
+    """
+    The AbstractSearchForm facilitates the development of a user interface for searching
+    entries of a Django model type from the database. This form is closely  linked to
+    the :func:`sdc_core.sdc_extentions.search.handle_search_form` handler. A form class
+    that extends this class is automatically created when you use the sdc management
+    command 'sdc_new_model'.
+
+    The following class properties can be used to customize the search form:
+
+    :cvar CHOICES: specifies the property according to which the search results are to be sorted.
+    The value is a tuple of tuples of human-readable name, property name.
+    :cvar DEFAULT_CHOICES: is the name of the property to which the search results are to be sorted if non is selected.
+    :cvar SEARCH_FIELDS: is a list or a tuple of names of the properties that are included in the actual search
+    :cvar PLACEHOLDER: is the placeholder text in the search input field.
+
+    """
+
+    CHOICES: tuple[tuple[str,str]] = ()
+    SEARCH_FIELDS: list[str] = []
+    DEFAULT_CHOICES: str = ""
+    NO_RESULTS_ON_EMPTY_SEARCH = False
+    PLACEHOLDER = _('Search')
+    search = forms.CharField(label=_('Search'), required=False, max_length=100, initial='')
+    order_by = forms.ChoiceField(widget=forms.Select, required=False, choices=CHOICES)
+    range_start = forms.IntegerField(widget=forms.HiddenInput(), required=False, initial=0)
+    _method = forms.CharField(widget=forms.HiddenInput(), required=True, initial='search')
+
+
+    def __init__(self, data=None, *args, **kwargs):
+        auto_id= self.__class__.__name__ + "_%s"
+        if len(data) == 0:
+            data = None
+        super(AbstractSearchForm, self).__init__(data, auto_id=auto_id, *args, **kwargs)
+        self.fields['search'].widget.attrs['placeholder'] = self.PLACEHOLDER
+        if len(self.CHOICES) == 0:
+            del self.fields["order_by"]
+        else:
+            self.fields['order_by'].choices = self.CHOICES
+            self.fields['order_by'].initial = self.DEFAULT_CHOICES

simpledomcontrol-0.56.2/sdc_core/sdc_extentions/import_manager.py

@@ -0,0 +1,18 @@
+import importlib
+
+
+def import_function(string_path: str) -> any:
+    """
+    Imports a function or a property using a python import sting (path separated by dots)
+
+    :param string_path: python import sting
+    :return: callable function, property or None
+    """
+
+    if string_path is not None:
+        p, m = string_path.rsplit('.', 1)
+        mod = importlib.import_module(p)
+        met = getattr(mod, m)
+        return met
+
+    return None

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/sdc_extentions/models.py

@@ -18,7 +18,13 @@ User = get_user_model()
 _ALL_MODELS = None
 
 
-def all_models():
+def all_models() -> dict[str,any]:
+    """
+    Collects and returns all SDC Models
+
+    :return: all SDC models as a dict with keys are model names and the class as value
+    """
+
     global _ALL_MODELS
     if _ALL_MODELS is None:
         _ALL_MODELS = {
@@ -27,7 +33,11 @@ def all_models():
     return _ALL_MODELS
 
 
-class ConsumerSerializer(Serializer):
+class SDCSerializer(Serializer):
+    """
+    The SDCSerializer serializes SdcModels for the API and websocket communication
+
+    """
 
     def handle_m2m_field(self, obj, field):
         super().handle_m2m_field(obj, field)
@@ -54,16 +64,25 @@ _SDC_META_DEFAULT = {'edit_form': None,
                      'html_form_template': getattr(settings, 'MODEL_FORM_TEMPLATE', "elements/form.html")
                      }
 
+
 class classproperty(property):
     def __get__(self, obj, objtype=None):
         return super().__get__(objtype)
+
     def __set__(self, obj, value):
         super().__set__(type(obj), value)
 
+
 class _SdcMetaDummy:
     _sdc_checked = False
 
+
 class SdcModel():
+    """
+    A Django Model which also extents the SdcModel class can be used as a Websocked based Client Model.
+    Use the SDC management command new_model to create a new model class.
+    """
+
     __is_sdc_model__ = True
     _scope = None
 
@@ -75,13 +94,23 @@ class SdcModel():
 
     @classproperty
     def SdcMeta(cls):
+        """
+        SdcMeta is a metaclass that contains all the
+        important metadata for rendering HTML views of instances.
+        All class variable are python import sting
+
+        :cvar edit_form: Import string to edit form class
+        :cvar create_form: Import string to edit form class
+        :cvar forms: Import string to edit form class
+
+        """
         if not hasattr(cls, '_SdcMeta'):
             setattr(cls, '_SdcMeta', _SdcMetaDummy())
 
         sdc_meta = getattr(cls, '_SdcMeta')
 
         if not getattr(sdc_meta, '_sdc_checked', False):
-            setattr(sdc_meta,'_sdc_checked', True)
+            setattr(sdc_meta, '_sdc_checked', True)
             for k, v in _SDC_META_DEFAULT.items():
                 if not hasattr(sdc_meta, k):
                     setattr(sdc_meta, k, getattr(cls, k, v))
@@ -89,10 +118,16 @@ class SdcModel():
 
     @property
     def scope(self) -> dict[str: any]:
+        """
+        :return: Websocket scope object
+        """
         return self._scope
 
     @scope.setter
     def scope(self, scope: dict[str: any]):
+        """
+        Set the Websocket scope object
+        """
         self._scope = scope
 
     @classmethod
@@ -114,9 +149,18 @@ class SdcModel():
 
 @receiver(post_save)  # instead of @receiver(post_save, sender=Rebel)
 @receiver(post_delete)  # instead of @receiver(post_save, sender=Rebel)
-def set_winner(sender, instance=None, created=False, **kwargs):
+def set_winner(sender, instance=None, created: bool = False, **kwargs):
+    """
+    Handles the client notification if an SDC model has been saved, created or deleted.
+
+    :param sender: The modul class
+    :param instance: Saved, created or deleted instance
+    :param created: True if instance has no db id before it has been saved
+    :param kwargs:
+    """
+
     if instance is not None and hasattr(sender, '__is_sdc_model__'):
-        serialize_instance = ConsumerSerializer().serialize([instance])
+        serialize_instance = SDCSerializer().serialize([instance])
         if created:
             async_to_sync(get_channel_layer().group_send)(sender.__name__, {
                 'event_id': 'none',

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/sdc_extentions/search.py

@@ -1,11 +1,21 @@
-from django.db.models import Q
+from django.db.models import Q, QuerySet
+from sdc_core.sdc_extentions.forms import AbstractSearchForm
 
-def generate_q_key_value_request(key, val):
+def _generate_q_key_value_request(key, val):
     map_val = {key + '__icontains': val}
     return Q(**map_val)
 
 
-def handle_search_form(query_set, search_form, filter_dict=None, range=0):
+def handle_search_form(query_set: QuerySet, search_form: AbstractSearchForm, filter_dict: dict=None, range: int=0):
+    """
+    This handler function takes a :class:`sdc_core.sdc_extentions.forms.AbstractSearchForm`
+
+    :param query_set:
+    :param search_form:
+    :param filter_dict:
+    :param range:
+    :return:
+    """
     if not search_form.is_valid():
         data = {}
     else:
@@ -26,9 +36,9 @@ def handle_search_form(query_set, search_form, filter_dict=None, range=0):
         q_list = None
         for key in search_form.SEARCH_FIELDS:
             if q_list is None:
-                q_list = generate_q_key_value_request(key, key_word)
+                q_list = _generate_q_key_value_request(key, key_word)
             else:
-                q_list = q_list | generate_q_key_value_request(key, key_word)
+                q_list = q_list | _generate_q_key_value_request(key, key_word)
         query_set = query_set.filter(q_list).distinct()
         query_set_count = query_set.count()
     elif(search_form.NO_RESULTS_ON_EMPTY_SEARCH):

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/template_files/Assets/src/index.style.scss

@@ -1,17 +1,17 @@
-@import "../node_modules/bootstrap/scss/bootstrap";
+@import "../../node_modules/bootstrap/dist/css/bootstrap";
 @import "./sdc_user/sdc_user.style";
 @import "./sdc_tools/sdc_tools.style";
 
+body::before {
+    content: "SDC Works";
+    font-size: larger;
+    color: red;
+}
+
 body {
     background-color: cornflowerblue;
 
-    ::before {
-        content: "SDC Works";
-        font-size: larger;
-        color: red;
-    }
-
     .navbar-dummy {
         height: 70px;
     }
-}
+}

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_core/template_files/package.json

@@ -50,6 +50,7 @@
     "glob-watcher": "^6.0.0",
     "gulp": "^4.0.2",
     "gulp-clean": "^0.4.0",
+    "gulp-copy": "^4.0.1",
     "gulp-exec": "^5.0.0",
     "gulp-rename": "^2.0.0",
     "gulp-sass": "^5.1.0",
@@ -57,12 +58,12 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "js-cookie": "^3.0.5",
-    "micromatch": "^4.0.6",
+    "micromatch": "^4.0.8",
     "sass": "^1.69.7",
     "sass-loader": "^13.3.3",
     "style-loader": "^3.3.4",
     "terser-webpack-plugin": "^5.3.10",
-    "webpack": "^5.89.0",
+    "webpack": "^5.95.0",
     "webpack-stream": "^7.0.0"
   },
   "overrides": {
@@ -75,6 +76,6 @@
     "esm": "^3.2.25",
     "jquery": "^3.7.0",
     "lodash": "^4.17.21",
-    "sdc_client": "^0.56.0"
+    "sdc_client": "^0.56.2"
   }
 }

{simpledomcontrol-0.56.0 → simpledomcontrol-0.56.2}/sdc_tools/Assets/src/sdc_tools/controller/sdc_search_view/sdc_search_view.js

@@ -84,7 +84,7 @@ export class SdcSearchViewController extends AbstractSDC {
 
         if (!this.isRange) {
             $pageContainer.remove();
-            return;
+            return super.willShow();
         }
 
         $pageContainer.find('.range-span').text(this.range[1] + ' - ' + this.range[2]);

simpledomcontrol-0.56.0/sdc_core/sdc_extentions/forms.py

@@ -1,26 +0,0 @@
-from django import forms
-from django.utils.translation import gettext_lazy as _
-
-class AbstractSearchForm(forms.Form):
-    CHOICES = ()
-    SEARCH_FIELDS = ()
-    DEFAULT_CHOICES = ""
-    NO_RESULTS_ON_EMPTY_SEARCH = False
-    PLACEHOLDER = _('Search')
-    search = forms.CharField(label=_('Search'), required=False, max_length=100, initial='')
-    order_by = forms.ChoiceField(widget=forms.Select, required=False, choices=CHOICES)
-    range_start = forms.IntegerField(widget=forms.HiddenInput(), required=False, initial=0)
-    _method = forms.CharField(widget=forms.HiddenInput(), required=True, initial='search')
-
-
-    def __init__(self, data=None, *args, **kwargs):
-        auto_id= self.__class__.__name__ + "_%s"
-        if len(data) == 0:
-            data = None
-        super(AbstractSearchForm, self).__init__(data, auto_id=auto_id, *args, **kwargs)
-        self.fields['search'].widget.attrs['placeholder'] = self.PLACEHOLDER
-        if len(self.CHOICES) == 0:
-            del self.fields["order_by"]
-        else:
-            self.fields['order_by'].choices = self.CHOICES
-            self.fields['order_by'].initial = self.DEFAULT_CHOICES

simpledomcontrol-0.56.0/sdc_core/sdc_extentions/import_manager.py

@@ -1,18 +0,0 @@
-import importlib
-
-
-def import_function(string_path):
-    if string_path is not None:
-        p, m = string_path.rsplit('.', 1)
-        mod = importlib.import_module(p)
-        met = getattr(mod, m)
-        return met
-
-
-    return None
-
-def import_functions(func_map):
-    if func_map == None:
-        return
-    for key in func_map:
-        yield key, import_function(func_map[key])