atomicshop 2.12.11__py3-none-any.whl → 2.12.13__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.12.11'
+__version__ = '2.12.13'

atomicshop/diff_check.py

@@ -2,7 +2,9 @@ import datetime
 from pathlib import Path
 from typing import Union, Literal
 import json
+import queue
 
+from . import filesystem, datetimes
 from .file_io import file_io, jsons
 from .print_api import print_api
 from .basics import list_of_dicts, dicts
@@ -39,7 +41,8 @@ class DiffChecker:
             input_file_rotation_cycle_hours: Union[
                 float,
                 Literal['midnight'],
-                None] = None
+                None] = None,
+            enable_statistics_queue: bool = False
     ):
         """
         :param check_object: any, object to check if it changed.
@@ -83,9 +86,30 @@ class DiffChecker:
                  compared only to itself, and if it changes, it will be updated.
             None: Nothing will be done, you will get an exception.
         :param input_file_rotation_cycle_hours:
-            float, the amount of hours the input file will be rotated.
+            float, the amount of hours the input file will be rotated in the 'hit_statistics' operation type.
             str, (only 'midnight' is valid), the input file will be rotated daily at midnight.
             This is valid only for the 'hit_statistics' operation type.
+        :param enable_statistics_queue: boolean, if True, the statistics queue will be enabled for the 'hit_statistics'
+            operation type. You can use this queue to process the statistics in another thread.
+
+            Example:
+            diff_checker = DiffChecker(
+                check_object_display_name='List of Dicts',
+                input_file_path='D:\\input\\list_of_dicts.json',
+                input_file_write_only=True,
+                return_first_cycle=True,
+                operation_type='hit_statistics',
+                input_file_rotation_cycle_hours='midnight',
+                enable_statistics_queue=True)
+
+            def process_statistics_queue():
+                while True:
+                    statistics = diff_checker.statistics_queue.get()
+                    print(statistics)
+
+            threading.Thread(target=process_statistics_queue).start()
+
+            <... Your checking operation for the object ...>
 
         --------------------------------------------------
 
@@ -167,6 +191,14 @@ class DiffChecker:
         if input_file_rotation_cycle_hours and operation_type != 'hit_statistics':
             raise ValueError("[input_file_rotation_cycle] can be specified only for 'hit_statistics' operation type.")
 
+        if enable_statistics_queue and operation_type != 'hit_statistics':
+            raise ValueError("[enable_statistics_queue] can be specified only for 'hit_statistics' operation type.")
+
+        if input_file_rotation_cycle_hours and not isinstance(input_file_rotation_cycle_hours, float) and \
+                not isinstance(input_file_rotation_cycle_hours, int) and \
+                input_file_rotation_cycle_hours != 'midnight':
+            raise ValueError("[input_file_rotation_cycle] must be float, int or 'midnight' str.")
+
         self.check_object = check_object
         self.check_object_display_name = check_object_display_name
         self.aggregation: bool = aggregation
@@ -175,6 +207,7 @@ class DiffChecker:
         self.return_first_cycle: bool = return_first_cycle
         self.operation_type = operation_type
         self.input_file_rotation_cycle = input_file_rotation_cycle_hours
+        self.enable_statistics_queue = enable_statistics_queue
 
         if not self.check_object_display_name:
             self.check_object_display_name = self.check_object
@@ -184,6 +217,19 @@ class DiffChecker:
         # The format the file will be saved as (not used as extension): txt, json.
         self.save_as: str = str()
 
+        # If the input file rotation cycle is set and the statistics queue is enabled, we will create the queue.
+        if self.input_file_rotation_cycle and self.enable_statistics_queue:
+            # You can use this queue to process the statistics in another thread.
+            self.statistics_queue = queue.Queue()
+        else:
+            self.statistics_queue = None
+
+        # If the input file rotation cycle is set to midnight, we will store the previous day as today.
+        if self.input_file_rotation_cycle == 'midnight':
+            self.previous_day = datetime.datetime.now().strftime('%d')
+        else:
+            self.previous_day = None
+
     def check_string(self, print_kwargs: dict = None):
         """
         The function will check file content for change by hashing it and comparing the hash.
@@ -297,6 +343,35 @@ class DiffChecker:
         return result, message
 
     def _hit_statistics_only_handling(self, current_content, result, message, sort_by_keys, print_kwargs: dict = None):
