From d70372f96a00eba1a4c2c937cf4b8cf38818bea8 Mon Sep 17 00:00:00 2001 From: "jetbrains-junie[bot]" <201638009+jetbrains-junie[bot]@users.noreply.github.com> Date: Mon, 3 Nov 2025 13:55:03 +0000 Subject: [PATCH] feat(api): add columnsScope() alias replacing deprecated properties() A new alias function `columnsScope()` was introduced for column-accessor-only completion. The original `properties()` function was deprecated with a ReplaceWith suggestion to maintain compatibility. KDoc and source updates were added to clarify usage and avoid breaking changes. --- .../jetbrains/kotlinx/dataframe/api/DataFrameGet.kt | 11 +++++++++++ .../jetbrains/kotlinx/dataframe/api/DataFrameGet.kt | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt index 77bd83cf1e..6d058aaa9f 100644 --- a/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt +++ b/core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt @@ -82,8 +82,19 @@ public fun ColumnsContainer.getColumnGroup(columnPath: ColumnPath): Colum * df.properties(). * ``` */ +@Deprecated("Renamed for clarity: use columnsScope() to access generated column properties only", ReplaceWith("columnsScope()")) public fun DataFrame.properties(): ColumnsScope = this +/** + * Returns a ColumnsScope that exposes only generated column accessor properties for code completion, + * hiding the rest of the DataFrame API. Useful to quickly discover available columns. + * + * Example: + * val df = DataFrame.read("file.csv") + * df.columnsScope(). // shows only column accessors in auto-complete + */ +public fun DataFrame.columnsScope(): ColumnsScope = this + // region getColumn public fun ColumnsContainer.getColumn(name: String): AnyCol = diff --git a/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt b/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt index 77bd83cf1e..6d058aaa9f 100644 --- a/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt +++ b/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt @@ -82,8 +82,19 @@ public fun ColumnsContainer.getColumnGroup(columnPath: ColumnPath): Colum * df.properties(). * ``` */ +@Deprecated("Renamed for clarity: use columnsScope() to access generated column properties only", ReplaceWith("columnsScope()")) public fun DataFrame.properties(): ColumnsScope = this +/** + * Returns a ColumnsScope that exposes only generated column accessor properties for code completion, + * hiding the rest of the DataFrame API. Useful to quickly discover available columns. + * + * Example: + * val df = DataFrame.read("file.csv") + * df.columnsScope(). // shows only column accessors in auto-complete + */ +public fun DataFrame.columnsScope(): ColumnsScope = this + // region getColumn public fun ColumnsContainer.getColumn(name: String): AnyCol =