django-pfx 1.4.dev112__tar.gz → 1.4.dev116__tar.gz

{django_pfx-1.4.dev112 → django_pfx-1.4.dev116}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.4.dev112
+Version: 1.4.dev116
 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.dev112 → django_pfx-1.4.dev116}/django_pfx.egg-info/SOURCES.txt

@@ -48,6 +48,7 @@ pfx/pfxcore/apidoc/tags.py
 pfx/pfxcore/decorator/__init__.py
 pfx/pfxcore/decorator/rest.py
 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
@@ -145,6 +146,7 @@ tests/tests/test_body_mixin.py
 tests/tests/test_cache.py
 tests/tests/test_client.py
 tests/tests/test_fields_choices.py
+tests/tests/test_fields_decimal.py
 tests/tests/test_fields_minutes_duration.py
 tests/tests/test_fields_nh3.py
 tests/tests/test_filters.py

{django_pfx-1.4.dev112 → django_pfx-1.4.dev116}/pfx/pfxcore/fields/__init__.py

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

django_pfx-1.4.dev116/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.dev112 → django_pfx-1.4.dev116}/pfx/pfxcore/views/fields.py

@@ -44,6 +44,7 @@ class FieldType:
     MODEL_FIELD_BINDING = [
         (pfx_fields.MinutesDurationField, MinutesDurationField),
         (pfx_fields.MediaField, MediaField),
+        (pfx_fields.DecimalField, DecimalField),
         (models.BooleanField, BooleanField),
         (models.IntegerField, IntegerField),
         (models.FloatField, FloatField),
@@ -146,8 +147,15 @@ class ViewField:
 
     def to_json(self, view, obj):
         value = self.get_value(obj)
-        if self.field_type == FieldType.MinutesDurationField:
-            return pfx_fields.MinutesDurationField.to_json(value)
+
+        if self.field_type == FieldType.ModelObject:
+            return self._json_repr(value)
+        if self.field_type == FieldType.ModelObjectList:
+            return [self._json_repr(o) for o in value.all()]
+
+        if self.json_repr:
+            return self.json_repr(value)
+
         if self.field_type == FieldType.MediaField:
             if value:
                 api_url = view._rest_view_path
@@ -155,10 +163,6 @@ class ViewField:
                 return value
             else:
                 return None
-        if self.field_type == FieldType.ModelObject:
-            return self._json_repr(value)
-        if self.field_type == FieldType.ModelObjectList:
-            return [self._json_repr(o) for o in value.all()]
         if self.choices:
             if value in self.choices:
                 return dict(value=value, label=str(self.choices[value]))
@@ -303,6 +307,8 @@ class ViewModelField(ViewField):
             self, name, model_field=None, **kwargs):
         super().__init__(name, **kwargs)
         self.model_field = model_field
+        if hasattr(model_field, 'to_json'):
+            self.json_repr = model_field.to_json
         if (hasattr(self.model_field, 'related_model') and
                 self.model_field.related_model and not self.related_model):
             self.related_model = self.model_field.related_model
@@ -326,6 +332,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):
@@ -340,6 +348,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.dev112 → django_pfx-1.4.dev116}/tests/tests/__init__.py

@@ -7,6 +7,7 @@ from .test_body_mixin import TestBodyMixin
 from .test_cache import TestCache
 from .test_client import TestApiClient
 from .test_fields_choices import TestFieldsChoices
+from .test_fields_decimal import TestFieldsDecimal
 from .test_fields_minutes_duration import TestFieldsMinutesDuration
 from .test_fields_nh3 import TestFieldsNh3
 from .test_filters import FiltersTest

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

@@ -0,0 +1,89 @@
+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)
+    percent = DecimalField(
+        max_digits=10, decimal_places=4, percent=True)
+    monetary = DecimalField(
+        max_digits=10, decimal_places=5, json_decimal_places=2,
+        currency="CHF")
+
+    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']
+
+
+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")
+
+    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")
+
+        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'))