django-pfx 1.7.3.dev4__tar.gz → 1.7.3.dev6__tar.gz

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/.pre-commit-config.yaml

@@ -1,11 +1,11 @@
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0
     hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: local
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: local
     hooks:
       - id: flake8
         name: flake8
@@ -13,17 +13,17 @@ repos:
         language: system
         types: [python]
         args: [--config=./setup.cfg]
--   repo: local
+  - repo: local
     hooks:
       - id: isort
         name: isort
         entry: isort
         language: system
         types: [python]
--   repo: local
+  - repo: local
     hooks:
       - id: make-messages
         name: make messages
         entry: ./make_messages
         language: system
-        types: [python]
+        pass_filenames: false

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.3.dev4
+Version: 1.7.3.dev6
 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
@@ -37,6 +37,9 @@ Requires-Dist: dill
 Requires-Dist: nh3
 Provides-Extra: otp
 Requires-Dist: pyotp; extra == "otp"
+Provides-Extra: heic-converter
+Requires-Dist: python-magic; extra == "heic-converter"
+Requires-Dist: pillow-heif; extra == "heic-converter"
 Dynamic: license-file
 
 # Django PFX

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.3.dev4
+Version: 1.7.3.dev6
 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
@@ -37,6 +37,9 @@ Requires-Dist: dill
 Requires-Dist: nh3
 Provides-Extra: otp
 Requires-Dist: pyotp; extra == "otp"
+Provides-Extra: heic-converter
+Requires-Dist: python-magic; extra == "heic-converter"
+Requires-Dist: pillow-heif; extra == "heic-converter"
 Dynamic: license-file
 
 # Django PFX

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/django_pfx.egg-info/SOURCES.txt

@@ -73,6 +73,7 @@ pfx/pfxcore/migrations/operations/__init__.py
 pfx/pfxcore/migrations/operations/permissions.py
 pfx/pfxcore/models/__init__.py
 pfx/pfxcore/models/abstract_pfx_base_user.py
+pfx/pfxcore/models/attachment_mixin.py
 pfx/pfxcore/models/cache_mixins.py
 pfx/pfxcore/models/login_ban.py
 pfx/pfxcore/models/mfa_user_mixin.py
@@ -125,8 +126,28 @@ pfx/pfxcore/views/parameters/subset_page_size.py
 pfx/pfxcore/views/parameters/subset_page_subset.py
 pfx/settings/__init__.py
 pfx/settings/dev.py
+pfx/userjobs/__init__.py
+pfx/userjobs/apps.py
+pfx/userjobs/tasks.py
+pfx/userjobs/urls.py
+pfx/userjobs/locale/fr/LC_MESSAGES/django.mo
+pfx/userjobs/locale/fr/LC_MESSAGES/django.po
+pfx/userjobs/migrations/0001_initial.py
+pfx/userjobs/migrations/0002_alter_userjob_options_alter_userjob_auto_queued_and_more.py
+pfx/userjobs/migrations/__init__.py
+pfx/userjobs/models/__init__.py
+pfx/userjobs/models/user_job.py
+pfx/userjobs/models/user_job_attachment.py
+pfx/userjobs/providers/__init__.py
+pfx/userjobs/providers/user_job_django_q_executor.py
+pfx/userjobs/providers/user_job_websocket_channel_provider.py
+pfx/userjobs/views/__init__.py
+pfx/userjobs/views/user_job_attachment_view.py
+pfx/userjobs/views/user_job_view.py
+pfx/userjobs/views/user_websocket_consumer.py
 tests/__init__.py
 tests/apps.py
+tests/channel_group_send_calls.py
 tests/models.py
 tests/urls.py
 tests/views.py
@@ -172,6 +193,9 @@ tests/tests/test_settings.py
 tests/tests/test_shortcuts.py
 tests/tests/test_timezone_middleware.py
 tests/tests/test_tools.py
+tests/tests/test_user_job_api.py
+tests/tests/test_user_job_messages.py
+tests/tests/test_user_job_model.py
 tests/tests/test_user_queryset.py
 tests/tests/test_view_decorators.py
 tests/tests/test_view_fields.py

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/django_pfx.egg-info/requires.txt

@@ -9,5 +9,9 @@ pytz
 dill
 nh3
 
