atomicshop 2.12.9__py3-none-any.whl → 2.12.10__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.9'
+__version__ = '2.12.10'

atomicshop/diff_check.py

@@ -31,7 +31,15 @@ class DiffChecker:
             input_file_path: str = None,
             input_file_write_only: bool = True,
             return_first_cycle: bool = True,
-            operation_type: Literal['new_objects', 'hit_statistics', 'all_objects', 'single_object'] = None
+            operation_type: Literal[
+                'new_objects',
+                'hit_statistics',
+                'all_objects',
+                'single_object'] = None,
+            input_file_rotation_cycle_hours: Union[
+                float,
+                Literal['midnight'],
+                None] = None
     ):
         """
         :param check_object: any, object to check if it changed.
@@ -68,10 +76,16 @@ class DiffChecker:
         :param operation_type: string, type of operation to perform. The type must be one of the following:
             'new_objects': will only store the new objects in the input file.
             'hit_statistics': will only store the statistics of the entries in the input file.
+                The file will be rotated after the specified time in the 'input_file_rotation_cycle' variable, if
+                it is specified.
             'all_objects': disable the DiffChecker features, meaning any new entries will be emitted as is.
             'single_object': will store the object as is, without any comparison. Meaning, that the object will be
                  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.
+            str, (only 'midnight' is valid), the input file will be rotated daily at midnight.
+            This is valid only for the 'hit_statistics' operation type.
 
         --------------------------------------------------
 
@@ -150,6 +164,9 @@ class DiffChecker:
             raise ValueError(f"[operation_type] must be one of the following: "
                              f"'new_objects', 'hit_statistics', 'all_objects', 'single_object'.")
 
+        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.")
+
         self.check_object = check_object
         self.check_object_display_name = check_object_display_name
         self.aggregation: bool = aggregation
@@ -157,6 +174,7 @@ class DiffChecker:
         self.input_file_write_only: bool = input_file_write_only
         self.return_first_cycle: bool = return_first_cycle
         self.operation_type = operation_type
+        self.input_file_rotation_cycle = input_file_rotation_cycle_hours
 
         if not self.check_object_display_name:
             self.check_object_display_name = self.check_object

atomicshop/filesystem.py

@@ -14,7 +14,7 @@ import psutil
 from .print_api import print_api, print_status_of_list
 from .basics import strings, list_of_dicts
 from .file_io import file_io
-from . import hashing
+from . import hashing, datetimes
 
 
 WINDOWS_DIRECTORY_SPECIAL_CHARACTERS = ['<', '>', ':', '"', '/', '\\', '|', '?', '*']
@@ -446,6 +446,26 @@ def move_file(source_file_path: str, target_file_path: str, overwrite: bool = Tr
     shutil.move(source_file_path, target_file_path)
 
 
+def move_folder(source_directory: str, target_directory: str, overwrite: bool = True) -> None:
+    """
+    The function moves folder from source to target.
+
+    :param source_directory: string, full path to source directory.
+    :param target_directory: string, full path to target directory.
+    :param overwrite: boolean, if 'False', then the function will not overwrite the directory if it exists.
+
+    :return: None
+    """
+
+    # Check if 'overwrite' is set to 'True' and if the directory exists.
+    if not overwrite:
+        if check_directory_existence(target_directory):
+            raise FileExistsError(f'Directory already exists: {target_directory}')
+
+    # Move directory.
+    shutil.move(source_directory, target_directory)
+
+
 def move_files_from_folder_to_folder(
         source_directory: str,
         target_directory: str,
@@ -1319,3 +1339,47 @@ def get_download_directory(place: Literal['temp', 'script', 'working'] = 'temp',
         raise ValueError("Invalid place specified.")
 
     return download_directory
+
+
+def backup_folder(directory_path: str, backup_directory: str) -> None:
+    """
+    Backup the specified directory.
+
+    :param directory_path: The directory path to backup.
+    :param backup_directory: The directory to backup the directory to.
+
+    Example:
+    backup_folder(directory_path='C:\\Users\\user1\\Downloads\\folder1', backup_directory='C:\\Users\\user1\\Downloads\\backup')
+
+    Backed up folder 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_folder1'
+    """
+
+    if check_directory_existence(directory_path):
+        timestamp: str = datetimes.TimeFormats().get_current_formatted_time_filename_stamp(True)
+        directory_name = Path(directory_path).name
+        backup_directory_path: str = str(Path(backup_directory) / f"{timestamp}_{directory_name}")
+        create_directory(backup_directory_path)
+        move_folder(directory_path, backup_directory_path)
+
+
+def backup_file(file_path: str, backup_directory: str) -> None:
+    """
+    Backup the specified file.
+
+    :param file_path: The file path to backup.
+    :param backup_directory: The directory to backup the file to.
+
+    Example:
+    backup_file(file_path='C:\\Users\\user1\\Downloads\\file.txt', backup_directory='C:\\Users\\user1\\Downloads\\backup')
+
+    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'
+    """
+
+    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}")
+        move_file(file_path, backup_file_path)

atomicshop/monitor/change_monitor.py

@@ -29,7 +29,13 @@ class ChangeMonitor:
             generate_input_file_name: bool = False,
             input_file_write_only: bool = True,
             store_original_object: bool = False,
-            operation_type: Literal['hit_statistics', 'all_objects'] = None
+            operation_type: Literal[
+                'hit_statistics',
+                'all_objects'] = None,
+            input_file_rotation_cycle_hours: Union[
+                float,
+                Literal['midnight'],
+                None] = None
     ):
         """
         :param object_type: string, type of object to check. The type must be one of the following:
