enlighten

Bug Fixes

• Resize handler crashes when window height is reduced and manager has no counters #64

Changes

• Resize handler now does line feeds when height is increased when not threaded
  • Previously only did when threaded
• A warning is raised when closing a previously closed counter
  • Previously raised a non-specific error in some conditions
  • If the counter would normally be refreshed before closing, it will only refresh if still attached to manager, i.e. leave=True

Housekeeping

• Pin Pip version in Tox to support older Python versions

Housekeeping

• Fix API links in Read The Docs

Housekeeping

• Add readthedocs.yaml
  • New requirement

Bug Fixes

• Minor doc fixes
  • Improved context manager example
  • Remove unexpected reference to enlighten.counter in example
    • Thanks to @raffaem for reporting #63

Changes

• Improved colors in multiprocessing example
• Added error handling to multiprocessing example

Bugfixes

• Elapsed time continued to increment after counter was closed #62
  • Elapsed time is now pinned to last time count changed if counter is stopped or count matches total
  • Thanks to @bedaberner for reporting
• Seconds occasionally rounded up to 00:60 vs 01:00
  • Thanks to @DJtheRedstoner for reporting and PR #61

Changes

• Counter positions are now recalculated when a counter is removed
  • Thanks to @SKnight79 for reporting #58
• Color resolution is now cached
  • Thanks to @Dauriel for inspiration #56
• Direct use of Counter class now redirects to Manager.counter()
  • This allows the behavior to be consistant
  • Thanks to @ngriffiths13 for inspiration
• Direct use of Counter class removed from documentation
  • Direct use of Counter class be refactored or removed in version 2.0
• Counters and status bars can now be coerced to strings
  • Output is same as Counter.format() with default values
  • Does not apply to subcounters
• Python 3.12 support added to metadata
• Dropped support for Python 3.4
  • No code changes, but metadata and tests removed

Housekeeping

• Minor code tweaks
• Minor test cleanup
• Demo gif updated
• Specialist Tox environment added
• Basic ASV benchmark script added

Bugfixes

• NotebookManager raised exception if there were no counters when stop() was called #53

Changes

• Python 3.11 support added to metadata

Housekeeping

• Update tests for Prefixed 0.6.0
  • '!' flag now adds space after number even if there is no prefix added
• Make Python 3.11 the base version for tests

Bugfixes

• Wrong stream referenced in tests
• Multiple bug fixes for utility classes used by NotebookManager
  • HTMLConverter: Don't test blink if not listed as supported on platform
  • HTMLConverter: Did not handle when term.normal was a single termcap
  • HTMLConverter: Friendly color names depended on the platform
    • Now friendly color names are always used for class names when available
  • HTMLConverter: Tests attempted to use a different term kind than other tests
  • Lookahead raised exception when iterator was empty

Changes

• HTMLConverter: Termcap parsing is now cached to improve performance for multiple lookups.

Changes

• Default to sys.__stdout__ instead of sys.stdout
  • For most this will be a no-op change since sys.stdout, by default, references sys.__stdout__
  • Should increase compatibility on platforms where stdout has been redirected such as #49

Housekeeping

• Code tweaks and linting fixes

Changes

• Curly braces in field names no longer have to be escaped #45

Bugfixes

• Bytecode for examples and tests no longer included in sdist
• companion_stream tests did not provide coverage in some test environments
• TestManager.test_autorefresh failed on macOS #44

Housekeeping

• Switched to GitHub Actions for testing
• Fixes for Pylint changes

Bugfixes

• Jupyter output order reversed
• Special characters in Jupyter output not escaped
• Demo example imports break depending on how it's called
• Whitespace missing on PyPI readme

New Features

• [Experimental] Support for Jupyter Notebooks
• width keyword can be applied to manager classes to statically specify width

New Features

• Human-readable numeric prefixes #29
  • Allows automatic conversion of SI (metric) and IEC (binary) unit prefixes
• Improved exemption messages for unavailable reserve fields
• rate_0, rate_00, interval_0, and interval_00 added as formatting fields

Changes

• New dependency: Prefixed
• all_fields can now be specified as a keyword argument to Counter to set the default value for subcounters

Housekeeping

• Minor refactoring and optimizations
• Demo updated
• Added Conda badge and instructions

New Features

• Manager.counter() and Manager.status_bar() now have a replace keyword argument

  • replace value must be an existing managed counter or status bar
  • New counter will assume the position of the counter it replaces
  • Old counter will be closed and removed
  • Equivalent to setting leave=False and running counter.close before adding a new counter

