v2.0.4

Added

• Support for hooks registered with ANY as the source, including a specific event or ANY
  event, with regression tests for callback delivery and removal.
• Generated llms.txt for the published documentation.
• Hatch scripts for regenerating the configuration and test protobuf bindings.
• AGENTS.md and per-module development guides.
• A modular coding-agent skill for using firebird-base.
• A development roadmap.
• A Hatch command to package the agent skill as a ZIP archive.

Changed

• Migrated the documentation from Sphinx and reStructuredText to Zensical and Markdown,
  including the Read the Docs and docset build workflows.
• Linked the published changelog to this file and expanded the configuration, collections,
  buffer, logging, trace, and protobuf documentation.
• Updated the protobuf tests and regenerated the test protobuf binding.
• Added Python 3.14 and 3.15 package classifiers and Python 3.15 to the Hatch test matrix.
• Added light and dark themes to the published documentation.

Fixed

• Corrected the public protobuf descriptor registration name to register_descriptor();
  the previous register_decriptor() spelling remains as a deprecated alias until 3.0.
• Corrected configuration, trace, and signal documentation examples.
• Corrected attribute and signature rendering in the generated API reference.

v2.0.3

Fixed

• Problem with entry_points in protobuf module under Python 3.14

v2.0.2: Release 2.0.2

Fixed

• Fix: "quick fingers" issue with _decompose fix.

v2.0.1: Release 2.0.1

Fixed

• Issue with trace configuration.
• Issues with _decompose.
• Signature match in eventsocket.

v2.0.0

Added

• firebird.base.buffer.MemoryBuffer.get_raw method.
• get_raw method to BufferFactory, BytesBufferFactory and CTypesBufferFactory.
• __repr__ method for PyCode and PyCallable that will limit output to 50 characters.
• Optional encoding parameter for ZMQAddress constructor.

Changed

• Tests changed from unittest to pytest, 96% code coverage.
• Minimal Python version raised to 3.11.
• The firebird.base.logging module was completelly reworked.
• Function firebird.base.types.Conjunctive renamed to conjunctive.
• firebird.base.collections.DataList.__init__ parameter frozen is now keyword-only.
• firebird.base.collections.DataList.extract parameter copy is now keyword-only.
• firebird.base.collections.DataList.sort parameter reverse is now keyword-only.
• firebird.base.collections.DataList.split parameter frozen is now keyword-only.
• firebird.base.collections.Registry.popitem parameter last is now keyword-only.
• firebird.base.collections.BaseObjectCollection.contains parameter expr now does not have default value.
• Deprecated firebird.base.config.create_config function was removed.
• firebird.base.config.DirectoryScheme parameter force_home is now keyword only.
• firebird.base.config.Option parameters required and default are now keyword only.
• Parameter context was removed from firebird.base.trace.traced decorator.
• Option context was removed from firebird.base.trace.BaseTraceConfig.
• Log function return value as repr rather than str.
• Sentinel objects completely reworked. Individual sentinels are now classes derived from Sentinel.

Fixed

• Broken firebird.base.types.Distinct support for dataclasses and hash function.
• Raise BufferError istead IOError in firebird.base.buffer.MemoryBuffer methods resize,
  read and read_number
• Problem with firebird.base.collections.Registry.pop that did not raised KeyError when
  default was not specified.
• Bug in firebird.base.collections.Registry.popitem with last = True.
• Problem with name handling in firebird.base.config.ConfigOption.clear and set_value.
• Problem with firebird.base.config.WindowsDirectoryScheme and firebird.base.config.MacOSDirectoryScheme constructors.
• Problem with firebird.base.config.ListOption.item_types value.
• Problem with internal .Convertor initialization in firebird.base.config.ListOption.
• Use copy of default list stead direct use in firebird.base.config.ListOption.
• firebird.base.config.ListOption.get_formatted and firebird.base.config.ListOption.get_as_str
  should return typed values for multitype lists.
• firebird.base.config.ConfigOption.validate should validate the Config as well if defined.
• firebird.base.config.ConfigListOption.validate should report error for empty list when required.
• Problem with conversion of flags from string in firebird.base.strconv.

v1.8.0

Added

• New EnvExtendedInterpolation class in config module that extends configparser.ExtendedInterpolation
  with special handling for "env" section that returns value of specified environment
  variable, or empty string if such variable is not defined.

v1.7.2

Fixed

• Error.getattr() should not mask the absence of __notes__ attribute.

v1.7.1

Fixed

• Log record values module and filename were not assigned properly under Python 3.11
• Failed tests due to subtle changes in Python 3.11

Changed

• Downgrade dependency to protobuf>=4.23.4

v1.7.0

Added

• .pyi file for config protobuf
• Stub pytest test

Changed

• Update dependency to protobuf >=4.24.3
• Build system changed from setuptools to hatch
• Package version is now defined in firebird.base.__about__.py (__version__)

v1.6.1

• firebird.base.config module:

  • Fixed bug with Config.get_config() and plain bool argument.
  • StrOption now supports preservation of significant leading whitespace for multiline
    values (like PyCodeOption).