API reference

This page provides an auto-generated summary of filefishers’ API.

FileFinder

FileFinder(path_pattern, file_pattern, *[, ...])
create_path_name([keys])	build path (folder) name from keys
create_file_name([keys])	build file name from keys
create_full_name([keys])	build full (folder + file) name from keys
find_paths([keys, on_parse_error, on_empty])	find files in the file system using the file and path (folder) pattern
find_files([keys, on_parse_error, on_empty])	find files in the file system using the file pattern
find_single_path([keys])	find exactly one path in the file system using the path pattern
find_single_file([keys])	find exactly one file in the file system using the file and path pattern

FileContainer

FileContainer(df)
meta	Return metadata as list of dictionaries
paths	Return paths as list
items()	Return a generator of (path, metadata) tuples
search(**query)	subset paths given a search query
concat(other[, drop_duplicates])	concatenate two FileContainers

Filters

priority_filter(obj, column, order, *[, ...])

filter a dataframe on for nonunique entries according to a priority list