• percentage_00 and count_00 added as bar_format formatting fields (#42)

  • Sum of percentages and counts for all subcounters
  • Inverse of percentage_0 and count_0

Changes

• position for Manager.counter() and Manager.status_bar() must be >= 1
  • This was assumed before, but not enforced

Bugfixes

• Improved behavior of multicolored bars to avoid partial bars when count is 0 (#41)

Housekeeping

• Fixed typos
• Minor refactoring

Changes

• Manager() argument, threaded, now defaults to True when multiple processes are detected
• Evaluation of Manager() argument, threaded, now deferred until scroll area is set when not set explicitly
• Added FAQ question about reentrant calls

Housekeeping

• blessed.Terminal subclass removed
• Removed assert statements from code

Bugfixes

• Improved write atomicity [ Issue #36 ]
  • Improved behavior when multiple processes are writing to the terminal

New Features

• Added interval, the inverse of rate as a built-in formatting field. [ Issue #34 ]
• Added new Manager() argument, threaded, which forces threading behavior when True
  • Defaults to True when multiple threads are detected

Changes

• Deferred resize handing introduced in 1.6.2 is now only performed if threaded is True (default when multiple threads are detected)

Bugfixes

• Improved resize handing [ Issue #33 ]

Housekeeping

• Add 3.9 support to package metadata
• Minor optimizations

Changes

• Output will now be resized on the first write after a resize is detected
  • This addresses an issue that can cause threaded programs to crash #28
• Default Unicode are now used when running under Windows Terminal
  • Other windows terminals, like CMD, will still default to cp65001 compatible characters

Bug fixes'

• Additional stream flushes added to ensure incidental flush aren't relied upon #21
• Updated RPM installation instructions

Changes

• Warning is now emitted when a reserved field is passed as a user-defined field
• Drop Python 2.6 support
• Begin testing 3.10-dev

Bug fixes

• Preserve max scroll offset when number of status bars decrease (#27)
• Minor doc fixes

New Features

• Status bars can now be created with Manager.status_bar()
• Bars can now be invoked with autorefresh=True to trigger a refresh whenever another bar is updated or refreshed
• fill can now be used multiple times in counters and status bars
  • Remaining space is divided equally
• Fill character can now be specified for counters, with fill keyword
• Compound colors, like 'aqua_on_seagreen' are now supported
• Additional keywords passed to Counter() and Counter.update() are now used as user-defined fields

Changes

• Counter.last_update is now updated when Counter.refresh() is called
• Counter.last_update is now reset when Counter.clear() is called

Bug fixes

• Position pinning now works as expected

Bug Fixes:

• Ensure scroll reset does not exceed screen height #19

Housekeeping:

• Updated documentation to provide colored text examples

Bug Fixes:

• Fix Read The Docs references that point to latest
• Support counter tests in non-Unicode environments
• Account for unsupported encoding value when determining default series

New Features:

• Support for RGB and X11 colors
• New parameter for Counter(): additional_fields
  • User-defined fields available for counter formatting
• New multiprocessing example
• Subcounter fields count_n and rate_n are now available in counter-only format
• New repr output

Bug Fixes:

• Fallback series for non-unicode encoding #13
• Workaround implemented for Python 3.9 Issue 39966

Changes:

• Drop EL6-specific testing
  • Python 2.6 automated testing is still enabled, but failures are non-blocking
• Specifying color by index is now deprecated
• Minimum supported version of Blessed is 1.17.2

Housekeeping:

• Added Python 3.9-dev testing

New Features:

• Escape sequences automatically detected when determining bar width When offset is set, this functionality is disabled

Changes:

• Flush streams on program exit Prevents escape processing from being disabled on Windows before all data with written to the terminal
• Use Blessed for Windows support Windows support in Enlighten has been merged into Blessed

Housekeeping:

• Update FAQ
• Cleanup Examples
• Unicode cleanup (Python 2.7)
• Add tests and metadata for Python 3.8 Final

• Catch additional exception for invalid filehandle when checking terminal size in WIndows

• Provide fallback for Windows terminal size (80x25)

• Bugfix: Account for stream without encoding attribute
• Add PEP 508 dependency logic
• Manager logic when using Counter directly now uses get_manager()

• Windows is now supported!
• Bugfix: Don't assume stdout is always UTF-8

• Support for colorized progress bars
• Support for multicolor progress bars
• Counters return a generator that automatically updates the count as it yields elements from one or more iterables
• Add offset argument to Counter
  • Allows accounting for non-printable characters in bar_format and counter_format
• Add no_resize argument to Manager
  • Disables automatic resizing

• Convert from module to package
• Examples included in sdist
• Fixes for tests in some environments

• Documentation updates
• Minor optimizations