django-inspect-tasks 0.5.0__py3-none-any.whl

django_inspect_tasks/management/commands/tasks.py

@@ -0,0 +1,66 @@
+import argparse
+import logging
+from pprint import pformat
+
+from crontask import scheduler
+from django.core.management import BaseCommand, CommandError
+
+from django_inspect_tasks import util
+from django_inspect_tasks.util import all_tasks
+
+
+class Command(BaseCommand):
+    def add_arguments(self, parser: argparse.ArgumentParser):
+        task = parser.add_argument_group("Task Options")
+        task.add_argument("--queue")
+        task.add_argument("--backend")
+        task.add_argument("--priority")
+        task.add_argument("task", nargs="?")
+
+    def handle_task(self, task: str, **options):
+        try:
+            task_obj = util.get_task(task)
+            result = task_obj.using(
+                queue_name=options["queue"],
+                priority=options["priority"],
+                backend=options["backend"],
+            ).enqueue()
+        except (ImportError, AttributeError):
+            raise CommandError(f"Unknown task: {task}")
+        else:
+            return pformat(result)
+
+    def handle(self, task, verbosity, **options):
+        ch = logging.StreamHandler()
+        formatter = logging.Formatter(logging.BASIC_FORMAT)
+        ch.setFormatter(formatter)
+        match verbosity:
+            case 2:
+                logging.root.addHandler(ch)
+                logging.root.setLevel(logging.INFO)
+            case 3:
+                logging.root.addHandler(ch)
+                logging.root.setLevel(logging.DEBUG)
+
+        # If we're passed a task name, we'll send that off to be executed
+        if task:
+            return self.handle_task(task, **options)
+
+        # First we need to lookup all the tasks our app can see
+        tasks = {t.module_path: t for t in all_tasks()}
+
+        # Then we check the schedule
+        scheduled = {}
+        for job in scheduler.get_jobs():
+            scheduled[job.func.__self__.module_path] = job.trigger
+
+        # Then we format the output, showing an extra annotation
+        # for scheduled tasks
+        padding = max([len(k) for k in tasks])
+        for task in sorted(tasks):
+            if task in scheduled:
+                self.stdout.write(
+                    task.ljust(padding) + self.style.MIGRATE_HEADING(scheduled[task]),
+                )
+            else:
+                self.stdout.write(task)

django_inspect_tasks/util.py

@@ -0,0 +1,49 @@
+import importlib
+import logging
+from collections.abc import Iterable
+from types import ModuleType
+
+from django.apps import apps
+from django.tasks import Task, task_backends
+
+logger = logging.getLogger(__name__)
+
+
+def get_task(task: str) -> Task | None:
+    try:
+        module_name, task_name = task.rsplit(".", 1)
+        module = importlib.import_module(module_name)
+        return getattr(module, task_name)
+    except ModuleNotFoundError as e:
+        raise ImportError from e
+
+
+def task_classes() -> tuple[Task]:
+    return tuple({backend.task_class for backend in task_backends.all()})
+
+
+def task_modules(name="tasks") -> Iterable[ModuleType]:
+    for app in apps.get_app_configs():
+        try:
+            module = importlib.import_module(f"{app.name}.{name}")
+        except (ImportError, ModuleNotFoundError):
+            logger.debug("No tasks found for %s", app.name)
+        else:
+            logger.debug("Found %s", module.__name__)
+            yield module
+
+
+def tasks_from_module(mod: ModuleType, TYPES):
+    for key in dir(mod):
+        obj = getattr(mod, key)
+        if isinstance(obj, TYPES):
+            yield obj
+        if isinstance(obj, ModuleType):
+            if mod.__package__ == obj.__package__:
+                yield from tasks_from_module(obj, TYPES)
+
+
+def all_tasks() -> Iterable[Task]:
+    TYPES = task_classes()
+    for module in task_modules():
+        yield from tasks_from_module(module, TYPES)

django_inspect_tasks-0.5.0.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: django-inspect-tasks
+Version: 0.5.0
+Summary: Inspect Tasks in your Django App
+Keywords: django,tasks
+Author: Paul Traylor
+Author-email: Paul Traylor <kungfudiscomonkey@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django :: 6.0
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: django-crontask>=1.0.3
+Requires-Dist: django>=6.0
+Requires-Python: >=3.12
+Project-URL: download, https://pypi.org/project/django-inspect-tasks/
+Project-URL: issues, https://codeberg.org/kfdm/django-inspect-tasks/issues
+Project-URL: source, https://codeberg.org/kfdm/django-inspect-tasks
+Description-Content-Type: text/markdown
+
+# Inspect Tasks in your Django App
+
+![PyPI - Version](https://img.shields.io/pypi/v/django-inspect-tasks)
+![PyPI - License](https://img.shields.io/pypi/l/django-inspect-tasks)
+
+# Instalation
+
+Install using `pip` or `uv` (or your favorite tool)
+
+```shell
+uv add django-inspect-tasks
+```
+
+Then add to your projects `settings.py` under `INSTALLED_APPS`
+
+```python
+INSTALLED_APPS = [
+    "myapp",
+    # Third Party
+    "crontask",
+    "django_inspect_tasks",
+    # Default Django
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+```
+
+Adds a `tasks` subcommand to your app
+
+```shell
+python manage.py tasks
+crontask.tasks.heartbeat cron[month='*', day='*', day_of_week='*', hour='*', minute='*']
+myapp.tasks.example_regular_task
+myapp.tasks.example_scheduled_task interval[0:01:00]
+```

django_inspect_tasks-0.5.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+django_inspect_tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_inspect_tasks/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_inspect_tasks/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_inspect_tasks/management/commands/tasks.py,sha256=148CAbf0GZ6W5m1Zf_x0T72phaCkcS80tr0YwLtK3yY,2287
+django_inspect_tasks/util.py,sha256=sfQ6F93z5U_2NPbCufNNYnFvxO3O6X0S21elOqNKSHI,1434
+django_inspect_tasks-0.5.0.dist-info/WHEEL,sha256=KSLUh82mDPEPk0Bx0ScXlWL64bc8KmzIPNcpQZFV-6E,79
+django_inspect_tasks-0.5.0.dist-info/METADATA,sha256=f_aAzmVmjjRREUaphS3kE1wwfWNw2eXwExNEADy_5tk,1780
+django_inspect_tasks-0.5.0.dist-info/RECORD,,

django_inspect_tasks-0.5.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.22
+Root-Is-Purelib: true
+Tag: py3-none-any