+[heic-converter]
+python-magic
+pillow-heif
+
 [otp]
 pyotp

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/doc/conf.py

@@ -25,7 +25,9 @@ settings.configure(
         'django.contrib.auth',
         'django.contrib.contenttypes',
         'django.contrib.postgres',
-        'pfx.pfxcore'])
+        'pfx.pfxcore',
+        'pfx.userjobs'],
+    STORAGE_DEFAULT='pfx.pfxcore.storage.LocalStorage')
 django.setup()
 
 

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/make_messages

@@ -1,3 +1,4 @@
 #!/usr/bin/env bash
 (cd pfx/pfxcore && django-admin makemessages -a)
+(cd pfx/userjobs && django-admin makemessages -a)
 (cd tests && django-admin makemessages -a)

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/__init__.py

@@ -1,6 +1,4 @@
 from .apps import PfxAppConfig
 from .shortcuts import register_views
 
-default_app_config = 'pfx.pfxcore.apps.PfxCoreConfig'
-
 __PFX_VIEWS__ = []

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/apps.py

@@ -1,5 +1,6 @@
 import inspect
 import logging
+import os
 from pathlib import Path
 
 from django import apps
@@ -88,9 +89,22 @@ class PfxAppConfig(AppConfig):
 
     def ready(self):
         post_migrate.connect(update_groups_permissions_action, sender=self)
-        return super().ready()
+        super().ready()
 
 
 class PfxCoreConfig(AppConfig):
     name = 'pfx.pfxcore'
     default = True
+
+    def ready(self):
+        if os.environ.get("RUN_MAIN") == "true":
+            try:
+                from pillow_heif import register_heif_opener
+                register_heif_opener()
+                logger.info("PFX HEIC opener registered.")
+            except Exception:
+                logger.warning(
+                    "PFX HEIC opener not registered "
+                    "(use `pip install django-pfx[heic-converter]` "
+                    "to use it.)")
+        super().ready()

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/default_settings.py

@@ -1,3 +1,5 @@
+from django.utils.translation import gettext_lazy as _
+
 PFX_TOKEN_SHORT_VALIDITY = {'hours': 12}
 PFX_TOKEN_LONG_VALIDITY = {'days': 30}
 PFX_TOKEN_OTP_VALIDITY = {'minutes': 15}
@@ -42,3 +44,8 @@ PFX_MFA_BACKENDS = ["authenticator", "email"]
 PFX_MFA_FORCE = False
 
 PFX_SMS_BACKEND = 'pfx.pfxcore.sms.backends.console.ConsoleSMSBackend'
+
+# PFX assume you have a log monitoring system (like Sentry), but
+# you can adapt the message to your use case.
+PFX_SYSTEM_ERROR_USER_MESSAGE = _(
+    "A system error occurred. Our support team has been notified.")

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/fields/media_field.py

@@ -1,3 +1,4 @@
+import io
 import logging
 from importlib import import_module
 from urllib.request import urlopen
@@ -42,7 +43,8 @@ def validate_media_json(value):
 class MediaField(models.JSONField):
     def __init__(
             self, *args, max_length=255, get_key=None, storage=None,
-            auto_delete=False, extra_keys=None, **kwargs):
+            auto_delete=False, extra_keys=None,
+            convert_heic=False, **kwargs):
         self.get_key = get_key or self.get_default_key
         if not storage and not settings.STORAGE_DEFAULT:
             raise Exception(
@@ -51,6 +53,7 @@ class MediaField(models.JSONField):
         self.storage = storage or get_storage_class(settings.STORAGE_DEFAULT)
         self.auto_delete = auto_delete
         self.allowed_keys = DEFAULT_KEYS.union(extra_keys or set())
+        self.convert_heic = convert_heic
         self._db_value = None
 
         # Inject default validator if empty
@@ -107,9 +110,24 @@ class MediaField(models.JSONField):
             request, self.value_from_object(obj)['key'])
 
     def upload(self, obj, file, filename, **kwargs):
+        if self.convert_heic:
+            file, filename = self.convert_heic_file(file, filename)
         key = self.get_key(obj, filename)
         return self.to_python(self.storage.upload(key, file, **kwargs))
 
