csctracker-queue-scheduler 24.1.1__tar.gz → 24.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/PKG-INFO +3 -5
  2. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/README.md +2 -4
  3. csctracker-queue-scheduler-24.1.3/csctracker_queue_scheduler/services/__init__.py +0 -0
  4. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/services/queue_service.py +6 -2
  5. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/services/scheduler_service.py +65 -33
  6. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler.egg-info/PKG-INFO +3 -5
  7. csctracker-queue-scheduler-24.1.1/csctracker_queue_scheduler/services/__init__.py +0 -3
  8. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/LICENSE +0 -0
  9. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/__init__.py +0 -0
  10. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/models/__init__.py +0 -0
  11. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/models/base_dto.py +0 -0
  12. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/models/enums/__init__.py +0 -0
  13. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/models/enums/time_unit.py +0 -0
  14. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/models/generic_data_dto.py +0 -0
  15. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/utils/__init__.py +0 -0
  16. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler/utils/utils.py +0 -0
  17. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler.egg-info/SOURCES.txt +0 -0
  18. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler.egg-info/dependency_links.txt +0 -0
  19. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler.egg-info/requires.txt +0 -0
  20. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/csctracker_queue_scheduler.egg-info/top_level.txt +0 -0
  21. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/setup.cfg +0 -0
  22. {csctracker-queue-scheduler-24.1.1 → csctracker-queue-scheduler-24.1.3}/setup.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: csctracker-queue-scheduler
3
- Version: 24.1.1
3
+ Version: 24.1.3
4
4
  Summary: A library for handle scheduled jobs.
5
5
  Home-page: https://github.com/krlsedu/CscTrackerQueueScheduler.git
6
6
  Author: Carlos Eduardo
@@ -35,16 +35,14 @@ Description: # CscTrackerQueueScheduler
35
35
 
36
36
  ```python
37
37
  from csctracker_queue_scheduler.models.enums.time_unit import TimeUnit
38
- from csctracker_queue_scheduler.services.queue_service import QueueService
39
38
  from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
40
39
 
41
40
 
42
41
  def my_function(): print("Hello, world!")
43
42
 
44
43
 
45
- scheduler = SchedulerService(queue_service=QueueService(), services=[])
46
- scheduler.start_scheduled_job(
47
- function=my_function, period=5, time_unit=TimeUnit.MINUTES)
44
+ SchedulerService.start_scheduled_job(
45
+ function=my_function, period=5, time_unit=TimeUnit.SECONDS)
48
46
  ```
49
47
 
50
48
  In the above example, `my_function` would be scheduled to run every 5 minutes.
@@ -28,16 +28,14 @@ COMING SOON
28
28
 
29
29
  ```python
30
30
  from csctracker_queue_scheduler.models.enums.time_unit import TimeUnit
31
- from csctracker_queue_scheduler.services.queue_service import QueueService
32
31
  from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
33
32
 
34
33
 
35
34
  def my_function(): print("Hello, world!")
36
35
 
37
36
 
38
- scheduler = SchedulerService(queue_service=QueueService(), services=[])
39
- scheduler.start_scheduled_job(
40
- function=my_function, period=5, time_unit=TimeUnit.MINUTES)
37
+ SchedulerService.start_scheduled_job(
38
+ function=my_function, period=5, time_unit=TimeUnit.SECONDS)
41
39
  ```
42
40
 
43
41
  In the above example, `my_function` would be scheduled to run every 5 minutes.
@@ -1,4 +1,5 @@
1
1
  import logging
2
+ import os
2
3
  import queue
3
4
  import threading
4
5
  import time
@@ -9,11 +10,14 @@ from csctracker_queue_scheduler.utils import Utils
9
10
 
10
11
 
11
12
  class QueueService:
12
- def __init__(self, num_threads: int = 10):
13
+ def __init__(self, threads: int = None):
13
14
  self.logger = logging.getLogger()
15
+ if threads is None:
16
+ threads = int(os.getenv("NUM_THREADS", 10))
17
+ self.logger.debug(f"NUM_THREADS={threads}")
14
18
  self.normal_queue = Queue()
15
19
  self.priority_queue = Queue()
16
- self.init_threads(num_threads)
20
+ self.init_threads(threads)
17
21
 
18
22
  def init_threads(self, num_threads):
19
23
  for i in range(num_threads):
@@ -11,59 +11,78 @@ from csctracker_queue_scheduler.utils.utils import Utils
11
11
 
