pfdo 6.0.0__py3-none-any.whl

pfdo/__init__.py

@@ -0,0 +1,37 @@
+"""pfdo: walk a directory tree with pftree and do something in every directory.
+
+The base class of a family of tools, each doing one thing per directory of an input
+tree and writing results to the same place in an output tree. ``Pfdo`` is a
+``Pftree`` whose callbacks are meant to be overridden, plus the family's shared
+``--analyzeFileIndex`` choice of which files the analyze step gets.
+
+Key components:
+    - Pfdo: the base class
+    - PfdoOptions: pftree's options plus pfdo's
+    - fileIndex_select: the ``--analyzeFileIndex`` rule
+    - __main__: the ``pfdo`` command line, its manual, and the parts a package
+      built on pfdo assembles its own from
+
+Typical usage:
+    from pfdo import Pfdo, PfdoOptions
+    Pfdo(PfdoOptions(inputDir=Path("/in"), outputDir=Path("/out"), testRun=True)).run()
+
+Dependencies:
+    - pftree
+"""
+
+from __future__ import annotations
+
+__version__: str = "6.0.0"
+
+from pfdo.models import PfdoOptions, fileIndex_validate
+from pfdo.pfdo import ANALYZED_PREFIX, Pfdo, fileIndex_select
+
+__all__ = [
+    "ANALYZED_PREFIX",
+    "Pfdo",
+    "PfdoOptions",
+    "__version__",
+    "fileIndex_select",
+    "fileIndex_validate",
+]

pfdo/__main__.py

