Hints and lints

django_q/cluster.py

@@ -1,4 +1,5 @@
 import ast
+
 # Standard
 import importlib
 import signal
@@ -10,6 +11,7 @@ from time import sleep
 
 # external
 import arrow
+
 # Django
 from django import db
 from django.conf import settings
@@ -344,9 +346,10 @@ def pusher(task_queue: Queue, event: Event, broker: Broker = None):
     logger.info(_(f"{current_process().name} stopped pushing tasks"))
 
 
-def monitor(result_queue, broker=None):
+def monitor(result_queue: Queue, broker: Broker = None):
     """
     Gets finished tasks from the result queue and saves them to Django
+    :type broker: brokers.Broker
     :type result_queue: multiprocessing.Queue
     """
     if not broker:
@@ -373,9 +376,12 @@ def monitor(result_queue, broker=None):
     logger.info(_(f"{name} stopped monitoring results"))
 
 
-def worker(task_queue, result_queue, timer, timeout=Conf.TIMEOUT):
+def worker(
+    task_queue: Queue, result_queue: Queue, timer: Value, timeout: int = Conf.TIMEOUT
+):
     """
     Takes a task from the task queue, tries to execute it and puts the result back in the result queue
+    :param timeout: number of seconds wait for a worker to finish.
     :type task_queue: multiprocessing.Queue
     :type result_queue: multiprocessing.Queue
     :type timer: multiprocessing.Value
@@ -434,9 +440,11 @@ def worker(task_queue, result_queue, timer, timeout=Conf.TIMEOUT):
     logger.info(_(f"{name} stopped doing work"))
 
 
-def save_task(task, broker):
+def save_task(task, broker: Broker):
     """
     Saves the task package to Django or the cache
+    :param task: the task package
+    :type broker: brokers.Broker
     """
     # SAVE LIMIT < 0 : Don't save success
     if not task.get("save", Conf.SAVE_LIMIT >= 0) and task["success"]:
@@ -482,7 +490,7 @@ def save_task(task, broker):
         logger.error(e)
 
 
-def save_cached(task, broker):
+def save_cached(task, broker: Broker):
     task_key = f'{broker.list_key}:{task["id"]}'
     timeout = task["cached"]
     if timeout is True:
@@ -534,7 +542,7 @@ def save_cached(task, broker):
         logger.error(e)
 
 
-def scheduler(broker=None):
+def scheduler(broker: Broker = None):
     """
     Creates a task from a schedule at the scheduled time and schedules next run
     """

django_q/conf.py

@@ -1,6 +1,4 @@
 import logging
-
-# external
 import os
 from copy import deepcopy
 from multiprocessing import cpu_count
@@ -8,11 +6,8 @@ from signal import signal
 
 import pkg_resources
 from django.conf import settings
-
-# django
 from django.utils.translation import gettext_lazy as _
 
-# local
 from django_q.queues import Queue
 
 # optional

django_q/signing.py

@@ -11,7 +11,7 @@ class SignedPackage:
     """Wraps Django's signing module with custom Pickle serializer."""
 
     @staticmethod
-    def dumps(obj, compressed=Conf.COMPRESSED):
+    def dumps(obj, compressed: bool = Conf.COMPRESSED) -> str:
         return signing.dumps(
             obj,
             key=Conf.SECRET_KEY,
@@ -21,7 +21,7 @@ class SignedPackage:
         )
 
     @staticmethod
-    def loads(obj):
+    def loads(obj) -> any:
         return signing.loads(
             obj, key=Conf.SECRET_KEY, salt=Conf.PREFIX, serializer=PickleSerializer
         )