Skip to main content

Run things on paths

Project description

trailrunner

Walk paths and run things

version documentation changelog license build status code coverage

trailrunner is a simple library for walking paths on the filesystem, and executing functions for each file found. trailrunner obeys project level .gitignore files, and runs functions on a process pool for increased performance. trailrunner is designed for use by linting, formatting, and other developer tools that need to find and operate on all files in project in a predictable fashion with a minimal API:

walk() takes a single Path, and generates a list of significant files in that tree:

>>> from trailrunner import walk
>>> sorted(walk(Path("trailrunner")))
[
    PosixPath('trailrunner/__init__.py'),
    PosixPath('trailrunner/__version__.py'),
    PosixPath('trailrunner/core.py'),
    PosixPath('trailrunner/tests/__init__.py'),
    PosixPath('trailrunner/tests/__main__.py'),
    PosixPath('trailrunner/tests/core.py'),
]

run() takes a list of Path objects and a function, and runs that function once for each path given. It runs these functions on a process pool, and returns a mapping of paths to results:

>>> from trailrunner import run
>>> paths = [Path('trailrunner/core.py'), Path('trailrunner/tests/core.py')]
>>> run(paths, str)
{
    PosixPath('trailrunner/core.py'): 'trailrunner/core.py',
    PosixPath('trailrunner/tests/core.py'): 'trailrunner/tests/core.py',
}

walk_and_run() does exactly what you would expect:

>>> from trailrunner import walk_and_run
>>> walk_and_run([Path('trailrunner/tests')], str)
{
    PosixPath('trailrunner/tests/__init__.py'): 'trailrunner/tests/__init__.py',
    PosixPath('trailrunner/tests/__main__.py'): 'trailrunner/tests/__main__.py',
    PosixPath('trailrunner/tests/core.py'): 'trailrunner/tests/core.py',
}

Install

trailrunner requires Python 3.6 or newer. You can install it from PyPI:

$ pip install trailrunner

License

trailrunner is copyright Amethyst Reese, and licensed under the MIT license. I am providing code in this repository to you under an open source license. This is my personal repository; the license you receive to my code is from me and not from my employer. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trailrunner-1.4.0.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

trailrunner-1.4.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file trailrunner-1.4.0.tar.gz.

File metadata

  • Download URL: trailrunner-1.4.0.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for trailrunner-1.4.0.tar.gz
Algorithm Hash digest
SHA256 3fe61e259e6b2e5192f321c265985b7a0dc18497ced62b2da244f08104978398
MD5 ba046917f1562397306b167a6ae62c83
BLAKE2b-256 4d93630e10bacd897daeb9ff5a408f4e7cb0fc2f243e7e3ef00f9e6cf319b11c

See more details on using hashes here.

Provenance

File details

Details for the file trailrunner-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: trailrunner-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for trailrunner-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a286d39f2723f28d167347f41cf8f232832648709366e722f55cf5545772a48e
MD5 a1fb077ad0302c9e61dddf130d7c03fc
BLAKE2b-256 b12921001afea86bac5016c3940b43de3ce4786b0d8337d4ea79bb903c649ce3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page