12
12
 
13
13
  class SchedulerService:
14
- def __init__(self, queue_service: QueueService, services: list):
15
- self.logger = logging.getLogger()
16
- self.queue_service = queue_service
17
- self.services = services
18
- self.services.append(self.queue_service)
19
- threading.Thread(target=self.worker).start()
20
-
21
- def worker(self):
14
+ __queue_service = None
15
+ __logger = logging.getLogger()
16
+ __services = []
17
+
18
+ @staticmethod
19
+ def init(threads: int = None, services: list = []):
20
+ SchedulerService.__queue_service = QueueService(threads=threads)
21
+ SchedulerService.__services = services
22
+ SchedulerService.__services.append(SchedulerService.__queue_service)
23
+ threading.Thread(target=SchedulerService.__worker).start()
24
+
25
+ @staticmethod
26
+ def get_queue_service():
27
+ return SchedulerService.__queue_service
28
+
29
+ @staticmethod
30
+ def add_services(services: list):
31
+ SchedulerService.__services.append(services)
32
+
33
+ @staticmethod
34
+ def __worker():
22
35
  while True:
23
36
  try:
24
37
  schedule.run_pending()
25
38
  time.sleep(1)
26
39
  except Exception as e:
27
- self.logger.error(e)
40
+ SchedulerService.__logger.error(e)
28
41
  pass
29
42
  pass
30
43
 
