Skip to content

Latest commit

 

History

History
222 lines (174 loc) · 7.35 KB

CHANGELOG.md

File metadata and controls

222 lines (174 loc) · 7.35 KB
Raw

Changelog

Development

2.7.1

  • Actually advertise that our C extension supports sub-interpreters, and per-GIL ones for that matter.

2.7.post1

  • Added missing test files to source distribution (#59).

2.7.post0

  • Fixed generation of source distribution (#58).

2.7

  • Added a gil_relese_mode parameter to the CRC32CHash constructor used by all underlying crc32c function calls (#51).
  • Added support for free-threaded Python builds, declaring that our C extension doesn't need the GIL. In free-threaded builds the gil_release_mode parameter doesn't have any effect.
  • Added CRC32CHash.checksum auxiliary property.
  • Added new crc32c.benchmark utility for simple benchmarking.
  • The crc32c module doesn't fail to import when CRC32C_SW_MODE is none and no hardware acceleration is found, making the act of importing the module less ackward. Now a RuntimeWarning is issued at import time instead, and aRuntimeError is raised any time a checksum calculation is attempted.
  • Improved support in the C extension for Python sub-interpreters by keeping all global state on a per-module basis, and performing multi-phase initialisation as per PEP-489.
  • Skip hardware probing if the CRC32C_SKIP_HW_PROBE environment variable is set to 1.
  • Cleaned up wheel generation so it doesn't include C extension sources after changes introduced in 2.5.

2.6

  • Added new crc32c.CRC32CHash class modelled after the stdlib hashlib hash objects.
  • Drop support for Python < 3.7.

2.5

  • Made this package PEP 561 compliant (#49).
  • Release GIL during the computation of the CRC32C hash. A new gil_release_mode argument lets users choose between always/never/automatically releasing it (#47).
  • Add keyword support to crc32c function (crc32c(data, value=0, gil_release_mode=-1)).
  • Turned crc32c from a module-only distribution into a package, and moves all sources under src.
  • Adding explicit fallthrough annotations in several switch C statements for clarity, and to avoid potential warnings (#46).
  • Run test against different memory alignments.
  • Mention explicit support for Python 3.13.
  • Drop support for Python 2.7.

2.4.1

  • Fixed failure on big-endian, signed char platforms (found in SPARC, but there might be more) due to an incorrect (and unnecessary) cast from unsigned char * to char * (#43).

2.4

  • Changed package compilation under gcc/clang to use compiler extensions to build hardware-specific functions instead of command-line options for improved portability (#31).

2.3.post0

  • Mention explicit support for Python 3.11.
  • Re-generating wheels to get 3.11 versions.

2.3

  • Improved macro definition logic and platform detection to enable building universal2 binary wheels for macOS, alongside arm64 and x86_64 ones; added step to GitHub Actions to generate and publish them (#28).
  • Mention explicit support for Python 3.10.
  • Fixed minor compilation warning in ARM64 builds.

2.2.post0

  • Updated GitHub Actions to produce ARM64 Linux binary wheels and publish them to PyPI.
  • Removed Windows python 2.7 binary wheels. There are two reasons: cibuildwheels has removed such support, our Windows user base is < %5, and our Python 2.7 user base is also < %5.

2.2

  • Fixed software algorithm implementation to work on big endian machines (#22). Now the algorithm works correctly, with numerical (uint32_t) values still representing the correct checksum.
  • Added a new big_endian attribute that indicates if the currently platform is big endian or not.
  • Fixed compilation issues in some ARM Linux boxes (#21).

2.1

  • Initial hardware-based implementation on ARMv8 machines (#11).
  • Add hardware-based implementation on x86 32bit machines. The C code was already there, but we did not include it for this architecture. As a result, 32-bit x86 wheels should run faster now.
  • Deprecated the crc32 function in favour of the new crc32c function, which apart from the new, better name has no other changes.
  • Fixed minor warning.

2.0.1

  • Changed binary distribution generation strategy, moving from a local+Travis+AppVeyor setup to a unified script using GitHub Actions.
  • Fixed generation of source distribution (two C source code files were missing from the tarball). This bug was introduced in 1.6, but the source code distributions found in PyPI were not affected because the environment where they were created predates the bug, and already contained references to the two missing files.

2.0

  • Changed package import logic (#12). Instead of failing to import if hardware support is not found, the package now automatically falls back to using the software implementation, and thus can always be imported. Old behavior can still be obtained by setting CRC32C_SW_MODE to none.
  • Fixed cross-compilation support (#10).

1.7

  • Fixes wrong uploads to PyPI (#8).

1.6

  • Added new auto software mode to allow automatic selection of hardware or software backend (#5).
  • Fixed compilation in non-Intel platforms (#6).
  • Added support to compile with icc.

1.5

  • Adding software implementation of crc32c algorithm, original developed by Mark Adler (#4). Software implementation is not accessible by default in order to maintain current importing logic, and is switched on by setting CRC32C_SW_MODE to 1.
  • Changed Intel's hardware-based implementation of crc32c from our own home-brewed code to Mark Adler's.

1.4

  • Added support to compile in Windows using MSVC.
  • Removing experimental read/crc/write C method.
  • First version with binary wheels uploaded to PyPI (#2).

1.3

  • Added support to compile in Windows using the MinGW compiler (#1).

1.2

  • First version of crc32c doing pre- and post-masking against 0xffffffff. This is thus the first version of the package that is easily usable.

1.1

  • Correct license reference.

1.0

  • Initial release.