django-pfx 1.4.dev114__tar.gz → 1.4.dev118__tar.gz

{django_pfx-1.4.dev114 → django_pfx-1.4.dev118}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev114
+Version: 1.4.dev118
 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.dev114 → django_pfx-1.4.dev118}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev114
+Version: 1.4.dev118
 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.dev114 → django_pfx-1.4.dev118}/pfx/pfxcore/decorator/rest.py

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

django_pfx-1.4.dev118/pfx/pfxcore/fields/decimal_field.py

@@ -0,0 +1,33 @@
+from decimal import Decimal
+
+from django.db import models
+
+
+class DecimalField(models.DecimalField):
+    def __init__(
+            self, *args, percent=False, currency=None,
+            json_decimal_places=None, **kw):
+        super().__init__(*args, **kw)
+        self.percent = percent
+        self.currency = currency
+        self.json_quantize = Decimal(10) ** -(json_decimal_places or (
+            percent and self.decimal_places - 2 or self.decimal_places))
+
+    def to_json_meta(self, meta):
+        meta.update(
+            percent=self.percent,
+            currency=self.currency)
+        return meta
+
+    def to_json(self, value):
+        if value is None:
+            return None
+        if self.percent:
+            value *= Decimal(100)
+        return value.quantize(self.json_quantize)
+
+    def from_json(self, value):
+        if value is None:
+            return None
+        value = Decimal(value)
+        return self.percent and value / Decimal(100) or value

{django_pfx-1.4.dev114 → django_pfx-1.4.dev118}/pfx/pfxcore/views/fields.py

@@ -173,6 +173,17 @@ class ViewField:
     @classmethod
     def from_property(cls, name, prop, **kwargs):
         if hasattr(prop, 'fget'):
+            field = getattr(prop.fget, 'field', None)
+            if field:
+                setifnone(
+                    kwargs, 'verbose_name',
+                    cls._get_model_verbose_name(field))
+                setifnone(
+                    kwargs, 'field_type',
+                    FieldType.from_model_field(field.__class__))
+                kwargs['readonly'] = True
+                return ViewModelField(
+                    name, model_field=field, **kwargs)
             verbose_name = getattr(
                 prop.fget, 'short_description', prop.fget.__name__)
             field_type = getattr(prop.fget, 'field_type', None)
@@ -332,6 +343,8 @@ class ViewModelField(ViewField):
         res['required'] = not (
             getattr(self.model_field, 'null', False) or
             getattr(self.model_field, 'blank', False))
+        if hasattr(self.model_field, 'to_json_meta'):
+            res = self.model_field.to_json_meta(res)
         return res
 
     def to_model_value(self, value, get_related_queryset):
@@ -346,6 +359,8 @@ class ViewModelField(ViewField):
             value = _get_obj(value)
         elif self.field_type == FieldType.ModelObjectList:
             value = ModelList(_get_obj(v) for v in value)
