django-pfx 1.7.6.dev13__tar.gz → 1.7.6.dev15__tar.gz

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/PKG-INFO

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

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

@@ -223,6 +223,7 @@ tests/tests/test_emails_send_email_message.py
 tests/tests/test_fields_choices.py
 tests/tests/test_fields_date.py
 tests/tests/test_fields_decimal.py
+tests/tests/test_fields_help_text.py
 tests/tests/test_fields_minutes_duration.py
 tests/tests/test_fields_one2many.py
 tests/tests/test_fields_rich_text.py

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/django_pfx.egg-info/scm_file_list.json

@@ -214,6 +214,7 @@
     "tests/tests/test_fields_choices.py",
     "tests/tests/test_fields_date.py",
     "tests/tests/test_fields_decimal.py",
+    "tests/tests/test_fields_help_text.py",
     "tests/tests/test_fields_minutes_duration.py",
     "tests/tests/test_fields_one2many.py",
     "tests/tests/test_fields_rich_text.py",

django_pfx-1.7.6.dev15/django_pfx.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.7.5",
+  "distance": 15,
+  "node": "g0ccc5f338cdd3620484d6168dbd4463e12179c94",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-29"
+}

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/doc/source/pfx_views.md

@@ -272,6 +272,10 @@ field = [VF('name')]
 ```
 You can specify following optional attributes:
 * `verbose_name`
+* `help_text`: defaults to the model field `help_text` (or the `help_text`
+  argument of `@rest_property`), use an empty string to disable it.
+  It is returned by the `/meta` services and used as the field `description`
+  in the generated OpenAPI documentation.
 * `field_type`
 * `alias`
 * `readonly`
@@ -286,7 +290,7 @@ Refer to method documentation for details.
 ### Meta
 
 The `ModelResponseMixin` (included in every mixin with a service whose response is a simple object),
-exposes a `/meta` service to identify fields (and their characteristics: type, required, readonly, ...),
+exposes a `/meta` service to identify fields (and their characteristics: type, required, readonly, help_text, ...),
 to enable automatic generation of forms.
 
 See the generated API documentation for more details.

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/pfx/pfxcore/decorator/rest.py

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

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/pfx/pfxcore/views/fields.py

@@ -123,12 +123,13 @@ class ViewField:
             choices=None, json_repr=None, media_field_api=None,
             related_model=None, related_model_api=None, related_fields=None,
             related_filter=None,
-            select_related=None, prefetch_related=None):
+            select_related=None, prefetch_related=None, help_text=None):
         self.name = name
         self.alias = alias or name
         self.readonly_create = readonly or readonly_create
         self.readonly_update = readonly or readonly_update
         self.verbose_name = verbose_name or name
+        self.help_text = help_text
         self.field_type = field_type
         self.db_type = db_type
         self.order = order
@@ -151,7 +152,8 @@ class ViewField:
 
     def meta(self):
         res = dict(
-            type=self.field_type, db_type=self.db_type, name=self.verbose_name)
+            type=self.field_type, db_type=self.db_type, name=self.verbose_name,
+            help_text=self.help_text and str(self.help_text) or None)
         if self.choices:
             res['choices'] = [
                 dict(label=str(v), value=k) for k, v in self.choices.items()]
@@ -242,14 +244,17 @@ class ViewField:
                 return cls.from_model_field(name, field, **kwargs)
             verbose_name = getattr(
                 prop.fget, 'short_description', prop.fget.__name__)
+            help_text = getattr(prop.fget, 'help_text', None)
             field_type = getattr(prop.fget, 'field_type', None)
             db_type = getattr(prop.fget, 'db_type', None)
         else:
             verbose_name = (
                 hasattr(prop, 'name') and prop.name or str(prop))
+            help_text = None
             field_type = None
             db_type = None
         setifnone(kwargs, 'verbose_name', verbose_name)
+        setifnone(kwargs, 'help_text', help_text)
         setifnone(kwargs, 'field_type', field_type)
         setifnone(kwargs, 'db_type', db_type)
         return ViewField(name, **kwargs)
@@ -257,6 +262,7 @@ class ViewField:
     @classmethod
     def from_model_field(cls, name, field, **kwargs):
         setifnone(kwargs, 'verbose_name', cls._get_model_verbose_name(field))
+        setifnone(kwargs, 'help_text', getattr(field, 'help_text', None))
         setifnone(
             kwargs, 'field_type', FieldType.from_model_field(field.__class__))
         setifnone(
@@ -343,7 +349,7 @@ class ViewField:
                 else:
                     res['properties'] = properties
         elif self.field_type == FieldType.MinutesDurationField:
-            res = pfx_fields.MinutesDurationField.schema
+            res = dict(pfx_fields.MinutesDurationField.schema)
         elif self.field_type == FieldType.ModelObjectList:
             res['items'] = dict(type='object')
             properties = {}
@@ -378,6 +384,8 @@ class ViewField:
         res['readonly'] = self.readonly_create and self.readonly_update
         if self.choices:
             res['enum'] = list(self.choices)
+        if self.help_text:
+            res['description'] = str(self.help_text)
         return res
 
 
@@ -481,10 +489,10 @@ 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, related_filter=None,
-            media_field_api=None, db_type=None, order=None):
+            media_field_api=None, db_type=None, order=None, help_text=None):
         self.kwargs = dict(
-            name=name, verbose_name=verbose_name, field_type=field_type,
-            alias=alias,
+            name=name, verbose_name=verbose_name, help_text=help_text,
+            field_type=field_type, alias=alias,
             readonly=readonly, readonly_create=readonly_create,
             readonly_update=readonly_update, choices=choices,
             select_related=select_related, prefetch_related=prefetch_related,

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/tests/migrations/0001_initial.py

@@ -40,7 +40,7 @@ class Migration(migrations.Migration):
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('first_name', models.CharField(max_length=30, verbose_name='First Name')),
                 ('last_name', models.CharField(max_length=30, verbose_name='Last Name')),
-                ('slug', models.SlugField(unique=True, verbose_name='Slug')),
+                ('slug', models.SlugField(help_text='Unique identifier used in URLs', unique=True, verbose_name='Slug')),
                 ('gender', models.CharField(choices=[('male', 'Male'), ('female', 'Female')], default='male', max_length=10, verbose_name='Gender')),
                 ('science_fiction', models.BooleanField(default=False, verbose_name='Science Fiction')),
                 ('created_at', models.DateField(auto_now_add=True, verbose_name='Created at')),

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/tests/models.py

@@ -56,7 +56,8 @@ class Author(CacheableMixin, JSONReprMixin, models.Model):
 
     first_name = models.CharField(_("First Name"), max_length=30)
     last_name = models.CharField(_("Last Name"), max_length=30)
-    slug = models.SlugField("Slug", unique=True)
+    slug = models.SlugField(
+        "Slug", unique=True, help_text="Unique identifier used in URLs")
     gender = models.CharField("Gender", max_length=10, choices=[
         ('male', "Male"), ('female', "Female")], default='male')
     science_fiction = models.BooleanField("Science Fiction", default=False)
@@ -83,7 +84,9 @@ class Author(CacheableMixin, JSONReprMixin, models.Model):
     def __str__(self):
         return f"{self.first_name} {self.last_name}"
 
-    @rest_property("Name Length", "IntegerField")
+    @rest_property(
+        "Name Length", "IntegerField",
+        help_text="Length of the author's full name")
     def name_length(self):
         return len(str(self))
 

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/tests/tests/basic_api_test.py

@@ -596,6 +596,13 @@ class BasicAPITest(TestAssertMixin, TestCase):
         self.assertJE(response, 'fields.name_length.name', 'Name Length')
         self.assertJE(response, 'fields.types.type', 'ModelObjectList')
         self.assertJE(response, 'fields.types.name', 'Types')
+        self.assertJE(response, 'fields.first_name.help_text', None)
+        self.assertJE(
+            response, 'fields.slug.help_text',
+            'Unique identifier used in URLs')
+        self.assertJE(
+            response, 'fields.name_length.help_text',
+            "Length of the author's full name")
         response = self.client.get('/api/books/meta')
         self.assertJE(response, 'fields.author.type', 'ModelObject')
         self.assertJE(response, 'fields.author.model', 'tests.Author')

{django_pfx-1.7.6.dev13 → django_pfx-1.7.6.dev15}/tests/tests/test_api_doc.py

@@ -209,9 +209,15 @@ class ApiDocTest(TestAssertMixin, TestCase):
         self.assertIn("Author", schema_key)
         props = spec['components']['schemas'][schema_key]['properties']
         self.assertJE(props, 'first_name.type', 'string')
+        self.assertJENotExists(props, 'first_name.description')
+        self.assertJE(
+            props, 'slug.description', 'Unique identifier used in URLs')
         # Check an @rest_property field (readonly)
         self.assertJE(props, 'name_length.type', 'number')
         self.assertJE(props, 'name_length.readonly', True)
+        self.assertJE(
+            props, 'name_length.description',
+            "Length of the author's full name")
         self.assertJE(props, 'gender.type', 'string')
         self.assertJE(props, 'gender.enum', ['male', 'female'])
         self.assertJE(props, 'types.type', 'array')

django_pfx-1.7.6.dev15/tests/tests/test_fields_help_text.py

@@ -0,0 +1,35 @@
+from django.test import TestCase
+
+from pfx.pfxcore.views.fields import VF, process_fields
+from tests.models import Author
+
+
+class FieldsHelpTextTest(TestCase):
+
+    def test_help_text_from_model(self):
+        fields = process_fields(Author, ['first_name', 'slug', 'name_length'])
+        self.assertIsNone(fields['first_name'].meta()['help_text'])
+        self.assertEqual(
+            fields['slug'].meta()['help_text'],
+            "Unique identifier used in URLs")
+        self.assertEqual(
+            fields['name_length'].meta()['help_text'],
+            "Length of the author's full name")
+
+    def test_help_text_override(self):
+        fields = process_fields(Author, [
+            VF('first_name', help_text="Custom first name help"),
+            VF('slug', help_text="Custom slug help"),
+            VF('name_length', help_text="Custom length help")])
+        self.assertEqual(
+            fields['first_name'].meta()['help_text'], "Custom first name help")
+        self.assertEqual(
+            fields['slug'].meta()['help_text'], "Custom slug help")
+        self.assertEqual(
+            fields['name_length'].meta()['help_text'], "Custom length help")
+
+    def test_help_text_disable(self):
+        fields = process_fields(Author, [
+            VF('slug', help_text=''), VF('name_length', help_text='')])
+        self.assertIsNone(fields['slug'].meta()['help_text'])
+        self.assertIsNone(fields['name_length'].meta()['help_text'])

django_pfx-1.7.6.dev13/django_pfx.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "1.7.5",
-  "distance": 13,
-  "node": "ge2688ed2e503d5fd499e73d8edb4fd9f28499922",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-09-24"
-}