+    def convert_heic_file(self, file, filename):
+        import magic
+        from PIL import Image
+        mime_type = magic.from_buffer(file, mime=True)
+        if mime_type in ('image/heic', 'image/heif'):
+            img = Image.open(io.BytesIO(file))
+            buf = io.BytesIO()
+            img.convert("RGB").save(buf, format="PNG")
+
+            file = buf.getvalue()
+            filename = filename.rsplit(".", 1)[0] + '.png'
+        return file, filename
+
     def delete(self, value):
         return self.storage.delete(value)
 

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2026-05-12 10:30+0200\n"
+"POT-Creation-Date: 2026-05-21 16:23+0200\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -22,6 +22,12 @@ msgstr ""
 msgid "An internal server error occured."
 msgstr "Une erreur interne du serveur est survenue."
 
+#: default_settings.py:51
+msgid "A system error occurred. Our support team has been notified."
+msgstr ""
+"Une erreur système s’est produite. "
+"Notre équipe d’assistance en a été informée."
+
 #: exceptions.py:53 exceptions.py:76
 #, python-brace-format
 msgid "{model} not found."
@@ -67,6 +73,10 @@ msgstr "utilisateur"
 msgid "users"
 msgstr "utilisateurs"
 
+#: models/attachment_mixin.py:25
+msgid "File"
+msgstr "Fichier"
+
 #: models/login_ban.py:54
 msgid "Username"
 msgstr "Nom d’utilisateur"
@@ -139,10 +149,14 @@ msgstr "Configuration MFA requise"
 msgid "Is MFA forced"
 msgstr "MFA est forcé"
 
+#: models/ordered_model_mixin.py:10
+msgid "Sequence"
+msgstr "Séquence"
+
 #: models/pfx_models.py:14
 #, python-format
 msgid "%(model_name)s with this %(field_labels)s already exists."
-msgstr "%(model_name)s avec ce/cette %(field_labels)s éxiste déjà."
+msgstr "%(model_name)s avec ce/cette %(field_labels)s existe déjà."
 
 #: shortcuts.py:52
 #, python-brace-format
@@ -172,7 +186,7 @@ msgstr "{key} doit être « true », « false », « 1 », « 0
 #: templates/registration/otp_code_email.txt:2
 #, python-format
 msgid ""
-"You're receiving this email because you requested an authentication code at "
+"You’re receiving this email because you requested an authentication code at "
 "%(site_name)s."
 msgstr ""
 "Vous recevez cet e-mail parce que vous avez demandé un code d’authentication "
@@ -191,14 +205,14 @@ msgstr "Ce code est valable durant %(otp_validity)s minutes."
 #: templates/registration/password_reset_email.txt:10
 #: templates/registration/welcome_email.txt:10
 msgid "Thanks for using our site!"
-msgstr "Merci d'utiliser notre site !"
+msgstr "Merci d’utiliser notre site !"
 
 #: templates/registration/otp_code_email.txt:10
 #: templates/registration/password_reset_email.txt:12
 #: templates/registration/welcome_email.txt:12
 #, python-format
 msgid "The %(site_name)s team"
-msgstr "L'équipe de %(site_name)s"
+msgstr "L’équipe de %(site_name)s"
 
 #: templates/registration/otp_code_subject.txt:2
 #, python-format
@@ -208,7 +222,7 @@ msgstr "Nouveau code d’authentication pour %(site_name)s"
 #: templates/registration/password_reset_email.txt:2
 #, python-format
 msgid ""
-"You're receiving this email because you requested a password reset for your "
+"You’re receiving this email because you requested a password reset for your "
 "user account at %(site_name)s."
 msgstr ""
 "Vous recevez cet e-mail parce que vous avez demandé une réinitialisation du "
@@ -223,8 +237,8 @@ msgstr ""
 
 #: templates/registration/password_reset_email.txt:8
 #: templates/registration/welcome_email.txt:8
-msgid "Your username, in case you've forgotten:"
-msgstr "Votre nom d'utilisateur, au cas où vous l'auriez oublié :"
+msgid "Your username, in case you’ve forgotten:"
+msgstr "Votre nom d’utilisateur, au cas où vous l’auriez oublié :"
 
 #: templates/registration/password_reset_subject.txt:2
 #, python-format
@@ -281,11 +295,11 @@ msgstr "Un mot de passe vide n’est pas autorisé"
 
 #: views/authentication_views.py:557
 msgid "User and token are valid"
