Add BLAKE3 support with .bk3 checksum format (256/512/1024/2048-bit XOF)

.github/workflows/ci-python3-freebsd.yml

@@ -34,7 +34,7 @@ jobs:
       with:
         release: ${{ matrix.freebsd-release }}
         usesh: true
-        prepare: pkg install -y python3 devel/py-pip coreutils cksfv git-tiny rust
+        prepare: pkg install -y python3 devel/py-pip coreutils cksfv b3sum git-tiny rust
         run: |
           set -ex
 
@@ -55,15 +55,6 @@ jobs:
           pw groupadd docker -g 127
           pw useradd runner -u 1001 -g docker
 
-          # Install test dependencies
-          pip install pyroma
-          pip install check-manifest
-          pip install twine
-          pip install wheel
-          pip install flake8
-          pip install build
-          pip list
-
           # Check syntax by compiling code
           python -W error -bb -m compileall -f .
 
@@ -76,15 +67,25 @@ jobs:
           # Run integration tests (external process)
           su runner -c 'ulimit -n; ulimit -n 4096; test/test.py -e --exit-early'
 
-          # Check package quality
-          su runner -c 'pyroma -n 10 .'
+          # Install optional dependencies
+          # pillow dependencies
+          pkg install -y jpeg-turbo tiff webp openjpeg libavif
+          pip install .[full]
+          pip list
 
-          # Check the completeness of MANIFEST.in
-          su runner -c 'check-manifest .'
+          # Run unit tests (with optional dependencies)
+          su runner -c 'python -W error -bb test/test.py --unit --exit-early'
 
-          # Run flake
-          flake8 --exclude=build,venv --ignore= --max-line-length=200 --max-complexity=75 --show-source --statistics .
+          # Run integration tests (internal, with optional dependencies)
+          su runner -c 'ulimit -n; ulimit -n 4096; python -W error -bb test/test.py -i --exit-early'
+
+          # Run integration tests (external process, with optional dependencies)
+          su runner -c 'ulimit -n; ulimit -n 4096; test/test.py -e --exit-early'
+
+          # Install build dependencies
+          # Fallback hack required for pip < 25.1 (since newer pip is not available for Python < 3.9)
+          pip install --group build || pip install build
+          pip list
 
-          # Check distribution
+          # Build
           python -m build
