Skip to content

Latest commit

 

History

History
50 lines (25 loc) · 3.23 KB

CHANGES.md

File metadata and controls

50 lines (25 loc) · 3.23 KB
Raw

Change log for Sidetrack

Version 2.0.1

This version adds a backward compatibility function logr that is identical to log.

Version 2.0.0

This introduces backwards-incompatible changes to the API, and one new function.

In recognition that modern Python code more often uses f-strings, the function logr is now log, and what was previously log is now called logf. Users who called the log function with single strings will not notice any difference; users who called it with more than one argument (a string and format arguments) will get an error; and users who called logr will also get an error, about an undefined function. The new set of log functions is more logically organized:

  • log takes a single argument, a string. It does not apply format to the string.
  • loglist is like log, except it accepts multiple strings. It prints them one line at time.
  • logf takes a single string as the first argument and optionally multiple arguments after that. It passes the optional arguments to format.

Version 1.4.0

This version adds a new option to set_debug(...): the flag show_package, which will cause Sidetrack to prefix messages with the name of the Python package containing the source file from where the log function was called. This flag is useful if you use Sidetrack in multiple packages, or import packages that also use Sidetrack.

Version 1.3.0

This version changes the logging level used by Sidetrack. The level is now set to the value of logging.DEBUG + 1 (that is, the numeric value 11). This solves a problem caused by Python packages that turn off DEBUG-level logging at import time: previously, if such a package was imported after Sidetrack was loaded, it would end up disabling Sidetrack as a side-effect. This should no longer happen. (As a result, we can now legitimately say that Sidetrack goes to 11.)

Version 1.2.0

This version brings no changes to the API, but does remove a dependency on setuptools, and brings internal changes that solve problems in using Sidetrack inside binaries produced by PyInstaller. The internal changes remove a clever but problematic scheme for retrieving package metadata, and replaces it with a more conventional approach (storing version info directly into __init__.py) with accompanying automation in the Makefile to make it all work. Beneficial side-effect: the import sidetrack statement should run faster now.

Version 1.1.0

  • set_debug(...) now takes a different optional argument, extra, that can be used to add text to every debug output line. The text can contain Python logging package % format codes. The previous argument, show_thread, has been removed; extra is more general and can be used to achive the same ends.
  • Allow the destination parameter for set_debug(...) to be a stream, not just '-' or a file.
  • Fix documentation to explain that the default output is sys.stderr, not sys.stdout.
  • Additional documentation fixes and edits.

Version 1.0.1

  • Minor edits to the README file for grammar and clarity.
  • Improve Makefile automation for creating releases.

Version 1.0.0

First fully usable version, for testing.