-msgstr "L'utilisateur et le token sont valides"
+msgstr "L’utilisateur et le token sont valides"
 
 #: views/authentication_views.py:559
 msgid "User or token is invalid"
-msgstr "L'utilisateur ou le token est invalide"
+msgstr "L’utilisateur ou le token est invalide"
 
 #: views/authentication_views.py:671
 msgid "OTP is already enabled"
@@ -314,7 +328,7 @@ msgstr ""
 
 #: views/authentication_views.py:1082
 msgid "A new authentication code has been sent by email."
-msgstr "Un nouveau code d'authentification a été envoyé par e-mail."
+msgstr "Un nouveau code d’authentification a été envoyé par e-mail."
 
 #: views/filters_views.py:81
 #, python-brace-format
@@ -333,7 +347,7 @@ msgstr "Le paramètre object est requis pour move={move}."
 #: views/ordered_rest_view_mixin.py:39
 #, python-brace-format
 msgid "object {pk} does not exists in this move context."
-msgstr "object {pk} n'existe pas dans ce contexte de déplacement."
+msgstr "object {pk} n’existe pas dans ce contexte de déplacement."
 
 #: views/rest_views.py:228 views/rest_views.py:385
 #, python-brace-format

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/models/__init__.py

@@ -1,4 +1,5 @@
 from .abstract_pfx_base_user import AbstractPFXBaseUser, AbstractPFXUser
+from .attachment_mixin import AttachmentMixin
 from .cache_mixins import CacheableMixin, CacheDependsMixin
 from .login_ban import LoginBan
 from .mfa_user_mixin import MFAUserMixin, OtpUserMixin

django_pfx-1.7.3.dev6/pfx/pfxcore/models/attachment_mixin.py

@@ -0,0 +1,78 @@
+import logging
+
+from django.conf import settings
+from django.db import models
+from django.utils.module_loading import import_string
+from django.utils.translation import gettext_lazy as _
+
+from pfx.pfxcore.fields import MediaField
+
+logger = logging.getLogger(__name__)
+
+file_field_overrides_error = (
+    "PFX_ATTACHMENT_FILE_FIELD_OVERRIDES must be:\n"
+    "- a dict.\n"
+    "- a callable returning a dict.\n"
+    "- a dotted import path to a callable returning a dict.\n")
+
+
+def _get_file_key(obj, filename):
+    return obj.get_file_key(filename)
+
+
+def _get_attachment_file_field_kwargs():
+    kwargs = dict(
+        verbose_name=_("File"), get_key=_get_file_key,
+        auto_delete=True, blank=True, null=True)
+
+    try:
+        func_path = getattr(
+            settings, 'PFX_ATTACHMENT_FILE_FIELD_OVERRIDES', None)
+        custom_kwargs = {}
+        if func_path:
+            if isinstance(func_path, dict):
+                custom_kwargs = func_path
+            elif callable(func_path):
+                custom_kwargs = func_path()
+            else:
+                custom_kwargs = import_string(func_path)()
+        if custom_kwargs:
+            kwargs.update(custom_kwargs)
+    except Exception as e:
+        raise TypeError(
+            "PFX_ATTACHMENT_FILE_FIELD_OVERRIDES must be:\n"
+            "- a dict.\n"
+            "- a callable returning a dict.\n"
+            "- a dotted import path to a callable returning a dict.\n"
+        ) from e
+
+    return kwargs
+
+
+class AttachmentMixin(models.Model):
+    file = MediaField(**_get_attachment_file_field_kwargs())
+
+    class Meta:
+        abstract = True
+
+    def get_file_key(self, filename):
+        raise NotImplementedError()
+
+    def __str__(self):
+        return (self.file or {}).get('name', '')
+
+    @property
+    def url(self):
+        if not getattr(self, 'api', None):
+            raise RuntimeError(
+                f"api attribute is not defined on {self.__class__}")
+        return f'{self.api}/{self.pk}/file'
+
+    def json_repr(self, **values):
+        return super().json_repr(
+            file={
+                'url': self.url,
+                'name': (self.file or {}).get('name'),
+                'content-type': (self.file or {}).get('content-type'),
+                'content-length': (self.file or {}).get('content-length')},
+            **values)

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/models/ordered_model_mixin.py

@@ -1,12 +1,13 @@
 from django.db import models
 from django.db.models import F, Max, Min
