check-empty 0.5.0

Command-line utility, as well as a hook usable by the Python pre-commit framework, to ensure that selected files are empty.

check-empty

A simple, dependency-free and intuitive pre-commit/ prek hook, CLI, library and GitHub Action conglomerate that makes sure selected files are empty according to a filesystem stat call and clears them effectively with minimal I/O if required, written in Python. Also available as a tool on uv. Supports CPython 3.6+, PyPy 7.0+, GraalPy 19.0+ and (untested) every Python runtime you can think of that implements Python 3 syntax and f-strings.

Quickstart

Without installation (testing out the capabilities):

uvx check-empty -q src/mylib/py.typed docs/.nojekyll static/.gitkeep

# uv
uv tool install check-empty # bare executable on PATH
uv pip install check-empty # if you want the library as well

pip install check-empty # pip

Check the version with:

check-empty -v

Run the CLI:

check-empty -q src/mylib/py.typed docs/.nojekyll static/.gitkeep

As a pre-commit hook:

# .pre-commit-config.yaml
repos:
- repo: https://github.com/jonathandung/check-empty
  rev: v0.5.0 # repository version
  hooks:
    - id: check-empty # the hook
      args: # example list of arguments
        - --quiet # flag to silence output (equivalent to -q)
        # below: paths to files to clear or keep empty, either relative to the project
        # root or absolute (not shown)
        - src/mylib/py.typed
        - docs/.nojekyll
        - static/.gitkeep

equivalent in prek.toml format:

[[repos]]
repo = "https://github.com/jonathandung/check-empty"
rev = "v0.5.0"
hooks = [{
  id = "check-empty",
  args = [
    "--quiet",
    "src/mylib/py.typed",
    "docs/.nojekyll",
    "static/.gitkeep",
  ]
}]

As a GitHub action step:

steps:
- uses: jonathandung/check-empty@v0.5.0 # the latest version on the GitHub Actions
  # marketplace; this step will fail and subsequent jobs will not run if any file is
  # not empty
  with:
    python-version: '3.14' # run the script on the latest stable Python version
    # Python down to 3.6 is supported but not recommended due to end-of-life
    quiet: true
    filenames: |
      src/mylib/py.typed
      docs/.nojekyll
      static/.gitkeep