Change log to metadata in task function

Author: yidas

README.md

@@ -31,8 +31,9 @@ OUTLINE
 - [Installation](#installation)
 - [Usage](#usage)
     - [Options](#options)
-        - [task.callback](#taskcallback)
-        - [task.result_callback](#taskresult_callback)
+        - [task.function](#taskfunction)
+        - [task.callback.on_done](#taskcallbackon_done)
+        - [task.callback.on_all_done](#taskcallbackon_all_done)
     - [Other Methods](#other-methods)
         - [get_results()](#get_results)
         - [get_logs()](#get_logs)
@@ -81,7 +82,7 @@ Use 20 theads concurrently to dispatch tasks for HTTP reqeusts
 import worker_dispatcher
 import requests
 
-def each_task(id: int, config, task, log):
+def each_task(id: int, config, task, metadata):
     response = requests.get(config['my_endpoint'] + task)
     return response
 
@@ -104,7 +105,7 @@ Utilizes all CPU cores on the machine to compute tasks.
 ```python
 import worker_dispatcher
 
-def each_task(id: int, config, task, log):
+def each_task(id: int, config, task, metadata):
     result = sum(id * i for i in range(10**9))
     return result
 
@@ -209,15 +210,15 @@ results = worker_dispatcher.start({
 The main function to execute per task
 
 ```python
-task_function (id: int, config, task, log: dict) -> Any
+task_function (id: int, config, task, metadata: dict) -> Any
 ```
 
 |Argument          |Type     |Deafult      |Description|
 |:--               |:--      |:--          |:--        |
 |id                |int      |(auto)       |The sequence number generated by each task starting from 1|
 |config            |multitype|{}           |The custom variable to be passed to the callback function|
 |task              |multitype|(custom)     |Each value from the `task.list`|
-|log               |dict     |{}           |The log from each task written by this callback function.|
+|metadata          |dict     |{}           |A user-defined dictionary for custom metadata per task, saved in its log.|
 
 > The return value can be `False` to indicate task failure in TPS logs.  
 > Alternatively, it can be a `requests.Response`, indicating failure if the status code is not 200.
@@ -263,11 +264,12 @@ callback_on_all_done_function (id: int, config, result, log: dict) -> Any
     Get all logs in list type after completing `start()`
 
     Each log is of type dict, containing the results of every task processed by the worker:
-    - task_id 
-    - started_at 
-    - ended_at 
-    - duration 
-    - result
+    - task_id *(Auto-increased number)*
+    - started_at *(Unixtime)*
+    - ended_at *(Unixtime)*
+    - duration *(Seconds)*
+    - result *(Boolean or user-defined)*
+    - metadata *(can be set within each task function)*
 
 - #### get_result_info()
     Get a dict with the whole spending time and started/ended timestamps after completing `start()`
@@ -314,7 +316,7 @@ Perform a stress test scenario with 10 requests per second.
 ```python
 import worker_dispatcher
 
-def each_task(id, config, task, log):
+def each_task(id, config, task, metadata):
     response = None
     try:
         response = requests.get(config['my_endpoint'], timeout=(5, 10))

src/worker_dispatcher/worker_dispatcher.py

@@ -3,7 +3,7 @@
 import queue as Queue
 
 # Sample task function
-def task_function_sample(id: int, config=None, task=None, log: dict=None):
+def task_function_sample(id: int, config=None, task=None, metadata: dict=None):
     if id == 1:
         print("Runing sample task function, please customize yours according to the actual usage.")
     result = {
@@ -536,8 +536,8 @@ def _consume_queue(queue, config, timeout_unixtime, frequency_interval_seconds)
 # Single Task function
 def _consume_task(data, config) -> dict:
     started_at = time.time()
-    task_rewrite_data = {}
-    return_value = config['task']['function'](config=config['task']['config'], id=data['id'], task=data['task'], log=task_rewrite_data)
+    customized_meta = {}
+    return_value = config['task']['function'](config=config['task']['config'], id=data['id'], task=data['task'], metadata=customized_meta)
     ended_at = time.time()
     duration = ended_at - started_at
     log = {
@@ -546,7 +546,7 @@ def _consume_task(data, config) -> dict:
         'ended_at': ended_at,
         'duration': duration,
         'result': return_value,
-        'log': task_rewrite_data,
+        'metadata': customized_meta,
     }
     # On_done hook (will update the result in the log)
     if callable(config['task']['callback']['on_done']):