A python utility to find file paths.
Python Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
pathfinder
tests
.gitignore
.travis.yml
AUTHORS.rst
HISTORY.rst Updating HISTORY. Sep 2, 2013
INSTALL Adding INSTALL instructions. Apr 23, 2012
LICENSE
MANIFEST.in
README.rst
example.py
requirements.txt
setup.py

README.rst

pathfinder

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

A utility to find file paths.

Examples

from pathfinder import find

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

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

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

# get all jpg files using posix wildcards
paths = find(".", 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(".", filter=image_filter)

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

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

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

Installation

To install pathfinder, simply:

$ pip install pathfinder