django-pfx 1.2.dev88__tar.gz → 1.2.dev92__tar.gz

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev88
+Version: 1.2.dev92
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.2.dev88
+Version: 1.2.dev92
 Summary: Django PFX is a toolkit to build web APIs dedicated to be used by React progressive web app.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/pfx/pfxcore/fields.py

@@ -55,6 +55,10 @@ class MinutesDurationField(models.DurationField):
     RE_HH_MM = re.compile(r'^([0-9]*):([0-5][0-9])?$')
     RE_HUMAN = re.compile(
         r'^\s*(?:([0-9]*(?:\.[0-9]*)?)h)?\s*(?:([0-9]*)m)?\s*$')
+    schema = dict(type='object', properties=dict(
+        minutes=dict(type='number', example=90),
+        clock_format=dict(type='string', example='01:30'),
+        human_format=dict(type='string', example='1h 30m')))
 
     def to_python(self, value):
         if value is None or value == '':

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/pfx/pfxcore/views/fields.py

@@ -9,6 +9,7 @@ from django.utils.formats import date_format
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
 
+from apispec.utils import deepupdate
 from apispec.yaml_utils import load_yaml_from_docstring
 
 from pfx.pfxcore import fields as pfx_fields
@@ -222,13 +223,14 @@ class ViewField:
                 properties.update(self.related_model.json_repr_schema())
                 doc = inspect.getdoc(self.related_model.json_repr)
                 if doc:
-                    properties.update(load_yaml_from_docstring(doc))
+                    properties = deepupdate(
+                        load_yaml_from_docstring(doc), properties)
             if self.json_repr:
                 doc = inspect.getdoc(self.json_repr)
                 if doc:
                     p = load_yaml_from_docstring(doc)
                     if p.pop('_extends', False):
-                        properties.update(p)
+                        properties = deepupdate(p, properties)
                     else:
                         properties = p
             if properties:
@@ -241,8 +243,37 @@ class ViewField:
                              properties=dict(pk=properties.get('pk')))]
                 else:
                     res['properties'] = properties
+        elif self.field_type == FieldType.MinutesDurationField:
+            res = pfx_fields.MinutesDurationField.schema
         elif self.field_type == FieldType.ModelObjectList:
             res['items'] = dict(type='object')
+            properties = {}
+            if self.related_model:
+                res['items']['format'] = str(
+                    self.related_model._meta.verbose_name)
+                properties.update(self.related_model.json_repr_schema())
+                doc = inspect.getdoc(self.related_model.json_repr)
+                if doc:
+                    properties = deepupdate(
+                        load_yaml_from_docstring(doc), properties)
+            if self.json_repr:
+                doc = inspect.getdoc(self.json_repr)
+                if doc:
+                    p = load_yaml_from_docstring(doc)
+                    if p.pop('_extends', False):
+                        properties = deepupdate(p, properties)
+                    else:
+                        properties = p
+            if properties:
+                if request:
+                    res.pop('type', None)
+                    res.pop('format', None)
+                    res['oneOf'] = [
+                        properties.get('pk'),
+                        dict(type='object',
+                             properties=dict(pk=properties.get('pk')))]
+                else:
+                    res['items']['properties'] = properties
         res['readonly'] = self.readonly_create and self.readonly_update
         if self.choices:
             res['enum'] = list(self.choices)

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/tests/models.py

@@ -201,3 +201,11 @@ class Book(CacheDependsMixin, PFXModelMixin, models.Model):
 
     def __str__(self):
         return f"{self.name}"
+
+    def json_repr(self, **values):
+        """JSON representation.
+        ---
+        author_name:
+            type: string
+        """
+        return super().json_repr(author_name=str(self.author), **values)

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/tests/tests/test_api_doc.py

@@ -236,6 +236,23 @@ class ApiDocTest(TestAssertMixin, TestCase):
         self.assertJE(props, 'gender.type', 'string')
         self.assertJE(props, 'gender.enum', ['male', 'female'])
 
+        schema_key = self.get_val(
+            paths,
+            '/authors-annotate/{pk}.get.responses.200.content'
+            '.application/json.schema'
+        )['$ref'].split('/')[-1]
+        # Check ModelObjectList fields
+        props = spec['components']['schemas'][schema_key]['properties']
+        self.assertJE(props, 'books.type', 'array')
+        self.assertJE(props, 'books.items.type', 'object')
+        self.assertJE(props, 'books.items.format', 'Book')
+        props = self.get_val(props, 'books.items.properties')
+        self.assertJE(props, 'pk.type', 'number')
+        self.assertJE(props, 'resource_name.type', 'string')
+        self.assertJE(props, 'resource_reference.type', 'string')
+        self.assertJE(props, 'author_name.type', 'string')
+        self.assertJE(props, 'author_gender.type', 'string')
+
         schema_key = self.get_val(
             paths,
             '/books-custom-author/{pk}.get.responses.200.content'
@@ -261,6 +278,13 @@ class ApiDocTest(TestAssertMixin, TestCase):
         props = spec['components']['schemas'][schema_key]['properties']
         # Check that json_repr docstring from model is used
         self.assertJE(props, 'author.properties.new_field.type', 'string')
+        # Check MinutesDurationField fields json schema
+        self.assertJE(props, 'read_time.type', 'object')
+        self.assertJE(props, 'read_time.properties.minutes.type', 'number')
+        self.assertJE(
+            props, 'read_time.properties.clock_format.type', 'string')
+        self.assertJE(
+            props, 'read_time.properties.human_format.type', 'string')
 
         schema_key = self.get_val(
             paths,

{django-pfx-1.2.dev88 → django-pfx-1.2.dev92}/tests/views.py

@@ -125,11 +125,22 @@ class AuthorRestView(AuthorRestViewMixin, SlugDetailRestViewMixin, RestView):
         return JsonResponse(dict(value='static:more'))
 
 
+def books_json_repr(book):
+    """JSON representation.
+    ---
+    _extends: true
+    author_gender:
+        type: string
+    """
+    return book.json_repr(author_gender=book.author.gender)
+
+
 @rest_doc('/<int:id>', 'get', summary="Get custom author", groups=["custom"])
 @rest_view("/authors-annotate")
 class AuthorAnnotateRestView(AuthorRestView):
     fields = [
         'first_name', 'last_name', 'slug',
+        VF('books', json_repr=books_json_repr),
         'books_count', 'books_count_annotate', 'books_count_prop']
     list_fields = [
         'first_name', 'last_name', 'slug',