Skip to main content

pathfinder – a simpler os.walk

Project description

A utility to find file paths.

https://snyk.io/test/github/jkeyes/pathfinder/badge.svg

https://travis-ci.org/jkeyes/pathfinder.png?branch=master

https://static.deepsource.io/deepsource-badge-light.svg

Examples

from pathfinder import find_paths

# get all directories and sub-directories in current directory
paths = find_paths(".", just_dirs=True)

# get all files in the current directory and all sub-directories
paths = find_paths(".", just_files=True)

# get all jpg files using a regex
paths = find_paths(".", regex=".*\.jpg$")

# get all jpg files using posix wildcards
paths = find_paths(".", fnmatch="*.jpg")

# get all jpg files and png files
from pathfinder import FnmatchFilter
from pathfinder import OrFilter
jpg_filter = FnmatchFilter("*.jpg")
png_filter = FnmatchFilter("*.png")
gif_filter = FnmatchFilter("*.gif")
image_filter = OrFilter(jpg_filter, png_filter, gif_filter)
paths = find_paths(".", filter=image_filter)

# shortcut using bitwise or
paths = find_paths(".", filter=jpg_filter | png_filter | gif_filter)

# even shorter using ImageFilter to find all images
from pathfinder import ImageFilter
paths = find_paths(".", filter=ImageFilter())

# and an even shorter way
paths = ImageFilter().find(".")

Installation

To install pathfinder, simply:

$ pip install pathfinder

Development

To install development dependencies run:

$ pip install -r dev-requirements.txt

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

pathfinder-0.6.2.tar.gz (4.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page