+        elif hasattr(field, 'from_json'):
+            value = field.from_json(value)
         elif hasattr(field, 'choices') and field.choices:
             value = (value['value']
                      if isinstance(value, dict) and 'value' in value

django_pfx-1.4.dev118/tests/tests/test_fields_decimal.py

@@ -0,0 +1,99 @@
+from decimal import Decimal
+
+from django.db import connection, models
+from django.test import TestCase
+from django.test.utils import override_settings
+from django.urls import include, path
+
+from pfx.pfxcore import register_views
+from pfx.pfxcore.decorator import rest_property, rest_view
+from pfx.pfxcore.fields import DecimalField
+from pfx.pfxcore.models import JSONReprMixin
+from pfx.pfxcore.test import APIClient, TestAssertMixin
+from pfx.pfxcore.views import RestView
+from tests.views import FakeViewMixin
+
+
+class TestDecimalModel(JSONReprMixin, models.Model):
+    decimal = DecimalField(
+        max_digits=10, decimal_places=5, json_decimal_places=2)
+    percent = DecimalField(
+        max_digits=10, decimal_places=4, percent=True)
+    monetary = DecimalField(
+        max_digits=10, decimal_places=5, json_decimal_places=2,
+        currency="CHF")
+
+    @rest_property(field=DecimalField(
+        max_digits=10, decimal_places=5, json_decimal_places=2,
+        currency="CHF"))
+    def price_double(self):
+        return Decimal(self.monetary * 2)
+
+    class Meta:
+        verbose_name = "TestModel"
+        verbose_name_plural = "TestModels"
+        ordering = ['pk']
+
+
+@rest_view("/test-decimal-model")
+class DecimalModelRestView(FakeViewMixin, RestView):
+    default_public = True
+    model = TestDecimalModel
+    fields = ['decimal', 'percent', 'monetary', 'price_double']
+
+
+urlpatterns = [
+    path('api/', include(register_views(DecimalModelRestView))),
+    path('api/', include('pfx.pfxcore.urls'))
+]
+
+
+@override_settings(ROOT_URLCONF=__name__)
+class TestFieldsDecimal(TestAssertMixin, TestCase):
+
+    def setUp(self):
+        self.client = APIClient(default_locale='en')
+
+    @classmethod
+    def setUpTestData(cls):
+        with connection.schema_editor() as schema_editor:
+            schema_editor.create_model(TestDecimalModel)
+
+    def test_decimal_meta(self):
+        response = self.client.get('/api/test-decimal-model/meta')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'fields.decimal.percent', False)
+        self.assertJE(response, 'fields.decimal.currency', None)
+        self.assertJE(response, 'fields.percent.percent', True)
+        self.assertJE(response, 'fields.percent.currency', None)
+        self.assertJE(response, 'fields.monetary.percent', False)
+        self.assertJE(response, 'fields.monetary.currency', "CHF")
+        self.assertJE(response, 'fields.price_double.percent', False)
+        self.assertJE(response, 'fields.price_double.currency', "CHF")
+
+    def test_decimal(self):
+        t = TestDecimalModel.objects.create(
+            decimal=3.14, percent=0.0810, monetary=100)
+        t.save()
+        t.refresh_from_db()
+        self.assertEqual(t.decimal, Decimal('3.14000'))
+        self.assertEqual(t.percent, Decimal('0.0810'))
+
+        response = self.client.get(f'/api/test-decimal-model/{t.pk}')
+        self.assertRC(response, 200)
+        self.assertJE(response, 'decimal', "3.14")
+        self.assertJE(response, 'percent', "8.10")
+        self.assertJE(response, 'monetary', "100.00")
+        self.assertJE(response, 'price_double', "200.00")
+
+        response = self.client.put(f'/api/test-decimal-model/{t.pk}', dict(
+            decimal="3.12121",
+            percent="7.7",
+        ))
+        self.assertRC(response, 200)
+        self.assertJE(response, 'decimal', "3.12")
+        self.assertJE(response, 'percent', "7.70")
+
+        t.refresh_from_db()
+        self.assertEqual(t.decimal, Decimal('3.12121'))
+        self.assertEqual(t.percent, Decimal('0.0770'))

django_pfx-1.4.dev114/pfx/pfxcore/fields/decimal_field.py

@@ -1,15 +0,0 @@
-from decimal import Decimal
-
-from django.db import models
-
-
-class DecimalField(models.DecimalField):
-    def __init__(self, *args, json_decimal_places=None, **kw):
-        super().__init__(*args, **kw)
-        self.json_quantize = Decimal(10) ** -(
-            json_decimal_places or self.decimal_places)
-
-    def to_json(self, value):
-        if value is None:
-            return None
-        return value.quantize(self.json_quantize)

django_pfx-1.4.dev114/tests/tests/test_fields_decimal.py

@@ -1,59 +0,0 @@
-from decimal import Decimal
-
-from django.db import connection, models
-from django.test import TestCase
-from django.test.utils import override_settings
-from django.urls import include, path
-
-from pfx.pfxcore import register_views
-from pfx.pfxcore.decorator import rest_view
-from pfx.pfxcore.fields import DecimalField
-from pfx.pfxcore.models import JSONReprMixin
-from pfx.pfxcore.test import APIClient, TestAssertMixin
-from pfx.pfxcore.views import RestView
-from tests.views import FakeViewMixin
-
-
-class TestDecimalModel(JSONReprMixin, models.Model):
-    decimal = DecimalField(
-        max_digits=10, decimal_places=5, json_decimal_places=2)
-
-    class Meta:
-        verbose_name = "TestModel"
-        verbose_name_plural = "TestModels"
-        ordering = ['pk']
-
-
-@rest_view("/test-decimal-model")
-class DecimalModelRestView(FakeViewMixin, RestView):
-    default_public = True
-    model = TestDecimalModel
-    fields = ['decimal']
-
-
-urlpatterns = [
-    path('api/', include(register_views(DecimalModelRestView))),
-    path('api/', include('pfx.pfxcore.urls'))
-]
-
-
-@override_settings(ROOT_URLCONF=__name__)
-class TestFieldsDecimal(TestAssertMixin, TestCase):
-
-    def setUp(self):
-        self.client = APIClient(default_locale='en')
-
-    @classmethod
-    def setUpTestData(cls):
-        with connection.schema_editor() as schema_editor:
-            schema_editor.create_model(TestDecimalModel)
-
-    def test_decimal(self):
-        t = TestDecimalModel.objects.create(decimal=3.14)
-        t.save()
-        t.refresh_from_db()
-        self.assertEqual(t.decimal, Decimal('3.14000'))
-
-        response = self.client.get(f'/api/test-decimal-model/{t.pk}')
-        self.assertRC(response, 200)
-        self.assertJE(response, 'decimal', "3.14")