django-pfx 1.4.dev150__tar.gz → 1.4.dev154__tar.gz

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev150
+Version: 1.4.dev154
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev150
+Version: 1.4.dev154
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/django_pfx.egg-info/SOURCES.txt

@@ -51,7 +51,7 @@ pfx/pfxcore/fields/__init__.py
 pfx/pfxcore/fields/decimal_field.py
 pfx/pfxcore/fields/media_field.py
 pfx/pfxcore/fields/minutes_duration_field.py
-pfx/pfxcore/fields/nh3_field.py
+pfx/pfxcore/fields/rich_text_field.py
 pfx/pfxcore/http/__init__.py
 pfx/pfxcore/http/json_response.py
 pfx/pfxcore/locale/fr/LC_MESSAGES/django.mo
@@ -149,8 +149,8 @@ tests/tests/test_fields_choices.py
 tests/tests/test_fields_date.py
 tests/tests/test_fields_decimal.py
 tests/tests/test_fields_minutes_duration.py
-tests/tests/test_fields_nh3.py
 tests/tests/test_fields_one2many.py
+tests/tests/test_fields_rich_text.py
 tests/tests/test_filters.py
 tests/tests/test_locale_api.py
 tests/tests/test_ordered_rest_view_mixin.py

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/pfx/pfxcore/decorator/rest.py

@@ -54,11 +54,12 @@ def rest_api(
     return decorator
 
 
-def rest_property(string=None, type="CharField", field=None):
+def rest_property(string=None, type="CharField", field=None, order=None):
     def decorator(func):
         func.short_description = string
         func.field_type = type
         func.field = field
+        func.order = order
         return property(func)
     return decorator
 

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/pfx/pfxcore/fields/__init__.py

@@ -1,4 +1,4 @@
 from .decimal_field import DecimalField
 from .media_field import MediaField
 from .minutes_duration_field import MinutesDurationField
-from .nh3_field import NH3Field
+from .rich_text_field import RichTextField

django_pfx-1.4.dev154/pfx/pfxcore/fields/rich_text_field.py

@@ -0,0 +1,46 @@
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+from django.db import models
+from django.utils.safestring import mark_safe
+
+import nh3
+
+
+class RichTextField(models.TextField):
+    """
+    A TextField that automatically sanitizes HTML input using nh3.
+
+    Args:
+        nh3_config (str|None): Key of the NH3_CONFIGS dict from settings.
+            Set to None to disable sanitization for this field.
+    """
+    def __init__(self, *args, nh3_config='default', **kwargs):
+        super().__init__(*args, **kwargs)
+        if nh3_config is None:
+            self.nh3_kwargs = None
+        else:
+            if (not hasattr(settings, 'NH3_CONFIGS') or
+                    nh3_config not in settings.NH3_CONFIGS):
+                raise ImproperlyConfigured(
+                    f"Missing NH3_CONFIGS['{nh3_config}'] configuration. "
+                    "You must use an existing configuration or set "
+                    "nh3_config=None to explicitly disable sanitization "
+                    "for this field.")
+            self.nh3_kwargs = settings.NH3_CONFIGS[nh3_config]
+
+    def pre_save(self, model_instance, add):
+        data = getattr(model_instance, self.attname)
+        if data is None:
+            return data
+        clean_value = (
+            nh3.clean(data, **self.nh3_kwargs)
+            if self.nh3_kwargs and data else data or "")
+        setattr(model_instance, self.attname, mark_safe(clean_value))
+        return clean_value
+
+    def from_db_value(self, value, expression, connection):
+        if value is None:
+            return value
+        # Values are sanitized before saving, so any value returned from the DB
+        # is safe to render unescaped.
+        return mark_safe(value)

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/pfx/pfxcore/views/fields.py

@@ -29,6 +29,7 @@ class ModelList(list):
 class FieldType:
     CharField = "CharField"
     TextField = "TextField"
+    RichTextField = "RichTextField"
     BooleanField = "BooleanField"
     IntegerField = "IntegerField"
     FloatField = "FloatField"
@@ -45,6 +46,7 @@ class FieldType:
         (pfx_fields.MinutesDurationField, MinutesDurationField),
         (pfx_fields.MediaField, MediaField),
         (pfx_fields.DecimalField, DecimalField),
+        (pfx_fields.RichTextField, RichTextField),
         (models.BooleanField, BooleanField),
         (models.IntegerField, IntegerField),
         (models.FloatField, FloatField),
@@ -64,6 +66,7 @@ class FieldType:
     APIDOC_FIELD_BINDING = {
         CharField: "string",
         TextField: "string",
+        RichTextField: "string",
         BooleanField: "boolean",
         IntegerField: "number",
         FloatField: "number",
@@ -106,7 +109,7 @@ def get_db_type(field):
 class ViewField:
     def __init__(
             self, name, verbose_name=None, alias=None,
-            field_type=None, db_type=None,
+            field_type=None, db_type=None, order=None,
             readonly=False, readonly_create=False, readonly_update=False,
             choices=None, json_repr=None, media_field_api=None,
             related_model=None, related_model_api=None, related_fields=None,
@@ -118,6 +121,7 @@ class ViewField:
         self.verbose_name = verbose_name or name
         self.field_type = field_type
         self.db_type = db_type
+        self.order = order
         self.choices = dict(choices or [])
         self.json_repr = json_repr
         self.media_field_api = media_field_api
@@ -150,6 +154,7 @@ class ViewField:
         res['readonly'] = dict(
             post=self.readonly_create,
             put=self.readonly_update)
+        res['order'] = self.order
         return res
 
     def get_value(self, obj):
@@ -213,6 +218,7 @@ class ViewField:
     def from_property(cls, name, prop, **kwargs):
         kwargs['readonly'] = True
         if hasattr(prop, 'fget'):
+            setifnone(kwargs, 'order', getattr(prop.fget, 'order', None))
             field = getattr(prop.fget, 'field', None)
             if field:
                 return cls.from_model_field(name, field, **kwargs)
@@ -237,6 +243,8 @@ class ViewField:
             kwargs, 'field_type', FieldType.from_model_field(field.__class__))
         setifnone(
             kwargs, 'db_type', get_db_type(field))
+        if kwargs.get('order') == '__auto__':
+            kwargs['order'] = name
         return ViewModelField(
             name, model_field=field, **kwargs)
 
@@ -254,6 +262,7 @@ class ViewField:
         if isinstance(attr, (property, cached_property)):
             return cls.from_property(name, attr, **kwargs)
         field = field or attr_model._meta.get_field(attr_name)
+        kwargs['order'] = '__auto__'
         if LOOKUP_SEP in name:
             kwargs['readonly'] = True
         return cls.from_model_field(name, field, **kwargs)
@@ -446,7 +455,7 @@ class VF:
             choices=None, select_related=None, prefetch_related=None,
             json_repr=None, related_model=None, related_model_api=None,
             field=None, related_fields=None, media_field_api=None,
-            db_type=None):
+            db_type=None, order=None):
         self.kwargs = dict(
             name=name, verbose_name=verbose_name, field_type=field_type,
             alias=alias,
@@ -456,7 +465,7 @@ class VF:
             json_repr=json_repr, related_model=related_model,
             related_model_api=related_model_api, field=field,
             related_fields=related_fields, media_field_api=media_field_api,
-            db_type=db_type)
+            db_type=db_type, order=order)
 
     def to_field(self, model):
         return ViewField.from_name(model, **self.kwargs)

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/tests/settings/common.py

