django-pfx 1.7.6.dev3__tar.gz → 1.7.6.dev7__tar.gz

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev3
+Version: 1.7.6.dev7
 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
@@ -35,6 +35,7 @@ Requires-Dist: pyyaml
 Requires-Dist: pytz
 Requires-Dist: dill
 Requires-Dist: nh3
+Requires-Dist: packaging
 Provides-Extra: otp
 Requires-Dist: pyotp>=2.10.0; extra == "otp"
 Provides-Extra: heic-converter

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev3
+Version: 1.7.6.dev7
 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
@@ -35,6 +35,7 @@ Requires-Dist: pyyaml
 Requires-Dist: pytz
 Requires-Dist: dill
 Requires-Dist: nh3
+Requires-Dist: packaging
 Provides-Extra: otp
 Requires-Dist: pyotp>=2.10.0; extra == "otp"
 Provides-Extra: heic-converter

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/django_pfx.egg-info/SOURCES.txt

@@ -68,6 +68,7 @@ pfx/pfxcore/settings.py
 pfx/pfxcore/shortcuts.py
 pfx/pfxcore/test.py
 pfx/pfxcore/urls.py
+pfx/pfxcore/version_check.py
 pfx/pfxcore/apidoc/__init__.py
 pfx/pfxcore/apidoc/parameters.py
 pfx/pfxcore/apidoc/schema.py
@@ -244,6 +245,7 @@ tests/tests/test_user_job_messages.py
 tests/tests/test_user_job_model.py
 tests/tests/test_user_queryset.py
 tests/tests/test_user_websocket.py
+tests/tests/test_version_check.py
 tests/tests/test_view_decorators.py
 tests/tests/test_view_fields.py
 tests_base_user/__init__.py

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/django_pfx.egg-info/requires.txt

@@ -8,6 +8,7 @@ pyyaml
 pytz
 dill
 nh3
+packaging
 
 [heic-converter]
 python-magic

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/django_pfx.egg-info/scm_file_list.json

@@ -126,6 +126,7 @@
     "pfx/pfxcore/templates/registration/welcome_subject.txt",
     "pfx/pfxcore/test.py",
     "pfx/pfxcore/urls.py",
+    "pfx/pfxcore/version_check.py",
     "pfx/pfxcore/views/__init__.py",
     "pfx/pfxcore/views/authentication_views.py",
     "pfx/pfxcore/views/fields.py",
@@ -235,6 +236,7 @@
     "tests/tests/test_user_job_model.py",
     "tests/tests/test_user_queryset.py",
     "tests/tests/test_user_websocket.py",
+    "tests/tests/test_version_check.py",
     "tests/tests/test_view_decorators.py",
     "tests/tests/test_view_fields.py",
     "tests/urls.py",

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

@@ -0,0 +1,8 @@
+{
+  "tag": "1.7.5",
+  "distance": 7,
+  "node": "g826b6a00c2d1527733a0e70ce4eda6b122b24cc9",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-08-31"
+}

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/doc/source/settings.md

