Skip to content

Squash annotations #1647

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

Open
koperagen wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Squash annotations #1647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dd6f5f
Squash annotations on deprecated access APIs
koperagen Dec 18, 2025
f1aaea7
Squash Refine + Interpretable annotations
koperagen Dec 18, 2025
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
27 changes: 9 additions & 18 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnSelectionDsl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,24 +73,21 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
* @include [CommonKPropertyInvokeDocs]
* @return The [DataColumn] this [KProperty Accessor][KProperty] points to.
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T> KProperty<T>.invoke(): DataColumn<T> = this@ColumnSelectionDsl[this]

/**
* @include [CommonKPropertyInvokeDocs]
* @return The [ColumnGroup] this [KProperty Accessor][KProperty] points to.
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T> KProperty<DataRow<T>>.invoke(): ColumnGroup<T> = this@ColumnSelectionDsl[this]

/**
* @include [CommonKPropertyInvokeDocs]
* @return The [FrameColumn] this [KProperty Accessor][KProperty] points to.
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T> KProperty<DataFrame<T>>.invoke(): FrameColumn<T> = this@ColumnSelectionDsl[this]

/**
Expand All @@ -114,8 +111,7 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
*/
@Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("KPropertyDataRowGet")
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<R>): DataColumn<R> = invoke()[column]

/**
Expand All @@ -124,8 +120,7 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
*/
@Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("KPropertyDataRowGet")
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<DataRow<R>>): ColumnGroup<R> =
invoke()[column]

Expand All @@ -135,34 +130,30 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
*/
@Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("KPropertyDataRowGet")
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<DataFrame<R>>): FrameColumn<R> =
invoke()[column]

