Skip to content

Add deprecated filterNotNull for discoverability of dropNulls #1334

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
merged 1 commit into from
Jul 18, 2025
Merged

Add deprecated filterNotNull for discoverability of dropNulls #1334

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions core/api/core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3494,6 +3494,7 @@ public final class org/jetbrains/kotlinx/dataframe/api/NullsKt {
public static final fun fillNulls (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Ljava/lang/String;)Lorg/jetbrains/kotlinx/dataframe/api/Update;
public static final fun fillNulls (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lkotlin/reflect/KProperty;)Lorg/jetbrains/kotlinx/dataframe/api/Update;
public static final fun fillNulls (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/ColumnReference;)Lorg/jetbrains/kotlinx/dataframe/api/Update;
public static final fun filterNotNull (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
}

public final class org/jetbrains/kotlinx/dataframe/api/ParseKt {
Expand Down
9 changes: 9 additions & 0 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/Nulls.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,15 @@ public fun <T> DataFrame<T>.dropNulls(whereAllNull: Boolean = false, columns: Co
}
}

@Refine
@Interpretable("DropNulls0")
@Deprecated(
"DataFrame conventional name for filterNot* functions is drop*",
ReplaceWith("dropNulls(columns = columns)"),
DeprecationLevel.ERROR,
)
public fun <T> DataFrame<T>.filterNotNull(columns: ColumnsSelector<T, *>): DataFrame<T> = dropNulls(columns = columns)
Copy link
Collaborator

@Jolanrensen Jolanrensen Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you annotate something with ERROR, there's no need to write an implementation for it; the function cannot be called.


/**
* @include [CommonDropNullsFunctionDoc]
* This overload operates on all columns in the [DataFrame].
Expand Down
2 changes: 1 addition & 1 deletion docs/StardustDocs/topics/drop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ df.drop { it["weight"] == null || it["city"] == null }

## dropNulls

Remove rows with `null` values
Remove rows with `null` values. This is a DataFrame equivalent of `filterNotNull`.

See [column selectors](ColumnSelectors.md) for how to select the columns for this operation.

Expand Down