accrete 0.0.23__py3-none-any.whl → 0.0.25__py3-none-any.whl

accrete/contrib/ui/__init__.py

@@ -11,7 +11,4 @@ from .components import (
     TableFieldAlignment,
     TableFieldType
 )
-from .querystring import (
-    parse_querystring,
-    build_querystring
-)
+from .querystring import load_querystring, build_url_params

accrete/contrib/ui/components.py

@@ -22,12 +22,14 @@ class TableField:
 
     label: str
     name: str
-    alignment: type[TableFieldAlignment] = TableFieldAlignment.LEFT
-    header_alignment: type[TableFieldAlignment] = None
-    field_type: type[TableFieldType] = TableFieldType.NONE
+    alignment: TableFieldAlignment | Enum = TableFieldAlignment.LEFT
+    header_alignment: TableFieldAlignment | Enum = None
+    header_info: str = None
+    field_type: TableFieldType | Enum = TableFieldType.NONE
     prefix: str = ''
     suffix: str = ''
     truncate_after: int = 0
+    template: str = None
 
 
 @dataclass
@@ -43,7 +45,7 @@ class ClientAction:
     name: str
     url: str = ''
     query_params: str = ''
-    attrs: list[str] = field(default_factory=list)
+    attrs: list[tuple[str, str]] = field(default_factory=list)
     submit: bool = False
     form_id: str = 'form'
-    class_list: list = field(default_factory=list)
+    class_list: list[str] = field(default_factory=list)

accrete/contrib/ui/context.py

@@ -4,8 +4,9 @@ from dataclasses import dataclass, field
 from django.utils.translation import gettext_lazy as _
 from django.db.models import Model, QuerySet, Q
 from django.core.paginator import Paginator
+from accrete.querystring import parse_querystring
 
-from .querystring import parse_querystring, build_querystring
+from .querystring import load_querystring, build_url_params
 from .components import ClientAction, BreadCrumb, TableField
 from .filter import Filter
 
@@ -17,7 +18,7 @@ DEFAULT_PAGINATE_BY = 40
 @dataclass
 class ListContext:
 
-    model: Model
+    model: type[Model]
     get_params: dict
     title: str = None
     context: dict = field(default_factory=dict)
@@ -31,7 +32,7 @@ class ListContext:
     default_filter_term: str = ''
     actions: list[ClientAction] = field(default_factory=list)
     breadcrumbs: list[BreadCrumb] = field(default_factory=list)
-    obj_label: str = None
+    object_label: str = None
     fields: list[TableField] = field(default_factory=list)
     unselect_button: bool = False
 
@@ -103,12 +104,13 @@ class ListContext:
             'page': page,
             'list_pagination': True,
             'title': self.title or self.model._meta.verbose_name_plural,
+            'object_label': self.object_label or self.model._meta.verbose_name or _('Name'),
             'filter_terms': Filter(self.model, self.filter_relation_depth).get_query_terms(),
             'default_filter_term': self.default_filter_term,
             'breadcrumbs': self.breadcrumbs,
-            'querystring': build_querystring(self.get_params),
+            'querystring': load_querystring(self.get_params),
+            'url_params': build_url_params(self.get_params),
             'actions': self.actions,
-            'obj_label': self.obj_label or _('Name'),
             'fields': self.fields
         }
         context.update(self.context)
@@ -118,7 +120,7 @@ class ListContext:
 @dataclass
 class DetailContext:
 
-    obj: Model
+    obj: Model | type[Model]
     get_params: dict
     order_by: str = None
     paginate_by: int = DEFAULT_PAGINATE_BY
@@ -205,9 +207,8 @@ class DetailContext:
             'order_by': self.get_params.get('order_by', self.obj._meta.model._meta.ordering),
             'paginate_by': paginate_by,
             'detail_pagination': False,
-            'view_type': 'detail',
             'breadcrumbs': self.breadcrumbs,
-            'querystring': build_querystring(self.get_params, ['page']),
+            'url_params': build_url_params(self.get_params, ['page']),
             'actions': self.actions
         }
         if self.paginate_by > 0:
@@ -238,7 +239,7 @@ class FormContext:
             )
         ]
         try:
