Skip to content

Commit a39dcc6

Browse files
koperagenkoperagen
committed
Deprecate @AccessApiOverload functions
1 parent 337341f commit a39dcc6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1734
-0
lines changed

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/ColumnsContainer.kt

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,15 @@ public interface ColumnsContainer<out T> : ColumnsScope<T> {
4343

4444
public fun getColumnOrNull(index: Int): AnyCol?
4545

46+
@Deprecated(
47+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
48+
)
4649
@AccessApiOverload
4750
public fun <R> getColumnOrNull(column: ColumnReference<R>): DataColumn<R>?
4851

52+
@Deprecated(
53+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
54+
)
4955
@AccessApiOverload
5056
public fun <R> getColumnOrNull(column: KProperty<R>): DataColumn<R>?
5157

@@ -61,31 +67,58 @@ public interface ColumnsContainer<out T> : ColumnsScope<T> {
6167

6268
public operator fun get(columnPath: ColumnPath): AnyCol = getColumn(columnPath)
6369

70+
@Deprecated(
71+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
72+
)
6473
@AccessApiOverload
6574
public operator fun <R> get(column: DataColumn<R>): DataColumn<R> = getColumn(column.name()).cast()
6675

76+
@Deprecated(
77+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
78+
)
6779
@AccessApiOverload
6880
public operator fun <R> get(column: DataColumn<DataRow<R>>): ColumnGroup<R> = getColumn(column)
6981

82+
@Deprecated(
83+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
84+
)
7085
@AccessApiOverload
7186
public operator fun <R> get(column: DataColumn<DataFrame<R>>): FrameColumn<R> = getColumn(column)
7287

88+
@Deprecated(
89+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
90+
)
7391
@AccessApiOverload
7492
public operator fun <R> get(column: ColumnReference<R>): DataColumn<R> = getColumn(column)
7593

94+
@Deprecated(
95+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
96+
)
7697
@AccessApiOverload
7798
public operator fun <R> get(column: ColumnReference<DataRow<R>>): ColumnGroup<R> = getColumn(column)
7899

100+
@Deprecated(
101+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
102+
)
79103
@AccessApiOverload
80104
public operator fun <R> get(column: ColumnReference<DataFrame<R>>): FrameColumn<R> = getColumn(column)
81105

106+
@Deprecated(
107+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
108+
)
82109
@AccessApiOverload
83110
public operator fun <R> get(column: KProperty<R>): DataColumn<R> = get(column.columnName).cast()
84111

112+
@Deprecated(
113+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
114+
)
85115
@AccessApiOverload
86116
public operator fun <R> get(column: KProperty<DataRow<R>>): ColumnGroup<R> =
87117
get(column.columnName).asColumnGroup().cast()
88118

119+
@Deprecated(
120+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
121+
)
89122
@AccessApiOverload
90123
public operator fun <R> get(column: KProperty<DataFrame<R>>): FrameColumn<R> =
91124
get(column.columnName).asAnyFrameColumn().castFrameColumn()

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/DataFrame.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ public interface DataFrame<out T> :
121121
*/
122122
public operator fun <T, C> DataFrame<T>.get(columns: ColumnsSelector<T, C>): List<DataColumn<C>> = this.get(columns)
123123

124+
@Deprecated(
125+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
126+
)
124127
@AccessApiOverload
125128
public operator fun <T> DataFrame<T>.get(first: AnyColumnReference, vararg other: AnyColumnReference): DataFrame<T> =
126129
select { (listOf(first) + other).toColumnSet() }

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/DataRow.kt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,27 @@ public interface DataRow<out T> {
2828

2929
public operator fun <R> get(expression: RowExpression<T, R>): R = expression(this, this)
3030

31+
@Deprecated(
32+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
33+
)
3134
@AccessApiOverload
3235
public operator fun <R> get(column: ColumnReference<R>): R
3336

37+
@Deprecated(
38+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
39+
)
3440
@AccessApiOverload
3541
public operator fun <R> get(columns: List<ColumnReference<R>>): List<R> = columns.map { get(it) }
3642

43+
@Deprecated(
44+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
45+
)
3746
@AccessApiOverload
3847
public operator fun <R> get(property: KProperty<R>): R = get(property.columnName) as R
3948

49+
@Deprecated(
50+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
51+
)
4052
@AccessApiOverload
4153
public operator fun get(first: AnyColumnReference, vararg other: AnyColumnReference): DataRow<T> =
4254
owner.get(first, *other)[index]
@@ -71,6 +83,9 @@ public interface DataRow<out T> {
7183

7284
public fun getOrNull(name: String): Any?
7385

86+
@Deprecated(
87+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
88+
)
7489
@AccessApiOverload
7590
public fun <R> getValueOrNull(column: ColumnReference<R>): R?
7691

@@ -80,6 +95,9 @@ public interface DataRow<out T> {
8095

8196
public operator fun String.get(vararg path: String): ColumnPath = ColumnPath(listOf(this) + path)
8297

98+
@Deprecated(
99+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
100+
)
83101
@AccessApiOverload
84102
public operator fun <R> ColumnReference<R>.invoke(): R = get(this)
85103

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnSelectionDsl.kt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,29 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
7171
* @include [CommonKPropertyInvokeDocs]
7272
* @return The [DataColumn] this [KProperty Accessor][KProperty] points to.
7373
*/
74+
@Deprecated(
75+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
76+
)
7477
@AccessApiOverload
7578
public operator fun <T> KProperty<T>.invoke(): DataColumn<T> = this@ColumnSelectionDsl[this]
7679

7780
/**
7881
* @include [CommonKPropertyInvokeDocs]
7982
* @return The [ColumnGroup] this [KProperty Accessor][KProperty] points to.
8083
*/
84+
@Deprecated(
85+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
86+
)
8187
@AccessApiOverload
8288
public operator fun <T> KProperty<DataRow<T>>.invoke(): ColumnGroup<T> = this@ColumnSelectionDsl[this]
8389

8490
/**
8591
* @include [CommonKPropertyInvokeDocs]
8692
* @return The [FrameColumn] this [KProperty Accessor][KProperty] points to.
8793
*/
94+
@Deprecated(
95+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
96+
)
8897
@AccessApiOverload
8998
public operator fun <T> KProperty<DataFrame<T>>.invoke(): FrameColumn<T> = this@ColumnSelectionDsl[this]
9099

@@ -109,6 +118,9 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
109118
*/
110119
@Suppress("INAPPLICABLE_JVM_NAME")
111120
@JvmName("KPropertyDataRowGet")
121+
@Deprecated(
122+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
123+
)
112124
@AccessApiOverload
113125
public operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<R>): DataColumn<R> = invoke()[column]
114126

@@ -118,6 +130,9 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
118130
*/
119131
@Suppress("INAPPLICABLE_JVM_NAME")
120132
@JvmName("KPropertyDataRowGet")
133+
@Deprecated(
134+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
135+
)
121136
@AccessApiOverload
122137
public operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<DataRow<R>>): ColumnGroup<R> =
123138
invoke()[column]
@@ -128,6 +143,9 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
128143
*/
129144
@Suppress("INAPPLICABLE_JVM_NAME")
130145
@JvmName("KPropertyDataRowGet")
146+
@Deprecated(
147+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
148+
)
131149
@AccessApiOverload
132150
public operator fun <T, R> KProperty<DataRow<T>>.get(column: KProperty<DataFrame<R>>): FrameColumn<R> =
133151
invoke()[column]
@@ -136,13 +154,19 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
136154
* @include [CommonKPropertyGetDocs]
137155
* @return The [DataColumn] these [KProperty Accessors][KProperty] point to.
138156
*/
157+
@Deprecated(
158+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
159+
)
139160
@AccessApiOverload
140161
public operator fun <T, R> KProperty<T>.get(column: KProperty<R>): DataColumn<R> = invoke().asColumnGroup()[column]
141162

142163
/**
143164
* @include [CommonKPropertyGetDocs]
144165
* @return The [ColumnGroup] these [KProperty Accessors][KProperty] point to.
145166
*/
167+
@Deprecated(
168+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
169+
)
146170
@AccessApiOverload
147171
public operator fun <T, R> KProperty<T>.get(column: KProperty<DataRow<R>>): ColumnGroup<R> =
148172
invoke().asColumnGroup()[column]
@@ -151,6 +175,9 @@ public interface ColumnSelectionDsl<out T> : ColumnsContainer<T> {
151175
* @include [CommonKPropertyGetDocs]
152176
* @return The [FrameColumn] these [KProperty Accessors][KProperty] point to.
153177
*/
178+
@Deprecated(
179+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
180+
)
154181
@AccessApiOverload
155182
public operator fun <T, R> KProperty<T>.get(column: KProperty<DataFrame<R>>): FrameColumn<R> =
156183
invoke().asColumnGroup()[column]

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/ColumnsSelectionDsl.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,9 @@ public interface ColumnsSelectionDsl<out T> : // SingleColumn<DataRow<T>>
399399
*
400400
* `df.`[select][DataFrame.select]` { DataSchemaType::myColGroup `[`{`][KProperty.select]` colA `[`and`][ColumnsSelectionDsl.and]` colB `[`}`][KProperty.select]` }`
401401
*/
402+
@Deprecated(
403+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
404+
)
402405
@AccessApiOverload
403406
public operator fun <C, R> KProperty<C>.invoke(selector: ColumnsSelector<C, R>): ColumnSet<R> =
404407
columnGroup(this).select(selector)

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataFrameGet.kt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,23 @@ public fun <T> DataFrame<T>.properties(): ColumnsScope<T> = this
8787
public fun <T> ColumnsContainer<T>.getColumn(name: String): AnyCol =
8888
getColumnOrNull(name) ?: throw IllegalArgumentException("Column not found: '$name'")
8989

90+
@Deprecated(
91+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
92+
)
9093
@AccessApiOverload
9194
public fun <T, R> ColumnsContainer<T>.getColumn(column: ColumnReference<DataFrame<R>>): FrameColumn<R> =
9295
getColumnOrNull(column)?.asFrameColumn() ?: throw IllegalArgumentException("FrameColumn not found: '$column'")
9396

97+
@Deprecated(
98+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
99+
)
94100
@AccessApiOverload
95101
public fun <T, R> ColumnsContainer<T>.getColumn(column: ColumnReference<DataRow<R>>): ColumnGroup<R> =
96102
getColumnOrNull(column)?.asColumnGroup() ?: throw IllegalArgumentException("ColumnGroup not found: '$column'")
97103

104+
@Deprecated(
105+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
106+
)
98107
@AccessApiOverload
99108
public fun <T, R> ColumnsContainer<T>.getColumn(column: ColumnReference<R>): DataColumn<R> =
100109
getColumnOrNull(column) ?: throw IllegalArgumentException("Column not found: '$column'")
@@ -116,10 +125,16 @@ public fun <T> ColumnsContainer<T>.getColumnGroup(index: Int): ColumnGroup<*> =
116125

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

128+
@Deprecated(
129+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
130+
)
119131
@AccessApiOverload
120132
public fun <T> ColumnsContainer<T>.getColumnGroup(column: KProperty<*>): ColumnGroup<*> =
121133
getColumnGroup(column.columnName)
122134

135+
@Deprecated(
136+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
137+
)
123138
@AccessApiOverload
124139
public fun <T, C> ColumnsContainer<T>.getColumnGroup(column: ColumnReference<DataRow<C>>): ColumnGroup<C> =
125140
getColumn(column)
@@ -134,6 +149,9 @@ public fun <T, C> ColumnsContainer<T>.getColumnGroup(column: ColumnSelector<T, D
134149
public fun <T> ColumnsContainer<T>.getColumnGroupOrNull(name: String): ColumnGroup<*>? =
135150
getColumnOrNull(name)?.asColumnGroup()
136151

152+
@Deprecated(
153+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
154+
)
137155
@AccessApiOverload
138156
public fun <T> ColumnsContainer<T>.getColumnGroupOrNull(column: KProperty<*>): ColumnGroup<*>? =
139157
getColumnGroupOrNull(column.columnName)
@@ -142,15 +160,27 @@ public fun <T> ColumnsContainer<T>.getColumnGroupOrNull(column: KProperty<*>): C
142160

143161
// region containsColumn
144162

163+
@Deprecated(
164+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
165+
)
145166
@AccessApiOverload
146167
public fun <C> ColumnsContainer<*>.containsColumn(column: ColumnReference<C>): Boolean = getColumnOrNull(column) != null
147168

169+
@Deprecated(
170+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
171+
)
148172
@AccessApiOverload
149173
public fun ColumnsContainer<*>.containsColumn(column: KProperty<*>): Boolean = containsColumn(column.columnName)
150174

175+
@Deprecated(
176+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
177+
)
151178
@AccessApiOverload
152179
public operator fun ColumnsContainer<*>.contains(column: AnyColumnReference): Boolean = containsColumn(column)
153180

181+
@Deprecated(
182+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
183+
)
154184
@AccessApiOverload
155185
public operator fun ColumnsContainer<*>.contains(column: KProperty<*>): Boolean = containsColumn(column)
156186

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataRowApi.kt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,23 @@ public fun AnyRow.namedValues(): List<NameValuePair<Any?>> =
6262

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

65+
@Deprecated(
66+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
67+
)
6568
@AccessApiOverload
6669
public fun <T> AnyRow.getValue(column: ColumnReference<T>): T = get(column)
6770

71+
@Deprecated(
72+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
73+
)
6874
@AccessApiOverload
6975
public fun <T> AnyRow.getValue(column: KProperty<T>): T = get(column)
7076

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

79+
@Deprecated(
80+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
81+
)
7382
@AccessApiOverload
7483
public fun <T> AnyRow.getValueOrNull(column: KProperty<T>): T? = getValueOrNull<T>(column.columnName)
7584

@@ -79,14 +88,23 @@ public fun <T> AnyRow.getValueOrNull(column: KProperty<T>): T? = getValueOrNull<
7988

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

91+
@Deprecated(
92+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
93+
)
8294
@AccessApiOverload
8395
public fun AnyRow.containsKey(column: AnyColumnReference): Boolean = owner.containsColumn(column)
8496

97+
@Deprecated(
98+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
99+
)
85100
@AccessApiOverload
86101
public fun AnyRow.containsKey(column: KProperty<*>): Boolean = owner.containsColumn(column)
87102

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

105+
@Deprecated(
106+
"Recommended to migrate to use String or Extension properties API https://kotlin.github.io/dataframe/apilevels.html",
107+
)
90108
@AccessApiOverload
91109
public operator fun AnyRow.contains(column: KProperty<*>): Boolean = containsKey(column)
92110

0 commit comments

Comments
 (0)