django-pfx 1.7.2.dev16__tar.gz → 1.7.3.dev2__tar.gz

{django_pfx-1.7.2.dev16 → django_pfx-1.7.3.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.2.dev16
+Version: 1.7.3.dev2
 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.7.2.dev16 → django_pfx-1.7.3.dev2}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.2.dev16
+Version: 1.7.3.dev2
 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.7.2.dev16 → django_pfx-1.7.3.dev2}/django_pfx.egg-info/SOURCES.txt

@@ -159,6 +159,7 @@ tests/tests/test_fields_decimal.py
 tests/tests/test_fields_minutes_duration.py
 tests/tests/test_fields_one2many.py
 tests/tests/test_fields_rich_text.py
+tests/tests/test_fields_time.py
 tests/tests/test_filters.py
 tests/tests/test_locale_api.py
 tests/tests/test_ordered_rest_view_mixin.py

{django_pfx-1.7.2.dev16 → django_pfx-1.7.3.dev2}/pfx/pfxcore/views/fields.py

@@ -39,6 +39,7 @@ class FieldType:
     FloatField = "FloatField"
     DecimalField = "DecimalField"
     DateField = "DateField"
+    TimeField = "TimeField"
     DateTimeField = "DateTimeField"
     MinutesDurationField = "MinutesDurationField"
     MediaField = "MediaField"
@@ -57,6 +58,7 @@ class FieldType:
         (models.DecimalField, DecimalField),
         (models.DateTimeField, DateTimeField),
         (models.DateField, DateField),
+        (models.TimeField, TimeField),
         (models.TextField, TextField),
         (models.CharField, CharField),
         (models.URLField, CharField),
@@ -78,6 +80,7 @@ class FieldType:
         FloatField: "number",
         DecimalField: "string",
         DateField: "string",
+        TimeField: "string",
         DateTimeField: "string",
         MinutesDurationField: "object",
         MediaField: "object",
@@ -305,9 +308,11 @@ class ViewField:
     def to_apidoc(self, request=False):
         res = dict(type=FieldType.to_apidoc(self.field_type))
         if self.field_type == FieldType.DateField:
-            res['format'] = 'date'
+            res['format'] = 'date'  # Official specification name.
+        elif self.field_type == FieldType.TimeField:
+            res['format'] = 'time'  # Custom name, does no exists.
         elif self.field_type == FieldType.DateTimeField:
-            res['format'] = 'date-time'
+            res['format'] = 'date-time'  # Official specification name.
         elif self.field_type == FieldType.ModelObject:
             properties = {}
             if self.related_model:
@@ -442,7 +447,9 @@ class ViewModelField(ViewField):
             value = (value['value']
                      if isinstance(value, dict) and 'value' in value
                      else value)
-        elif self.field_type in (FieldType.DateField, FieldType.DateTimeField):
+        elif self.field_type in (
+                FieldType.DateField, FieldType.TimeField,
+                FieldType.DateTimeField):
             try:
                 value = value and field.to_python(value) or None
             except ValidationError as e:

{django_pfx-1.7.2.dev16 → django_pfx-1.7.3.dev2}/tests/tests/__init__.py

@@ -12,6 +12,7 @@ from .test_fields_decimal import TestFieldsDecimal
 from .test_fields_minutes_duration import TestFieldsMinutesDuration
 from .test_fields_one2many import TestFieldsOne2Many
 from .test_fields_rich_text import TestFieldsRichText
+from .test_fields_time import TestFieldsTime
 from .test_filters import FiltersTest
 from .test_locale_api import LocaleAPITest
 from .test_ordered_rest_view_mixin import TestOrderedRestViewMixin

django_pfx-1.7.3.dev2/tests/tests/test_fields_time.py

