Python utility designed to enable dynamic loading and processing of files.
Project description
DataLoader
Table of Contents
Requirements
-
Python
: ~=3.10 -
pytest
: ~=7.4.3 -
setuptools
: ~=68.2.2 -
pandas
: ~=2.2.0
This project mandates the use of
Python 3.7
or later versions. Compatibility issues have been identified with the use for dataclasses inPython 3.6
and earlier versions.
Getting Started
Installation Methods
Cloning the Repository
- Clone the repository.
- Install the required dependencies
pip install -r requirements.txt
Install via pip
pip install dynamic-loader
pip install -r requirements.txt
Overview.
The DataLoader project is a comprehensive utility that facilitates the efficient loading and processing of data from specified directories. This project is designed to be user-friendly and easy to integrate into your projects.
The DataMetrics class focuses on processing data paths and gathering statistics related to the file system and specified paths. Also allows the ability to export all statistics to a JSON file.
The Extensions class is a utility that provides a set of default file extensions for the DataLoader
class. Its the back-bone for mapping all file extensions to its respective loading method.
Features
DataLoader
The DataLoader
class is specifically designed for loading and processing data from directories. It provides the following key features:
Key Features:
- Dynamic Loading: Load files from a single directory or merge files from multiple directories.
- Flexible Configuration: Set various parameters, such as default file extensions, full POSIX paths, method loader execution, and more.
- Parallel Execution: Leverage parallel execution with the
total_workers
parameter to enhance performance. - Custom Loaders: Implement custom loaders for specific file extensions.
- Please note that at the moment, the loading methods kwargs will be uniformly applied to all files with the specified extension.
- Additionally, the first parameter of the loader method is automatically passed and should be skipped. If passed, the loader will fail and return the contents of the file as
TextIOWrapper
.
Future updates will include the ability to specify what loader method to use for a specific files efficiently.
Parameters:
path
(str or Path): The path of the directory from which to load files.directories
(Iterable): An iterable of directories from which to all files.default_extensions
(Iterable): Default file extensions to be processed.full_posix
(bool): Indicates whether to display full POSIX paths.no_method
(bool): Indicates whether to skip loading method matching execution.verbose
(bool): Indicates whether to display verbose output.generator
(bool): Indicates whether to return the loaded files as a generator; otherwise, returns as a dictionary.total_workers
(int): Number of workers for parallel execution.ext_loaders
(dict[str, Any, dict[key-value]]): Dictionary containing extensions mapped to specified loaders. (Refer to the Extensions class for more information)
Class & Property Methods:
load_file
(class_method): Load a specific file.get_files
(class_method): Retrieve files from a directory based on default extensions and filters unwanted files.dir_files
(property): Loaded files from specified directories.files
(property): Loaded files from a single directoryall_exts
(property): Retrieve all supported file extensions with their respective loader methods being used.EXTENSIONS
(Extensions class instance): Retrieve all default supported file extensions with their respective loader methods.
DataMetrics
The DataMetrics
class focuses on processing data paths and gathering statistics related to the file system. Key features include:
Key Features:
- OS Statistics: Retrieve detailed statistics for each path, including symbolic link status, calculated size, and size in bytes.
- Export to JSON: Export all statistics to a JSON file for further analysis and visualization.
Parameters:
paths
(Iterable): Paths for which to gather statistics.file_name
(str): The file name to be used when exporting all files metadata stats.full_posix
(bool): Indicates whether to display full POSIX paths.
Property Methods:
all_stats
: Retrieve statistics for all paths.total_size
: Calculate the total size of all paths.total_files
: Calculate the total number of files in all paths.export_stats()
: Export all statistics to a JSON file.
OS Stats Results:
os_stats_results
: OS statistics results for each path.- Custom Stats:
st_fsize
: Full file size statistics.st_vsize
: Full volume size statistics.
Extensions
:
The Extensions
class is a utility that provides a set of default file extensions for the DataLoader
class. Its the back-bone for mapping all file extensions to its respective loading method. All extensions are stored in a dictionary (no period included), and the Extensions
class provides the following key features:
Key Features:
- File Extension Mapping: Retrieve all supported file extensions with their respective loader methods.
- Loader Method Retrieval: Retrieve the loader method for a specific file extension.
- Loader Method Check: Check if a specific file extension has a loader method implemented that's not
open
. - Supported Extension Check: Check if a specific file extension is supported.
- Customization: Customize the
Extensions
class with new files extensions and its respective loader methods.
Parameters:
- No parameters are required for the
Extensions
class. Extensions()
: Initializes theExtensions
class with all implemented file extensions and their respective loader methods.- Acts as a dictionary for accessing supported file extensions and their loader methods via Extensions().ALL_EXTS.
Class Methods:
ALL_EXTS
: Retrieve all supported file extensions with their respective loader methods.get_loader
: Retrieve the loader method for a specific file extension.has_loader
: Checks if a specific file extension has a loader method implemented thats notopen
.is_supported
: Checks if a specific file extension is supported.customize
: Customize theExtensions
class with new files extensions and its respective loader methods.- Specified loading method will be converted to a lambda function to support kwargs.
- The first parameter of the loader method is automatically passed and should be skipped. If passed, the loader will fail and return the contents of the file as
TextIOWrapper
. - Future updates will include the ability to specify what loader method to use for a specific files efficiently.
- The loader method kwargs will be uniformly applied to all files with the specified extension.
- Example:
# Structure: {extension: {loader_method: {kwargs}}} ext_loaders = {"csv": {pd.read_csv: {"header": 10}}}
Usage:
DataLoader
Usage
from dynamic_loader import DataLoader
# Load files from a single directory
dl = DataLoader(path="path/to/directory")
print(dl.files) # Loaded files from a single directory (returns as a generator object)
# Load files from multiple directories
dl = DataLoader(directories=["path/to/directory1", "path/to/directory2"])
print(dl.dir_files) # Loaded files from specified directories (returns as a generator object)
# Load a specific file
file = DataLoader.load_file("path/to/file")
print(file) # Loaded file
# Parameter Configuration
dl = DataLoader(path="path/to/directory", total_workers=200, default_extensions=[".csv", ".json"], generator=False, verbose=True)
print(dl.files) # Loaded files from a single directory with specified parameters (returns as a dictionary (_SpecialGenRepr) object)
dl = DataLoader(directories=["path/to/directory1", "path/to/directory2"], total_workers=200, default_extensions=["csv", "json"], generator=False, verbose=True)
# Load files from a single directory with specified extensions and parameters (returns as a dictionary (_SpecialGenRepr) object)
dl = DataLoader(directories=["path/to/directory1", "path/to/directory2"], ext_loaders={"csv": {pd.read_csv: {"header": 10}}, "json": {pd.read_json: {}}})
# Loaded files from specified directories with specified loader methods (returns as a generator (_SpecialGenRepr) object)
DataMetrics
Usage
from dynamic_loader import DataMetrics
# Retrieve statistics for all paths
dm = DataMetrics(files=["path/to/directory1", "path/to/directory2"])
print(dm.all_stats) # Retrieve statistics for all paths
# Calculate the total size of all paths
print(dm.total_size) # Calculate the total size of all paths
# Calculate the total number of files in all paths
print(dm.total_files) # Calculate the total number of files in all paths
dm.export_stats() # Export all statistics to a JSON file
Extensions
Usage
from dynamic_loader import Extensions
ALL_EXTS = Extensions() # Initializes the Extensions class or use the default instance Extensions().ALL_EXTS
print("csv" in ALL_EXTS) # True
print(ALL_EXTS.get_loader("csv")) # <function read_csv at 0x7f8e3e3e3d30>
# or
print(ALL_EXTS.get_loader(".pickle")) # <function read_csv at 0x7f8e3e3e3d30>
print(ALL_EXTS.has_loader("docx")) # False
print(ALL_EXTS.is_supported("docx")) # True
ALL_EXTS.customize({"docx": {open: {mode="rb"}},
"png": {PIL.Image.open: {}}}) # Customize the Extensions class with a new file extension and loader method
print(ALL_EXTS.get_loader("docx")) # <function <lambda> at 0x7f8e3e3e3d30>
Output Example
DataLoader((all-duas.json, <Dict>),
(ara_eng.txt, <Str>),
(milestones.pdf, <ExtractPages>),
(islamic_facts.csv, <DataFrame>),
(SOURCES.md, <TextIOWrapper>),
(islam-laws.docx, <Open>),
(db_config.ini, <ConfigParser>),
(allahs_names.csv, <DataFrame>),
(The Road to Peace and Salvation.html, <Open>),
(arabic_numbers.csv, <DataFrame>),
(all-surah-meanings.json, <Dict>)
)
dm = DataMetrics((path/to/directory1, <Dict>),
(path/to/directory2, <Dict>)
)
dm[path/to/directory1] -> {**os_stats_results,
'st_fsize': Stats(symbolic='6.20 KB', calculated_size=6.19921875, bytes_size=6348), 'st_vsize': {'total': Stats(symbolic='465.63 GB (Gigabytes)', calculated_size=465.62699127197266, bytes_size=499963174912), 'used': Stats(symbolic='131.60 GB (Gigabytes)', calculated_size=131.59552001953125, bytes_size=141299613696), 'free': Stats(symbolic='334.03 GB (Gigabytes)', calculated_size=334.0314712524414, bytes_size=358663561216)}}
dm.export_stats() # Exported all statistics to a JSON file (all_metadata_stats.json))
print(dm.total_size) # Calculate the total size of all paths
print(dm.total_files) # Calculate the total number of files in all paths
Future Updates
- Implement support for specifying what loader method to use for a specific file extension.
- Add support for loader method kwarg parameters.
- Add support for customizing the
Extensions
class with new file extensions and its respective loader methods. - Implement support for specifying what loader method to use for specific files efficiently rather than uniformly.
- Add support for specifying what loader method to use for a specific file.
- Allow special representation of the loaded files to show all contents rather than the type of the data.
- Add more tests to cover all implemented features.
- Add test for
ext_loaders
parameter.
- Add test for
- Add loading method and kwargs support for
load_file
class method.
Feedback
Feedback is crucial for the improvement of the DataLoader
project. If you encounter any issues, have suggestions, or want to share your experience, please consider the following channels:
-
GitHub Issues: Open an issue on the GitHub repository to report bugs or suggest enhancements.
-
Contact: Reach out to the project maintainer via the following:
Contact Information
- [Discord](https://discord.com/users/581590351165259793)
- [Gmail](yousefzahrieh17@gmail.com)
Your feedback and contributions play a significant role in making the
DataLoader
project more robust and valuable for the community. Thank you for being part of this endeavor!
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.