Skip to content

Commit 6d68416

Browse files
committed
Deprecate trivial dataFrameOf shortcut
1 parent ff0e3d9 commit 6d68416

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import org.jetbrains.kotlinx.dataframe.impl.columns.createComputedColumnReferenc
3232
import org.jetbrains.kotlinx.dataframe.impl.columns.forceResolve
3333
import org.jetbrains.kotlinx.dataframe.impl.columns.unbox
3434
import org.jetbrains.kotlinx.dataframe.size
35+
import org.jetbrains.kotlinx.dataframe.util.DATAFRAME_OF_WITH_VALUES
3536
import kotlin.random.Random
3637
import kotlin.random.nextInt
3738
import kotlin.reflect.KProperty
@@ -361,6 +362,7 @@ public fun dataFrameOf(header: Iterable<String>): DataFrameBuilder = DataFrameBu
361362
public fun dataFrameOf(vararg columns: Pair<String, List<Any?>>): DataFrame<*> =
362363
columns.map { it.second.toColumn(it.first, Infer.Type) }.toDataFrame()
363364

365+
@Deprecated(DATAFRAME_OF_WITH_VALUES, ReplaceWith("dataFrameOf(header).withValues(values)"))
364366
public fun dataFrameOf(header: Iterable<String>, values: Iterable<Any?>): DataFrame<*> =
365367
dataFrameOf(header).withValues(values)
366368

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,9 @@ internal const val TO_CSV_REPLACE = "this.toCsvStr()"
163163
internal const val SPLIT_STR =
164164
"Please explicitly specify how the String should be split. This shortcut will be removed in version 1.1.0"
165165

166+
internal const val DATAFRAME_OF_WITH_VALUES =
167+
"Deprecated in favor of dataFrameOf(names).withValues(values). Will be error in 1.1.0"
168+
166169
// endregion
167170

168171
// region keep across releases

dataframe-json/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/ImageSerializationTests.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ class ImageSerializationTests {
6060
images: List<BufferedImage>,
6161
encodingOptions: Base64ImageEncodingOptions?,
6262
): JsonObject {
63-
val df = dataFrameOf(listOf("imgs"), images)
63+
val df = dataFrameOf("imgs" to images)
6464
val jsonStr = df.toJsonWithMetadata(
6565
20,
6666
nestedRowLimit = 20,

0 commit comments

Comments
 (0)