- Notifications
You must be signed in to change notification settings - Fork6
Function decorators for Pandas Dataframe column name and data type validation
License
ThoughtWorksInc/daffy
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Working with DataFrames often means passing them through multiple transformation functions, making it easy to lose track of their structure over time. Daffy adds runtime validation and documentation to your DataFrame operations through simple decorators. By declaring the expected columns and types in your function definitions, you can:
@df_in(columns=["price","bedrooms","location"])@df_out(columns=["price_per_room","price_category"])defanalyze_housing(houses_df):# Transform raw housing data into price analysisreturnanalyzed_df
Like type hints for DataFrames, Daffy helps you catch structural mismatches early and keeps your data pipeline documentation synchronized with the code. Compatible with both Pandas and Polars.
- Validate DataFrame columns at function entry and exit points
- Support regex patterns for matching column names (e.g.,
"r/column_\d+/") - Check data types of columns
- Control strictness of validation (allow or disallow extra columns)
- Works with both Pandas and Polars DataFrames
- Project-wide configuration via pyproject.toml
- Integrated logging for DataFrame structure inspection
- Enhanced type annotations for improved IDE and type checker support
- Usage Guide - Detailed usage instructions
- Development Guide - Guide for contributing to Daffy
- Changelog - Version history and release notes
Install with your favorite Python dependency manager:
pip install daffy
fromdaffyimportdf_in,df_out@df_in(columns=["Brand","Price"])# Validate input DataFrame columns@df_out(columns=["Brand","Price","Discount"])# Validate output DataFrame columnsdefapply_discount(cars_df):cars_df=cars_df.copy()cars_df["Discount"]=cars_df["Price"]*0.1returncars_df
MIT
About
Function decorators for Pandas Dataframe column name and data type validation
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.