Skip to content

docs: Document that validate and filter remove excess columns #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
borchero merged 1 commit into from
Jan 28, 2026
Merged

docs: Document that validate and filter remove excess columns #264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions dataframely/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,8 +553,9 @@ def validate(

Returns:
The input eager or lazy frame, wrapped in a generic version of the
input's data frame type to reflect schema adherence. This operation is
guaranteed to maintain input ordering of rows.
input's data frame type to reflect schema adherence. Columns not defined
in the schema are removed from the output. This operation is guaranteed
to maintain input ordering of rows.

Raises:
SchemaError: If `eager=True` and the input data frame misses columns or
Expand Down Expand Up @@ -704,7 +705,8 @@ def filter(
Returns:
A tuple of the validated rows in the input data frame (potentially
empty) and a simple dataclass carrying information about the rows of the
data frame which could not be validated successfully. Just like in polars'
data frame which could not be validated successfully. Columns not defined
in the schema are removed from the output. Just like in polars'
native :meth:`~polars.DataFrame.filter`, the order of rows in the returned
data frame is maintained.

Expand Down
Loading