Skip to content

Commit 6b74884

Browse files
authored
Merge pull request #1418 from Kotlin/jetbrains-junie-issue-1417-run-9adb9248-1a5b-4505-8012-2c3061ca05cf
[Junie]: refactor: rename add overloads to addAll and deprecate old versions
2 parents 281902d + 5c6e8f8 commit 6b74884

File tree

3 files changed

+51
-0
lines changed

3 files changed

+51
-0
lines changed

core/api/core.api

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,8 @@ public final class org/jetbrains/kotlinx/dataframe/api/AddKt {
358358
public static final fun add (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/DataFrame;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
359359
public static final fun add (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/BaseColumn;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
360360
public static final fun addAll (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Ljava/lang/Iterable;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
361+
public static final fun addAll (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/DataFrame;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
362+
public static final fun addAll (Lorg/jetbrains/kotlinx/dataframe/DataFrame;[Lorg/jetbrains/kotlinx/dataframe/columns/BaseColumn;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
361363
public static final fun addAllFrames (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Ljava/lang/Iterable;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
362364
}
363365

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ import org.jetbrains.kotlinx.dataframe.exceptions.DuplicateColumnNamesException
2626
import org.jetbrains.kotlinx.dataframe.exceptions.UnequalColumnSizesException
2727
import org.jetbrains.kotlinx.dataframe.impl.api.insertImpl
2828
import org.jetbrains.kotlinx.dataframe.impl.columns.resolveSingle
29+
import org.jetbrains.kotlinx.dataframe.util.ADD_VARARG_COLUMNS
30+
import org.jetbrains.kotlinx.dataframe.util.ADD_VARARG_COLUMNS_REPLACE
31+
import org.jetbrains.kotlinx.dataframe.util.ADD_VARARG_FRAMES
32+
import org.jetbrains.kotlinx.dataframe.util.ADD_VARARG_FRAMES_REPLACE
2933
import org.jetbrains.kotlinx.dataframe.util.DEPRECATED_ACCESS_API
3034
import kotlin.reflect.KProperty
3135

@@ -43,8 +47,27 @@ import kotlin.reflect.KProperty
4347
* @throws [UnequalColumnSizesException] if columns in an expected result have different sizes.
4448
* @return new [DataFrame] with added columns.
4549
*/
50+
@Deprecated(
51+
message = ADD_VARARG_COLUMNS,
52+
replaceWith = ReplaceWith(ADD_VARARG_COLUMNS_REPLACE),
53+
level = DeprecationLevel.WARNING,
54+
)
4655
public fun <T> DataFrame<T>.add(vararg columns: AnyBaseCol): DataFrame<T> = addAll(columns.asIterable())
4756

57+
/**
58+
* Adds new [columns] to the end of this [DataFrame] (at the top level).
59+
*
60+
* Returns a new [DataFrame] with the new [columns] appended to the original list of [DataFrame.columns].
61+
*
62+
* For more information: {@include [DocumentationUrls.Add]}.
63+
*
64+
* @param columns columns to add.
65+
* @throws [DuplicateColumnNamesException] if columns in an expected result have repeated names.
66+
* @throws [UnequalColumnSizesException] if columns in an expected result have different sizes.
67+
* @return new [DataFrame] with added columns.
68+
*/
69+
public fun <T> DataFrame<T>.addAll(vararg columns: AnyBaseCol): DataFrame<T> = addAll(columns.asIterable())
70+
4871
/**
4972
* Adds new [columns] to the end of this [DataFrame] (at the top level).
5073
*
@@ -73,8 +96,28 @@ public fun <T> DataFrame<T>.addAll(columns: Iterable<AnyBaseCol>): DataFrame<T>
7396
* @throws [UnequalColumnSizesException] if columns in an expected result have different sizes.
7497
* @return new [DataFrame] with added columns.
7598
*/
99+
@Deprecated(
100+
message = ADD_VARARG_FRAMES,
101+
replaceWith = ReplaceWith(ADD_VARARG_FRAMES_REPLACE),
102+
level = DeprecationLevel.WARNING,
103+
)
76104
public fun <T> DataFrame<T>.add(vararg dataFrames: AnyFrame): DataFrame<T> = addAll(dataFrames.asIterable())
77105

106+
/**
107+
* Adds all columns from the given [dataFrames] to the end of this [DataFrame] (at the top level).
108+
*
109+
* Returns a new [DataFrame] with the columns from the specified
110+
* [dataFrames] appended to the original list of [DataFrame.columns].
111+
*
112+
* For more information: {@include [DocumentationUrls.Add]}.
113+
*
114+
* @param dataFrames dataFrames to get columns from.
115+
* @throws [DuplicateColumnNamesException] if columns in an expected result have repeated names.
116+
* @throws [UnequalColumnSizesException] if columns in an expected result have different sizes.
117+
* @return new [DataFrame] with added columns.
118+
*/
119+
public fun <T> DataFrame<T>.addAll(vararg dataFrames: AnyFrame): DataFrame<T> = addAll(dataFrames.asIterable())
120+
78121
/**
79122
* Adds all columns from the given [dataFrames] to the end of this [DataFrame] (at the top level).
80123
*

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,12 @@ internal const val LENGTH_REPLACE = "this.map { it?.length ?: 0 }"
239239
internal const val LOWERCASE_REPLACE = "this.map { it?.lowercase() }"
240240
internal const val UPPERCASE_REPLACE = "this.map { it?.uppercase() }"
241241

242+
internal const val ADD_VARARG_COLUMNS = "Deprecated in favor of `addAll(vararg)` to improve completion. $MESSAGE_1_1"
243+
internal const val ADD_VARARG_COLUMNS_REPLACE = "this.addAll(*columns)"
244+
245+
internal const val ADD_VARARG_FRAMES = "Deprecated in favor of `addAll(vararg)` to improve completion. $MESSAGE_1_1"
246+
internal const val ADD_VARARG_FRAMES_REPLACE = "this.addAll(*dataFrames)"
247+
242248
// endregion
243249

244250
// region keep across releases

0 commit comments

Comments
 (0)