-            url = self.discard_url or self.model.get_absolute_url()
+            url = self.discard_url or (self.model.pk and self.model.get_absolute_url())
         except TypeError:
             raise TypeError(
                 'Supply the discard_url parameter if FormContext is called '
@@ -272,9 +273,8 @@ class FormContext:
     def dict(self):
         ctx = {
             'title': self.get_title(),
-            'view_type': 'form',
             'form_id': self.form_id,
-            'querystring': build_querystring(self.get_params, ['page']),
+            'url_params': build_url_params(self.get_params, ['page']),
             'actions': []
         }
         if self.add_default_actions:

accrete/contrib/ui/filter.py

@@ -7,7 +7,6 @@ from django.utils.translation import gettext_lazy as _
 class Filter:
 
     query_relation_depth = 4
-    exclude_from_terms = []
     query_float_fields = ['DecimalField', 'FloatField']
     query_char_fields = ['CharField', 'TextField']
     query_boolean_fields = ['BooleanField']
@@ -27,14 +26,9 @@ class Filter:
     LABEL_SET = _('Is Set')
     LABEL_NOT_SET = _('Is Not Set')
 
-    def __init__(
-            self, model,
-            query_relation_depth: int = 4,
-            exclude_from_terms: list = None,
-    ):
+    def __init__(self, model, query_relation_depth: int = 4):
         self.model = model
         self.query_relation_depth = query_relation_depth
-        self.exclude_from_terms = exclude_from_terms or []
 
     def get_choice_char_query_term(self, label, param, choices):
         choices = [(choice[0], str(choice[1])) for choice in choices]
@@ -289,12 +283,10 @@ class Filter:
 
     def get_relation_query_terms(self, model, path):
         terms = []
-        if 'tenant' not in self.exclude_from_terms:
-            self.exclude_from_terms.append('tenant')
+        filter_exclude = getattr(model, 'filter_exclude', [])
+        filter_exclude.append('tenant')
         fields = filter(
-            lambda x:
-            x.is_relation and
-            x.name not in self.exclude_from_terms,
+            lambda x: x.is_relation and x.name not in filter_exclude,
             sorted(model._meta.get_fields(), key=lambda x: x.name.lower())
         )
         cpath = path.copy()
@@ -317,10 +309,11 @@ class Filter:
 
     def get_local_query_terms(self, model):
         terms = []
-        fields = filter(lambda x: not x.is_relation, model._meta.get_fields())
-        searchable_methods = []
-        if hasattr(model, 'searchable_methods'):
-            searchable_methods = model.searchable_methods
+        filter_exclude = getattr(model, 'filter_exclude', [])
+        fields = filter(
+            lambda x: not x.is_relation and x.name not in filter_exclude,
+            model._meta.get_fields()
+        )
         for field in fields:
             term = self.get_query_term(field)
             if field.null is True and term.get('params'):

accrete/contrib/ui/querystring.py

@@ -1,85 +1,11 @@
 import json
-import logging
-import operator
-from django.db.models import Model, Q
 
-_logger = logging.getLogger(__name__)
 
+def load_querystring(get_params: dict) -> list:
+    return json.loads(get_params.get('q', '[]'))
 
-def parse_querystring(model: type[Model], query_string: str) -> Q:
 
-    def get_expression(term: str, value) -> Q:
-        invert = False
-        if term.startswith('~'):
-            invert = True
-            term = term[1:]
-
-        parts = term.split('_a_')
-        if len(parts) == 1:
-            expression = Q(**{term: value})
-            return ~expression if invert else expression
-
-        rel_path = parts[0].rstrip('__')
-        term = parts[1]
-        rel_model = get_related_model(rel_path) if rel_path else model
-        objects = rel_model.objects.annotate(**{
-            annotation['name']: annotation['func']
-            for annotation in rel_model.annotations
-        }).filter(Q(**{term: value}))
-        expression = Q(**{
-            f'{rel_path}{"__" if rel_path else ""}id__in': objects.values_list('id', flat=True)
-        })
-
-        return ~expression if invert else expression
-
-    def get_related_model(rel_path: str):
-        related_model = model
-        for part in rel_path.split('__'):
-            try:
-                related_model = related_model._meta.fields_map[part].related_model
-            except (AttributeError, KeyError):
-                try:
-                    related_model = getattr(related_model, part).field.related_model
-                except AttributeError:
-                    break
-        return related_model
-
-    def parse_query_block(sub_item) -> Q:
-        op = ops['&']
-        parsed_query = Q()
-        for item in sub_item:
-            if isinstance(item, list):
-                parsed_query = op(parsed_query, parse_query_block(item))
-            elif isinstance(item, dict):
-                dict_query = Q()
-                for term, value in item.items():
-                    dict_query = ops['&'](dict_query, get_expression(term, value))
-                parsed_query = op(parsed_query, dict_query)
-            elif isinstance(item, str):
-                try:
-                    op = ops[item]
-                except KeyError as e:
-                    _logger.exception(e)
-                    raise ValueError(
-                        f'Invalid operator in querystring: {item}.'
-                        f'Operator must be one of &, |, ^'
-                    )
-            else:
-                raise ValueError(
-                    f'Unsupported item in querystring: {item}'
-                )
-        return parsed_query
-
-    query_data = json.loads(query_string)
-    if isinstance(query_data, dict):
-        query_data = [query_data]
-
-    ops = {'&': operator.and_, '|': operator.or_, '^': operator.xor}
-    query = parse_query_block(query_data)
-    return query
-
-
-def build_querystring(get_params: dict, extra_params: list[str] = None) -> str:
+def build_url_params(get_params: dict, extra_params: list[str] = None) -> str:
     querystring = f'?q={get_params.get("q", "[]")}'
     if paginate_by := get_params.get('paginate_by', False):
         querystring += f'&paginate_by={paginate_by}'