Switch to standard STORAGES setting

Switch from our own custom settings to Django's new standard STORAGE
settings.

Implements: #187

Author: WhyNotHugo

django_afip/migrations/0004_storages_and_help_texts.py

@@ -19,9 +19,7 @@ class Migration(migrations.Migration):
                 blank=True,
                 help_text="The actual file which contains the PDF data.",
                 null=True,
-                storage=django_afip.models._get_storage_from_settings(
-                    "AFIP_PDF_STORAGE"
-                ),
+                storage=django_afip.models._get_storage_from_settings("afip_pdfs"),
                 upload_to=django_afip.models.ReceiptPDF.upload_to,
                 verbose_name="pdf file",
             ),
@@ -32,9 +30,7 @@ class Migration(migrations.Migration):
             field=models.FileField(
                 blank=True,
                 null=True,
-                storage=django_afip.models._get_storage_from_settings(
-                    "AFIP_CERT_STORAGE"
-                ),
+                storage=django_afip.models._get_storage_from_settings("afip_certs"),
                 upload_to="afip/taxpayers/certs/",
                 verbose_name="certificate",
             ),
@@ -45,9 +41,7 @@ class Migration(migrations.Migration):
             field=models.FileField(
                 blank=True,
                 null=True,
-                storage=django_afip.models._get_storage_from_settings(
-                    "AFIP_KEY_STORAGE"
-                ),
+                storage=django_afip.models._get_storage_from_settings("afip_keys"),
                 upload_to="afip/taxpayers/keys/",
                 verbose_name="key",
             ),
@@ -59,9 +53,7 @@ class Migration(migrations.Migration):
                 blank=True,
                 help_text="A logo to use when generating printable receipts.",
                 null=True,
-                storage=django_afip.models._get_storage_from_settings(
-                    "AFIP_LOGO_STORAGE"
-                ),
+                storage=django_afip.models._get_storage_from_settings("afip_logos"),
                 upload_to="afip/taxpayers/logos/",
                 verbose_name="logo",
             ),

django_afip/models.py

@@ -6,6 +6,7 @@
 import random
 import re
 import warnings
+from contextlib import suppress
 from datetime import datetime
 from datetime import timedelta
 from datetime import timezone
@@ -16,12 +17,16 @@
 from typing import BinaryIO
 from typing import ClassVar
 from typing import Generic
+from typing import Literal
 from typing import TypeVar
 from uuid import uuid4
 
 from django.conf import settings
 from django.core import management
 from django.core.files import File
+from django.core.files.storage import InvalidStorageError
+from django.core.files.storage import default_storage
+from django.core.files.storage import storages
 from django.core.validators import MinValueValidator
 from django.db import connection
 from django.db import models
@@ -126,13 +131,30 @@ def first_currency() -> int | None:
     return None
 
 
-def _get_storage_from_settings(setting_name: str) -> Storage:
-    path = getattr(settings, setting_name, None)
-    if not path:
-        from django.core.files.storage import default_storage
+_DEPRECATED_STORAGE_SETTINGS = {
+    "afip_keys": "AFIP_KEY_STORAGE",
+    "afip_certs": "AFIP_CERT_STORAGE",
+    "afip_pdfs": "AFIP_PDF_STORAGE",
+    "afip_logos": "AFIP_LOGO_STORAGE",
+}
 
