dirstree 0.0.1

Another library for iterating through the contents of a directory

dirstree: an another library for iterating through the contents of a directory

There are many libraries for traversing directories. You can also do this using the standard library. This particular library is very different in that:

• Supports filtering by file extensions.
• Supports filtering in the .gitignore format.
• Natively works with both Path objects from the standard library and strings.

Table of contents

• Installation
• Basic usage

Installation

You can install dirstree using pip:

pip install dirstree

You can also quickly try out this and other packages without having to install using instld.

Basic usage

It's very easy to work with the library in your own code:

• Create a crawler object, passing the path to the base directory and, if necessary, additional arguments.
• Iterate recursively through the files in this directory using the .walk() method.

The simplest code example would look like this:

from dirstree import DirectoryWalker

walker = DirectoryWalker('.')

for file in walker.walk():
    print(file)

Here we output recursively (that is, including the contents of nested directories) all files from the current directory. At each iteration, we get a new Path object.

However, we can iterate not over all files in the directory, but only over files with the extension we need, if we pass the collection with the desired extensions when creating the crawler object:

walker = DirectoryWalker('.', extensions=['.txt'])  # Iterate only on .txt files.

We can also pass a list of exceptions, specifying files or subdirectories for which we will NOT iterate:

walker = DirectoryWalker('.', exclude_patterns=['.git', 'venv'])  # Exclude ".git" and "venv" directories.

Please note that you can specify any files and folders in the .gitignore format.