+        if self.input_file_rotation_cycle == 'midnight':
+            # If the current time is midnight, we will rotate the file.
+            # Get current date.
+            current_date = datetime.datetime.now().strftime('%d')
+            # If current date is different from previous date it means it is a new day, rotate the file.
+            if current_date != self.previous_day:
+                input_file_statistics = None
+                try:
+                    # Read the latest statistics from the input file.
+                    input_file_statistics = jsons.read_json_file(self.input_file_path)
+                # Basically, this means that the input statistics file doesn't exist yet, and no events hit
+                # yet and new day has come, so it doesn't matter, since there are no statistics to rotate the file.
+                except FileNotFoundError:
+                    pass
+
+                if input_file_statistics:
+                    # Rename the file.
+                    filesystem.backup_file(
+                        self.input_file_path, str(Path(self.input_file_path).parent), timestamp_as_prefix=False)
+                    # Update the previous date.
+                    self.previous_day = current_date
+
+                    previous_day_date_object = (datetime.datetime.now() - datetime.timedelta(days=1)).date()
+                    # Put the statistics in the queue to be processed.
+                    if self.statistics_queue:
+                        self.statistics_queue.put((input_file_statistics, previous_day_date_object))
+        else:
+            raise NotImplementedError("This feature is not implemented yet.")
+
         # Convert the dictionary entry to string, since we will use it as a key in the dictionary.
         current_entry = json.dumps(current_content[0])
 

atomicshop/filesystem.py

@@ -1391,23 +1391,44 @@ def backup_folder(directory_path: str, backup_directory: str) -> None:
         move_folder(directory_path, backup_directory_path)
 
 
-def backup_file(file_path: str, backup_directory: str) -> None:
+def backup_file(file_path: str, backup_directory: str, timestamp_as_prefix: bool = False) -> None:
     """
     Backup the specified file.
 
     :param file_path: The file path to backup.
     :param backup_directory: The directory to backup the file to.
-
+    :param timestamp_as_prefix: boolean, if
+        True, then the timestamp will be added as a prefix to the file name.
+        False, then the timestamp will be added as a suffix to the file name.
+    -----------------------------------------
     Example:
-    backup_file(file_path='C:\\Users\\user1\\Downloads\\file.txt', backup_directory='C:\\Users\\user1\\Downloads\\backup')
+    backup_file(
+        file_path='C:\\Users\\user1\\Downloads\\file.txt',
+        backup_directory='C:\\Users\\user1\\Downloads\\backup',
+        timestamp_as_prefix=True
+    )
 
     Backed up file will be moved to 'C:\\Users\\user1\\Downloads\\backup' with timestamp in the name.
     Final path will look like: 'C:\\Users\\user1\\Downloads\\backup\\20231003-120000-000000_file.txt'
+    ---------------------------------------------
+    Example when timestamp_as_prefix is False:
+    backup_file(
+        file_path='C:\\Users\\user1\\Downloads\\file.txt',
+        backup_directory='C:\\Users\\user1\\Downloads\\backup',
+        timestamp_as_prefix=False
+    )
+
+    Backed up file will be moved to 'C:\\Users\\user1\\Downloads\\backup' with timestamp in the name.
+    Final path will look like: 'C:\\Users\\user1\\Downloads\\backup\\file_20231003-120000-000000.txt'
     """
 
     if check_file_existence(file_path):
         timestamp: str = datetimes.TimeFormats().get_current_formatted_time_filename_stamp(True)
         file_name_no_extension = Path(file_path).stem
         file_extension = Path(file_path).suffix
-        backup_file_path: str = str(Path(backup_directory) / f"{file_name_no_extension}_{timestamp}{file_extension}")
+        if timestamp_as_prefix:
+            file_name: str = f"{timestamp}_{file_name_no_extension}{file_extension}"
+        else:
+            file_name: str = f"{file_name_no_extension}_{timestamp}{file_extension}"
+        backup_file_path: str = str(Path(backup_directory) / file_name)
         move_file(file_path, backup_file_path)

atomicshop/monitor/change_monitor.py