-          twine check dist/*

.github/workflows/ci-python3.yml

@@ -15,7 +15,41 @@ on:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
+  lint:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-24.04
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.15'
+          allow-prereleases: true
+          check-latest: true
+
+      - name: Install lint dependencies
+        run: |
+          pip install --group ci
+          pip list
+
+      - name: Run flake
+        run: flake8 --exclude=build,venv --ignore= --max-line-length=200 --max-complexity=75 --show-source --statistics .
+
+      - name: Check package quality
+        run: pyroma -n 10 .
+
+      - name: Check the completeness of MANIFEST.in
+        run: check-manifest .
+
+      - name: Check distribution
+        run: |
+          python -m build
+          twine check dist/*
+
   test:
     # The type of runner that the job will run on
     runs-on: ${{ matrix.os }}
@@ -45,14 +79,7 @@ jobs:
 
       - name: Install test dependencies
         run: |
-          sudo apt install coreutils cksfv
-          pip install pyroma
-          pip install check-manifest
-          pip install twine
-          pip install wheel
-          pip install flake8
-          pip install build
-          pip list
+          sudo apt install coreutils cksfv b3sum
 
       - name: Check syntax by compiling code
         run: python -W error -bb -m compileall -f .
@@ -72,17 +99,35 @@ jobs:
           ulimit -n 4096
           test/test.py -e --exit-early
 
-      - name: Check package quality
-        continue-on-error: ${{ contains(fromJson('["3.7", "3.8"]'), matrix.python-version) }}
-        run: pyroma -n 10 .
+      - name: Install optional dependencies
+        continue-on-error: ${{ contains(fromJson('["3.15"]'), matrix.python-version) }}
+        run: |
+          # pillow dependencies
+          sudo apt install libjpeg8-dev zlib1g-dev libtiff5-dev libwebp-dev libopenjp2-7-dev libavif-dev
+          pip install .[full]
+          pip list
 
-      - name: Check the completeness of MANIFEST.in
-        run: check-manifest .
+      - name: Run unit tests (with optional dependencies)
+        run: python -W error -bb test/test.py --unit --exit-early
 
-      - name: Run flake
-        run: flake8 --exclude=build,venv --ignore= --max-line-length=200 --max-complexity=75 --show-source --statistics .
+      - name: Run integration tests (internal, with optional dependencies)
+        run: |
+          ulimit -n
+          ulimit -n 4096
+          python -W error -bb test/test.py -i --exit-early
 
-      - name: Check distribution
+      - name: Run integration tests (external process, with optional dependencies)
+        run: |
+          ulimit -n
+          ulimit -n 4096
+          test/test.py -e --exit-early
+
+      - name: Install build dependencies
+        run: |
+          # Fallback hack required for pip < 25.1 (since newer pip is not available for Python < 3.9)
+          pip install --group build || pip install build
+          pip list
+
+      - name: Build
         run: |
           python -m build
-          twine check dist/*

Changelog

@@ -1,5 +1,6 @@
 2025-xx-xx - v3.2.1.dev0:
 	* WARNING: This is a development snapshot, not a stable release.
+	* Support for BLAKE3 b3sum format (Thanks to Artur Ladka).
 
 2025-11-02 - v3.2.0:
 	* Drop support for Python 3.6.

README.md

@@ -1,8 +1,8 @@
 # cfv – Command-line File Verify
 
 cfv is a utility to test and create a wide range of checksum verification files.
-It currently supports testing and creating sfv, sfvmd5, csv, csv2, csv4, md5, bsdmd5, sha1, sha224,
-sha256, sha384, sha512, torrent and crc files.
+It currently supports testing and creating sfv, sfvmd5, csv, csv2, csv4, crc, md5, bsdmd5,
+sha1, sha224, sha256, sha384, sha512, b3 (BLAKE3) and torrent files.
 Test-only support is available for par, par2.
 
 cfv was originally written by Matthew Mueller ([original project home](http://cfv.sourceforge.net/)).
@@ -25,6 +25,9 @@ For Python 2 support, see the [python2 branch](https://github.com/cfv-project/cf
 * [Python Imaging Library (PIL)](https://www.pythonware.com/products/pil/) or
   [Pillow](https://python-pillow.org/) – only needed if you want to create the
   dimensions column of .crc files.
+* [blake3](https://pypi.org/project/blake3/) – needed for BLAKE3 b3sum files (B3SUMS, .b3, .bk3).
+  Default output is 256 bits (32 bytes).
+  Install via `pip install blake3` or `apt install python3-blake3`.
 
 ## Install
 

cfv.1

@@ -1,8 +1,8 @@
 .TH cfv 1 "05 Feb 2005"
 .SH NAME
-cfv \- Verify file consistency with .sfv, .csv, .crc, .md5, md5sum, sha1sum, sha224sum, sha256sum, sha384sum, sha512sum, .torrent, par, or par2 files
+cfv \- Verify file consistency with .sfv, .csv, .crc, .md5, md5sum, sha1sum, sha224sum, sha256sum, sha384sum, sha512sum, b3sum, .torrent, .par, or .par2 files
 .SH SYNOPSIS
-.B cfv [\-p dir] [\-v|\-V|\-VV|\-q|\-Q] [\-\-progress VAL] [\-r|\-rr|\-R] [\-l|\-L] [\-n|\-N] [\-\-renameformat <s>] [\-s|\-S] [\-zz|\-z|\-Z|\-ZZ] [\-T|\-C] [\-m|\-M] [\-i|\-I] [\-u|\-uu|\-U] [\-\-encoding <e>] [\-\-unquote <b>] [\-\-fixpaths <s>] [\-\-strippaths <p>] [\-\-showpaths <i>] [\-\-list/\-\-list0 <l>] [\-\-announceurl <u>] [\-\-piece_size_pow2 <n>] [\-\-private_torrent] [\-t type] [\-f file] [files...]
+.B cfv [\-p dir] [\-v|\-V|\-VV|\-q|\-Q] [\-\-progress VAL] [\-r|\-rr|\-R] [\-l|\-L] [\-n|\-N] [\-\-renameformat <s>] [\-s|\-S] [\-zz|\-z|\-Z|\-ZZ] [\-T|\-C] [\-m|\-M] [\-i|\-I] [\-u|\-uu|\-U] [\-\-encoding <e>] [\-\-unquote <b>] [\-\-fixpaths <s>] [\-\-strippaths <p>] [\-\-showpaths <i>] [\-\-list/\-\-list0 <l>] [\-\-announceurl <u>] [\-\-piece_size_pow2 <n>] [\-\-private_torrent] [\-\-length <n>] [\-t type] [\-f file] [files...]
 .SH DESCRIPTION
 .B cfv
 verifies that the files you have are the same as those that the were used to create
@@ -120,14 +120,18 @@ Specify the name of the checksum file to test or create.
 If file is \-, stdin (for \-T) or stdout (for \-C) will be used.
 .IP "\-t type"
 Specify the type of the file.
-Can be sfv, sfvmd5, csv, csv2, csv4, sha1, sha224, sha256, sha384, sha512, md5, bsdmd5, par, par2, torrent, crc, auto, or help.
+Can be sfv, sfvmd5, csv, csv2, csv4, crc, md5, bsdmd5, sha1, sha224, sha256, sha384, sha512, b3, torrent, par, par2, auto, or help.
+For details see supported checksum formats section.
 If the type is help, or an unknown type is given, a list of the types and their descriptions will be printed.
 The default is auto, which will detect the file type for you.
 When creating, if type is auto an sfv will be made, unless a different default has been set in the config file.
 .IP "\-\-list listset"
 Prints a raw listing of files in the given set (ok, bad, unverified, notfound).  Usually used with \-q, but not strictly needed since specifying \-\-list will redirect all other messages to stderr.
 .IP "\-\-list0 listset"
 Like \-\-list but files are separated by a null char.  Useful in combination with xargs \-0.
+.IP "\-\-length BITS"
+Set digest length in bits for hash types that support variable output (b3).
+The default for b3 is 256 bits. Must be a multiple of 8.
 .IP "\-\-announceurl URL"
 Tracker announce URL for .torrent file creation.
 .IP "\-\-piece_size_pow2 N"
@@ -139,6 +143,8 @@ Set private flag in torrent during .torrent file creation.
 Print help info.
 .IP "\-\-version"
 Print version of cfv and modules it uses.
+.SH SUPPORTED CHECKSUM FILE FORMATS
+The following types are supported:
 .P
 .B sfv
 is a Simple File Verify format file
@@ -155,6 +161,15 @@ is a Comma Separated Value file, with the fields being name,size,
 .B csv4
 is a Comma Separated Value file, with the fields being name,size,crc32,path
 .br
+.B crc
+is a JPEG Sheriff format crc file
+.br
+.B md5
+is a GNU md5sum format file
+.br
+.B bsdmd5
+is a BSD md5 format file
+.br
 .B sha1
 is a GNU sha1sum format file
 .br
@@ -170,23 +185,17 @@ is a GNU sha384sum format file
 .B sha512
 is a GNU sha512sum format file
 .br
-.B md5
-is a GNU md5sum format file
+.B b3
+is a BLAKE3 b3sum format file (B3SUMS, .b3, .bk3). Requires the Python blake3 module.
 .br
-.B bsdmd5
-is a BSD md5 format file
+.B torrent
+is a BitTorrent metainfo file
 .br
 .B par
 is parchive v1 format file (test-only)
 .br
 .B par2
 is parchive v2 format file (test-only)
-.br
-.B torrent
-is a BitTorrent metainfo file
-.br
-.B crc
-is a JPEG Sheriff format crc file
 .SH EXIT STATUS
 The exit status of cfv can be examined to determine what kind of errors, if any, occurred.
 .P