check-empty 3.0.0__tar.gz → 4.0.0__tar.gz

{check_empty-3.0.0 → check_empty-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: check-empty
-Version: 3.0.0
+Version: 4.0.0
 Summary: Command-line utility, as well as a hook usable by the Python pre-commit framework, and a GitHub Action, to ensure that selected files are empty.
 Keywords: check,command-line,empty,files,github-action,helper,hook,lightweight,pre-commit,prek,tool,utility
 Author: Jonathan Dung
@@ -27,7 +27,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Dist: py7zr==1.1.3 ; extra == '7z'
 Requires-Dist: acefile==0.6.14 ; extra == 'ace'
-Requires-Dist: check-empty[7z,ace,ar,lzh,rar]==3.0.0 ; extra == 'all'
+Requires-Dist: check-empty[7z,ace,ar,lzh,rar]==4.0.0 ; extra == 'all'
 Requires-Dist: arpy==2.4.0 ; extra == 'ar'
 Requires-Dist: lhafile==0.3.1 ; extra == 'lzh'
 Requires-Dist: rarfile==4.5 ; extra == 'rar'
@@ -42,7 +42,7 @@ Provides-Extra: lzh
 Provides-Extra: rar
 Description-Content-Type: text/markdown
 
-# [check-empty](https://pypi.org/p/check-empty/3.0.0)
+# [check-empty](https://pypi.org/project/check-empty/4.0.0)
 
 [![#StandWithPalestine](https://raw.githubusercontent.com/TheBSD/StandWithPalestine/main/badges/StandWithPalestine.svg)](https://github.com/TheBSD/StandWithPalestine/blob/main/docs/README.md)
 
@@ -126,7 +126,7 @@ As a pre-commit hook:
 # .pre-commit-config.yaml
 repos:
 - repo: https://github.com/jonathandung/check-empty
-  rev: v3.0.0 # repository version
+  rev: v4.0.0 # repository version
   hooks:
     - id: check-empty # the hook
       args: # example list of arguments
@@ -142,7 +142,7 @@ equivalent in `prek.toml` format:
 ```toml
 [[repos]]
 repo = "https://github.com/jonathandung/check-empty"
-rev = "v3.0.0"
+rev = "v4.0.0"
 
 [[repos.hooks]]
 id = "check-empty"
@@ -166,7 +166,7 @@ or (TOML 1.1+):
 # using multiline inline tables
 [[repos]]
 repo = "https://github.com/jonathandung/check-empty"
-rev = "v3.0.0"
+rev = "v4.0.0"
 hooks = [{
   id = "check-empty",
   args = ["-Q"],
@@ -186,7 +186,7 @@ As a GitHub Actions workflow step:
 
 ```yaml
 steps:
-- uses: jonathandung/check-empty@v3.0.0 # the latest version on the GitHub Actions
+- uses: jonathandung/check-empty@v4.0.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:
@@ -197,6 +197,7 @@ steps:
       static/.gitkeep
       some_dir
     globs: '**/*.lock'
+    # must use single quotes to escape asterisks, which refer to YAML aliases
     # can also be an array of globs joined into a newline-delimited multiline string,
     # as in filenames
 ```
@@ -244,10 +245,11 @@ to read the
 and the
 [contributing guide](https://github.com/jonathandung/.github/blob/main/CONTRIBUTING.md).
 
-To build the docs locally (needs Python 3.12+ because of Sphinx), install with the
-`docs` [group](https://packaging.python.org/en/latest/specifications/dependency-groups)
-using a package manager that supports it (e.g. pip 25.1+ or uv 0.4.27+), preferably
-into a virtual environment.
+To build the docs locally (needs Python 3.12+ because of Sphinx), install the package
+with the `docs`
+[group](https://packaging.python.org/en/latest/specifications/dependency-groups) using
+a package manager that supports it (e.g. pip 25.1+ or uv 0.4.27+), preferably into a
+virtual environment.
 
 Tests are run with:
 

{check_empty-3.0.0 → check_empty-4.0.0}/README.md

@@ -1,4 +1,4 @@
-# [check-empty](https://pypi.org/p/check-empty/3.0.0)
+# [check-empty](https://pypi.org/project/check-empty/4.0.0)
 
 [![#StandWithPalestine](https://raw.githubusercontent.com/TheBSD/StandWithPalestine/main/badges/StandWithPalestine.svg)](https://github.com/TheBSD/StandWithPalestine/blob/main/docs/README.md)
 
@@ -82,7 +82,7 @@ As a pre-commit hook:
 # .pre-commit-config.yaml
 repos:
 - repo: https://github.com/jonathandung/check-empty
-  rev: v3.0.0 # repository version
+  rev: v4.0.0 # repository version
   hooks:
     - id: check-empty # the hook
       args: # example list of arguments
@@ -98,7 +98,7 @@ equivalent in `prek.toml` format:
 ```toml
 [[repos]]
 repo = "https://github.com/jonathandung/check-empty"
-rev = "v3.0.0"
+rev = "v4.0.0"
 
 [[repos.hooks]]
 id = "check-empty"
@@ -122,7 +122,7 @@ or (TOML 1.1+):
 # using multiline inline tables
 [[repos]]
 repo = "https://github.com/jonathandung/check-empty"
-rev = "v3.0.0"
+rev = "v4.0.0"
 hooks = [{
   id = "check-empty",
   args = ["-Q"],
@@ -142,7 +142,7 @@ As a GitHub Actions workflow step:
 
 ```yaml
 steps:
-- uses: jonathandung/check-empty@v3.0.0 # the latest version on the GitHub Actions
+- uses: jonathandung/check-empty@v4.0.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:
@@ -153,6 +153,7 @@ steps:
       static/.gitkeep
       some_dir
     globs: '**/*.lock'
+    # must use single quotes to escape asterisks, which refer to YAML aliases
     # can also be an array of globs joined into a newline-delimited multiline string,
     # as in filenames
 ```
@@ -200,10 +201,11 @@ to read the
 and the
 [contributing guide](https://github.com/jonathandung/.github/blob/main/CONTRIBUTING.md).
 
-To build the docs locally (needs Python 3.12+ because of Sphinx), install with the
-`docs` [group](https://packaging.python.org/en/latest/specifications/dependency-groups)
-using a package manager that supports it (e.g. pip 25.1+ or uv 0.4.27+), preferably
-into a virtual environment.
+To build the docs locally (needs Python 3.12+ because of Sphinx), install the package
+with the `docs`
+[group](https://packaging.python.org/en/latest/specifications/dependency-groups) using
+a package manager that supports it (e.g. pip 25.1+ or uv 0.4.27+), preferably into a
+virtual environment.
 
 Tests are run with:
 

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/__init__.py

@@ -7,12 +7,10 @@ Pre-commit hook, command-line tool and GitHub Action all-in-one.
 
 from __future__ import annotations
 
-from contextlib import suppress
-
 from check_empty import constants, reporter
 
 __all__ = ('Handler', 'check', 'default_reporter')
-__version__ = '3.0.0'
+__version__ = '4.0.0'
 """The version of the package."""
 default_reporter: reporter.Reporter = reporter.Reporter()
 """The default reporter used by :func:`check`."""
@@ -124,6 +122,7 @@ def check(
         The integer exit code calculated by the reporter.
 
     """
+    from contextlib import suppress
     from os import fsdecode, scandir, stat
 
     files = list(files)
@@ -323,6 +322,6 @@ def check(
             Handler(*i, a).o()
     x, d = k[1] if z is None else len(z) - 1, k[2] if w is None else len(w)
     y, p = k[3] if r is None else len(r), k[0] if b is None else len(b) - 1
-    reporter.report(z, w, v, b, r, x, y, d, p, n, t, verbosity, clear)
+    reporter.report(z, v, b, ra, r, w, x, y, d, p, n, t, verbosity, clear)
     reporter.reset_out()
     return reporter.calculate_result(*map(bool, (y, x and not may_not_exist, d)))

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/__main__.py

@@ -68,15 +68,16 @@ def main(argv: Iterable[str] | None = None) -> int:
         # ruff: ignore[open-file-with-context-handler]
         c.default_reporter.to(open(o, 'w', encoding='utf-8'))
     m = c.constants
-    r = m.RecurseInto.NONE
-    for a in m.ARCHIVE_FORMATS:
-        if getattr(n, a._name_.lower()):
-            r |= a
+    r = m.RecurseInto
     return c.check(
         n.filenames,
         clear=n.clear,
         may_not_exist=n.may_not_exist,
-        recurse_into=r,
+        recurse_into=__import__('functools').reduce(
+            r.__or__,
+            filter(lambda a: getattr(n, a.name.lower()), m.ARCHIVE_FORMATS),
+            r.NONE,
+        ),
         verbosity=2 + n.verbose - n.quiet,
     )
 

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/archives.py

@@ -3,14 +3,13 @@
 from __future__ import annotations
 
 import os
-from itertools import filterfalse
-from operator import attrgetter
-from tempfile import NamedTemporaryFile
+from tempfile import NamedTemporaryFile as h
 
 __all__ = (
     'AR_FS',
     'AR_MAG',
     'AR_NAME_SIZE',
+    'AR_SKIP',
     'clear_file_in_zip',
     'purge_7z',
     'purge_ar',
@@ -18,13 +17,17 @@ __all__ = (
 )
 _ = __import__('io').BytesIO()
 AR_FS: Final = b'%-16b0           0     0     100644  %-10d`\n%b'
+"""A C-style format string used to create file headers and bodies in ar archives."""
 AR_MAG: Final = b'!<arch>\n'
+"""The magic number for ar archives."""
 AR_NAME_SIZE: Final = 16
+"""The maximum length of a file name in an ar archive before special handling."""
 AR_SKIP: Final[
     frozenset[
         Literal[b'/', b'//', b'/SYM64/', b'__.SYMDEF', b'__.SYMDEF SORTED'] | None
     ]
 ] = frozenset((b'/', b'//', b'/SYM64/', b'__.SYMDEF', b'__.SYMDEF SORTED', None))
+"""The file names to skip when clearing files in an ar archive."""
 TYPE_CHECKING = False
 if TYPE_CHECKING:
     import tarfile
@@ -62,7 +65,7 @@ def purge_tar(t: tarfile.TarFile) -> None:
     import tarfile as z
 
     with (
-        NamedTemporaryFile(suffix='.tar.gz', delete=False) as p,
+        h(suffix='.tar.gz', delete=False) as p,
         z.open(fileobj=p, mode='w:gz') as f,
     ):
         a = f.addfile
@@ -80,15 +83,17 @@ def purge_ar(a: Archive, g: int) -> None:
         os.truncate(n, 8)
         return
 
-    with NamedTemporaryFile(suffix='.a', delete=False) as f:
+    with h(suffix='.a', delete=False) as f:
         w = f.write
         w(AR_MAG)
-        q = filterfalse(AR_SKIP.__contains__, map(attrgetter('name'), i))
-        _purge_ar_gnu(tuple(q), w) if i[0].type == g else _purge_ar_bsd(q, w)
+        q = __import__('itertools').filterfalse(
+            AR_SKIP.__contains__, map(__import__('operator').attrgetter('name'), i)
+        )
+        _gnu(tuple(q), w) if i[0].type == g else _bsd(q, w)
     os.replace(f.name, n)
 
 
-def _purge_ar_bsd(q: Iterable[bytes], w: Callable[[bytes], int]) -> None:
+def _bsd(q: Iterable[bytes], w: Callable[[bytes], int]) -> None:
     """Clear the contents of each file in a BSD .a, .ar or .lib archive."""
     for m in q:
         x = len(m)
@@ -96,7 +101,7 @@ def _purge_ar_bsd(q: Iterable[bytes], w: Callable[[bytes], int]) -> None:
         w(AR_FS % (b'#1/%d' % x if b else m, x, m if b else b''))
 
 
-def _purge_ar_gnu(q: tuple[bytes, ...], w: Callable[[bytes], int]) -> None:
+def _gnu(q: tuple[bytes, ...], w: Callable[[bytes], int]) -> None:
     """Clear the contents of each file in a GNU .a, .ar or .lib archive."""
     c, d = 0, {}
     for m in q:

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/constants.py

@@ -16,7 +16,7 @@ TYPE_CHECKING = False
 if TYPE_CHECKING:
     from typing import Final
 TYPE_MASK: Final = 0xF000
-"""This mask extracts the type of a file from its mode bits from :func:`os.stat`."""
+"""The mask that extracts the type of a file from its mode bits from :func:`os.stat`."""
 S_IFDIR: Final = 0x4000
 """Equal to :data:`stat.S_IFDIR`."""
 ENOENT: Final = 2
@@ -58,7 +58,7 @@ class RecurseInto(__import__('enum').IntFlag):
     """Recurse into all archive types."""
 
 
-ARCHIVE_FORMATS: Final = tuple(
+ARCHIVE_FORMATS: Final[tuple[RecurseInto, ...]] = tuple(
     filter(lambda x: x > 0 == x & (x - 1), RecurseInto)
     if __import__('sys').version_info < (3, 11)
     else RecurseInto

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/reporter/__init__.py

@@ -34,10 +34,11 @@ class Reporter(abcdef.ReporterABC):
     def report(  # ruff: ignore[too-many-arguments, too-many-positional-arguments]
         self,
         z: list[str] | None,
-        w: list[OSError] | None,
         a: list[str] | None,
         b: list[str] | None,
+        e: list[str] | None,
         r: list[tuple[str, int]] | None,
+        w: list[OSError] | None,
         x: int,
         y: int,
         d: int,
@@ -59,6 +60,8 @@ class Reporter(abcdef.ReporterABC):
         q = (s.stdout if q is None else q).write
         if a is not None:
             q('\nRecursing into directory: '.join(a))
+        if e is not None:
+            q('\nRecursing into archive: '.join(e))
         if z is not None:
             q('\nNot found: '.join(z))
         q(

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/reporter/abcdef.py

@@ -22,10 +22,11 @@ class ReporterABC(metaclass=a.ABCMeta):
     def report(  # ruff: ignore[too-many-arguments, too-many-positional-arguments]
         self,
         z: list[str] | None,
-        w: list[OSError] | None,
         a: list[str] | None,
         b: list[str] | None,
+        e: list[str] | None,
         r: list[tuple[str, int]] | None,
+        w: list[OSError] | None,
         x: int,
         y: int,
         d: int,
@@ -39,11 +40,18 @@ class ReporterABC(metaclass=a.ABCMeta):
         """Report the results of the check.
 
         Args:
-            z: list of paths to files that were not found.
-            w: list of I/O errors when processing non-missing files.
-            a: list of directories that were recursed into.
-            b: list of empty file paths.
-            r: list of 2-tuples representing non-empty files and their sizes.
+            z: list of paths to files that were not found, or ``None`` if ``v`` is less
+              than 3; the first element of the list is an empty string.
+            a: list of paths to directories that were recursed into, or ``None`` if
+              ``v`` is less than 4; the first element of the list is an empty string.
+            b: list of empty file paths, or ``None`` if ``v`` is less than 5; the first
+              element of the list is an empty string.
+            e: list of paths to archives that were recursed into, or ``None`` if
+              ``v`` is less than 4; the first element of the list is an empty string.
+            r: list of 2-tuples representing non-empty files and their sizes, or
+              ``None`` if ``v`` is less than 2.
+            w: list of I/O errors when processing non-missing files, or ``None`` if
+              ``v`` is less than 3.
             x: number of files that were not found.
             y: number of non-empty files.
             d: number of I/O errors encountered.
@@ -72,7 +80,7 @@ class ReporterABC(metaclass=a.ABCMeta):
             x: whether any files or directories were absent and
               :ref:`-m <check-empty--m>` /
               :ref:`--may-not-exist <check-empty---may-not-exist>` was omitted
-            d: whether any :exc:`OSError` was caught while processing files.
+            d: whether any :exc:`OSError` were caught while processing files.
 
         Returns:
             An integer derived from the arguments, which will be returned by

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/reporter/dct.py

@@ -138,3 +138,6 @@ class SelfReporter(DictReporter):
             This is only implemented at type-check time because the exact attributes
             and their types are not statically known.
             """
+
+
+del TYPE_CHECKING

{check_empty-3.0.0 → check_empty-4.0.0}/check_empty/reporter/exceptions.py

@@ -37,7 +37,11 @@ class ReporterError(Exception):
 
 
 class NoReport(ReporterError):
-    """A delayed reporter was asked to report but had nothing to report."""
+    """Raised by a :class:`check_empty.reporter.abcdef.DelayedReporterMixin`.
+
+    The error is due to no data having been collected to report when the reporter was
+    asked to report.
+    """
 
     reporter: DelayedReporterMixin
     """The reporter concerned."""
@@ -52,7 +56,7 @@ class IncorrectKeynames(ReporterError):
 
 
 class IncorrectKeynamesLength(IncorrectKeynames):
-    """The length of ``keys`` was not 13."""
+    """The length of ``keys`` was not equal to 13."""
 
     message = 'keys must have length 13'
 

{check_empty-3.0.0 → check_empty-4.0.0}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["uv_build>=0.12.19"]
+requires = ["uv_build>=0.13.0"]
 build-backend = "uv_build"
 
 [dependency-groups]
@@ -55,7 +55,7 @@ license-files = [
 name = "check-empty"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "3.0.0"
+version = "4.0.0"
 
 [[project.authors]]
 name = "Jonathan Dung"
@@ -68,7 +68,7 @@ email = "jonathandung@yahoo.com"
 [project.optional-dependencies]
 7z = ["py7zr==1.1.3"]
 ace = ["acefile==0.6.14"]
-all = ["check-empty[7z,ace,ar,lzh,rar]==3.0.0"]
+all = ["check-empty[7z,ace,ar,lzh,rar]==4.0.0"]
 ar = ["arpy==2.4.0"]
 lzh = ["lhafile==0.3.1"]
 rar = ["rarfile==4.5"]
@@ -77,7 +77,7 @@ rar = ["rarfile==4.5"]
 check-empty = "check_empty.__main__:main"
 
 [tool.ruff]
-required-version = ">=0.16.9"
+required-version = ">=0.17.0"
 target-version = "py310"
 
 [tool.ruff.analyze]
@@ -93,6 +93,7 @@ ignore = [
     "PT",
     "bad-quotes-inline-string",
     "builtin-open",
+    "camelcase-imported-as-lowercase",
     "complex-structure",
     "error-suffix-on-exception-name",
     "import-outside-top-level",
@@ -152,8 +153,14 @@ possibly-unresolved-reference = "ignore"
 redundant-condition = "ignore"
 unsound-assignment = "ignore"
 
+[[tool.ty.overrides]]
+include = ["check_empty/reporter/exceptions.py"]
+
+[tool.ty.overrides.rules]
+invalid-mutable-override = "ignore"
+
 [tool.uv]
-required-version = ">=0.12.19"
+required-version = ">=0.13.0"
 
 [tool.uv.build-backend]
 module-name = "check_empty"

{check_empty-3.0.0 → check_empty-4.0.0}/pyproject.toml.orig

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["uv_build>=0.12.19"]
+requires = ["uv_build>=0.13.0"]
 build-backend = "uv_build"
 
 [dependency-groups]
@@ -16,12 +16,12 @@ maintainers = [{name = "Jonathan Dung", email = "jonathandung@yahoo.com"}]
 name = "check-empty"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "3.0.0"
+version = "4.0.0"
 
 [project.optional-dependencies]
 "7z" = ["py7zr==1.1.3"]
 ace = ["acefile==0.6.14"]
-all = ["check-empty[7z,ace,ar,lzh,rar]==3.0.0"]
+all = ["check-empty[7z,ace,ar,lzh,rar]==4.0.0"]
 ar = ["arpy==2.4.0"]
 lzh = ["lhafile==0.3.1"]
 rar = ["rarfile==4.5"]
@@ -30,7 +30,7 @@ rar = ["rarfile==4.5"]
 check-empty = "check_empty.__main__:main"
 
 [tool.ruff]
-required-version = ">=0.16.9"
+required-version = ">=0.17.0"
 target-version = "py310"
 
 [tool.ruff.analyze]
@@ -40,7 +40,7 @@ type-checking-imports = false
 quote-style = "single"
 
 [tool.ruff.lint]
-ignore = ["COM", "FBT", "PT", "bad-quotes-inline-string", "builtin-open", "complex-structure", "error-suffix-on-exception-name", "import-outside-top-level", "incorrect-blank-line-before-class", "meta-class-abc-meta", "multi-line-summary-second-line", "non-empty-init-module", "os-replace"]
+ignore = ["COM", "FBT", "PT", "bad-quotes-inline-string", "builtin-open", "camelcase-imported-as-lowercase", "complex-structure", "error-suffix-on-exception-name", "import-outside-top-level", "incorrect-blank-line-before-class", "meta-class-abc-meta", "multi-line-summary-second-line", "non-empty-init-module", "os-replace"]
 preview = true
 select = ["ALL"]
 
@@ -81,8 +81,12 @@ missing-override-decorator = "ignore"
 include = ["check_empty/__init__.py"]
 rules = {possibly-unresolved-reference = "ignore", redundant-condition = "ignore", unsound-assignment = "ignore"}
 
+[[tool.ty.overrides]]
+include = ["check_empty/reporter/exceptions.py"]
+rules = {invalid-mutable-override = "ignore"}
+
 [tool.uv]
-required-version = ">=0.12.19"
+required-version = ">=0.13.0"
 
 [tool.uv.build-backend]
 module-name = "check_empty"