@@ -0,0 +1,331 @@
+"""The ``pfdo`` command line and its manual.
+
+``pfdo`` on its own walks a tree, applies the filters, and with ``--test`` runs the
+base class's demonstration callbacks. Its parser and manual are assembled from
+pftree's parts plus pfdo's own, and are themselves exposed in parts so a package
+built on pfdo can assemble its own.
+
+Key components:
+    - CLI_SELF, ARGS_SYNOPSIS_SELF, EXAMPLES: pfdo's manual pieces
+    - CLI_FULL, CLI_DS, ARGS_SYNOPSIS_FULL, ARGS_SYNOPSIS_DS: the assembled pieces,
+      standalone and ChRIS-DS style
+    - synopsis: the manual text for a command built on pfdo
+    - manual_build: the page, rendered through ``pftree.manual``
+    - parserSelf_build / parser_build: the argument parsers
+    - main: the entry point, honouring an explicit ``argv``
+
+Typical usage:
+    pfdo --inputDir /data --outputDir /tmp/out --fileFilter jpg --test --json
+    pfdo --man
+
+Dependencies:
+    - pftree (its CLI parts and manual renderer)
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+from collections.abc import Sequence
+
+from pftree.__main__ import (
+    ARGS_SYNOPSIS_CORE,
+    ARGS_SYNOPSIS_DS,
+    ARGS_SYNOPSIS_IO,
+    CLI_CORE,
+    CLI_DS_IO,
+    CLI_IO_CORE,
+    logging_configure,
+    parserCore_build,
+    parserIO_build,
+)
+from pftree.manual import Manual, manual_print
+from pftree.models import RunResult
+
+from pfdo import __version__
+from pfdo.models import PfdoOptions
+from pfdo.pfdo import Pfdo
+
+BANNER_ART: str = r"""
+
+                                  __      _
+                                 / _|    | |
+                          _ __  | |_   __| |  ___
+                         | '_ \ |  _| / _` | / _ \
+                         | |_) || |  | (_| || (_) |
+                         | .__/ |_|   \__,_| \___/
+                         | |
+                         |_|
+
+"""
+
+BANNER_TITLE: str = "Path-File Do (something)"
+
+BANNER_TEXT: str = """
+                          Path-File Do (something)
+
+        Recursively walk down a directory tree and perform some operation
+        on files in each directory (optionally filtered by some simple
+        expression). Results of each operation are saved in output tree
+        that  preserves the input directory structure.
+
+                             -- version {version} --
+
+        'pfdo' is the base infrastructure app/class for walking down some
+        dir tree, optionally finding and tagging files that conform to
+        a simple filter, and running (something) on the files. This class
+        provides the basic mechanism for using pftree in this manner and the
+        (something) operation should be provided by a subclass of this base.
+
+        As part of the "pf*" suite of applications, it is geared to IO as
+        directories. Nested directory trees within some input directory
+        are reconstructed in an output directory, preserving directory
+        structure.
+
+        In many ways, this module is a slight variation on 'pftree' on which
+        it builds. It can be thought of as less of a descendent and more of a
+        sibling.
+
+"""
+
+CLI_SELF: str = """
+        [--analyzeFileIndex <a|f|l|m|N>]                                        \\
+        [--test]                                                                \\"""
+
+ARGS_SYNOPSIS_SELF: str = """
+        [--test]
+        If specified, run the "dummy" internal callback loop triad. The test
+        flow simply tags files in some inputDir tree and "touches" them to a
+        reconstituted tree in the output directory, prefixed with the text
+        "analyzed-". An output file that already exists stops that directory
+        unless --overwrite is given.
+
+        [--analyzeFileIndex <a|f|l|m|N>]
+        An optional string to further "filter" the list of files that have
+        been detected to analyze. This is useful for certain operations
+        that might need only one file in an input directory to start but
+        then once started will self consume multiple files independently
+        of the external controller. The default is "a" which implies
+        *ALL* files in a given directory. The set of valid values:
+
+            "a":    "all" files.
+            "m":    only the "middle" file in the file list
+            "f":    only the "first" file in the file list
+            "l":    only the "last" file in the file list
+            "<N>":  only the file at index N in the file list. This index
+                    can "wrap" in the positive and negative direction and
+                    can exceed the actual list length (in which case it is
+                    mapped back into the original list).
+
+                    Pedantically, in the negative direction:
+                        '-1' will mean the last file, while
+                        -<listLen> will mean the first file again
+                        -<listLen+1> will mean the last file again
+                        etc...
+                    and in the positive direction:
+                        <listLen> will mean the first file
+                        <listLen>*2 will mean the first file
+                        etc...
+"""
+
+EXAMPLES: str = """
+
+    EXAMPLES
+
+    Perform a `pfdo` down some input directory:
+
+        pfdo                                                                    \\
+            --inputDir /var/www/html/data                                       \\
+            --fileFilter jpg                                                    \\
+            --outputDir /tmp/jpg                                                \\
+            --test --json                                                       \\
+            --threads 0 --printElapsedTime
+
+    The above will find all files in the tree structure rooted at
+    /var/www/html/data that also contain the string "jpg" anywhere
+    in the filename. For each file found, a corresponding file will
+    be touched in the output directory, in the same tree location as
+    the original input. This touched file will be prefixed with the
+    string "analyzed-".
+
+        pfdo                                                                    \\
+            --inputDir $PWD/raw                                                 \\
+            --dirFilter 100307                                                  \\
+            --outputDir $PWD/out --test --json                                  \\
+            --analyzeFileIndex m                                                \\
+            --threads 0 --printElapsedTime
+
+    Here, only the middle file in (all) directories whose path contains
+    the string ``100307`` will be targetted.
+
+    Finally the elapsed time and a JSON output are printed.
+
+"""
+
+CLI_FULL: str = CLI_IO_CORE + CLI_SELF + CLI_CORE
+ARGS_SYNOPSIS_FULL: str = ARGS_SYNOPSIS_IO + ARGS_SYNOPSIS_SELF + ARGS_SYNOPSIS_CORE
+CLI_DS: str = CLI_DS_IO + CLI_SELF + CLI_CORE
+ARGS_SYNOPSIS_DS: str = ARGS_SYNOPSIS_DS + ARGS_SYNOPSIS_SELF + ARGS_SYNOPSIS_CORE
+
+DESCRIPTION: str = """
+    DESCRIPTION
+
+        ``pfdo`` provides the base mechanism for navigating some arbitrary
+        tree, providing the base hooks for operating on (possibly filtered)
+        files in each directory, and saving results in an output tree that
+        reflects the input tree topology.
+
+        A subclass overrides the inputAnalyze_callback and outputSave_callback
+        methods (each receives the DirNode for a directory and returns a
+        StageResult) and sets processAlways; ``pfdo`` itself only runs its
+        demonstration callbacks under --test.
+"""
+
+
+def synopsis(shortOnly: bool = False, command: str = "pfdo") -> str:
+    """Assemble the manual text.
+
+    Args:
+        shortOnly: NAME, SYNOPSIS and a brief example only.
+        command: the command name shown, for a package built on pfdo.
+
+    Returns:
+        The manual text, without the banner.
+    """
+    shortSynopsis: str = (
+        f"""
+    NAME
+
+        {command}
+
+    SYNOPSIS
+
+        {command} \\"""
+        + CLI_FULL
+        + f"""
+
+    BRIEF EXAMPLE
+
+        {command}                                                                    \\
+            --inputDir /var/www/html/data                                       \\
+            --fileFilter jpg                                                    \\
+            --outputDir /var/www/html/jpg                                       \\
+            --threads 0 --printElapsedTime --test
+    """
+    )
+    if shortOnly:
+        return shortSynopsis
+    return shortSynopsis + DESCRIPTION + "\n    ARGS " + ARGS_SYNOPSIS_FULL + EXAMPLES
+
+
+def manual_build() -> Manual:
+    """The pfdo manual page.
+
+    Returns:
+        The page, with both synopses assembled.
+    """
+    return Manual(
+        command="pfdo",
+        art=BANNER_ART,
+        title=BANNER_TITLE,
+        text=BANNER_TEXT,
+        version=__version__,
+        synopsisShort=synopsis(shortOnly=True),
+        synopsisFull=synopsis(shortOnly=False),
+    )
+
+
+def parserSelf_build() -> argparse.ArgumentParser:
+    """pfdo's own options.
+
+    Returns:
+        A parent parser with ``--test`` and ``--analyzeFileIndex``.
+    """
+    parser: argparse.ArgumentParser = argparse.ArgumentParser(add_help=False)
+    parser.add_argument("--test", dest="testRun", action="store_true", help="run the demonstration callbacks")
+    parser.add_argument(
+        "--analyzeFileIndex",
+        dest="analyzeFileIndex",
+        default="a",
+        help="which files per directory the analyze step gets: a (all), f, l, m, or an index",
+    )
+    return parser
+
+
+def parser_build(standalone: bool = True) -> argparse.ArgumentParser:
+    """Assemble the full parser.
+
+    Args:
+        standalone: include ``--inputDir`` / ``--outputDir``. A ChRIS DS plugin
+            passes False and adds its own positional directories.
+
+    Returns:
+        The parser; ``--help`` is the quick reference and points at ``--man``.
+    """
+    parents: list[argparse.ArgumentParser] = [parserCore_build("pfdo", __version__), parserSelf_build()]
+    if standalone:
+        parents.insert(0, parserIO_build())
+    return argparse.ArgumentParser(
+        prog="pfdo",
+        description="Walk a directory tree and do something in every directory. Full manual: pfdo --man",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        parents=parents,
+    )
+
+
+def options_fromArgs(args: argparse.Namespace) -> PfdoOptions:
+    """Turn parsed arguments into options.
+
+    Args:
+        args: the parser's Namespace.
+
+    Returns:
+        PfdoOptions with every known field applied.
+    """
+    return PfdoOptions.fromDict(vars(args))
+
+
+def result_report(args: argparse.Namespace, result: RunResult) -> None:
+    """Print what the arguments asked for.
+
+    Args:
+        args: the parsed arguments.
+        result: the run's result.
+    """
+    if args.json:
+        print(json.dumps(result.toDict(), indent=4, sort_keys=True))
+    if args.printElapsedTime:
+        print(f"Elapsed time = {result.runTime:.6f} seconds")
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    """Run the command.
+
+    Args:
+        argv: arguments without the program name; ``None`` reads ``sys.argv``.
+
+    Returns:
+        The exit code: 0 on success, 1 when the run failed, 2 on bad arguments.
+    """
+    parser: argparse.ArgumentParser = parser_build()
+    args: argparse.Namespace = parser.parse_args(argv)
+    if args.man or args.synopsis:
+        manual_print(manual_build(), shortOnly=not args.man)
+        return 0
+    if not args.inputDir:
+        parser.error("--inputDir is required")
+    try:
+        options: PfdoOptions = options_fromArgs(args)
+    except ValueError as err:
+        parser.error(str(err))
+    logging_configure(options.verbosity)
+    result: RunResult = Pfdo(options).run()
+    result_report(args, result)
+    if result.error:
+        print(result.error, file=sys.stderr)
+    return 0 if result.status else 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pfdo/models.py

@@ -0,0 +1,75 @@
+"""The data models of pfdo.
+
+pfdo adds two options to pftree's: which file(s) in each directory the analyze
+callback should work on, and whether the base class's demonstration callbacks run.
+Everything else, from the input and output directories to the filters and threads,
+is pftree's ``TreeOptions``.
+
+Key components:
+    - PfdoOptions: ``TreeOptions`` plus ``analyzeFileIndex`` and ``testRun``
+    - fileIndex_validate: the grammar of ``--analyzeFileIndex``
+
+Typical usage:
+    options = PfdoOptions.fromDict(vars(args))
+    Pfdo(options).run()
+
+Dependencies:
+    - pftree.models
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from pftree.models import TreeOptions
+
+FILE_INDEX_ALL: str = "a"
+FILE_INDEX_FIRST: str = "f"
+FILE_INDEX_LAST: str = "l"
+FILE_INDEX_MIDDLE: str = "m"
+FILE_INDEX_WORDS: tuple[str, ...] = (FILE_INDEX_ALL, FILE_INDEX_FIRST, FILE_INDEX_LAST, FILE_INDEX_MIDDLE)
+
+
+def fileIndex_validate(spec: str) -> None:
+    """Check an ``--analyzeFileIndex`` value.
+
+    Args:
+        spec: ``a``, ``f``, ``l``, ``m`` or an integer, possibly negative.
+
+    Raises:
+        ValueError: for anything else.
+    """
+    if spec in FILE_INDEX_WORDS:
+        return
+    try:
+        int(spec)
+    except ValueError as err:
+        raise ValueError(f"analyzeFileIndex must be a, f, l, m or an integer, not {spec!r}") from err
+
+
+@dataclass
+class PfdoOptions(TreeOptions):
+    """pftree's options plus pfdo's own.
+
+    Attributes:
+        analyzeFileIndex: which of a directory's files the analyze callback gets:
+            ``a`` all (the default), ``f`` the first, ``l`` the last, ``m`` the
+            middle, or an integer index that wraps in either direction.
+        testRun: run the base class's demonstration callbacks over the tree.
+
+    Example:
+        >>> PfdoOptions.fromDict({"inputDir": "/in", "analyzeFileIndex": "-1"}).analyzeFileIndex
+        '-1'
+    """
+
+    analyzeFileIndex: str = FILE_INDEX_ALL
+    testRun: bool = False
+
+    def __post_init__(self) -> None:
+        """Validate pftree's options and then ``analyzeFileIndex``.
+
+        Raises:
+            ValueError: on a bad filter, leaf template or file index.
+        """
+        super().__post_init__()
+        fileIndex_validate(self.analyzeFileIndex)

