Python package that provides a utility function to recursively get files that match a pattern
Project description
Get Files List
Python package that provides a utility function to recursively get files that match a pattern.
Usage
Example of this package usage in a folder with the following structure:
├── LICENSE
├── README.md
├── deploy.sh
└── get_files_list/
│ ├──── __init__.py
│ └──── get_dir_content.py
├── requirements.in
├── requirements.txt
└── setup.py
The following code:
from get_files_list import get_dir_content
# Print every file
print("Print every file\n")
for file in get_dir_content("./"):
print(file)
# Print everyPython file
print("\n\nPrint every Python file\n")
for file in get_dir_content("./", pattern="*.py"):
print(file)
# Print every Python file without the prepended folder name
print("\n\nPrint every Python file without the prepended folder name\n")
for file in get_dir_content("./", prepend_folder_name=False, pattern="*.py"):
print(file)
# Print every file without recursion
print("\n\nPrint every file without recursion\n")
for file in get_dir_content("./", recursive=False):
print(file)
# Print every file that is not a Python file
print("\n\nPrint every file that is not a Python file\n")
for file in get_dir_content("./", exclude_pattern="*.py"):
print(file)
Would output:
Print every file
./LICENSE
./requirements.txt
./get_files_list/get_dir_content.py
./get_files_list/__init__.py
./README.md
./setup.py
./deploy.sh
./requirements.in
Print every python file
./get_files_list/get_dir_content.py
./get_files_list/__init__.py
./setup.py
Print every python file without the prepended folder name
get_files_list/get_dir_content.py
get_files_list/__init__.py
setup.py
Print every file without recursion
./LICENSE
./requirements.txt
./README.md
./setup.py
./deploy.sh
./requirements.in
Print every file that is not a Python file
./LICENSE
./requirements.txt
./README.md
./deploy.sh
./requirements.in
get_dir_content
is a Python generator so the following code would not work:
from get_files_list import get_dir_content
num_py_files = len(get_dir_content("./", pattern="*.py"))
# TypeError: object of type 'generator' has no len()
# You have to explicitely generate a list
num_py_files = len(list(get_dir_content("./", pattern="*.py")))
# This works
This is also valid if you want to order, shuffle or slice the list of files.
Inspiration
This code is inspired by this StackOverflow Question/Answer.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
get_files_list-0.1.0.tar.gz
(3.9 kB
view hashes)
Built Distribution
Close
Hashes for get_files_list-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5213927a80eaf342df000b23c8c23e46f573f2d1639f5f96717e37e65f7475e7 |
|
MD5 | bfb3463a551b552fc2bba0a6b603a6ad |
|
BLAKE2b-256 | 19f94e62394dbfff791226ed1f49958fd9299643f8e13530c69207dbfb1ca279 |