Skip to content

CHANGELOG.md

Latest commit

 

History

History
144 lines (90 loc) · 4.03 KB

CHANGELOG.md

File metadata and controls

144 lines (90 loc) · 4.03 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.6.0 - 2025-10-18

💥 Breaking changes

  • End of Python 3.7, 3.8, and 3.9 support

🏠 Internal

  • Fix test xz files generation for xz-utils 5.5.1+
  • Update license metadata as per PEP 639
  • Freeze dev dependencies versions
  • Use pyproject.toml and modern build system
  • Update dev dependencies
  • Update GitHub actions dependencies
  • Add tests for CPython 3.12, 3.13 and 3.14; and PyPy 3.10 and 3.11
  • Use CPython 3.14 for misc. tests
  • Improve tox & CI pipelines
  • Use ruff as linter and formatter

0.5.0 - 2023-02-27

💥 Breaking changes

  • End of Python 3.6 support

🏠 Internal

  • Necessary code changes following dev dependency update: black, pylint, pytest
  • Refactor a descriptor following PEP 487
  • Add tests for CPython 3.11 and PyPy 3.9
  • Use CPython 3.11 for misc. tests
  • Update GitHub actions dependencies
  • Import typing modules impacted by PEP 585 based on Python version

0.4.0 - 2022-01-09

🚀 Added

  • Advanced users may use the new block_read_strategy argument of XZFile/xz.open to customize the strategy for freeing block readers, and implement a different tradeoff between memory consumption and read speed when alternating reads between several blocks; the following strategies are provided: RollingBlockReadStrategy and KeepBlockReadStrategy

🐛 Fixes

  • Free memory after a block is fully read
  • Free memory of LZMA decompressors when many blocks are partially read; this is a tradeoff defaulting to keeping the last 8 LZMA decompressors used
  • Typing: use BinaryIO instead of IO[bytes]

🏠 Internal

  • Specify the Python versions required in package metadata
  • Test the mode attribute of objects returned by xz.open/XZFile
  • Minor improvements in some docstrings

0.3.1 - 2021-12-26

🏠 Internal

  • Add tests for CPython 3.10 and PyPy 3.8
  • Use CPython 3.10 for misc. tests
  • Clarify which Python versions are supported in readme
  • Fix some linting issues found by latest versions of mypy/pylint

0.3.0 - 2021-11-07

💥 Breaking changes

  • The filename argument of XZFile is now mandatory; this change should have very limited impact as not providing it makes no sense and would have raised a TypeError, plus it was already mandatory on xz.open

🚀 Added

  • Type hints

🏠 Internal

  • Type validation with mypy
  • Distribute py.typed file in conformance with PEP 561

0.2.0 - 2021-10-23

🚀 Added

  • Write modes (w, x, r+, w+, x+) 🎉
  • Allow to seek past the end of the fileobj
  • Calling len on a fileobj gives its length, and bool tells if it is empty
  • Export useful constants and functions from lzma for easy access: checks, filters, etc.

🏠 Internal

  • Test that no warnings are generated
  • Change development status to Alpha

0.1.2 - 2021-09-19

🚀 Added

  • Add __version__ attribute to module, despite PEP 396 being rejected

0.1.1 - 2021-05-14

🚀 Added

  • Implementation of the fileno method

0.1.0 - 2021-05-13

🚀 Added

  • Initial public release 🎉