atomicshop 2.12.20__py3-none-any.whl → 2.12.21__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.20'
+__version__ = '2.12.21'

atomicshop/mitm/initialize_mitm_server.py

@@ -16,26 +16,13 @@ from ..wrappers.loggingw import loggingw
 from ..print_api import print_api
 
 
+STATISTICS_HEADER: str = \
+    'request_time_sent,host,path,command,status_code,request_size_bytes,response_size_bytes,file_path,process_cmd,error'
+
+
 def initialize_mitm_server(config_static):
     # Main function should return integer with error code, 0 is successful.
     # Since listening server is infinite, this will not be reached.
-    def output_statistics_csv_header():
-        # Since there is no implementation of header in logging file handler modules, we'll do it manually each time.
-        statistics_header: list = ['request_time_sent',
-                                   'host',
-                                   'path',
-                                   'command',
-                                   'status_code',
-                                   'request_size_bytes',
-                                   'response_size_bytes',
-                                   # 'request_hex',
-                                   # 'response_hex',
-                                   'file_path',
-                                   'process_cmd',
-                                   'error'
-                                   ]
-        statistics_logger.info(','.join(statistics_header))
-
     # After modules import - we check for python version.
     check_python_version_compliance(minimum_version='3.11')
 
@@ -190,9 +177,8 @@ def initialize_mitm_server(config_static):
     # Creating Statistics logger.
     statistics_logger = loggingw.get_logger_with_stream_handler_and_timedfilehandler(
         logger_name="statistics", directory_path=config['log']['logs_path'],
-        file_extension=config_static.CSV_EXTENSION, formatter_message_only=True
+        file_extension=config_static.CSV_EXTENSION, formatter_message_only=True, header=STATISTICS_HEADER
     )