@@ -58,6 +58,24 @@ TEMPLATES = [
     }
 ]
 
+NH3_CONFIGS = {
+    'default': {
+        'tags': None,
+        'attributes': None,
+        'strip_comments': True,
+        'url_schemes': None,
+        'attribute_filter': None,
+        'link_rel': None,
+        'generic_attribute_prefixes': None,
+        'tag_attribute_values': {},
+        'set_tag_attribute_values': {},
+    },
+    'custom': {
+        'tags': {'h1', 'p', 'span'},
+        'attributes': {'*': {'class'}},
+    }
+}
+
 LOGGING = {
     'version': 1,
     'disable_existing_logger': False,

{django_pfx-1.4.dev150 → django_pfx-1.4.dev154}/tests/tests/__init__.py

@@ -10,8 +10,8 @@ from .test_fields_choices import TestFieldsChoices
 from .test_fields_date import TestFieldsDate
 from .test_fields_decimal import TestFieldsDecimal
 from .test_fields_minutes_duration import TestFieldsMinutesDuration
-from .test_fields_nh3 import TestFieldsNh3
 from .test_fields_one2many import TestFieldsOne2Many
+from .test_fields_rich_text import TestFieldsRichText
 from .test_filters import FiltersTest
 from .test_locale_api import LocaleAPITest
 from .test_ordered_rest_view_mixin import TestOrderedRestViewMixin

django_pfx-1.4.dev150/tests/tests/test_fields_nh3.py → django_pfx-1.4.dev154/tests/tests/test_fields_rich_text.py

@@ -2,16 +2,14 @@ from django.db import connection, models
 from django.test import TestCase
 from django.test.utils import override_settings
 
-from pfx.pfxcore.fields import NH3Field
+from pfx.pfxcore.fields import RichTextField
 from pfx.pfxcore.models import JSONReprMixin
 from pfx.pfxcore.test import TestAssertMixin
 
 
-class TestNh3Model(JSONReprMixin, models.Model):
-    html = NH3Field()
-    custom_html = NH3Field(
-        allowed_tags={'h1', 'p', 'span'},
-        allowed_attributes={'*': {'class'}})
+class TestRichTextFieldModel(JSONReprMixin, models.Model):
+    html = RichTextField()
+    custom_html = RichTextField(nh3_config='custom')
 
     class Meta:
         verbose_name = "TestModel"
@@ -20,15 +18,15 @@ class TestNh3Model(JSONReprMixin, models.Model):
 
 
 @override_settings(ROOT_URLCONF=__name__)
-class TestFieldsNh3(TestAssertMixin, TestCase):
+class TestFieldsRichText(TestAssertMixin, TestCase):
 
     @classmethod
     def setUpTestData(cls):
         with connection.schema_editor() as schema_editor:
-            schema_editor.create_model(TestNh3Model)
+            schema_editor.create_model(TestRichTextFieldModel)
 
     def test_save(self):
-        t = TestNh3Model.objects.create(
+        t = TestRichTextFieldModel.objects.create(
             html="<unknown>AAA</unknown>",
             custom_html='<h1>TEST</h1>'
             '<script>alert("hello")</script>'

django_pfx-1.4.dev150/pfx/pfxcore/fields/nh3_field.py

@@ -1,83 +0,0 @@
-from django.conf import settings
-from django.db import models
-from django.utils.safestring import mark_safe
-
-import nh3
-
-
-def get_nh3_default_options():
-    nh3_args = {}
-    nh3_settings = {
-        "NH3_ALLOWED_TAGS": "tags",
-        "NH3_ALLOWED_ATTRIBUTES": "attributes",
-        "NH3_STRIP_COMMENTS": "strip_comments",
-        "NH3_URL_SCHEMES": "url_schemes",
-        "NH3_ATTRIBUTE_FILTER": "attribute_filter",
-        "NH3_LINK_REL": "link_rel",
-        "NH3_GENERIC_ATTRIBUTE_PREFIXES": "generic_attribute_prefixes",
-        "NH3_TAG_ATTRIBUTE_VALUES": "tag_attribute_values",
-        "NH3_SET_TAG_ATTRIBUTE_VALUES": "set_tag_attribute_values",
-    }
-
-    for setting, kwarg in nh3_settings.items():
-        if hasattr(settings, setting):
-            attr = getattr(settings, setting)
-            nh3_args[kwarg] = attr
-
-    return nh3_args
-
-
-class NH3Field(models.TextField):
-    def __init__(
-        self,
-        allowed_tags=None,
-        allowed_attributes=None,
-        url_schemes=None,
-        strip_comments=None,
-        attribute_filter=None,
-        link_rel=None,
-        generic_attribute_prefixes=None,
-        tag_attribute_values=None,
-        set_tag_attribute_values=None,
-        *args,
-        **kwargs,
-    ):
-        super().__init__(*args, **kwargs)
-
-        self.nh3_kwargs = get_nh3_default_options()
-
-        if allowed_tags:
-            self.nh3_kwargs["tags"] = allowed_tags
-        if allowed_attributes:
-            self.nh3_kwargs["attributes"] = allowed_attributes
-        if url_schemes:
-            self.nh3_kwargs["url_schemes"] = url_schemes
-        if strip_comments:
-            self.nh3_kwargs["strip_comments"] = strip_comments
-        if attribute_filter:
-            self.nh3_kwargs["attribute_filter"] = attribute_filter
-        if link_rel:
-            self.nh3_kwargs["link_rel"] = link_rel
-        if generic_attribute_prefixes:
-            self.nh3_kwargs["generic_attribute_prefixes"] = (
-                generic_attribute_prefixes)
-        if tag_attribute_values:
-            self.nh3_kwargs["tag_attribute_values"] = tag_attribute_values
-        if set_tag_attribute_values:
-            self.nh3_kwargs["set_tag_attribute_values"] = (
-                set_tag_attribute_values)
-
-    def pre_save(self, model_instance, add):
-        data = getattr(model_instance, self.attname)
-        if data is None:
-            return data
-        clean_value = nh3.clean(data, **self.nh3_kwargs) if data else ""
-        setattr(model_instance, self.attname, mark_safe(clean_value))
-        return clean_value
-
-    def from_db_value(self, value, expression, connection):
-        if value is None:
-            return value
-        # Values are sanitised before saving, so any value returned from the DB
-        # is safe to render unescaped.
-        return mark_safe(value)