/**
* @include [CommonKPropertyGetDocs]
* @return The [DataColumn] these [KProperty Accessors][KProperty] point to.
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T, R> KProperty<T>.get(column: KProperty<R>): DataColumn<R> = invoke().asColumnGroup()[column]

/**
* @include [CommonKPropertyGetDocs]
* @return The [ColumnGroup] these [KProperty Accessors][KProperty] point to.
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T, R> KProperty<T>.get(column: KProperty<DataRow<R>>): ColumnGroup<R> =
invoke().asColumnGroup()[column]

/**
* @include [CommonKPropertyGetDocs]
* @return The [FrameColumn] these [KProperty Accessors][KProperty] point to.
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <T, R> KProperty<T>.get(column: KProperty<DataFrame<R>>): FrameColumn<R> =
invoke().asColumnGroup()[column]

Expand Down
3 changes: 1 addition & 2 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,8 +406,7 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
*
* `df.`[select][DataFrame.select]` { DataSchemaType::myColGroup `[`{`][KProperty.select]` colA `[`and`][ColumnsSelectionDsl.and]` colB `[`}`][KProperty.select]` }`
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun <C, R> KProperty<C>.invoke(selector: ColumnsSelector<C, R>): ColumnSet<R> =
columnGroup(this).select(selector)

Expand Down
30 changes: 10 additions & 20 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,15 @@ public fun <T> DataFrame<T>.properties(): ColumnsScope<T> = this
public fun <T> ColumnsContainer<T>.getColumn(name: String): AnyCol =
getColumnOrNull(name) ?: throw IllegalArgumentException("Column not found: '$name'")

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, R> ColumnsContainer<T>.getColumn(column: ColumnReference<DataFrame<R>>): FrameColumn<R> =
getColumnOrNull(column)?.asFrameColumn() ?: throw IllegalArgumentException("FrameColumn not found: '$column'")

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, R> ColumnsContainer<T>.getColumn(column: ColumnReference<DataRow<R>>): ColumnGroup<R> =
getColumnOrNull(column)?.asColumnGroup() ?: throw IllegalArgumentException("ColumnGroup not found: '$column'")

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, R> ColumnsContainer<T>.getColumn(column: ColumnReference<R>): DataColumn<R> =
getColumnOrNull(column) ?: throw IllegalArgumentException("Column not found: '$column'")

Expand All @@ -121,13 +118,11 @@ public fun <T> ColumnsContainer<T>.getColumnGroup(index: Int): ColumnGroup<*> =

public fun <T> ColumnsContainer<T>.getColumnGroup(name: String): ColumnGroup<*> = getColumn(name).asColumnGroup()

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> ColumnsContainer<T>.getColumnGroup(column: KProperty<*>): ColumnGroup<*> =
getColumnGroup(column.columnName)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> ColumnsContainer<T>.getColumnGroup(column: ColumnReference<DataRow<C>>): ColumnGroup<C> =
getColumn(column)

Expand All @@ -141,29 +136,24 @@ public fun <T, C> ColumnsContainer<T>.getColumnGroup(column: ColumnSelector<T, D
public fun <T> ColumnsContainer<T>.getColumnGroupOrNull(name: String): ColumnGroup<*>? =
getColumnOrNull(name)?.asColumnGroup()

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> ColumnsContainer<T>.getColumnGroupOrNull(column: KProperty<*>): ColumnGroup<*>? =
getColumnGroupOrNull(column.columnName)

// endregion

// region containsColumn

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <C> ColumnsContainer<*>.containsColumn(column: ColumnReference<C>): Boolean = getColumnOrNull(column) != null

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun ColumnsContainer<*>.containsColumn(column: KProperty<*>): Boolean = containsColumn(column.columnName)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun ColumnsContainer<*>.contains(column: AnyColumnReference): Boolean = containsColumn(column)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun ColumnsContainer<*>.contains(column: KProperty<*>): Boolean = containsColumn(column)

// region rows
Expand Down
18 changes: 6 additions & 12 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataRowApi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,15 @@ public fun AnyRow.namedValues(): List<NameValuePair<Any?>> =

public fun <T> AnyRow.getValue(columnName: String): T = get(columnName) as T

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> AnyRow.getValue(column: ColumnReference<T>): T = get(column)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> AnyRow.getValue(column: KProperty<T>): T = get(column)

public fun <T> AnyRow.getValueOrNull(columnName: String): T? = getOrNull(columnName) as T?

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> AnyRow.getValueOrNull(column: KProperty<T>): T? = getValueOrNull<T>(column.columnName)

// endregion
Expand All @@ -93,18 +90,15 @@ public fun <T> AnyRow.getValueOrNull(column: KProperty<T>): T? = getValueOrNull<

public fun AnyRow.containsKey(columnName: String): Boolean = owner.containsColumn(columnName)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun AnyRow.containsKey(column: AnyColumnReference): Boolean = owner.containsColumn(column)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun AnyRow.containsKey(column: KProperty<*>): Boolean = owner.containsColumn(column)

public operator fun AnyRow.contains(column: AnyColumnReference): Boolean = containsKey(column)

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public operator fun AnyRow.contains(column: KProperty<*>): Boolean = containsKey(column)

// endregion
Expand Down
51 changes: 17 additions & 34 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 @@ -86,8 +86,7 @@ public fun <T> DataFrame<T>.fillNulls(vararg columns: String): Update<T, Any?> =
* @include [SelectingColumns.KProperties.WithExample] {@include [SetFillNullsOperationArg]}
* @include [Update.KPropertiesParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> DataFrame<T>.fillNulls(vararg columns: KProperty<C>): Update<T, C?> =
fillNulls { columns.toColumnSet() }

Expand All @@ -96,8 +95,7 @@ public fun <T, C> DataFrame<T>.fillNulls(vararg columns: KProperty<C>): Update<T
* @include [SelectingColumns.ColumnAccessors.WithExample] {@include [SetFillNullsOperationArg]}
* @include [Update.ColumnAccessorsParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> DataFrame<T>.fillNulls(vararg columns: ColumnReference<C>): Update<T, C?> =
fillNulls { columns.toColumnSet() }

Expand Down Expand Up @@ -216,17 +214,15 @@ public fun <T> DataFrame<T>.fillNaNs(vararg columns: String): Update<T, Any?> =
* @include [SelectingColumns.KProperties.WithExample] {@include [SetFillNaNsOperationArg]}
* @include [Update.KPropertiesParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> DataFrame<T>.fillNaNs(vararg columns: KProperty<C>): Update<T, C> = fillNaNs { columns.toColumnSet() }

/**
* @include [CommonFillNaNsFunctionDoc]
* @include [SelectingColumns.ColumnAccessors.WithExample] {@include [SetFillNaNsOperationArg]}
* @include [Update.ColumnAccessorsParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> DataFrame<T>.fillNaNs(vararg columns: ColumnReference<C>): Update<T, C> =
fillNaNs { columns.toColumnSet() }

Expand Down Expand Up @@ -291,17 +287,15 @@ public fun <T> DataFrame<T>.fillNA(vararg columns: String): Update<T, Any?> = fi
* @include [SelectingColumns.KProperties.WithExample] {@include [SetFillNAOperationArg]}
* @include [Update.KPropertiesParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> DataFrame<T>.fillNA(vararg columns: KProperty<C>): Update<T, C?> = fillNA { columns.toColumnSet() }

/**
* @include [CommonFillNAFunctionDoc]
* @include [SelectingColumns.ColumnAccessors.WithExample] {@include [SetFillNAOperationArg]}
* @include [Update.ColumnAccessorsParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T, C> DataFrame<T>.fillNA(vararg columns: ColumnReference<C>): Update<T, C?> =
fillNA { columns.toColumnSet() }

Expand Down Expand Up @@ -372,8 +366,7 @@ private interface CommonDropNullsFunctionDoc
* @include [DropNulls.WhereAllNullParam]
* @include [DropDslParam]
*/
@Refine
@Interpretable("DropNulls0")
@[Refine Interpretable("DropNulls0")]
public fun <T> DataFrame<T>.dropNulls(whereAllNull: Boolean = false, columns: ColumnsSelector<T, *>): DataFrame<T> {
val cols = this[columns]
return if (whereAllNull) {
Expand All @@ -383,8 +376,7 @@ public fun <T> DataFrame<T>.dropNulls(whereAllNull: Boolean = false, columns: Co
}
}

@Refine
@Interpretable("DropNulls0")
@[Refine Interpretable("DropNulls0")]
@Deprecated(
"DataFrame conventional name for filterNot* functions is drop*",
ReplaceWith("dropNulls(columns = columns)"),
Expand All @@ -397,8 +389,7 @@ public fun <T> DataFrame<T>.filterNotNull(columns: ColumnsSelector<T, *>): DataF
* This overload operates on all columns in the [DataFrame].
* @include [DropNulls.WhereAllNullParam]
*/
@Refine
@Interpretable("DropNulls1")
@[Refine Interpretable("DropNulls1")]
public fun <T> DataFrame<T>.dropNulls(whereAllNull: Boolean = false): DataFrame<T> = dropNulls(whereAllNull) { all() }

/**
Expand All @@ -408,8 +399,7 @@ public fun <T> DataFrame<T>.dropNulls(whereAllNull: Boolean = false): DataFrame<
* @include [DropNulls.WhereAllNullParam]
* @include [DropKPropertiesParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> DataFrame<T>.dropNulls(vararg columns: KProperty<*>, whereAllNull: Boolean = false): DataFrame<T> =
dropNulls(whereAllNull) { columns.toColumnSet() }

Expand All @@ -430,8 +420,7 @@ public fun <T> DataFrame<T>.dropNulls(vararg columns: String, whereAllNull: Bool
* @include [DropNulls.WhereAllNullParam]
* @include [DropColumnAccessorsParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> DataFrame<T>.dropNulls(vararg columns: AnyColumnReference, whereAllNull: Boolean = false): DataFrame<T> =
dropNulls(whereAllNull) { columns.toColumnSet() }

Expand Down Expand Up @@ -493,8 +482,7 @@ private interface CommonDropNAFunctionDoc
* @include [DropNA.WhereAllNAParam]
* @include [DropDslParam]
*/
@Refine
@Interpretable("DropNa0")
@[Refine Interpretable("DropNa0")]
public fun <T> DataFrame<T>.dropNA(whereAllNA: Boolean = false, columns: ColumnsSelector<T, *>): DataFrame<T> {
val cols = this[columns]
return if (whereAllNA) {
Expand All @@ -511,8 +499,7 @@ public fun <T> DataFrame<T>.dropNA(whereAllNA: Boolean = false, columns: Columns
* @include [DropNA.WhereAllNAParam]
* @include [DropKPropertiesParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> DataFrame<T>.dropNA(vararg columns: KProperty<*>, whereAllNA: Boolean = false): DataFrame<T> =
dropNA(whereAllNA) { columns.toColumnSet() }

Expand All @@ -533,8 +520,7 @@ public fun <T> DataFrame<T>.dropNA(vararg columns: String, whereAllNA: Boolean =
* @include [DropNA.WhereAllNAParam]
* @include [DropColumnAccessorsParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> DataFrame<T>.dropNA(vararg columns: AnyColumnReference, whereAllNA: Boolean = false): DataFrame<T> =
dropNA(whereAllNA) { columns.toColumnSet() }

Expand All @@ -543,8 +529,7 @@ public fun <T> DataFrame<T>.dropNA(vararg columns: AnyColumnReference, whereAllN
* This overload operates on all columns in the [DataFrame].
* @include [DropNA.WhereAllNAParam]
*/
@Refine
@Interpretable("DropNa1")
@[Refine Interpretable("DropNa1")]
public fun <T> DataFrame<T>.dropNA(whereAllNA: Boolean = false): DataFrame<T> = dropNA(whereAllNA) { all() }

/**
Expand Down Expand Up @@ -624,8 +609,7 @@ public fun <T> DataFrame<T>.dropNaNs(whereAllNaN: Boolean = false, columns: Colu
* @include [DropNaNs.WhereAllNaNParam]
* @include [DropKPropertiesParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> DataFrame<T>.dropNaNs(vararg columns: KProperty<*>, whereAllNaN: Boolean = false): DataFrame<T> =
dropNaNs(whereAllNaN) { columns.toColumnSet() }

Expand All @@ -646,8 +630,7 @@ public fun <T> DataFrame<T>.dropNaNs(vararg columns: String, whereAllNaN: Boolea
* @include [DropNaNs.WhereAllNaNParam]
* @include [DropColumnAccessorsParam]
*/
@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
@[Deprecated(DEPRECATED_ACCESS_API) AccessApiOverload]
public fun <T> DataFrame<T>.dropNaNs(vararg columns: AnyColumnReference, whereAllNaN: Boolean = false): DataFrame<T> =
dropNaNs(whereAllNaN) { columns.toColumnSet() }

Expand Down
Loading