add Path overloads for io methods #1560

AndreiKingsley · 2025-11-11T20:00:20Z

Helps #527 - adds missing Path overloads

Jolanrensen · 2025-11-12T12:14:06Z

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/guess.kt

+public fun DataFrame.Companion.read(path: Path, header: List<String> = emptyList()): AnyFrame =
+    read(
+        path = path,
+        format = guessFormat(path.toString())?.also {


This doesn't use guessFormatForExtension() anymore, does it? the logic has changed a bit

Jolanrensen · 2025-11-12T12:15:50Z

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/GuessOverloadsTest.kt

+
+class GuessOverloadsTest {
+
+    private fun sampleJson(): String =


Can do with a @Language("JSON") :)

also, const val

Jolanrensen · 2025-11-12T12:17:03Z

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/GuessOverloadsTest.kt

+        """.trimIndent()
+
+    @Test
+    fun read_guess_overloads_String_Path_File_produce_same_df() {


what is this snake_case btw? XD usually we write test names with backticks and spaces

Junie, is this you? ;P

You need proper junie guide))

Jolanrensen · 2025-11-12T12:17:53Z

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/HtmlOverloadsTest.kt

+class HtmlOverloadsTest {
+
+    @Test
+    fun writeHtml_overloads_String_Path_File_produce_same_content() {


Jolanrensen · 2025-11-12T12:18:47Z

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/HtmlOverloadsTest.kt

+            html.writeHtml(fileOut)
+            html.writeHtml(strOut)
+
+            fun readText(p: Path): String = String(Files.readAllBytes(p), Charsets.UTF_8)


uhm, you can just call path.readText() in Kotlin. This function is useless

Jolanrensen · 2025-11-12T12:32:24Z

dataframe-csv/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/CsvOverloadsTest.kt

+import kotlin.io.path.createTempDirectory
+import kotlin.io.path.writeText
+
+class CsvOverloadsTest {


this doesn't add much value

Jolanrensen · 2025-11-12T12:35:10Z

dataframe-excel/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/ExcelOverloadsTest.kt

+
+    @Test
+    fun writeExcel_overloads_String_Path_File_create_nonempty_files() {
+        val df = dataFrameOf("name", "age")(


you can @Suppress("ktlint:standard:argument-list-wrapping") to make it look better. Or use the "name" to columnOf() api

Jolanrensen · 2025-11-12T12:35:54Z

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/io/write.kt

+fun GeoDataFrame<*>.writeGeoJson(path: Path) {
    val featureJSON = FeatureJSON()
-    file.outputStream().use { outputStream ->
+    Files.newOutputStream(path).use { outputStream ->


why not use the kotlin api XD path.outputStream()

Jolanrensen · 2025-11-12T12:36:34Z

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/io/write.kt

-        directory.mkdirs()
+/** Path overload for writing Shapefile to a directory */
+fun GeoDataFrame<*>.writeShapefile(directory: Path) {
+    if (!Files.exists(directory)) {


also this has Kotlin extension functions, similar to File

Jolanrensen · 2025-11-12T12:38:02Z

dataframe-openapi-generator/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/isOpenApi.kt

-
-    return isOpenApiStr(file.readText())
+public fun isOpenApi(path: Path): Boolean {
+    val name = path.fileName?.toString()?.lowercase() ?: return false


path also has .extension, just like files

Jolanrensen · 2025-11-12T12:40:25Z

...enapi-generator/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/IsOpenApiOverloadsTest.kt

+            val yaml = tmp.resolve("api.yml")
+            yaml.writeText("openapi: 3.0.0\ncomponents:\n  schemas: {}\n")
+            val json = tmp.resolve("api.json")
+            json.writeText("{" + "\"openapi\":\"3.0.0\",\"components\":{\"schemas\":{}}}")


what's this +?

zaleslaw

Naming in tests
@BeforeClass if it's possible
Clear the point about deleting files with Comparator
Clear the code from unexpected stuff

zaleslaw · 2025-11-12T13:00:19Z

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

+
+class JsonOverloadsTest {
+
+    private fun sampleJson(): String =


Create @before or @BeforeAll and move initialization there
https://www.baeldung.com/junit-before-beforeclass-beforeeach-beforeall

Why it's important?

better structured

performant (run once before all tests, not for each test)

best practice for Kotlin

zaleslaw · 2025-11-12T13:01:32Z

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

+    writeJson(file.toPath(), prettyPrint)
+}
+
+public fun AnyFrame.writeJson(path: Path, prettyPrint: Boolean = false) {


Let's improve here! No public method without KDoc

zaleslaw · 2025-11-12T13:03:22Z

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/io/write.kt

    }
 }
+
+fun GeoDataFrame<*>.writeShapefile(directory: File) {


Could you please say, are these write functions part of public API or not? I guess it's a public and should be with apropriate modifier and KDocs?

zaleslaw · 2025-11-12T13:03:47Z

dataframe-geo/src/main/kotlin/org/jetbrains/kotlinx/dataframe/geo/io/write.kt

 }

+fun GeoDataFrame<*>.writeGeoJson(file: File) {
+    // TODO: adds ids that breaks order of reading


TODO: issue or it will be forgotten

zaleslaw · 2025-11-12T13:05:01Z

dataframe-csv/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/CsvOverloadsTest.kt

+
+class CsvOverloadsTest {
+
+    private fun sampleCsv(): String =


Looks weird to me, better to prepare test data in @BeforeClass section and reuse it

zaleslaw · 2025-11-12T13:07:01Z

dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/readTsv.kt

-            compression = compression,
-            adjustCsvSpecs = ADJUST_CSV_SPECS,
-        )
-    }


Sorry, but from this edits with +/- is not clear, did you removed a adjustCsvSpecs = ADJUST_CSV_SPECS parameter? and what's happened with compression = Compression.of(file.toPath()),?

zaleslaw · 2025-11-12T13:08:34Z

dataframe-arrow/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/ArrowOverloadsSmokeTest.kt

+            r.rowsCount() shouldBe df.rowsCount()
+            r.columnNames() shouldBe df.columnNames()
+        } finally {
+            Files.walk(tmp).sorted(Comparator.reverseOrder()).forEach { it.toFile().delete() }


What's happened if it will be an exception in finally block? on File.delete()
Do we really need to clear the tmp directory in this way?

zaleslaw · 2025-11-12T13:09:53Z

dataframe-arrow/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/ArrowOverloadsSmokeTest.kt

+    }
+
+    @Test
+    fun ipc_overloads_write_and_read() {


Rename testname to back stick

*backtick XD

zaleslaw · 2025-11-12T13:11:58Z

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/jupyter/ImportDataSchemaOverloadsTest.kt

+        try {
+            val file = tmp.resolve("schema.json").toFile().also { it.writeText("{}") }
+            val path = file.toPath()
+            val str = path.toUri().toString() // String-оверлоад ожидает URL/URI-строку


Das ist nicht auf Russisch geschrieben, aber auf eine translatenend und machine-generiert subset von Russisch!

This reverts commit 9e0d436.

This reverts commit 6331f91.

AndreiKingsley added 6 commits November 12, 2025 00:00

add Path overloads for io methods

886af8b

fix Path overloads

2b38cbc

ktlintFormat and apiDump

a1f4c60

[Junie] make Path implementation default

299adb8

[Junie] IO overloads tests

6331f91

ktlint format and apiDump

9e0d436

AndreiKingsley requested review from Jolanrensen and zaleslaw November 12, 2025 11:38

Jolanrensen requested changes Nov 12, 2025

View reviewed changes

Jolanrensen reviewed Nov 12, 2025

View reviewed changes

zaleslaw requested changes Nov 12, 2025

View reviewed changes

AndreiKingsley added 3 commits November 13, 2025 00:52

Revert "ktlint format and apiDump"

3831751

This reverts commit 9e0d436.

Revert "[Junie] IO overloads tests"

8af8973

This reverts commit 6331f91.

path overloads fixes

e422860

AndreiKingsley closed this Nov 13, 2025


		class GuessOverloadsTest {

		private fun sampleJson(): String =

add Path overloads for io methods #1560

add Path overloads for io methods #1560

Uh oh!

Conversation

AndreiKingsley commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zaleslaw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zaleslaw Nov 12, 2025 • edited by Jolanrensen Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AndreiKingsley commented Nov 11, 2025 •

edited

Loading

zaleslaw Nov 12, 2025 •

edited by Jolanrensen

Loading