Developing Logging Feature for 'BinLogStreamReader' Object Creation Parameters

pymysqlreplication/binlogstream.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 import struct
+import logging
 from distutils.version import LooseVersion
 
 import pymysql
@@ -142,7 +143,8 @@ def __init__(self, connection_settings, server_id,
                  slave_heartbeat=None,
                  is_mariadb=False,
                  annotate_rows_event=False,
-                 ignore_decode_errors=False):
+                 ignore_decode_errors=False,
+                 parma_logging=True, ):
         """
         Attributes:
             ctl_connection_settings: Connection settings for cluster holding
@@ -224,6 +226,8 @@ def __init__(self, connection_settings, server_id,
         self.skip_to_timestamp = skip_to_timestamp
         self.is_mariadb = is_mariadb
         self.__annotate_rows_event = annotate_rows_event
+        if parma_logging:
+            self.__log_valid_parameters()
 
         if end_log_pos:
             self.is_past_end_log_pos = False
@@ -363,9 +367,11 @@ def __connect_to_stream(self):
 
                 if not self.__blocking:
                     flags |= 0x01  # BINLOG_DUMP_NON_BLOCK
+
                 prelude += struct.pack('<H', flags)
 
                 prelude += struct.pack('<I', self.__server_id)
+
                 prelude += self.log_file.encode()
         else:
             if self.is_mariadb:
@@ -604,6 +610,7 @@ def _allowed_event_list(self, only_events, ignored_events,
         if only_events is not None:
             events = set(only_events)
         else:
+            a = QueryEvent
             events = set((
                 QueryEvent,
                 RotateEvent,
@@ -667,5 +674,22 @@ def __get_table_information(self, schema, table):
                 else:
                     raise error
 
+    def __log_valid_parameters(self):
+        ignore_list = ["allowed_events_in_packet", "table_map"]
+        for parameter, value in self.__dict__.items():
+            if not value:
+                continue
+            if parameter.startswith("_BinLogStreamReader__"):
+                parameter = parameter.replace("_BinLogStreamReader__", "")
+            if type(value) == bool or type(value) == int:
+                comment = f"{parameter} is {value}"
+            elif type(value) == frozenset:
+                string_list = [str(item).split()[-1][:-2].split('.')[2] for item in value]
+                items = ", ".join(string_list)
+                comment = f"{parameter}: [{items}]"
+            else:
+                comment = "Set parameter - {}, value - {}".format(parameter, value)
+            logging.info(comment)
+
     def __iter__(self):
         return iter(self.fetchone, None)