+from django.utils.translation import gettext_lazy as _
 
 
 class OrderedModelMixin(models.Model):
     ordered_by = []
     ordered_default = 'last'
 
-    seq = models.PositiveBigIntegerField("Séquence")
+    seq = models.PositiveBigIntegerField(_("Sequence"))
 
     class Meta:
         abstract = True

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/shortcuts.py

@@ -167,3 +167,8 @@ def file_extension(filename):
         return ''.join(suffixes[-2:])
     else:
         return suffixes[-1]
+
+
+def get_system_error_user_message(context=None):
+    # use str() to force lazy gettext string to be translated.
+    return str(settings.PFX_SYSTEM_ERROR_USER_MESSAGE)

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/templates/registration/otp_code_email.txt

@@ -1,5 +1,5 @@
 {% load i18n %}{% autoescape off %}
-{% blocktrans %}You're receiving this email because you requested an authentication code at {{ site_name }}.{% endblocktrans %}
+{% blocktrans %}You’re receiving this email because you requested an authentication code at {{ site_name }}.{% endblocktrans %}
 
 {% trans "Authentication code:" %} {{ otp_code }}
 

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/templates/registration/password_reset_email.txt

@@ -1,11 +1,11 @@
 {% load i18n %}{% autoescape off %}
-{% blocktrans %}You're receiving this email because you requested a password reset for your user account at {{ site_name }}.{% endblocktrans %}
+{% blocktrans %}You’re receiving this email because you requested a password reset for your user account at {{ site_name }}.{% endblocktrans %}
 
 {% trans "Please go to the following page and choose a new password:" %}
 {% block reset_link %}
 {{ reset_url }}
 {% endblock %}
-{% trans "Your username, in case you've forgotten:" %} {{ user.get_username }}
+{% trans "Your username, in case you’ve forgotten:" %} {{ user.get_username }}
 
 {% trans "Thanks for using our site!" %}
 

{django_pfx-1.7.3.dev4 → django_pfx-1.7.3.dev6}/pfx/pfxcore/templates/registration/welcome_email.txt

@@ -5,7 +5,7 @@
 {% block reset_link %}
 {{ reset_url }}
 {% endblock %}
-{% trans "Your username, in case you've forgotten:" %} {{ user.get_username }}
+{% trans "Your username, in case you’ve forgotten:" %} {{ user.get_username }}
 
 {% trans "Thanks for using our site!" %}
 

django_pfx-1.7.3.dev6/pfx/settings/dev.py

@@ -0,0 +1,34 @@
+SECRET_KEY = 'fake-key'
+INSTALLED_APPS = [
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.postgres',
+    'pfx.pfxcore',
+    'pfx.userjobs',
+]
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+STORAGE_DEFAULT = 'pfx.pfxcore.storage.LocalStorage'
+
+CACHE_MEMORY = {
+    'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+    'LOCATION': 'unique-snowflake',
+}
+CACHES = {
+    'default': CACHE_MEMORY,
+    'django-q': CACHE_MEMORY
+}
+
+CHANNEL_LAYERS = {
+    "default": {
+        "BACKEND": "channels.layers.InMemoryChannelLayer"
+    }
+}
+
+Q_CLUSTER = {
+    'retry': 600,
+    'timeout': 300,
+    'sync': True,
+    'catch_up': False,
+    'max_attempts': 5,
+    'orm': 'default'
+}

django_pfx-1.7.3.dev6/pfx/userjobs/__init__.py

@@ -0,0 +1 @@
+from .apps import UserJobsConfig

django_pfx-1.7.3.dev6/pfx/userjobs/apps.py

@@ -0,0 +1,22 @@
+from django.apps import AppConfig
+from django.db.models.signals import post_migrate
+
+
+def register_periodic_tasks(sender, **kwargs):
+    from . import tasks
+    tasks.register_periodic_tasks()
+
+
+class UserJobsConfig(AppConfig):
+    name = 'pfx.userjobs'
+    default = True
+
+    def ready(self):
+        from pfx.userjobs.models.user_job import (
+            get_executor,
+            get_websocket_provider,
+        )
+        get_executor().validate_setup()
+        get_websocket_provider().validate_setup()
+        post_migrate.connect(register_periodic_tasks, sender=self)
+        super().ready()