@@ -34,6 +34,36 @@ if len(sys.argv) > 1 and sys.argv[1] == 'test':
     PFX_TEST_MODE=True
 ```
 
+### PFX_CHECK_LATEST_VERSION
+
+Boolean (optional, default `False`). When enabled, print a warning at
+startup if a newer django-pfx is published on PyPI. The message is
+printed rather than logged, so that a project log configuration cannot
+silently filter it out.
+
+Only versions of the same kind as the installed one are reported. A
+project running on a dev build follows the dev builds, a project running
+on a final release is only told about newer final releases. A project
+that chose a final release will not move to a dev build, and since one
+is published on every commit pushed to master, reporting them would turn
+the message into permanent noise.
+
+`pip install -r requirements.txt` does not upgrade a package that is
+already installed and still satisfies the requirement, so a project can
+keep running against an outdated django-pfx without anyone noticing.
+This setting turns that into a visible message instead of something to
+remember.
+
+The check only runs under `runserver` (it relies on the same
+`RUN_MAIN` guard as the other startup hooks), never during tests or in
+production. It runs in a background thread, its result is cached for
+4 hours, and any failure (offline, proxy, PyPI outage) is silent.
+
+```python
+DEBUG = True
+PFX_CHECK_LATEST_VERSION = DEBUG
+```
+
 
 ## Authentication
 

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/pfx/pfxcore/apps.py

@@ -108,4 +108,7 @@ class PfxCoreConfig(AppConfig):
                     "PFX HEIC opener not registered "
                     "(use `pip install django-pfx[heic-converter]` "
                     "to use it.)")
+            if settings.PFX_CHECK_LATEST_VERSION:
+                from pfx.pfxcore.version_check import check_latest_version
+                check_latest_version()
         super().ready()

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/pfx/pfxcore/default_settings.py

@@ -38,6 +38,8 @@ STORAGE_LOCAL_X_ACCEL_REDIRECT = False
 
 PFX_TEST_MODE = False
 
+PFX_CHECK_LATEST_VERSION = False
+
 PFX_AUTH_GROUPS_CREATE_ONLY = False
 
 PFX_MFA_BACKENDS = [

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/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-08-18 10:56+0200\n"
+"POT-Creation-Date: 2026-08-12 16:15+0200\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -22,7 +22,7 @@ msgstr ""
 msgid "An internal server error occured."
 msgstr "Une erreur interne du serveur est survenue."
 
-#: default_settings.py:54
+#: default_settings.py:56
 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é "
@@ -206,12 +206,12 @@ msgid ""
 "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 "
+"Vous recevez cet e-mail parce que vous avez demandé un code d’authentification "
 "sur %(site_name)s."
 
 #: templates/registration/otp_code_email.txt:4
 msgid "Authentication code:"
-msgstr "Code d’authentication :"
+msgstr "Code d’authentification :"
 
 #: templates/registration/otp_code_email.txt:6
 #, python-format
@@ -234,7 +234,7 @@ msgstr "L’équipe de %(site_name)s"
 #: templates/registration/otp_code_subject.txt:2
 #, python-format
 msgid "New authentication code for %(site_name)s"
-msgstr "Nouveau code d’authentication pour %(site_name)s"
+msgstr "Nouveau code d’authentification pour %(site_name)s"
 
 #: templates/registration/password_reset_email.txt:2
 #, python-format

django_pfx-1.7.6.dev7/pfx/pfxcore/version_check.py

@@ -0,0 +1,121 @@
+"""Development helper warning when a newer django-pfx is published.
+
+`pip install -r requirements.txt` does not upgrade an already installed
+package, so a project can keep running against an outdated django-pfx
+without anyone noticing. Enable it with the PFX_CHECK_LATEST_VERSION
+setting, it only runs under `runserver`.
+"""
+import json
+import logging
+import tempfile
+import threading
+import time
+import urllib.request
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+
+from django.core.management.color import color_style
+
+from packaging.version import InvalidVersion, Version
+
+logger = logging.getLogger(__name__)
+
+PACKAGE = 'django-pfx'
+PYPI_URL = f'https://pypi.org/pypi/{PACKAGE}/json'
+CACHE_FILE = Path(tempfile.gettempdir()) / f'{PACKAGE}-latest-version.json'
+CACHE_TTL = 4 * 60 * 60
+TIMEOUT = 3
+
+
+def parse_versions(raw_versions):
+    """Parse version strings, skipping the ones PyPI cannot guarantee."""
+    for raw in raw_versions:
+        try:
+            yield Version(raw)
+        except InvalidVersion:
+            continue
+
+
+def fetch_latest():
+    """Newest versions published on PyPI, as (any, final).
+
+    The `info.version` field only reports final releases, so it never
+    sees the dev builds published from master, and the final releases
+    have to be sorted out here.
+    """
+    with urllib.request.urlopen(PYPI_URL, timeout=TIMEOUT) as response:
+        releases = json.load(response)['releases']
+    versions = list(parse_versions(releases))
+    final = max((v for v in versions if not v.is_prerelease), default=None)
+    return str(max(versions)), final and str(final)
+
+
+def cached_latest():
+    """Newest published versions, fetched at most once every CACHE_TTL.
+
+    `runserver` reloads on every file change, an uncached check would
+    mean one PyPI request per save.
+    """
+    try:
+        age = time.time() - CACHE_FILE.stat().st_mtime
+        if age < CACHE_TTL:
+            cache = json.loads(CACHE_FILE.read_text())
+            return cache['latest'], cache['final']
+    except (OSError, ValueError, KeyError):
+        pass
+
+    latest, final = fetch_latest()
+    try:
+        CACHE_FILE.write_text(json.dumps(dict(latest=latest, final=final)))
+    except OSError:
+        pass  # a missing cache only costs an extra request
+    return latest, final
+
+
+def write(message):
+    """Print rather than log.
+
+    The message is only useful if the developer sees it, and a project
+    log configuration commonly filters out third party warnings.
+    Flushed because it is printed from a background thread, possibly
+    after the startup output.
+    """
+    print(color_style().WARNING(f"\n{message}\n"), flush=True)
+
+
+def check():
+    try:
+        current = Version(version(PACKAGE))
+    except PackageNotFoundError:
+        return  # running from a source checkout
+    latest, final = cached_latest()
+    # Report versions of the same kind as the installed one. A project
+    # running on a final release will not move to a dev build, reporting
+    # them would turn the message into permanent noise.
+    target = latest if current.is_prerelease else final
+    if not target:
+        return
+    target = Version(target)
+    if target <= current:
+        return
+    # No advice on how to update: the way the version is declared and
+    # installed is up to the project, any command suggested here would
+    # be wrong for someone.
+    kind = 'dev build' if target.is_prerelease else 'release'
+    write(
+        f"A newer {PACKAGE} {kind} is published: {target} "
+        f"(installed: {current}).")
+
+
+def check_safely():
+    try:
+        check()
+    except Exception as e:
+        # A development convenience must never break the startup
+        # (offline, proxy, PyPI outage, ...).
+        logger.debug("Unable to check the latest %s version: %s", PACKAGE, e)
+
+
+def check_latest_version():
+    """Check in the background, so startup never waits on PyPI."""
+    threading.Thread(target=check_safely, daemon=True).start()

{django_pfx-1.7.6.dev3 → django_pfx-1.7.6.dev7}/setup.cfg

@@ -41,6 +41,7 @@ install_requires =
 	pytz
 	dill
 	nh3
+	packaging
 
 [options.extras_require]
 otp = pyotp>=2.10.0

django_pfx-1.7.6.dev7/tests/tests/test_version_check.py

@@ -0,0 +1,96 @@
+import io
+import json
+from unittest.mock import MagicMock, patch
+
+from django.test import TestCase
+
+from pfx.pfxcore.version_check import (
+    check,
+    check_safely,
+    fetch_latest,
+    parse_versions,
+)
+
+MODULE = 'pfx.pfxcore.version_check'
+
+
+def pypi_response(payload):
+    response = MagicMock()
+    response.__enter__.return_value = io.StringIO(json.dumps(payload))
+    return response
+
+
+class VersionCheckTest(TestCase):
+
+    def test_parse_versions_skips_invalid(self):
+        versions = parse_versions(['1.7.4', 'not-a-version', '1.7.5.dev7'])
+        self.assertEqual(
+            [str(v) for v in versions], ['1.7.4', '1.7.5.dev7'])
+
+    def test_fetch_latest_separates_dev_and_final(self):
+        # `info.version` reports 1.7.4, the latest final release, while
+        # the newest published version is a dev build.
+        payload = dict(
+            info=dict(version='1.7.4'),
+            releases={'1.7.3': [], '1.7.4': [], '1.7.5.dev7': []})
+        with patch(
+                f'{MODULE}.urllib.request.urlopen',
+                return_value=pypi_response(payload)):
+            self.assertEqual(fetch_latest(), ('1.7.5.dev7', '1.7.4'))
+
+    @patch(f'{MODULE}.cached_latest', return_value=('1.7.5.dev7', '1.7.4'))
+    @patch(f'{MODULE}.version', return_value='1.7.3.dev2')
+    @patch(f'{MODULE}.write')
+    def test_dev_install_is_told_about_dev_builds(
+            self, write, version, cached_latest):
+        check()
+        message = write.call_args.args[0]
+        self.assertIn('dev build', message)
+        self.assertIn('1.7.5.dev7', message)
+        self.assertIn('1.7.3.dev2', message)
+
+    @patch(f'{MODULE}.cached_latest', return_value=('1.7.5.dev7', '1.7.4'))
+    @patch(f'{MODULE}.version', return_value='1.7.3')
+    @patch(f'{MODULE}.write')
+    def test_final_install_is_told_about_final_releases(
+            self, write, version, cached_latest):
+        check()
+        message = write.call_args.args[0]
+        self.assertIn('release', message)
+        self.assertIn('1.7.4', message)
+        self.assertNotIn('dev', message)
+
+    @patch(f'{MODULE}.cached_latest', return_value=('1.7.5.dev7', '1.7.4'))
+    @patch(f'{MODULE}.version', return_value='1.7.4')
+    @patch(f'{MODULE}.write')
+    def test_final_install_ignores_newer_dev_builds(
+            self, write, version, cached_latest):
+        # The whole point: a project on a final release would otherwise
+        # be warned on every commit pushed to master.
+        check()
+        write.assert_not_called()
+
+    @patch(f'{MODULE}.cached_latest', return_value=('1.7.5.dev7', '1.7.4'))
+    @patch(f'{MODULE}.version', return_value='1.7.5.dev7')
+    @patch(f'{MODULE}.write')
+    def test_check_silent_when_up_to_date(
+            self, write, version, cached_latest):
+        check()
+        write.assert_not_called()
+
+    @patch(f'{MODULE}.cached_latest', return_value=('1.7.5.dev7', '1.7.4'))
+    @patch(f'{MODULE}.version', return_value='1.7.6.dev1')
+    @patch(f'{MODULE}.write')
+    def test_check_silent_when_ahead_of_pypi(
+            self, write, version, cached_latest):
+        # A local build ahead of PyPI must not be reported.
+        check()
+        write.assert_not_called()
+
+    @patch(f'{MODULE}.check', side_effect=OSError('no network'))
+    @patch(f'{MODULE}.write')
+    @patch(f'{MODULE}.logger')
+    def test_check_safely_never_raises(self, logger, write, check_mock):
+        check_safely()
+        logger.debug.assert_called_once()
+        write.assert_not_called()

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

@@ -1,8 +0,0 @@
-{
-  "tag": "1.7.5",
-  "distance": 3,
-  "node": "g42bba3cdfc22d2fb5c6432d8a822d8b9a8875163",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-08-18"
-}