Root-agnostic filepath generation
Project description
Purpose
The filepaths module is designed to ease file path navigation in python scripts.
Use
from filepaths import Root
root = Root(depth=1).paths()
for file in root.data.files:
pd.read_csv(file)
The root object builds a dictionary of files and directories starting in either the current directory, or depth
levels up. By default, hidden files and folder are ignored, but ignore_hidden
can be set to False
.
The .path()
method returns an addict dictionary. This dictionary inherits the standard dictionary class; it can be accessed with either root[data][files]
or root.data.files
.
The keys 'files', 'dirs', 'path',
and 'filepaths'
are reserved for the dictionary: if there are directories with these names in any of the children directories, an error will be thrown.
Here, root
has a key for every directory in root. Every directory, including root
, has keys for 'files', 'dirs', 'path',
and 'filepaths'
. The values are either another nested dictionary for the dirs
, or:
root.example.path
returns the absolute path to theexample/
as a string.root.example.dirs
returns a list of the child directories inexample/
.root.example.files
returns a list of the filenames, as strings, for every file inexample/
.root.example.filepaths
returns a list of the absolute paths, as strings, to every file inexample/
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for filepaths-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e704d9661e4df552297fc125d64810743db44ae96faada8f340f2cbed5587469 |
|
MD5 | 03555373552380c42b5de935795872ab |
|
BLAKE2b-256 | 25c8f14a028d9b0aedf443797a092fef12bb20bd99247eab5783102ee716612a |