Konfoo

=====================

.. _3.0.0: https://github.com/JoeVirtual/KonFoo/compare/v2.1.0...v3.0.0

Enhancements
------------

* Add type hints.

Breaking Changes
----------------

* Rename ``size`` argument to ``capacity`` for
:class:`Array`, :class:`Stream`, :class:`String`,
:class:`ArrayPointer`,
:class:`StreamPointer`,
:class:`StringPointer`,
:class:`ArrayRelativePointer`,
:class:`StreamRelativePointer`,
and :class:`StringRelativePointer`
* Drop support for Python 3.6, 3.7, 3.8

=====================

.. _2.1.0: https://github.com/JoeVirtual/KonFoo/compare/v2.0...v2.1.0

Enhancements
------------

* Refactor repository and documentation structure.
* Change documentation theme.

=====================

.. _2.0.0: https://github.com/JoeVirtual/KonFoo/compare/v1.1...v2.0

Enhancements
------------

* Use :class:`dict` instead of :class:`~collections.OrderedDict` to improve
readability.
* Add method :meth:`Container.write_json` to write to a ``.json`` file.

Breaking Changes
----------------

* Drop support for Python 3.5

=====================

.. _1.1.0: https://github.com/JoeVirtual/KonFoo/compare/v1.0...v1.1

Enhancements
------------

* Add a :class:`Double` field class to map a double precision float value
within a byte stream.
* Extend methods :meth:`Structure.view_fields`, :meth:`Sequence.view_fields`
and :meth:`Pointer.view_fields` with keyword `fieldnames` to support customized
fieldnames for the selected field *attributes*.
* Extend method :meth:`Container.to_json` with keyword `fieldnames` to support
customized fieldnames for the selected field *attributes*.

Bug Fixes
---------

* Fix syntax warnings to support Python 3.8 correctly.
* Fix :class:`Structure` to raise the correct :class:`AttributeError` exception
instead of a :class:`KeyError` exception when an unknown attribute is accessed.
* Fix the :class:`Structure` class that the built-in :func:`help` function works
correctly on an instance of :class:`Structure`.

=====================

.. _1.0.0: https://github.com/JoeVirtual/KonFoo/compare

* First stable release.