-    output_statistics_csv_header()
 
     network_logger_name = "network"
     network_logger = loggingw.get_logger_with_stream_handler_and_timedfilehandler(

atomicshop/wrappers/loggingw/handlers.py

@@ -1,6 +1,34 @@
 import logging
 from logging.handlers import TimedRotatingFileHandler, QueueListener, QueueHandler
 import re
+import os
+
+
+class TimedRotatingFileHandlerWithHeader(TimedRotatingFileHandler):
+    """
+    Custom TimedRotatingFileHandler that writes a header to the log file each time there is a file rotation.
+    Useful for writing CSV files.
+
+    :param header: string, Header to write to the log file.
+        Example: "time,host,error"
+    """
+    def __init__(self, *args, **kwargs):
+        self.header = kwargs.pop('header', None)
+        super().__init__(*args, **kwargs)
+
+    def doRollover(self):
+        super().doRollover()
+        self._write_header()
+
+    def _write_header(self):
+        if self.header:
+            with open(self.baseFilename, 'a') as f:
+                f.write(self.header + '\n')
+
+    def emit(self, record):
+        if not os.path.exists(self.baseFilename) or os.path.getsize(self.baseFilename) == 0:
+            self._write_header()
+        super().emit(record)
 
 
 def get_stream_handler() -> logging.StreamHandler:
@@ -38,6 +66,28 @@ def get_timed_rotating_file_handler(
         filename=log_file_path, when=when, interval=interval, delay=delay, encoding=encoding)
 
 
+def get_timed_rotating_file_handler_with_header(
+        log_file_path: str, when: str = "midnight", interval: int = 1, delay: bool = False, encoding=None,
+        header: str = None) -> TimedRotatingFileHandlerWithHeader:
+    """
+    Function to get a TimedRotatingFileHandler with header.
+    This handler will output messages to a file, rotating the log file at certain timed intervals.
+    It will write a header to the log file each time there is a file rotation.
+
+    :param log_file_path: Path to the log file.
+    :param when: When to rotate the log file. Possible
+    :param interval: Interval to rotate the log file.
+    :param delay: bool, If set to True, the log file will be created only if there's something to write.
+    :param encoding: Encoding to use for the log file. Same as for the TimeRotatingFileHandler, which uses Default None.
+    :param header: Header to write to the log file.
+        Example: "time,host,error"
+    :return: TimedRotatingFileHandlerWithHeader.
+    """
+
+    return TimedRotatingFileHandlerWithHeader(
+        filename=log_file_path, when=when, interval=interval, delay=delay, encoding=encoding, header=header)
+
+
 def start_queue_listener_for_file_handler(
         file_handler: logging.FileHandler, queue_object) -> logging.handlers.QueueListener:
     """
@@ -133,3 +183,22 @@ def change_rotated_filename(file_handler: logging.Handler, file_extension: str):
     file_handler.suffix = logfile_suffix
     file_handler.namer = lambda name: name.replace(file_extension + ".", "") + file_extension
     file_handler.extMatch = logfile_regex_suffix
+
+
+def has_handlers(logger: logging.Logger) -> bool:
+    """
+    Function to check if the logger has handlers.
+    :param logger: Logger to check
+    :return: True if logger has handlers, False otherwise
+    """
+
+    # Omitted the usage of "hasHandlers()" method, since sometimes returned "True" even when there were no handlers
+    # Didn't research the issue much, just used the "len(logger.handlers)" to check how many handlers there are
+    # in the logger.
+    # if not logging.getLogger(function_module_name).hasHandlers():
+    # if len(logging.getLogger(function_module_name).handlers) == 0:
+
+    if len(logger.handlers) == 0:
+        return False
+    else:
+        return True

atomicshop/wrappers/loggingw/loggingw.py

@@ -78,7 +78,8 @@ def get_logger_with_stream_handler_and_timedfilehandler(
         when: str = "midnight",
         interval: int = 1,
         delay: bool = True,
-        encoding=None
+        encoding=None,
+        header: str = None
 ) -> logging.Logger:
     """
     Function to get a logger and add StreamHandler and TimedRotatingFileHandler to it.
@@ -116,6 +117,8 @@ def get_logger_with_stream_handler_and_timedfilehandler(
         If 'when="midnight"' and 'interval=2', then the log file will be rotated every 2nd midnights.
     :param delay: bool, If set to True, the log file will be created only if there's something to write.
     :param encoding: string, Encoding to use for the log file. Default is None.
+    :param header: string, Header to write to the log file.
+        Example: "time,host,error"
 
     :return: Logger.
 
@@ -126,25 +129,14 @@ def get_logger_with_stream_handler_and_timedfilehandler(
 
 
     def main():
-        def output_csv_header():
-            # Since there is no implementation of header in logging file handler modules, we'll do it manually each time.
-            header: list = ['time',
-                           'host',
-                           'path',
-                           'error'
-                           ]
-            error_logger.info(','.join(header))
-
-
+        header: str = "time,host,error"
         output_directory: str = "D:\\logs"
 
         error_logger = loggingw.get_logger_with_stream_handler_and_timedfilehandler(
             logger_name="errors", directory_path=output_directory,
-            file_extension=".csv", formatter_message_only=True
+            file_extension=".csv", formatter_message_only=True, header=header
         )
 
-        output_csv_header()
-
         error_logger.info(f"{datetime.now()},host1,/path/to/file,error message")
 
 
@@ -155,7 +147,7 @@ def get_logger_with_stream_handler_and_timedfilehandler(
     add_stream_handler(logger, logging_level, formatter_streamhandler, formatter_message_only)
     add_timedfilehandler_with_queuehandler(
         logger, directory_path, file_name, file_extension, logging_level, formatter_filehandler,
-        formatter_message_only, disable_duplicate_ms, when, interval, delay, encoding
+        formatter_message_only, disable_duplicate_ms, when, interval, delay, encoding, header
     )
 
     return logger
@@ -201,10 +193,20 @@ def add_stream_handler(
 
 
 def add_timedfilehandler_with_queuehandler(
-        logger: logging.Logger, directory_path, file_name_no_extension: str = None, file_extension: str = '.txt',
+        logger: logging.Logger,
+        directory_path: str,
+        file_name_no_extension: str = None,
+        file_extension: str = '.txt',
         logging_level="DEBUG",
-        formatter='default', formatter_message_only: bool = False, disable_duplicate_ms: bool = False,
-        when: str = 'midnight', interval: int = 1, delay: bool = True, encoding=None):
+        formatter='default',
+        formatter_message_only: bool = False,
+        disable_duplicate_ms: bool = False,
+        when: str = 'midnight',
+        interval: int = 1,
+        delay: bool = True,
+        encoding=None,
+        header: str = None
+):
     """
     Function to add TimedRotatingFileHandler and QueueHandler to logger.
     TimedRotatingFileHandler will output messages to the file through QueueHandler.
@@ -238,6 +240,8 @@ def add_timedfilehandler_with_queuehandler(
         If 'when="midnight"' and 'interval=2', then the log file will be rotated every 2nd midnights.
     :param delay: bool, If set to True, the log file will be created only if there's something to write.
     :param encoding: string, Encoding to use for the log file. Default is None.
+    :param header: string, Header to write to the log file.
+        Example: "time,host,error"
     """
 
     # If file name wasn't provided we will use the logger name instead.
@@ -254,8 +258,17 @@ def add_timedfilehandler_with_queuehandler(
 
     # Creating file handler with log filename. At this stage the log file is created and locked by the handler,
     # Unless we use "delay=True" to tell the class to write the file only if there's something to write.
-    file_handler = handlers.get_timed_rotating_file_handler(
-        log_file_path, when=when, interval=interval, delay=delay, encoding=encoding)
+
+    if file_extension == ".csv":
+        # If file extension is CSV, we'll set the header to the file.
+        # This is needed since the CSV file will be rotated, and we'll need to set the header each time.
+        # We'll use the custom TimedRotatingFileHandlerWithHeader class.
+        file_handler = handlers.get_timed_rotating_file_handler_with_header(
+            log_file_path, when=when, interval=interval, delay=delay, encoding=encoding, header=header)
+    else:
+        file_handler = handlers.get_timed_rotating_file_handler(
+            log_file_path, when=when, interval=interval, delay=delay, encoding=encoding)
+
     loggers.set_logging_level(file_handler, logging_level)
 
     if formatter == "default":

atomicshop/wrappers/loggingw/reading.py

@@ -236,16 +236,25 @@ def get_latest_lines(
     return: List of new lines.
 
     Usage:
+        from typing import Union
+
+
+        # The header of the log file will be read from the first iteration of the log file.
+        # When the file is rotated, this header will be used to not read the header again.
+        header: Union[list, None] = None
         while True:
-            latest_lines, current_lines, existing_lines, last_24_hours_lines = get_latest_log_lines(
+            latest_lines, previous_day_24h_lines, header = reading.get_latest_lines(
                 log_file_path='/path/to/log.csv',
-                log_type='csv'
+                log_type='csv',
+                date_pattern='%Y_%m_%d',
+                get_previous_file=True,
+                header=header
             )
 
             if latest_lines:
                 # Do something with the new lines.
 
-            if last_24_hours_lines:
+            if previous_day_24h_lines:
                 # Do something with the last 24 hours lines. Reminder, this will happen once a day on log rotation.
 
             time.sleep(1)

{atomicshop-2.12.20.dist-info → atomicshop-2.12.21.dist-info}/METADATA

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

{atomicshop-2.12.20.dist-info → atomicshop-2.12.21.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=U5HBBCgZbCFjvJTS1UanW_wKk5yZesdp5sAnQ2RGDSg,124
+atomicshop/__init__.py,sha256=LSUgsf6XY377_4Z2xaHNOnKX7HYoq7IlSOu4OJMwzf0,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
@@ -116,7 +116,7 @@ atomicshop/mitm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/connection_thread_worker.py,sha256=PQ8bwOgrPudYP5oPnSi_DWaKXOi038M8TMImlLkxuPI,20486
 atomicshop/mitm/import_config.py,sha256=_V-IVJ7a1L6E-VOR4CDfZj-S1odbsIlBe13ij0NlpqY,7974
 atomicshop/mitm/initialize_engines.py,sha256=UGdT5DKYNri3MNOxESP7oeSxYiUDrVilJ4jic_nwdew,8055
-atomicshop/mitm/initialize_mitm_server.py,sha256=aXNZlRu1_RGjC7lagvs2Q8rjQiygxYucy-U4C_SBnsk,13871
+atomicshop/mitm/initialize_mitm_server.py,sha256=5JGkyvAvz1sJVeRGMJWSQiQ-VOdrU-NJn633oxQe0cw,13143
 atomicshop/mitm/message.py,sha256=u2U2f2SOHdBNU-6r1Ik2W14ai2EOwxUV4wVfGZA098k,1732
 atomicshop/mitm/shared_functions.py,sha256=PaK_sbnEA5zo9k2ktEOKLmvo-6wRUunxzSNRr41uXIQ,1924
 atomicshop/mitm/statistic_analyzer.py,sha256=WvTal-Aox-enM-5jYtFqiTplNquS4VMnmQYNEIXvZZA,23552
@@ -214,12 +214,11 @@ atomicshop/wrappers/factw/rest/statistics.py,sha256=vznwzKP1gEF7uXz3HsuV66BU9wrp
 atomicshop/wrappers/factw/rest/status.py,sha256=4O3xS1poafwyUiLDkhyx4oMMe4PBwABuRPpOMnMKgIU,641
 atomicshop/wrappers/fibratusw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/fibratusw/install.py,sha256=PLVymDe0HuOvU0r2lje8BkQAgtiOWEeRO7n-1zKuL7A,3287
-atomicshop/wrappers/loggingw/checks.py,sha256=AGFsTsLxHQd1yAraa5popqLaGO9VM0KpcPGuSLn5ptU,719
 atomicshop/wrappers/loggingw/formatters.py,sha256=mUtcJJfmhLNrwUVYShXTmdu40dBaJu4TS8FiuTXI7ys,7189
-atomicshop/wrappers/loggingw/handlers.py,sha256=qm5Fbu8eDmlstMduUe5nKUlJU5IazFkSnQizz8Qt2os,5479
+atomicshop/wrappers/loggingw/handlers.py,sha256=2A_3Qy1B0RvVWZmQocAB6CmpqlXoKJ-yi6iBWG2jNLo,8274
 atomicshop/wrappers/loggingw/loggers.py,sha256=DHOOTAtqkwn1xgvLHSkOiBm6yFGNuQy1kvbhG-TDog8,2374
-atomicshop/wrappers/loggingw/loggingw.py,sha256=TJBT8n9wCcAgrnjvT3sz3OvRqJ0A3Q5GtYt7ZncvVv4,16146
-atomicshop/wrappers/loggingw/reading.py,sha256=CtYOwOLFHj_hqYyZx-dKUo5ZDrn3cO-f7vU4EX515xI,14980
+atomicshop/wrappers/loggingw/loggingw.py,sha256=m6YySEedP3_4Ik1S_uGMxETSbmRkmMYmAZxhHBlXSlo,16616
+atomicshop/wrappers/loggingw/reading.py,sha256=OgKDuYV8KD3brXD82_UIQLPGL6qUeFINcFOYxVIi8Q8,15347
 atomicshop/wrappers/nodejsw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/nodejsw/install_nodejs.py,sha256=QZg-R2iTQt7kFb8wNtnTmwraSGwvUs34JIasdbNa7ZU,5154
 atomicshop/wrappers/playwrightw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -255,8 +254,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.20.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.12.20.dist-info/METADATA,sha256=tpZ7mC5c8cpsmgMGGFRrXl5NUsNi8yfGpcMhH8HEYFY,10479
-atomicshop-2.12.20.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.12.20.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.12.20.dist-info/RECORD,,
+atomicshop-2.12.21.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.12.21.dist-info/METADATA,sha256=iWSjLaN-XwW8NsBxqu8wdQPgrJZZv1EaZ7-x4e_Tglo,10479
+atomicshop-2.12.21.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.12.21.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.12.21.dist-info/RECORD,,

atomicshop/wrappers/loggingw/checks.py

@@ -1,20 +0,0 @@
-import logging
-
-
-def has_handlers(logger: logging.Logger) -> bool:
-    """
-    Function to check if the logger has handlers.
-    :param logger: Logger to check
-    :return: True if logger has handlers, False otherwise
-    """
-
-    # Omitted the usage of "hasHandlers()" method, since sometimes returned "True" even when there were no handlers
-    # Didn't research the issue much, just used the "len(logger.handlers)" to check how many handlers there are
-    # in the logger.
-    # if not logging.getLogger(function_module_name).hasHandlers():
-    # if len(logging.getLogger(function_module_name).handlers) == 0:
-
-    if len(logger.handlers) == 0:
-        return False
-    else:
-        return True