queuerPy 0.9.0__tar.gz → 0.10.0__tar.gz

{queuerpy-0.9.0/queuerPy.egg-info → queuerpy-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: queuerPy
-Version: 0.9.0
+Version: 0.10.0
 Summary: A Python implementation of the queuer system - a job queuing and processing system with PostgreSQL backend
 Author-email: Simon Herrmann <siherrmann@users.noreply.github.com>
 Maintainer-email: Simon Herrmann <siherrmann@users.noreply.github.com>

{queuerpy-0.9.0 → queuerpy-0.10.0}/__init__.py

@@ -44,6 +44,10 @@ from model.worker import (
     WorkerStatus,
 )
 
+from model.master import (
+    Master,
+)
+
 from model.options_on_error import (
     OnError,
     RetryBackoff,
@@ -72,6 +76,7 @@ __all__ = [
     "JobStatus",
     "Worker",
     "WorkerStatus",
+    "Master",
     "OnError",
     "RetryBackoff",
     # Exceptions

{queuerpy-0.9.0 → queuerpy-0.10.0}/_version.py

@@ -1,6 +1,6 @@
 """Version information for queuerPy package."""
 
-__version__ = "0.9.0"
+__version__ = "0.10.0"
 __version_info__ = tuple(int(part) for part in __version__.split("."))
 
 # For compatibility

{queuerpy-0.9.0 → queuerpy-0.10.0}/core/listener.py

@@ -50,7 +50,7 @@ class Listener(Generic[T]):
         self._stop_event = stop_event
 
         # Define the main coroutine that handles subscription and message reception
-        async def _listen_async():
+        async def _listen_async() -> None:
             ch = await self.broadcaster.subscribe()
             if ready_event is not None:
                 ready_event.set()
@@ -67,7 +67,7 @@ class Listener(Generic[T]):
                             self._active_notifications += 1
                             self._completion_event.clear()
 
-                        def process_notification():
+                        def process_notification() -> None:
                             """Executes the user's callback in a separate thread."""
                             try:
                                 notify_function(msg)
@@ -96,7 +96,7 @@ class Listener(Generic[T]):
         Sends notification directly by broadcasting the data in a separate thread.
         """
 
-        async def _notify():
+        async def _notify() -> None:
             await self.broadcaster.broadcast(data)
 
         go_func(_notify, use_mp=False)
@@ -105,7 +105,7 @@ class Listener(Generic[T]):
         """Wait for all notifications to be processed."""
         return self._completion_event.wait(timeout=timeout)
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop listening."""
         if self._stop_event:
             self._stop_event.set()

{queuerpy-0.9.0 → queuerpy-0.10.0}/core/runner.py

@@ -44,11 +44,11 @@ class Runner(multiprocessing.Process):
         self.is_async = inspect.iscoroutinefunction(task)
         self._result_queue: multiprocessing.Queue[Any] = multiprocessing.Queue(1)
 
-    def go(self):
+    def go(self) -> None:
         """Starts the Runner process in the background."""
         self.start()
 
-    def run(self):
+    def run(self) -> None:
         """
         The main execution method, executed in the child process.
         It executes the assigned task, sends the result to the queue, and exits.
@@ -155,11 +155,11 @@ class SmallRunner(threading.Thread):
         self.is_async = inspect.iscoroutinefunction(task)
         self._result_queue: queue.Queue[Any] = queue.Queue(maxsize=1)
 
-    def go(self):
+    def go(self) -> None:
         """Starts the SmallRunner thread in the background."""
         self.start()
 
-    def run(self):
+    def run(self) -> None:
         """
         The main execution method for the thread.
         """

{queuerpy-0.9.0 → queuerpy-0.10.0}/core/scheduler.py

@@ -45,7 +45,7 @@ class Scheduler:
         self.kwargs = kwargs
         self.start_time = start_time
 
-    def go(self):
+    def go(self) -> None:
         """
         Start the scheduler to run the task at the specified start time.
         Mirrors Go's Go(ctx) method exactly.
@@ -57,7 +57,7 @@ class Scheduler:
         else:
             duration = 0
 
-        def scheduled_runner_task():
+        def scheduled_runner_task() -> None:
             """
             This synchronous function runs in the SmallRunner thread.
             It executes the delay and then runs the user's task.

{queuerpy-0.9.0 → queuerpy-0.10.0}/core/ticker.py

@@ -58,7 +58,7 @@ class Ticker:
             f"Ticker created: task={task.__name__}, interval={self.interval_seconds}s, use_mp={use_mp}, stop_event_created={id(self._stop_event)}"
         )
 
-    def _ticker_function(self):
+    def _ticker_function(self) -> None:
         """
         The continuous loop function executed by the Runner process/thread.
         It handles all the fixed-rate scheduling logic (sleep math).
@@ -101,7 +101,7 @@ class Ticker:
                     f"Interval {self.interval_seconds}s exceeded. Skipping sleep."
                 )
 
-    def go(self):
+    def go(self) -> None:
         """
         Starts the background runner process/thread, executing the internal scheduling loop.
         """
@@ -113,7 +113,7 @@ class Ticker:
             use_mp=self._use_mp,
         )
 
-    def stop(self):
+    def stop(self) -> None:
         """
         Stops the background runner process/thread.
         """

{queuerpy-0.9.0 → queuerpy-0.10.0}/database/db_job.py

@@ -67,14 +67,14 @@ class JobDBHandler:
             result = cur.fetchone()
             return result[0] if result else False
 
-    def create_table(self):
+    def create_table(self) -> None:
         """Create job table using SQL init function."""
         if self.db.instance is None:
             raise ValueError("Database connection is not established")
 
         run_ddl(self.db.instance, "SELECT init_job();")
 
-    def drop_tables(self):
+    def drop_tables(self) -> None:
         """Drop job tables with DDL deadlock protection."""
         if self.db.instance is None:
             raise ValueError("Database connection is not established")
@@ -128,7 +128,7 @@ class JobDBHandler:
         # In full implementation, this would handle explicit transaction context
         return self.insert_job(job)
 
-    def batch_insert_jobs(self, jobs: List[Job]):
+    def batch_insert_jobs(self, jobs: List[Job]) -> None:
         """
         Insert multiple jobs in a batch operation using executemany.
         Mirrors Go's BatchInsertJobs method with direct INSERT statements.
@@ -248,7 +248,7 @@ class JobDBHandler:
             except Exception as e:
                 raise QueuerError("update stale jobs", e)
 
-    def delete_job(self, rid: UUID):
+    def delete_job(self, rid: UUID) -> None:
         """
         Delete a job by RID using SQL function.
         Mirrors Go's DeleteJob method.
@@ -361,7 +361,7 @@ class JobDBHandler:
 
             return jobs
 
-    def add_retention_archive(self, days: int):
+    def add_retention_archive(self, days: int) -> None:
         """
         Add retention policy for archive cleanup.
         Mirrors Go's AddRetentionArchive method.
@@ -375,7 +375,7 @@ class JobDBHandler:
             cur.execute("SELECT add_retention_archive(%s);", (days,))
         self.db.instance.commit()
 
-    def remove_retention_archive(self):
+    def remove_retention_archive(self) -> None:
         """
         Remove retention policy for archive cleanup.
         Mirrors Go's RemoveRetentionArchive method.

{queuerpy-0.9.0 → queuerpy-0.10.0}/database/db_master.py

@@ -54,7 +54,7 @@ class MasterDBHandler:
             result = cur.fetchone()
             return bool(result[0]) if result else False
 
-    def create_table(self):
+    def create_table(self) -> None:
         """Create master table. Mirrors Go's CreateTable method."""
         if self.db.instance is None:
             raise ValueError("Database connection is not established")
@@ -63,7 +63,7 @@ class MasterDBHandler:
             cur.execute("SELECT init_master();")
         self.db.instance.commit()
 
-    def drop_table(self):
+    def drop_table(self) -> None:
         """Drop master table. Mirrors Go's DropTable method."""
         if self.db.instance is None:
             raise ValueError("Database connection is not established")

{queuerpy-0.9.0 → queuerpy-0.10.0}/helper/logging.py

@@ -98,7 +98,7 @@ class QueuerLogger:
         self.logger.addHandler(handler)
         self.logger.propagate = False
 
-    def debug(self, message: str, **kwargs: Any):
+    def debug(self, message: str, **kwargs: Any) -> None:
         """
         Log debug message with optional context.
 
@@ -107,7 +107,7 @@ class QueuerLogger:
         """
         self.log_with_context(logging.DEBUG, message, **kwargs)
 
-    def info(self, message: str, **kwargs: Any):
+    def info(self, message: str, **kwargs: Any) -> None:
         """
         Log info message with optional context.
 
@@ -116,7 +116,7 @@ class QueuerLogger:
         """
         self.log_with_context(logging.INFO, message, **kwargs)
 
-    def warning(self, message: str, **kwargs: Any):
+    def warning(self, message: str, **kwargs: Any) -> None:
         """
         Log warning message with optional context.
 
@@ -125,7 +125,9 @@ class QueuerLogger:
         """
         self.log_with_context(logging.WARNING, message, **kwargs)
 
-    def error(self, message: str, error: Optional[Exception] = None, **kwargs: Any):
+    def error(
+        self, message: str, error: Optional[Exception] = None, **kwargs: Any
+    ) -> None:
         """
         Log error message with optional exception and context.
 
@@ -137,7 +139,9 @@ class QueuerLogger:
             message = f"{message}: {error}"
         self.log_with_context(logging.ERROR, message, **kwargs)
 
-    def critical(self, message: str, error: Optional[Exception] = None, **kwargs: Any):
+    def critical(
+        self, message: str, error: Optional[Exception] = None, **kwargs: Any
+    ) -> None:
         """
         Log critical message with optional exception and context.
 
@@ -149,7 +153,7 @@ class QueuerLogger:
             message = f"{message}: {error}"
         self.log_with_context(logging.CRITICAL, message, **kwargs)
 
-    def log_with_context(self, level: int, message: str, **kwargs: Any):
+    def log_with_context(self, level: int, message: str, **kwargs: Any) -> None:
         """
         Log message with additional context information.
 
@@ -164,7 +168,7 @@ class QueuerLogger:
 
         self.logger.log(level, message)
 
-    def set_level(self, level: int):
+    def set_level(self, level: int) -> None:
         """Set the logging level."""
         self.logger.setLevel(level)
 
@@ -214,7 +218,7 @@ class PerformanceLogger:
         self.logger = logger
         self.start_time: Optional[datetime] = None
 
-    def start_timer(self, operation: str):
+    def start_timer(self, operation: str) -> None:
         """Start timing an operation."""
         self.start_time = datetime.now()
         self.logger.debug(f"Started {operation}")
@@ -233,7 +237,9 @@ class PerformanceLogger:
         return duration
 
 
-def time_operation(operation: str, logger: Optional[QueuerLogger] = None):
+def time_operation(
+    operation: str, logger: Optional[QueuerLogger] = None
+) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
     """
     Decorator to time function execution.
 

{queuerpy-0.9.0 → queuerpy-0.10.0}/helper/sql.py

@@ -18,7 +18,7 @@ logger = get_logger(__name__)
 _DDL_LOCK = threading.RLock()
 
 
-def run_ddl(conn: Connection, sql_statement: str, max_retries: int = 3):
+def run_ddl(conn: Connection, sql_statement: str, max_retries: int = 3) -> None:
     """
     Executes DDL under a process lock, retrying on deadlocks or serialization errors.
 

{queuerpy-0.9.0 → queuerpy-0.10.0}/helper/task.py

@@ -7,7 +7,7 @@ import inspect
 from typing import Any, Callable, List, Type
 
 
-def check_valid_task(task: Any):
+def check_valid_task(task: Any) -> None:
     """
     Check if the provided task is a valid function.
     Raises ValueError if the task is invalid.
@@ -23,7 +23,9 @@ def check_valid_task(task: Any):
         raise ValueError(f"task must be a function, got {type(task).__name__}")
 
 
-def check_valid_task_with_parameters(task: Callable[..., Any], *parameters: Any):
+def check_valid_task_with_parameters(
+    task: Callable[..., Any], *parameters: Any
+) -> None:
     """
     Check if the provided task and parameters are valid.
     Validates that the task is a valid function and parameters match input types.

{queuerpy-0.9.0 → queuerpy-0.10.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "queuerPy"
-version = "0.9.0"
+version = "0.10.0"
 description = "A Python implementation of the queuer system - a job queuing and processing system with PostgreSQL backend"
 readme = "README.md"
 license = "Apache-2.0"
@@ -97,7 +97,7 @@ pythonVersion = "3.8"
 pythonPlatform = "All"
 
 [tool.mypy]
-python_version = "0.9.0"
+python_version = "0.10.0"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = true

{queuerpy-0.9.0 → queuerpy-0.10.0}/queuer.py

@@ -155,7 +155,7 @@ class Queuer(
             f"Queuer with worker created: {new_worker_obj.name} (RID: {self.worker.rid})"
         )
 
-    def start(self, master_settings: Optional[MasterSettings] = None):
+    def start(self, master_settings: Optional[MasterSettings] = None) -> None:
         """Start the queuer."""
         if self.running:
             raise RuntimeError("Queuer is already running")
@@ -214,7 +214,7 @@ class Queuer(
 
         logger.info("Queuer started")
 
-    def stop(self):
+    def stop(self) -> None:
         """Stop the queuer."""
         # Store whether we were running to decide if we need to close connections
         was_running = getattr(self, "_running", False)
@@ -388,7 +388,7 @@ class Queuer(
         logger.info(f"Queuer '{self.worker.name}' stopped")
 
     # Job notification listeners
-    async def _handle_job_notification(self, notification: str):
+    async def _handle_job_notification(self, notification: str) -> None:
         """
         Handle job database notifications.
 
@@ -423,7 +423,7 @@ class Queuer(
         except Exception as e:
             logger.error(f"Error handling job notification: {e}")
 
-    async def _handle_job_archive_notification(self, notification: str):
+    async def _handle_job_archive_notification(self, notification: str) -> None:
         """
         Handle job archive database notifications.
 
@@ -452,7 +452,7 @@ class Queuer(
             logger.error(f"Error handling job archive notification: {e}")
             traceback.print_exc()
 
-    def _start_listeners(self):
+    def _start_listeners(self) -> None:
         """Start database listeners."""
         # Start job listener
         if self.job_db_listener:
@@ -482,7 +482,7 @@ class Queuer(
             except Exception as e:
                 logger.error(f"Error starting job archive listener: {e}")
 
-    def _wait_for_listeners_ready(self, timeout_seconds: float = 3.0):
+    def _wait_for_listeners_ready(self, timeout_seconds: float = 3.0) -> None:
         """
         Wait for both database listeners to be ready by checking their connection status.
 
@@ -520,7 +520,7 @@ class Queuer(
         )
 
     # Tickers
-    def _heartbeat_func(self):
+    def _heartbeat_func(self) -> None:
         """Send periodic heartbeats - only updates database, not queuer state."""
         try:
             # Get current worker from database
@@ -535,7 +535,7 @@ class Queuer(
         except Exception as e:
             logger.error(f"Heartbeat error: {e}")
 
-    def _start_heartbeat_ticker(self):
+    def _start_heartbeat_ticker(self) -> None:
         """Start heartbeat ticker using threading."""
         self.heartbeat_ticker = Ticker(
             timedelta(seconds=30),
@@ -544,7 +544,7 @@ class Queuer(
         )
         self.heartbeat_ticker.go()
 
-    def _poll_jobs_func(self):
+    def _poll_jobs_func(self) -> None:
         """Poll for jobs as backup to notification system."""
         try:
             logger.debug("Running backup job polling")
@@ -552,7 +552,7 @@ class Queuer(
         except Exception as e:
             logger.warning(f"Backup job polling error: {e}")
 
-    def _start_poll_job_ticker(self):
+    def _start_poll_job_ticker(self) -> None:
         """
         Start job polling ticker as backup mechanism.
         This provides a safety net in case notification-based processing fails.
@@ -565,7 +565,9 @@ class Queuer(
         self.poll_job_ticker.go()
 
     # Database listeners
-    async def _start_job_listener(self, handle_job_notification: Callable[[str], Any]):
+    async def _start_job_listener(
+        self, handle_job_notification: Callable[[str], Any]
+    ) -> None:
         """
         Start job database listener.
 

{queuerpy-0.9.0 → queuerpy-0.10.0/queuerPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: queuerPy
-Version: 0.9.0
+Version: 0.10.0
 Summary: A Python implementation of the queuer system - a job queuing and processing system with PostgreSQL backend
 Author-email: Simon Herrmann <siherrmann@users.noreply.github.com>
 Maintainer-email: Simon Herrmann <siherrmann@users.noreply.github.com>

{queuerpy-0.9.0 → queuerpy-0.10.0}/queuer_job.py

@@ -71,7 +71,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
             logger.error(f"Error adding job with options: {str(e)}")
             raise Exception(f"Adding job: {str(e)}")
 
-    def add_jobs(self, batch_jobs: List[BatchJob]):
+    def add_jobs(self, batch_jobs: List[BatchJob]) -> None:
         """
         Add a batch of jobs to the queue.
 
@@ -207,7 +207,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
         self._cancel_job(job)
         return job
 
-    def cancel_all_jobs_by_worker(self, worker_rid: UUID, entries: int = 100):
+    def cancel_all_jobs_by_worker(self, worker_rid: UUID, entries: int = 100) -> None:
         """
         Cancel all jobs assigned to a specific worker by its RID.
 
@@ -336,7 +336,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
         except Exception as e:
             raise Exception(f"Creating or inserting job: {str(e)}")
 
-    def _run_job_initial(self):
+    def _run_job_initial(self) -> None:
         """
         Called to run the next job in the queue.
         Updates job status to running with worker.
@@ -388,7 +388,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
 
     async def _wait_for_job(
         self, job: Job
-    ) -> tuple[List[Any], bool, Optional[Exception]]:
+    ) -> Tuple[List[Any], bool, Optional[Exception]]:
         """
         Execute the job and return the results or an error.
 
@@ -434,7 +434,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
             logger.error(f"Error setting up runner for task {job.task_name}: {e}")
             return [], False, e
 
-    async def _retry_job(self, job: Job, job_error: Exception):
+    async def _retry_job(self, job: Job, job_error: Exception) -> None:
         """
         Retry the job with the given job error.
 
@@ -467,7 +467,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
             results, _, _ = await self._wait_for_job(job)
             await self._succeed_job(job, results)
 
-    async def _run_job(self, job: Job):
+    async def _run_job(self, job: Job) -> None:
         """
         Run the job.
 
@@ -483,7 +483,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
         else:
             await self._succeed_job(job, results)
 
-    def _run_job_sync(self, job: Job):
+    def _run_job_sync(self, job: Job) -> None:
         """
         Synchronous wrapper for _run_job that can be called by the Scheduler.
         Mirrors the Go pattern where scheduler calls the function directly.
@@ -499,7 +499,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
         except Exception as e:
             logger.error(f"Error executing scheduled job {job.rid}: {e}")
 
-    def _cancel_job(self, job: Job):
+    def _cancel_job(self, job: Job) -> None:
         """
         Cancel a job.
 
@@ -524,7 +524,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
             except Exception as e:
                 logger.error(f"Error updating job status to cancelled: {e}")
 
-    async def _succeed_job(self, job: Job, results: List[Any]):
+    async def _succeed_job(self, job: Job, results: List[Any]) -> None:
         """
         Update the job status to succeeded and run the next job if available.
 
@@ -536,7 +536,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
         logger.debug(f"_succeed_job: Setting job {job.rid} results to {results}")
         await self._end_job(job)
 
-    async def _fail_job(self, job: Job, job_error: Exception):
+    async def _fail_job(self, job: Job, job_error: Exception) -> None:
         """
         Update the job status to failed.
 
@@ -547,7 +547,7 @@ class QueuerJobMixin(QueuerGlobalMixin):
         job.error = str(job_error)
         await self._end_job(job)
 
-    async def _end_job(self, job: Job):
+    async def _end_job(self, job: Job) -> None:
         """
         End a job and potentially schedule it again if it's a recurring job.
 

{queuerpy-0.9.0 → queuerpy-0.10.0}/queuer_master.py

@@ -51,7 +51,7 @@ class QueuerMasterMixin(QueuerGlobalMixin):
 
         try:
 
-            def ticker_task():
+            def ticker_task() -> None:
                 """Periodic task executed by the master ticker."""
                 try:
                     try:
@@ -129,7 +129,7 @@ class QueuerMasterMixin(QueuerGlobalMixin):
         """
         try:
 
-            def ticker_task():
+            def ticker_task() -> None:
                 """Periodic task that polls for master role."""
                 try:
                     logger.info("Polling master...")

{queuerpy-0.9.0 → queuerpy-0.10.0}/queuer_task.py

@@ -91,24 +91,33 @@ class QueuerTaskMixin(QueuerGlobalMixin):
         logger.info(f"Task added: {new_task_obj.name}")
         return new_task_obj
 
-    @overload
-    def task(self, name: None = None) -> Callable[[F], F]: ...
+    def task(self) -> Callable[[F], F]:
+        """
+        Decorator to register a task function with the queuer using the function name.
+        This is equivalent to calling add_task().
 
-    @overload
-    def task(self, name: str) -> Callable[[F], F]: ...
+        Usage:
+            @queuer.task()
+            def example_task(param1, param2):
+                return param1 + param2
 
-    def task(self, name: Optional[str] = None) -> Callable[[F], F]:
+        :return: The decorator function that preserves the original function's type
+        """
+
+        def decorator(func: F) -> F:
+            self.add_task(func)
+            return func
+
+        return decorator
+
+    def task_with_name(self, name: str) -> Callable[[F], F]:
         """
         Decorator to register a task function with the queuer.
         This is equivalent to calling add_task() or add_task_with_name().
 
         Usage:
-            @queuer.task()
-            def my_task(param1, param2):
-                return param1 + param2
-
-            @queuer.task(name="custom_task_name")
-            def my_other_task(param):
+            @queuer.task_with_name(name="custom_task_name")
+            def example_task(param):
                 return param * 2
 
         :param name: Optional custom name for the task. If not provided, uses function name.
@@ -116,10 +125,7 @@ class QueuerTaskMixin(QueuerGlobalMixin):
         """
 
         def decorator(func: F) -> F:
-            if name is not None:
-                self.add_task_with_name(func, name)
-            else:
-                self.add_task(func)
+            self.add_task_with_name(func, name)
             return func
 
         return decorator