Skip to content

[Junie]: feat(api): add columnsScope() alias replacing deprecated properties() #1540

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Junie]: feat(api): add columnsScope() alias replacing deprecated properties() #1540

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
11 changes: 11 additions & 0 deletions core/generated-sources/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 @@ -82,8 +82,19 @@ public fun <T> ColumnsContainer<T>.getColumnGroup(columnPath: ColumnPath): Colum
* df.properties().
* ```
*/
@Deprecated("Renamed for clarity: use columnsScope() to access generated column properties only", ReplaceWith("columnsScope()"))
public fun <T> DataFrame<T>.properties(): ColumnsScope<T> = 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 <T> DataFrame<T>.columnsScope(): ColumnsScope<T> = this

// region getColumn

public fun <T> ColumnsContainer<T>.getColumn(name: String): AnyCol =
Expand Down
11 changes: 11 additions & 0 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 @@ -82,8 +82,19 @@ public fun <T> ColumnsContainer<T>.getColumnGroup(columnPath: ColumnPath): Colum
* df.properties().
* ```
*/
@Deprecated("Renamed for clarity: use columnsScope() to access generated column properties only", ReplaceWith("columnsScope()"))
public fun <T> DataFrame<T>.properties(): ColumnsScope<T> = 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 <T> DataFrame<T>.columnsScope(): ColumnsScope<T> = this

// region getColumn

public fun <T> ColumnsContainer<T>.getColumn(name: String): AnyCol =
Expand Down