-        return default_storage
-    return import_string(path)
+
+def _get_storage_from_settings(
+    alias: Literal["afip_keys" | "afip_certs" | "afip_pdfs" | "afip_logos"],
+) -> Storage:
+    with suppress(InvalidStorageError):
+        return storages[alias]
+
+    old_setting = _DEPRECATED_STORAGE_SETTINGS[alias]
+    if path := getattr(settings, old_setting, None):
+        warnings.warn(
+            f"{old_setting} is deprecated. Use STORAGES['{alias}'] instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return import_string(path)
+
+    return default_storage
 
 
 _T = TypeVar("_T", bound="GenericAfipType", covariant=True)
@@ -386,14 +408,14 @@ class TaxPayer(models.Model):
     key = models.FileField(
         verbose_name=_("key"),
         upload_to="afip/taxpayers/keys/",
-        storage=_get_storage_from_settings("AFIP_KEY_STORAGE"),
+        storage=_get_storage_from_settings("afip_keys"),
         blank=True,
         null=True,
     )
     certificate = models.FileField(
         verbose_name=_("certificate"),
         upload_to="afip/taxpayers/certs/",
-        storage=_get_storage_from_settings("AFIP_CERT_STORAGE"),
+        storage=_get_storage_from_settings("afip_certs"),
         blank=True,
         null=True,
     )
@@ -423,7 +445,7 @@ class TaxPayer(models.Model):
     logo = models.ImageField(
         verbose_name=_("logo"),
         upload_to="afip/taxpayers/logos/",
-        storage=_get_storage_from_settings("AFIP_LOGO_STORAGE"),
+        storage=_get_storage_from_settings("afip_logos"),
         blank=True,
         null=True,
         help_text=_("A logo to use when generating printable receipts."),
@@ -1542,7 +1564,7 @@ class ReceiptPDF(models.Model):
     pdf_file = models.FileField(
         verbose_name=_("pdf file"),
         upload_to=_receipt_pdf_upload_to,
-        storage=_get_storage_from_settings("AFIP_PDF_STORAGE"),
+        storage=_get_storage_from_settings("afip_pdfs"),
         blank=True,
         null=True,
         help_text=_("The actual file which contains the PDF data."),

docs/changelog.rst

@@ -23,17 +23,28 @@ Any breaking changes which require intervention will be mentioned here.
 - Drop support for Python 3.9.
 - In order to align with Django's coding style conventions, the following
   fields no longer support ``NULL`` values. Use an empty string instead:
+
    - ``PointOfSales.issuing_name``
    - ``PointOfSales.issuing_address``
    - ``PointOfSales.issuing_email``
    - ``PointOfSales.vat_condition``
    - ``PointOfSales.gross_income_condition``
    - ``PointOfSales.sales_terms``
    - ``ReceiptPDF.issuing_email``
+
 - Remove ``ReceiptValidation.result``, ``ReceiptValidation.RESULT_APPROVED``
   and ``ReceiptValidation.RESULT_REJECTED``. Rejected validation requests were
   never saved. All validations created were of type ``RESULT_APPROVED``,
   making this field completely redundant.
+- Migrate to Django's :setting:`STORAGES` setting (introduced in Django 4.2)
+  for custom storage backends. The old names are deprecated and will be removed
+  in a future version. Use the following settings:
+
+   - ``AFIP_KEY_STORAGE`` → ``STORAGES["afip_keys"]``
+   - ``AFIP_CERT_STORAGE`` → ``STORAGES["afip_certs"]``
+   - ``AFIP_PDF_STORAGE`` → ``STORAGES["afip_pdfs"]``
+   - ``AFIP_LOGO_STORAGE``  → ``STORAGES["afip_logos"]``
+
 
 13.2.2
 ------

docs/installation.rst

@@ -76,21 +76,40 @@ También es posible (y opcional) definir varios :doc:`Storage
 <django:ref/files/storage>` para los archivos de la app. Si no están definidos,
 se usará el Storage predeterminado.
 
-El valor de estos ajustes debería ser un ``str`` con el path a una instancia
-del storage a usar. (eg: ``'myapp.storages.my_private_storage'``). Tanto S3
-como el storage predeterminado han sido testeados ampliamente, aunque cualquier
-storage compatible con django debería funcionar sin dramas.
+Podés configurar storages personalizados usando el setting :setting:`STORAGES`
+de Django con los siguientes alias:
 
 .. code-block:: python
 
-    AFIP_KEY_STORAGE  # Clave para autenticación con el AFIP. (TaxPayer.key)
-    AFIP_CERT_STORAGE  # Certificados para autenticación con el AFIP (TaxPayer.certificate)
-    AFIP_PDF_STORAGE  # PDFs generados para comprobantes (ReceiptPDF.pdf_file)
-    AFIP_LOGO_STORAGE  # Logos usados para comprobantes (TaxPayer.logo)
+    STORAGES = {
+        # …default storages…
+        "afip_keys": {  # Clave para autenticación con el AFIP. (TaxPayer.key)
+            "BACKEND": "myapp.storages.PrivateStorage",
+        },
+        "afip_certs": {  # Certificados para autenticación con el AFIP (TaxPayer.certificate)
+            "BACKEND": "myapp.storages.PrivateStorage",
+        },
+        "afip_pdfs": {  # PDFs generados para comprobantes (ReceiptPDF.pdf_file)
+            "BACKEND": "myapp.storages.ClientStorage",
+        },
+        "afip_logos": {  # Logos usados para comprobantes (TaxPayer.logo)
+            "BACKEND": "django.core.files.storage.FileSystemStorage",
+        },
+    }
 
 Si estás exponiendo tu Storage predeterminado a la web (que suele ser el caso
-en muchas aplicaciones), es recomendable, como mínimo, redefinir
-``AFIP_KEY_STORAGE`` para evitar exponer tu claves a la web.
+en muchas aplicaciones), es importante, como mínimo, redefinir ``afip_keys``
+para evitar exponer tu claves a la web.
+
+.. deprecated:: 14.0
+
+    Los siguientes settings están deprecados y serán removidos en una versión
+    futura. Usá :setting:`STORAGES` de Django en su lugar:
+
+    - ``AFIP_KEY_STORAGE`` → ``STORAGES["afip_keys"]``
+    - ``AFIP_CERT_STORAGE`` → ``STORAGES["afip_certs"]``
+    - ``AFIP_PDF_STORAGE`` → ``STORAGES["afip_pdfs"]``
+    - ``AFIP_LOGO_STORAGE`` → ``STORAGES["afip_logos"]``
 
 Versionado
 ----------