31
- def start_scheduled_job(self,
32
- function,
44
+ @staticmethod
45
+ def start_scheduled_job(function,
33
46
  args=None,
34
47
  period=5,
35
- time_hh_mm="04:00",
48
+ time_hh_mm=None,
36
49
  time_unit: TimeUnit = TimeUnit.MINUTES):
37
- thread = threading.Thread(target=self.start_scheduler,
50
+ if SchedulerService.__queue_service is None:
51
+ SchedulerService.init()
52
+ thread = threading.Thread(target=SchedulerService.__start_scheduler,
38
53
  args=(function, args, period, time_hh_mm, time_unit))
39
54
  thread.start()
40
55
 
41
- def start_scheduler(self, function, args=None, period=5, time_hh_mm=None,
42
- time_unit: TimeUnit = TimeUnit.MINUTES):
56
+ @staticmethod
57
+ def __start_scheduler(function, args=None, period=5, time_hh_mm=None,
58
+ time_unit: TimeUnit = TimeUnit.MINUTES):
43
59
  if args is None:
44
60
  args = {}
45
61
  if time_unit == TimeUnit.SECONDS:
46
- schedule.every(period).seconds.do(self.put_in_queue, function, args, True)
62
+ schedule.every(period).seconds.do(SchedulerService.put_in_queue, function, args, True)
47
63
  elif time_unit == TimeUnit.MINUTES:
48
- schedule.every(period).minutes.do(self.put_in_queue, function, args, True)
64
+ schedule.every(period).minutes.do(SchedulerService.put_in_queue, function, args, True)
49
65
  elif time_unit == TimeUnit.HOURS:
50
- schedule.every(period).hours.do(self.put_in_queue, function, args, True)
66
+ schedule.every(period).hours.do(SchedulerService.put_in_queue, function, args, True)
51
67
  elif time_unit == TimeUnit.DAYS:
52
- schedule.every(period).days.do(self.put_in_queue, function, args, True)
68
+ schedule.every(period).days.do(SchedulerService.put_in_queue, function, args, True)
53
69
  elif time_unit == TimeUnit.WEEKS:
54
- schedule.every(period).weeks.do(self.put_in_queue, function, args, True)
70
+ schedule.every(period).weeks.do(SchedulerService.put_in_queue, function, args, True)
55
71
  elif time_unit == TimeUnit.DAILY:
56
- schedule.every().day.at(time_hh_mm).do(self.put_in_queue, function, args, True)
72
+ if time_hh_mm is None:
73
+ time_hh_mm = period
74
+ schedule.every().day.at(time_hh_mm).do(SchedulerService.put_in_queue, function, args, True)
57
75
  else:
58
76
  raise Exception(f"Inválid time unit -> {time_unit}")
59
- if time_unit != 'daily':
60
- self.logger.info(
77
+ if time_unit != TimeUnit.DAILY:
78
+ SchedulerService.__logger.info(
61
79
  f"Job {Utils.get_friendly_method_name(function)}({args if args else ''}) scheduled to run every {period} {time_unit.value}")
62
80
  else:
63
- self.logger.info(
81
+ SchedulerService.__logger.info(
64
82
  f"Job {Utils.get_friendly_method_name(function)}({args if args else ''}) scheduled to run at {time_hh_mm}")
65
83
 
66
- def init_job(self, function, args=None, priority_job=False, class_name=None, async_job=True) -> GenericDataDTO:
84
+ @staticmethod
85
+ def init_job(function, args=None, priority_job=False, class_name=None, async_job=True) -> GenericDataDTO:
67
86
  executed = False
68
87
  if args is None:
69
88
  args = {}
@@ -75,22 +94,22 @@ class SchedulerService:
75
94
  del args['async_job']
76
95
  if '.' in function:
77
96
  classe, method = function.split('.')
78
- instance = self.get_instance_by_class_name(classe)
97
+ instance = SchedulerService.get_instance_by_class_name(classe)
79
98
  if instance is not None:
80
99
  call_method = SchedulerService.call_method(instance, method)
81
100
  if async_job:
82
- self.queue_service.put(call_method, priority_job, **args)
101
+ SchedulerService.__queue_service.put(call_method, priority_job, **args)
83
102
  else:
84
103
  ret_ = call_method(**args)
85
104
  return GenericDataDTO(msg=ret_)
86
105
  executed = True
87
106
  else:
88
107
  if class_name is not None:
89
- instance = self.get_instance_by_class_name(class_name)
108
+ instance = SchedulerService.get_instance_by_class_name(class_name)
90
109
  if instance is not None:
91
110
  service_call_method = SchedulerService.call_method(instance, function)
92
111
  if async_job:
93
- self.queue_service.put(service_call_method, priority_job, **args)
112
+ SchedulerService.__queue_service.put(service_call_method, priority_job, **args)
94
113
  else:
95
114
  ret_ = service_call_method(**args)
96
115
  return GenericDataDTO(msg=ret_)
@@ -106,12 +125,25 @@ class SchedulerService:
106
125
  method = getattr(instance, method_name)
107
126
  return method
108
127
 
109
- def put_in_queue(self, function, args=None, priority=False):
110
- self.queue_service.put(function, priority, **args)
128
+ @staticmethod
129
+ def put_in_queue(function, args=None, priority=False):
130
+ SchedulerService.__queue_service.put(function, priority, **args)
111
131
 
112
- def get_instance_by_class_name(self, class_name):
132
+ @staticmethod
133
+ def get_instance_by_class_name(class_name):
113
134
  class_name = Utils.snake_to_camel(class_name)
114
- for instance in self.services:
135
+ for instance in SchedulerService.__services:
115
136
  if type(instance).__name__ == class_name:
116
137
  return instance
117
138
  return None
139
+
140
+
141
+ def scheduled_job(args=None,
142
+ period=5,
143
+ time_hh_mm="04:00",
144
+ time_unit: TimeUnit = TimeUnit.MINUTES):
145
+ def decorator(func):
146
+ SchedulerService.start_scheduled_job(func, args, period, time_hh_mm, time_unit)
147
+ return func
148
+
149
+ return decorator
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: csctracker-queue-scheduler
3
- Version: 24.1.1
3
+ Version: 24.1.3
4
4
  Summary: A library for handle scheduled jobs.
5
5
  Home-page: https://github.com/krlsedu/CscTrackerQueueScheduler.git
6
6
  Author: Carlos Eduardo
@@ -35,16 +35,14 @@ Description: # CscTrackerQueueScheduler
35
35
 
36
36
  ```python
37
37
  from csctracker_queue_scheduler.models.enums.time_unit import TimeUnit
38
- from csctracker_queue_scheduler.services.queue_service import QueueService
39
38
  from csctracker_queue_scheduler.services.scheduler_service import SchedulerService
40
39
 
41
40
 
42
41
  def my_function(): print("Hello, world!")
43
42
 
44
43
 
45
- scheduler = SchedulerService(queue_service=QueueService(), services=[])
46
- scheduler.start_scheduled_job(
47
- function=my_function, period=5, time_unit=TimeUnit.MINUTES)
44
+ SchedulerService.start_scheduled_job(
45
+ function=my_function, period=5, time_unit=TimeUnit.SECONDS)
48
46
  ```
49
47
 
50
48
  In the above example, `my_function` would be scheduled to run every 5 minutes.
@@ -1,3 +0,0 @@
1
- from csctracker_queue_scheduler.services.queue_service import QueueService
2
-
3
- queue_service = QueueService()