ADO Work Item Reference

AB#37336

Summary

This pull request refactors the logging system in the mssql_python package, replacing the previous global logging mechanism with a centralized LoggingManager class. It also introduces a universal logging helper function (log) and a utility to sanitize sensitive information in connection strings. Additionally, it simplifies the codebase by removing redundant logging checks and improving resource management for cursors and connections.

Logging System Refactor:

• Introduced LoggingManager as a singleton class to manage logging configuration, replacing the global ENABLE_LOGGING variable. The class centralizes logging setup and provides backward compatibility for checking if logging is enabled. (mssql_python/logging_config.py, mssql_python/logging_config.pyR11-R52)
• Added a universal log function in helpers.py to streamline logging calls across the codebase. This function dynamically retrieves a logger instance and supports multiple log levels. (mssql_python/helpers.py, mssql_python/helpers.pyR187-R214)

Code Simplification:

• Replaced conditional ENABLE_LOGGING checks with calls to the new log function, simplifying logging logic in connection.py, cursor.py, and exceptions.py. (mssql_python/connection.py, [1]; mssql_python/cursor.py, [2]; mssql_python/exceptions.py, [3]
• Removed redundant logger initialization from several modules, as the log function now handles logger retrieval. (mssql_python/auth.py, [1]; mssql_python/cursor.py, [2]

New Utilities:

• Added sanitize_connection_string in helpers.py to mask sensitive information (e.g., passwords) in connection strings before logging. (mssql_python/helpers.py, mssql_python/helpers.pyR187-R214)

Resource Management Improvements:

• Improved cursor tracking by explicitly adding cursors to a connection's cursor set and ensuring proper cleanup during resource deallocation. (mssql_python/connection.py, mssql_python/connection.pyR186)
• Refactored cursor cleanup logic to avoid unnecessary operations and ensure weak references are handled correctly. (mssql_python/cursor.py, mssql_python/cursor.pyL419-R432)

Minor Enhancements:

• Updated __del__ methods in connection.py and cursor.py to handle exceptions gracefully during cleanup, avoiding issues during garbage collection. (mssql_python/connection.py, [1]; mssql_python/cursor.py, [2]