Skip to content

Added try-catch for column access with a detailed error messages #1873

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

Added try-catch for column access with a detailed error messages #1873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45ba38f
Add try-catch for column access with detailed error messages
AndreiKingsley May 25, 2026
d0f1476
ktlint format
AndreiKingsley May 25, 2026
841191e
Update codegen tests
AndreiKingsley May 25, 2026
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
34 changes: 33 additions & 1 deletion core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/impl/codeGen/CodeGeneratorImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ import org.jetbrains.kotlinx.dataframe.codeGen.TypeCastGenerator
import org.jetbrains.kotlinx.dataframe.codeGen.ValidFieldName
import org.jetbrains.kotlinx.dataframe.codeGen.toNullable
import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
import org.jetbrains.kotlinx.dataframe.impl.ColumnNameGenerator
import org.jetbrains.kotlinx.dataframe.impl.toSnakeCase
import org.jetbrains.kotlinx.dataframe.keywords.HardKeywords
import org.jetbrains.kotlinx.dataframe.keywords.ModifierKeywords
Expand Down Expand Up @@ -274,6 +275,32 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR

private fun String.removeQuotes() = this.removeSurrounding("`")

private val troubleshootingLink = ""

/**
* Generate a try-catch block for column accessor with custom error messages.
*
* Catch any exception. Returns an `error()` with a special message. Can be improved with custom exception (#1872).
Copy link
Copy Markdown
Collaborator

@Jolanrensen Jolanrensen May 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an *IllegalStateException, error() is just the function that triggers it

*
* 1) IllegalArgumentException -> most probably column not found. Should be replaced with a custom exception (#1871)
* 2) ClassCastException -> most probably incorrect column type. Should be replaced with a custom exception (#1871)
* 3) else -> unexpected exception.
*/
private fun generateTryCatchColumnAccess(columnAccessCode: String, columnName: String): String {
val renderedColumnName = renderStringLiteral(columnName)
return """
try {
$columnAccessCode
} catch (e: Exception) {
when (e) {
is IllegalArgumentException -> error(message = "Column not found exception in the generated DataFrame extension property '$renderedColumnName': " + e.getLocalizedMessage() + ". See $troubleshootingLink for more information.")
Copy link
Copy Markdown
Collaborator

@Jolanrensen Jolanrensen May 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these may require imports, you could put the FQ name here

is ClassCastException -> error(message = "Incorrect column type exception in generated DataFrame extension property '$renderedColumnName': " + e.getLocalizedMessage() + " See $troubleshootingLink for more information.")
else -> error(message = "Unexpected exception in generated DataFrame extension property '$renderedColumnName'. Please report it to https://github.com/Kotlin/dataframe/issues." + "Exception message: " + e.toString())
Copy link
Copy Markdown
Collaborator

@Jolanrensen Jolanrensen May 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it may be better to manually throw the IllegalStateException, because then you can add the cause there

}
}
""".trimIndent()
}

private fun generatePropertyCode(
marker: IsolatedMarker,
shortMarkerName: String,
Expand All @@ -282,6 +309,7 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR
propertyType: String,
getter: String,
visibility: String,
columnName: String,
): String {
// jvm name is required to prevent signature clash like this:
// val DataRow<Type>.name: String
Expand All @@ -296,7 +324,7 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR
}
return "${visibility}val$typeParameters $typeName.$name: $propertyType @JvmName(\"${
renderStringLiteral(jvmName)
}\") get() = $getter as $propertyType"
}\") get() = ${generateTryCatchColumnAccess("$getter as $propertyType", columnName)} "
}

/**
Expand Down Expand Up @@ -355,6 +383,7 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR
propertyType = columnType,
getter = getter,
visibility = visibility,
columnName = it.columnName,
),
generatePropertyCode(
marker = marker,
Expand All @@ -364,6 +393,7 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR
propertyType = fieldType,
getter = getter,
visibility = visibility,
columnName = it.columnName,
),
),
)
Expand All @@ -378,6 +408,7 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR
propertyType = nullableColumnType,
getter = getter,
visibility = visibility,
columnName = it.columnName,
),
generatePropertyCode(
marker = marker,
Expand All @@ -387,6 +418,7 @@ internal open class ExtensionsCodeGeneratorImpl(private val typeRendering: TypeR
propertyType = nullableFieldType,
getter = getter,
visibility = visibility,
columnName = it.columnName,
),
),
)
Expand Down
Loading
Loading