@@ -0,0 +1,133 @@
+from datetime import time
+
+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.models import JSONReprMixin
+from pfx.pfxcore.test import APIClient, TestAssertMixin
+from pfx.pfxcore.views import ModelFilter, RestView
+from tests.views import FakeViewMixin
+
+
+class TestTimeModel(JSONReprMixin, models.Model):
+    test_time = models.TimeField("Test Time Field", blank=True, null=True)
+
+    class Meta:
+        verbose_name = "TestModel"
+        verbose_name_plural = "TestModels"
+        ordering = ['pk']
+
+
+@rest_view("/test")
+class TestTimeRestView(FakeViewMixin, RestView):
+    default_public = True
+    model = TestTimeModel
+
+    filters = [ModelFilter(TestTimeModel, 'test_time')]
+
+
+urlpatterns = [
+    path('api/', include(register_views(TestTimeRestView))),
+    path('api/', include('pfx.pfxcore.urls'))
+]
+
+
+@override_settings(ROOT_URLCONF=__name__)
+class TestFieldsTime(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(TestTimeModel)
+
+    def test_meta(self):
+        res = self.client.get('/api/test/meta')
+        self.assertJE(res, 'fields.test_time.type', 'TimeField')
+        self.assertJE(res, 'fields.test_time.db_type', 'TimeField')
+        self.assertJE(res, 'fields.test_time.name', 'Test Time Field')
+
+    def test_get(self):
+        c1 = TestTimeModel.objects.create(test_time=time(14, 20))
+
+        res = self.client.get(f'/api/test/{c1.pk}')
+        self.assertRC(res, 200)
+        self.assertJE(res, 'test_time', '14:20:00')
+
+    def test_create(self):
+        res = self.client.post('/api/test', dict(
+            test_time='14:20'))
+        self.assertRC(res, 200)
+        self.assertJE(res, 'test_time', '14:20:00')
+
+    def test_create_null(self):
+        res = self.client.post('/api/test', dict(
+            test_time=None))
+        self.assertRC(res, 200)
+        self.assertJE(res, 'test_time', None)
+
+    def test_create_invalid(self):
+        res = self.client.post('/api/test', dict(
+            test_time='invalid'))
+        self.assertRC(res, 422)
+        self.assertJE(res, 'test_time', [
+            "“invalid” value has an invalid format. "
+            "It must be in HH:MM[:ss[.uuuuuu]] format."])
+
+    def test_update(self):
+        c1 = TestTimeModel.objects.create(test_time=time(14, 20))
+
+        res = self.client.put(f'/api/test/{c1.pk}', dict(
+            test_time='15:32'))
+        self.assertRC(res, 200)
+        self.assertJE(res, 'test_time', '15:32:00')
+
+    def test_update_null(self):
+        c1 = TestTimeModel.objects.create(test_time=time(14, 20))
+
+        res = self.client.put(f'/api/test/{c1.pk}', dict(
+            test_time=None))
+        self.assertRC(res, 200)
+        self.assertJE(res, 'test_time', None)
+
+    def test_list_order(self):
+        c1 = TestTimeModel.objects.create(test_time=time(14, 20))
+        c2 = TestTimeModel.objects.create(test_time=time(14, 21))
+        c3 = TestTimeModel.objects.create(test_time=time(22, 1))
+
+        res = self.client.get('/api/test?order=test_time')
+        self.assertRC(res, 200)
+        self.assertEqual(
+            [self.get_val(c, 'pk') for c in self.get_val(res, 'items')],
+            [c1.pk, c2.pk, c3.pk])
+
+        res = self.client.get('/api/test?order=-test_time')
+        self.assertRC(res, 200)
+        self.assertEqual(
+            [self.get_val(c, 'pk') for c in self.get_val(res, 'items')],
+            [c3.pk, c2.pk, c1.pk])
+
+    def test_list_filter(self):
+        TestTimeModel.objects.create(test_time=time(14, 20))
+        c2 = TestTimeModel.objects.create(test_time=time(14, 21))
+        c3 = TestTimeModel.objects.create(test_time=time(22, 1))
+
+        res = self.client.get('/api/test', dict(test_time='14:21:00'))
+        self.assertRC(res, 200)
+        self.assertSize(res, 'items', 1)
+        self.assertJE(res, 'items.@0.pk', c2.pk)
+
+        res = self.client.get('/api/test', dict(test_time='22:01'))
+        self.assertRC(res, 200)
+        self.assertSize(res, 'items', 1)
+        self.assertJE(res, 'items.@0.pk', c3.pk)
+
+        res = self.client.get('/api/test', dict(test_time='10:01'))
+        self.assertRC(res, 200)
+        self.assertSize(res, 'items', 0)