plain.jobs 0.36.3__tar.gz → 0.37.0__tar.gz

{plain_jobs-0.36.3 → plain_jobs-0.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.jobs
-Version: 0.36.3
+Version: 0.37.0
 Summary: Process background jobs with a database-driven job queue.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE

{plain_jobs-0.36.3 → plain_jobs-0.37.0}/plain/jobs/CHANGELOG.md

@@ -1,5 +1,16 @@
 # plain-jobs changelog
 
+## [0.37.0](https://github.com/dropseed/plain/releases/plain-jobs@0.37.0) (2025-10-22)
+
+### What's changed
+
+- Added `JobMiddleware` abstract base class for creating custom job middleware ([29e5c6df1a](https://github.com/dropseed/plain/commit/29e5c6df1a))
+- Changed "preparing to execute job" log message from `logger.info` to `logger.debug` to reduce log noise ([8e25856639](https://github.com/dropseed/plain/commit/8e25856639))
+
+### Upgrade instructions
+
+- If you have custom job middleware, update them to inherit from `JobMiddleware` and implement the `process_job()` method instead of `__call__()`
+
 ## [0.36.3](https://github.com/dropseed/plain/releases/plain-jobs@0.36.3) (2025-10-20)
 
 ### What's changed

plain_jobs-0.37.0/plain/jobs/__init__.py

@@ -0,0 +1,5 @@
+from .jobs import Job
+from .middleware import JobMiddleware
+from .registry import register_job
+
+__all__ = ["Job", "JobMiddleware", "register_job"]

plain_jobs-0.37.0/plain/jobs/middleware.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from collections.abc import Callable
+from typing import TYPE_CHECKING
+
+from plain.logs import app_logger
+
+if TYPE_CHECKING:
+    from .models import JobProcess, JobResult
+
+
+class JobMiddleware(ABC):
+    """
+    Abstract base class for job middleware.
+
+    Subclasses must implement process_job() to handle the job execution cycle.
+
+    Example:
+        class MyJobMiddleware(JobMiddleware):
+            def process_job(self, job: JobProcess) -> JobResult:
+                # Pre-processing
+                result = self.run_job(job)
+                # Post-processing
+                return result
+    """
+
+    def __init__(self, run_job: Callable[[JobProcess], JobResult]):
+        self.run_job = run_job
+
+    @abstractmethod
+    def process_job(self, job: JobProcess) -> JobResult:
+        """Process the job and return a result. Must be implemented by subclasses."""
+        ...
+
+
+class AppLoggerMiddleware(JobMiddleware):
+    def process_job(self, job: JobProcess) -> JobResult:
+        with app_logger.include_context(
+            job_request_uuid=str(job.job_request_uuid), job_process_uuid=str(job.uuid)
+        ):
+            return self.run_job(job)

{plain_jobs-0.36.3 → plain_jobs-0.37.0}/plain/jobs/workers.py

@@ -144,7 +144,7 @@ class Worker:
                     time.sleep(1)
                     continue
 
-                logger.info(
+                logger.debug(
                     'Preparing to execute job job_class=%s job_request_uuid=%s job_priority=%s job_source="%s" job_queues="%s"',
                     job_request.job_class,
                     job_request.uuid,
@@ -327,7 +327,7 @@ def process_job(job_process_uuid: str) -> None:
         for middleware_path in reversed(settings.JOBS_MIDDLEWARE):
             middleware_class = import_string(middleware_path)
             middleware_instance = middleware_class(middleware_chain)
-            middleware_chain = middleware_instance
+            middleware_chain = middleware_instance.process_job
 
         job_result = middleware_chain(job_process)
 

{plain_jobs-0.36.3 → plain_jobs-0.37.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain.jobs"
-version = "0.36.3"
+version = "0.37.0"
 description = "Process background jobs with a database-driven job queue."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"

plain_jobs-0.36.3/plain/jobs/__init__.py

@@ -1,4 +0,0 @@
-from .jobs import Job
-from .registry import register_job
-
-__all__ = ["Job", "register_job"]

plain_jobs-0.36.3/plain/jobs/middleware.py

@@ -1,20 +0,0 @@
-from __future__ import annotations
-
-from collections.abc import Callable
-from typing import TYPE_CHECKING
-
-from plain.logs import app_logger
-
-if TYPE_CHECKING:
-    from .models import JobProcess, JobResult
-
-
-class AppLoggerMiddleware:
-    def __init__(self, run_job: Callable[[JobProcess], JobResult]) -> None:
-        self.run_job = run_job
-
-    def __call__(self, job: JobProcess) -> JobResult:
-        with app_logger.include_context(
-            job_request_uuid=str(job.job_request_uuid), job_process_uuid=str(job.uuid)
-        ):
-            return self.run_job(job)