v0.10.2
- Consistent exception formatting in logs (#237). The logger's exception formatting has been enhanced to provide a consistent and readable log format, adhering to standard Python norms. When an exception occurs, the log message now ensures a newline character separates the error message from the exception details, regardless of whether logs are colorized or not. This update applies to both exception text and stack information, which are now prepended with a newline character if necessary, resulting in a uniform format for all log types. This change resolves previous inconsistencies between colorized and non-colorized logs, aligning the logging functionality with standard Python practices for exception logging, and improving overall log readability.
- Ensure that App logger emits
DEBUGevents if the CLI is invoked with--debug(#238). Theget_loggerfunction has been enhanced to provide more flexibility and consistency with standard logging practices. It now accepts an optionalmanagerparameter, allowing for customization of the logging manager, and returns alogging.Loggerobject. The logger level is automatically set toDEBUGwhen the application is running in debug mode, as detected by theis_in_debugfunction, and the level is set using thelogging.DEBUGconstant for consistency. This change simplifies the code and ensures that the logger emitsDEBUGevents when the application is run with the debug flag, which is verified through an updated test suite that covers various scenarios, including logger name setting, debug mode behavior, and logger propagation. - Ensure the names of logger levels are consistent (#234). The logger has been updated to use consistent naming conventions for logging levels, aligning with the Python ecosystem's norms. Previously, colorized logs used compact names
WARNandFATALfor warning and critical levels, while non-colorized logs used the conventionalWARNINGandCRITICALnames. To address this inconsistency, two new dictionaries have been introduced to store colorized level names and color codes, and theformatmethod has been modified to utilize these dictionaries, ensuring consistent logging level names and colorized message text. As a result, logging level names have been updated to use the conventionalWARNINGandCRITICALinstead ofWARNand "FATAL", and color codes for message text have been added for each logging level, promoting consistency and adherence to Python logging conventions. - Ensure the non-colorized logs also include timestamps with second-lev… (#235). The log formatter has been updated to include second-granular timestamps in non-colorized logs, providing more precise logging information and ensuring consistency with colorized output. Previously, only minute-granular timestamps were logged, which was insufficient for logging purposes. The update changes the timestamp format from
%H:%Mto%H:%M:%Sto include seconds, resulting in more detailed timestamp information. This change resolves the inconsistency between colorized and non-colorized logs, and is verified by updated tests that validate the formatter's behavior with and without colors, confirming that the formatter now correctly starts with a timestamp in both cases. - Fixed Blueprint Install (#225). The
__version__variable import statement has been updated to utilize a fully qualified module name, providing a more explicit and absolute reference to the module containing version information. This change ensures that the correct version is imported and used to set the user agent extra in relevant function calls, enhancing the reliability and accuracy of version tracking within the library. - Fixed argument interpolation in colorised logs (#233). The colorised log formatter has been enhanced to correctly handle log entries containing
%-style placeholders with arguments, a common pattern in third-party code, by retrieving the log message usingrecord.getMessage()instead of directly accessingrecord.msg. This update resolves an issue with improper formatting of logging from third-party components and builds upon previous changes to address the underlying logging problem. Additionally, the corresponding test case has been updated to verify that the formatter correctly handles messages with arguments that require interpolation, both with and without colors enabled, and is no longer expected to fail, indicating that the issue with argument interpolation in the colorized log formatter has been resolved. - Fixed logger name abbreviation fails if the logger name contains
..(#236). The logger's format method has been enhanced to correctly abbreviate logger names containing multiple consecutive dots, which previously led to exceptions. The new logic splits the logger name into components, abbreviating all but the last two, and then reassembles them, ensuring correct abbreviation and formatting even when consecutive dots are present. This improvement also fixes the colorized logger output to handle logger names with consecutive dots without throwing an exception, and the corresponding test case has been updated to reflect this change, now directly testing the logging functionality by formatting the log record and stripping ANSI escape sequences, providing a more straightforward verification of the logging functionality.
Contributors: @asnare, @sundarshankar89