Skip to main content

Root-agnostic filepath generation

Project description

Purpose

The filepaths module is designed to ease file path navigation in python scripts.

Installation

python -m pip install filepaths

Use

from filepaths import paths


paths = paths(1)

for file in paths.data.filepaths:
    pd.read_csv(file)
    pass

or

from filepaths import Root


root = Root(1).paths()

for file in root.data.filepaths:
    pd.read_csv(file)
    pass

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.

Alternitavely, one can call the function paths() with the same paramaters as the class Root which will return a addict dictionary directly.

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.

Either Root or paths dictionary 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 the example/ as a string.
  • root.example.dirs returns a list of the child directories in example/.
  • root.example.files returns a list of the filenames, as strings, for every file in example/.
  • root.example.filepaths returns a list of the absolute paths, as strings, to every file in example/.

Project details


Download files

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

Files for filepaths, version 0.0.7
Filename, size File type Python version Upload date Hashes
Filename, size filepaths-0.0.7-py3-none-any.whl (3.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page