pfdo/pfdo.py

@@ -0,0 +1,200 @@
+"""pfdo: walk a tree with pftree and do something in every directory.
+
+``Pfdo`` is the base class of a family of tools (pfdo_run, pfdo_med2image and
+others) that each do one thing per directory of an input tree and write their
+results to the same place in an output tree. It is a ``Pftree`` whose three
+callbacks are meant to be overridden, plus one convenience the family shares: the
+``--analyzeFileIndex`` choice of which of a directory's files the analyze step gets.
+
+The base class's own callbacks are a demonstration: read lists the files, analyze
+picks by index and prefixes each name with ``analyzed-``, save touches those names
+in the output directory. ``pfdo --test`` runs them.
+
+Key components:
+    - Pfdo: the base class; override ``inputAnalyze_callback`` and
+      ``outputSave_callback``, set ``processAlways`` to True
+    - fileIndex_select: the ``--analyzeFileIndex`` rule, as a pure function
+
+Typical usage:
+    class Mine(Pfdo):
+        processAlways = True
+
+        def inputAnalyze_callback(self, node: DirNode, read: StageResult) -> StageResult:
+            for name in self.filesToAnalyze(node):
+                ...
+
+    Mine(PfdoOptions.fromDict(vars(args))).run()
+
+Dependencies:
+    - pftree
+"""
+
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+
+from pftree.models import DirNode, ProcessResult, RunResult, StageResult
+from pftree.tree import Pftree
+
+from pfdo.models import (
+    FILE_INDEX_ALL,
+    FILE_INDEX_FIRST,
+    FILE_INDEX_LAST,
+    FILE_INDEX_MIDDLE,
+    PfdoOptions,
+)
+
+logger: logging.Logger = logging.getLogger("pfdo")
+
+ANALYZED_PREFIX: str = "analyzed-"
+
+
+def fileIndex_select(files: list[str], spec: str) -> list[str]:
+    """Pick the files ``--analyzeFileIndex`` names out of a directory's list.
+
+    Args:
+        files: the directory's file names, in order.
+        spec: ``a`` for all, ``f`` first, ``l`` last, ``m`` middle, or an integer.
+            An integer wraps: ``-1`` is the last file, ``len(files)`` the first again.
+
+    Returns:
+        The chosen files, in their original order; empty when ``files`` is empty.
+
+    Raises:
+        ValueError: if ``spec`` is none of the above.
+
+    Example:
+        >>> fileIndex_select(["a", "b", "c"], "m")
+        ['b']
+        >>> fileIndex_select(["a", "b", "c"], "-1")
+        ['c']
+    """
+    if not files:
+        return []
+    match spec:
+        case s if s == FILE_INDEX_ALL:
+            return list(files)
+        case s if s == FILE_INDEX_FIRST:
+            return [files[0]]
+        case s if s == FILE_INDEX_LAST:
+            return [files[-1]]
+        case s if s == FILE_INDEX_MIDDLE:
+            return [files[len(files) // 2]]
+        case _:
+            try:
+                index: int = int(spec)
+            except ValueError as err:
+                raise ValueError(f"analyzeFileIndex must be a, f, l, m or an integer, not {spec!r}") from err
+            return [files[index % len(files)]]
+
+
+class Pfdo(Pftree):
+    """Walk an input tree and run a per-directory read / analyze / save sequence.
+
+    Attributes:
+        options: the PfdoOptions in force.
+        processAlways: a subclass sets this True so ``run`` always runs the
+            callbacks; the base class runs them only under ``--test``.
+
+    Example:
+        >>> tool = Pfdo(PfdoOptions(inputDir=Path("."), outputDir=Path("/tmp/out"), verbosity=0))
+        >>> tool.run().status
+        True
+    """
+
+    processAlways: bool = False
+
+    def __init__(self, options: PfdoOptions) -> None:
+        super().__init__(options)
+        self.options: PfdoOptions = options
+
+    def filesToAnalyze(self, node: DirNode) -> list[str]:
+        """The files of a directory that ``--analyzeFileIndex`` selects.
+
+        Args:
+            node: the directory.
+
+        Returns:
+            The selected names, in order.
+        """
+        return fileIndex_select(node.files, self.options.analyzeFileIndex)
+
+    def inputRead_callback(self, node: DirNode) -> StageResult:
+        """Demonstration read: list the directory's files without opening them.
+
+        Args:
+            node: the directory.
+
+        Returns:
+            Success with the files; failure if there are none.
+        """
+        logger.debug("reading %s: %d files", node.relPath, len(node.files))
+        return StageResult(status=bool(node.files), files=list(node.files))
+
+    def inputAnalyze_callback(self, node: DirNode, read: StageResult) -> StageResult:
+        """Demonstration analyze: select by index and tag each name.
+
+        Args:
+            node: the directory.
+            read: the read stage's result.
+
+        Returns:
+            Success with ``analyzed-<name>`` for every selected file; failure when
+            the index selects nothing.
+        """
+        selected: list[str] = fileIndex_select(read.files, self.options.analyzeFileIndex)
+        logger.debug("analyzing %s: %s", node.relPath, selected)
+        return StageResult(status=bool(selected), files=[ANALYZED_PREFIX + name for name in selected])
+
+    def outputSave_callback(self, node: DirNode, analyze: StageResult) -> StageResult:
+        """Demonstration save: touch each analyzed name in the output directory.
+
+        Args:
+            node: the directory; its ``outputPath`` is created.
+            analyze: the analyze stage's result.
+
+        Returns:
+            Success with the names written. An existing file stops the directory
+            with a failure unless ``overwrite`` is set.
+        """
+        node.outputPath.mkdir(parents=True, exist_ok=True)
+        saved: list[str] = []
+        for name in analyze.files:
+            target: Path = node.outputPath / name
+            if target.exists() and not self.options.overwrite:
+                logger.error("%s exists; run with --overwrite to replace it", target)
+                return StageResult(status=False, files=saved)
+            target.touch()
+            saved.append(name)
+        logger.debug("saved %d files in %s", len(saved), node.outputPath)
+        return StageResult(status=True, files=saved)
+
+    def callbacks_run(self) -> ProcessResult:
+        """Run the three callbacks over the tree."""
+        return self.tree_process(
+            inputRead_callback=self.inputRead_callback,
+            inputAnalyze_callback=self.inputAnalyze_callback,
+            outputWrite_callback=self.outputSave_callback,
+        )
+
+    def run(self) -> RunResult:
+        """Probe, filter, then process when the class or ``--test`` asks for it.
+
+        Returns:
+            The run's result; ``status`` is False with ``error`` set when the input
+            directory is missing, or when processing failed in every directory.
+        """
+        error: str = self.env_check()
+        if error:
+            logger.error(error)
+            return RunResult(status=False, error=error, runTime=self.runTime_get())
+        self.tree_construct(self.tree_probe())
+        if self.fileTokens or self.dirTokens:
+            self.tree_filter()
+        process: ProcessResult | None = None
+        status: bool = True
+        if self.processAlways or self.options.testRun:
+            process = self.callbacks_run()
+            status = process.status
+        return RunResult(status=status, tree=dict(self.tree), process=process, runTime=self.runTime_get())

pfdo-6.0.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: pfdo
+Version: 6.0.0
+Summary: Walk a directory tree with pftree and do something in every directory: the base class of the pfdo family
+Author-email: FNNDSC <dev@babyMRI.org>
+License: MIT
+Project-URL: Homepage, https://github.com/FNNDSC/pfdo
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pftree>=4.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+pfdo
+====
+
+.. image:: https://github.com/FNNDSC/pfdo/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/FNNDSC/pfdo/actions/workflows/ci.yml
+
+.. image:: https://img.shields.io/pypi/v/pfdo.svg
+    :target: https://pypi.org/project/pfdo/
+
+.. image:: https://img.shields.io/badge/python-3.11%2B-blue.svg
+    :target: https://pypi.org/project/pfdo/
+
+Walk a directory tree with ``pftree`` and do something in every directory: the base class of the pfdo family.
+
+.. contents:: Table of Contents
+
+Overview
+--------
+
+``pfdo`` is the base class of a family of tools (``pfdo_run``, ``pfdo_med2image``, ``pfdo_mgz2image`` and others) that each do one thing per directory of an input tree and write their results to the same place in an output tree. It is a ``pftree.Pftree`` whose three callbacks, read, analyze and save, are meant to be overridden, plus one convenience the family shares: ``--analyzeFileIndex``, the choice of which of a directory's files the analyze step gets.
+
+On its own, ``pfdo`` walks a tree, applies ``pftree``'s filters, and with ``--test`` runs its demonstration callbacks: read lists each directory's files, analyze selects by index and prefixes every name with ``analyzed-``, save touches those names in the output directory.
+
+Installation
+------------
+
+.. code:: bash
+
+    pip install pfdo
+
+Python 3.11 or newer; depends on ``pftree``.
+
+Command line
+------------
+
+.. code:: bash
+
+    pfdo --inputDir /data --outputDir /tmp/out --fileFilter jpg --test --json
+    pfdo --inputDir /data --outputDir /tmp/out --dirFilter 100307 --analyzeFileIndex m --test
+    pfdo --man
+
+``pfdo --man`` prints the full manual, ``--synopsis`` its first page, ``--help`` the quick reference. All of ``pftree``'s options apply (``--fileFilter``, ``--dirFilter`` and their logic, ``--maxDepth``, ``--outputLeafDir``, ``--threads``, ``--relativeDir``, ``--followLinks``, ``--overwrite``, ``--json``, ``--printElapsedTime``); ``pfdo`` adds:
+
+``--analyzeFileIndex <a|f|l|m|N>``
+    Which of a directory's files the analyze step receives: ``a`` all (default), ``f`` first, ``l`` last, ``m`` middle, or an integer index that wraps in either direction (``-1`` is the last file, ``len`` the first again).
+
+``--test``
+    Run the demonstration callbacks. An output file that already exists stops that directory unless ``--overwrite`` is given.
+
+Library
+-------
+
+.. code:: python
+
+    from pathlib import Path
+    from pftree.models import DirNode, StageResult
+    from pfdo import Pfdo, PfdoOptions
+
+    class Counter(Pfdo):
+        processAlways = True
+
+        def inputAnalyze_callback(self, node: DirNode, read: StageResult) -> StageResult:
+            chosen = self.filesToAnalyze(node)
+            return StageResult(status=True, files=chosen, payload={"count": len(chosen)})
+
+        def outputSave_callback(self, node: DirNode, analyze: StageResult) -> StageResult:
+            node.outputPath.mkdir(parents=True, exist_ok=True)
+            (node.outputPath / "count.txt").write_text(f"{analyze.payload['count']}\n")
+            return StageResult(status=True, files=["count.txt"])
+
+    result = Counter(PfdoOptions(inputDir=Path("/data"), outputDir=Path("/out"), threads=4)).run()
+
+``PfdoOptions`` is ``pftree.TreeOptions`` plus ``analyzeFileIndex`` and ``testRun``; ``PfdoOptions.fromDict(vars(args))`` builds it from an argparse ``Namespace`` and ignores keys it does not know. A subclass sets ``processAlways = True`` so ``run()`` always runs the callbacks; it calls ``self.filesToAnalyze(node)`` to honour ``--analyzeFileIndex``. ``run()`` returns ``pftree``'s ``RunResult`` (``status``, ``tree``, ``process``, ``runTime``).
+
+For its command line, a package built on pfdo composes ``pfdo.__main__``'s parts: ``parserSelf_build()`` and ``pftree``'s ``parserCore_build()`` / ``parserIO_build()`` for the parser, ``synopsis(command=...)`` or the ``CLI_*`` and ``ARGS_SYNOPSIS_*`` texts for the manual, and ``pftree.manual.Manual`` with ``manual_print`` to render it.
+
+Changes in 6.0
+--------------
+
+- Built on ``pftree`` 4; ``pfmisc`` and ``pudb`` are no longer dependencies.
+- The callbacks are ``inputRead_callback``, ``inputAnalyze_callback`` and ``outputSave_callback``, taking a ``DirNode`` and returning a ``StageResult``, not tuples and dicts.
+- ``--analyzeFileIndex m`` picks the true middle file (index ``len // 2``); 5.x picked one past it for odd-length lists.
+- An existing output file fails that directory and the run continues; 5.x stopped the loop and left the directory half written.
+- ``--test`` maps to ``testRun``; ``pftree``'s own ``--test <seconds>`` is not exposed.
+- ``main(argv)`` honours ``argv``; ``--version``, ``--man`` and ``--synopsis`` exit 0.
+- Packaging is ``pyproject.toml`` only, published from CI on a ``v*`` tag.

pfdo-6.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+pfdo/__init__.py,sha256=0EsMWOqP_UED0Py4sGGz2oRZG3UAGffB52QsUkhsq-M,1155
+pfdo/__main__.py,sha256=Wtt9AfTr3NDMKU4uY6BXf2YaJrWKHXcL9OY461WyguU,11891
+pfdo/models.py,sha256=dFUrH0pig7PH-VtYzRsrf5tlKUnXOjYE54l4NzkO-Hs,2262
+pfdo/pfdo.py,sha256=uQ3pflXjjigs7KLG-MWl5hTNEnCq7GNqZHVQ_nIW1dU,7268
+pfdo-6.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pfdo-6.0.0.dist-info/METADATA,sha256=Mg_b52rRbCqJr7_iRgvVs9N0qCwDK3cDcGjVHekkyEQ,5617
+pfdo-6.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+pfdo-6.0.0.dist-info/entry_points.txt,sha256=hybk6kcGUEbZEyns6EGrrG3gjNWOUikazp2OTdwiPEQ,44
+pfdo-6.0.0.dist-info/top_level.txt,sha256=shX2HON2eRe6QKssvfYouSWv7aH5e61HqAWqN8D2vgk,5
+pfdo-6.0.0.dist-info/RECORD,,

pfdo-6.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pfdo-6.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pfdo = pfdo.__main__:main

pfdo-6.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pfdo-6.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pfdo