@@ -35,7 +35,8 @@ class ChangeMonitor:
             input_file_rotation_cycle_hours: Union[
                 float,
                 Literal['midnight'],
-                None] = None
+                None] = None,
+            enable_statistics_queue: bool = False
     ):
         """
         :param object_type: string, type of object to check. The type must be one of the following:
@@ -81,9 +82,10 @@ class ChangeMonitor:
             'all_objects': disable the DiffChecker features, meaning any new entries will be emitted as is.
             None: will use the default operation type, based on the object type.
         :param input_file_rotation_cycle_hours:
-            float, the amount of hours the input file will be rotated.
+            float, the amount of hours the input file will be rotated in the 'hit_statistics' operation type.
             str, (only 'midnight' is valid), the input file will be rotated daily at midnight.
             This is valid only for the 'hit_statistics' operation type.
+        :param enable_statistics_queue: boolean, if True, the statistics queue will be enabled.
 
         If 'input_file_directory' is not specified, the 'input_file_name' is not specified, and
         'generate_input_file_name' is False, then the input file will not be used and the object will be stored
@@ -127,6 +129,7 @@ class ChangeMonitor:
         self.store_original_object: bool = store_original_object
         self.operation_type = operation_type
         self.input_file_rotation_cycle_hours = input_file_rotation_cycle_hours
+        self.enable_statistics_queue = enable_statistics_queue
 
         # === EOF Initialize Main variables ================================
         # === Initialize Secondary variables ===============================
@@ -141,7 +144,8 @@ class ChangeMonitor:
                     DiffChecker(
                         input_file_write_only=self.input_file_write_only,
                         operation_type=self.operation_type,
-                        input_file_rotation_cycle_hours=self.input_file_rotation_cycle_hours
+                        input_file_rotation_cycle_hours=self.input_file_rotation_cycle_hours,
+                        enable_statistics_queue=self.enable_statistics_queue
                     )
                 )
         # Else, if 'check_object_list' is None, create a DiffChecker object only once.
@@ -150,7 +154,8 @@ class ChangeMonitor:
                 DiffChecker(
                     input_file_write_only=self.input_file_write_only,
                     operation_type=self.operation_type,
-                    input_file_rotation_cycle_hours=self.input_file_rotation_cycle_hours
+                    input_file_rotation_cycle_hours=self.input_file_rotation_cycle_hours,
+                    enable_statistics_queue=self.enable_statistics_queue
                 )
             )
 
@@ -172,6 +177,8 @@ class ChangeMonitor:
         self.fetch_engine = None
         self.thread_looper = scheduling.ThreadLooper()
 
+        self.statistics_queue = None
+
     def _set_input_file_path(self, check_object_index: int = 0):
         if self.first_cycle:
             # If 'input_file_directory' and 'input_file_name' are specified, we'll use a filename to store.

atomicshop/monitor/checks/dns.py

@@ -30,6 +30,11 @@ def _execute_cycle(change_monitor_instance, print_kwargs: dict = None):
         if not change_monitor_instance.operation_type:
             change_monitor_instance.diff_check_list[0].operation_type = 'new_objects'
 
+        # Since the 'operation_type' is 'hit_statistics', we'll set the 'statistics_queue' to the 'statistics_queue' of
+        # the 'diff_check_list[0]'.
+        if change_monitor_instance.diff_check_list[0].operation_type == 'hit_statistics':
+            change_monitor_instance.statistics_queue = change_monitor_instance.diff_check_list[0].statistics_queue
+
         if change_monitor_instance.generate_input_file_name:
             original_name = 'known_domains'
             # Make path for 'input_file_name'.

{atomicshop-2.12.11.dist-info → atomicshop-2.12.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.12.11
+Version: 2.12.13
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.12.11.dist-info → atomicshop-2.12.13.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=FlWupiC5nz7Tolwg5ENxv-hkazzMkviH2VV-21o4tHQ,124
+atomicshop/__init__.py,sha256=IAlzgmgRqFnCgrTcw-XPXKSojTHB6ZNg8wtkPn2glI8,124
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -9,12 +9,12 @@ atomicshop/config_init.py,sha256=z2RXD_mw9nQlAOpuGry1h9QT-2LhNscXgGAktN3dCVQ,249
 atomicshop/console_output.py,sha256=AOSJjrRryE97PAGtgDL03IBtWSi02aNol8noDnW3k6M,4667
 atomicshop/console_user_response.py,sha256=31HIy9QGXa7f-GVR8MzJauQ79E_ZqAeagF3Ks4GGdDU,3234
 atomicshop/datetimes.py,sha256=olsL01S5tkXk4WPzucxujqgLOh198BLgJntDnGYukRU,15533
-atomicshop/diff_check.py,sha256=aa0cJAXc643qLbAnVCnVQUEzf3V0cTsy-y9fwarIdPE,20160
+atomicshop/diff_check.py,sha256=YRe4BKLFhJrOtG56-45VsviR4buxZ2nSykNZGHfH1K4,24248
 atomicshop/dns.py,sha256=bNZOo5jVPzq7OT2qCPukXoK3zb1oOsyaelUwQEyK1SA,2500
 atomicshop/domains.py,sha256=Rxu6JhhMqFZRcoFs69IoEd1PtYca0lMCG6F1AomP7z4,3197
 atomicshop/emails.py,sha256=I0KyODQpIMEsNRi9YWSOL8EUPBiWyon3HRdIuSj3AEU,1410
 atomicshop/file_types.py,sha256=-0jzQMRlmU1AP9DARjk-HJm1tVE22E6ngP2mRblyEjY,763
-atomicshop/filesystem.py,sha256=Gp-Pt13hJkuqMqcaxm-x2uJUcv22Drdaa8QuOCDWbms,52879
+atomicshop/filesystem.py,sha256=202ue2LkjI1KdaxvB_RHV-2eIczy2-caZGLO4PSePik,53887
 atomicshop/functions.py,sha256=pK8hoCE9z61PtWCxQJsda7YAphrLH1wxU5x-1QJP-sY,499
 atomicshop/hashing.py,sha256=Le8qGFyt3_wX-zGTeQShz7L2HL_b6nVv9PnawjglyHo,3474
 atomicshop/http_parse.py,sha256=nrf2rZcprLqtW8HVrV7TCZ1iTBcWRRy-mXIlAOzcaJs,9703
@@ -132,9 +132,9 @@ atomicshop/mitm/engines/__reference_general/parser___reference_general.py,sha256
 atomicshop/mitm/engines/__reference_general/recorder___reference_general.py,sha256=KENDVf9OwXD9gwSh4B1XxACCe7iHYjrvnW1t6F64wdE,695
 atomicshop/mitm/engines/__reference_general/responder___reference_general.py,sha256=1AM49UaFTKA0AHw-k3SV3uH3QbG-o6ux0c-GoWkKNU0,6993
 atomicshop/monitor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/monitor/change_monitor.py,sha256=xLL5iLCAHSpxFqJ8EaYXo49py5k0r3qgZzbfbsgAebA,11801
+atomicshop/monitor/change_monitor.py,sha256=NgadgPynRohII4m5oawWfQXTTj5lUx8gj38Tuk1sWOg,12247
 atomicshop/monitor/checks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/monitor/checks/dns.py,sha256=orp-TgqL6EPzXVm0MtjEceFE8LRfTP3iPR6hGc8Y3TQ,4499
+atomicshop/monitor/checks/dns.py,sha256=QOjvIQZndETomgTuY1PcEbUJkZkRtr6GcRV3Tfbu89c,4866
 atomicshop/monitor/checks/hash.py,sha256=A6bJ7F5Qv_brdEh3sGhOyfviab2dsnvbXUufyBk5C1U,1951
 atomicshop/monitor/checks/network.py,sha256=I9f3KyNnlx97E8igGZXpVJl4MlUp9iU6aSbILCKqbA0,3820
 atomicshop/monitor/checks/process_running.py,sha256=948Sify4P2KFTE1ZrLHKLwd1B1HOgWmC11x3b6MCvz0,1892
@@ -251,8 +251,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=AhpurHJmP2kgzHaUbq5ey
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=aXBwlEIJhFT0-c4i8iNlFx2It9VpCEpsv--5Oqcpxao,11624
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=t3dtDEfN47CfYVi0CW6Kc2QHTEeZVyYhc57IYYh5nmA,826
-atomicshop-2.12.11.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.12.11.dist-info/METADATA,sha256=Pr00IaUDGCKqj4Nx-LPh-zTmnLNVryo2BMX-189flOg,10479
-atomicshop-2.12.11.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.12.11.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.12.11.dist-info/RECORD,,
+atomicshop-2.12.13.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.12.13.dist-info/METADATA,sha256=QiNXQOpYBd9zGkvMzfTeQveN68Bo67-LIMjKVLsS7xE,10479
+atomicshop-2.12.13.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.12.13.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.12.13.dist-info/RECORD,,