aa-structures 3.0.1__tar.gz → 3.1.0__tar.gz

{aa_structures-3.0.1 → aa_structures-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aa-structures
-Version: 3.0.1
+Version: 3.1.0
 Summary: App for managing Eve Online structures with Alliance Auth.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8

{aa_structures-3.0.1 → aa_structures-3.1.0}/structures/__init__.py

@@ -3,5 +3,5 @@
 # pylint: disable = invalid-name
 default_app_config = "structures.apps.StructuresConfig"
 
-__version__ = "3.0.1"
+__version__ = "3.1.0"
 __title__ = "Structures"

{aa_structures-3.0.1 → aa_structures-3.1.0}/structures/apps.py

@@ -7,3 +7,6 @@ class StructuresConfig(AppConfig):
     name = "structures"
     label = "structures"
     verbose_name = f"Structures v{__version__}"
+
+    def ready(self) -> None:
+        from . import checks  # noqa: F401 pylint: disable=unused-import

aa_structures-3.1.0/structures/checks.py

@@ -0,0 +1,49 @@
+"""Django checks."""
+
+import numbers
+
+from django.conf import settings
+from django.core.checks import Warning, register
+
+
+@register()
+def structures_config_check(app_configs, **kwargs):  # pylint: disable=W0613
+    """structures_config_check is a Django check that verifies that all periodic tasks
+    have been configured correctly in settings.
+    """
+    if not hasattr(settings, "CELERYBEAT_SCHEDULE"):
+        return []
+
+    warnings = []
+    for name, obj in settings.CELERYBEAT_SCHEDULE.items():
+        _verify_task_config(
+            warnings, name, obj, "structures.tasks.update_all_structures"
+        )
+        _verify_task_config(
+            warnings, name, obj, "structures.tasks.fetch_all_notifications"
+        )
+    return warnings
+
+
+def _verify_task_config(warnings: list, name: str, obj: dict, task_name: str):
+    if obj["task"] != task_name:
+        return
+
+    schedule = obj["schedule"]
+    if isinstance(schedule, numbers.Number):
+        return
+
+    warnings.append(
+        Warning(
+            (
+                "Periodic task has deprecated schedule: "
+                f'CELERYBEAT_SCHEDULE["{name}"]'
+            ),
+            hint=(
+                'The value for "schedule" must be a positive number, '
+                "not e.g. a cron definition. "
+                f"Current value is: {schedule}"
+            ),
+            id="structures.W001",
+        )
+    )