@@ -74,6 +80,10 @@ class ChangeMonitor:
             'hit_statistics': will only store the statistics of the entries in the input file.
             '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.
+            str, (only 'midnight' is valid), the input file will be rotated daily at midnight.
+            This is valid only for the 'hit_statistics' operation type.
 
         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
@@ -99,6 +109,9 @@ class ChangeMonitor:
                 raise ValueError(
                     'ERROR: [operation_type] must be one of the following: "hit_statistics", "all_objects".')
 
+        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.")
+
         # === EOF Exception section ========================================
         # === Initialize Main variables ====================================
 
@@ -113,6 +126,7 @@ class ChangeMonitor:
         self.input_file_write_only: bool = input_file_write_only
         self.store_original_object: bool = store_original_object
         self.operation_type = operation_type
+        self.input_file_rotation_cycle_hours = input_file_rotation_cycle_hours
 
         # === EOF Initialize Main variables ================================
         # === Initialize Secondary variables ===============================
@@ -126,7 +140,8 @@ class ChangeMonitor:
                 self.diff_check_list.append(
                     DiffChecker(
                         input_file_write_only=self.input_file_write_only,
-                        operation_type=self.operation_type
+                        operation_type=self.operation_type,
+                        input_file_rotation_cycle_hours=self.input_file_rotation_cycle_hours
                     )
                 )
         # Else, if 'check_object_list' is None, create a DiffChecker object only once.
@@ -134,7 +149,8 @@ class ChangeMonitor:
             self.diff_check_list.append(
                 DiffChecker(
                     input_file_write_only=self.input_file_write_only,
-                    operation_type=self.operation_type
+                    operation_type=self.operation_type,
+                    input_file_rotation_cycle_hours=self.input_file_rotation_cycle_hours
                 )
             )
 

{atomicshop-2.12.9.dist-info → atomicshop-2.12.10.dist-info}/METADATA

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

{atomicshop-2.12.9.dist-info → atomicshop-2.12.10.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=-vfpVbmmEp5MJjeiy8KXfc5AiYWei228hKs92EJDabk,123
+atomicshop/__init__.py,sha256=7Vx_nxgUsmh8XnHp545Je0VoGYtduvu1AXK5YqXnoYc,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=U7eshTajImlsL6aB0O2yiRsGCQCwumiCvGoFcJ2iAfs,19226
+atomicshop/diff_check.py,sha256=aa0cJAXc643qLbAnVCnVQUEzf3V0cTsy-y9fwarIdPE,20160
 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=JVWoOSkm-lfh11nBMlrP0w_YnrTFnJ5noYLtoN5Nf5o,48809
+atomicshop/filesystem.py,sha256=3LfLBXRwvdeK_qIBhIyGrDBO5l4OMpQ7Nev24yUfg0U,51606
 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,7 +132,7 @@ 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=5LNBcVodxeZMXsDvhzdhb67ipUau__Kh6v6Znj9QjyY,10858
+atomicshop/monitor/change_monitor.py,sha256=xLL5iLCAHSpxFqJ8EaYXo49py5k0r3qgZzbfbsgAebA,11801
 atomicshop/monitor/checks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/monitor/checks/dns.py,sha256=orp-TgqL6EPzXVm0MtjEceFE8LRfTP3iPR6hGc8Y3TQ,4499
 atomicshop/monitor/checks/hash.py,sha256=A6bJ7F5Qv_brdEh3sGhOyfviab2dsnvbXUufyBk5C1U,1951
@@ -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.9.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.12.9.dist-info/METADATA,sha256=p5kxZx91i1n0Os02yyC3ce6mvSZARM6G-jl2qFh8e_0,10478
-atomicshop-2.12.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.12.9.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.12.9.dist-info/RECORD,,
+atomicshop-2.12.10.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.12.10.dist-info/METADATA,sha256=qeP1u3Xf--S_WBIEm2cilMZUhmBdQZMWS-COhqHhmKE,10479
+atomicshop-2.12.10.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.12.10.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.12.10.dist-info/RECORD,,