Skip to content

Commit c0c7b7f

Browse files
AndreiKingsleyAndreiKingsley
authored
Merge pull request #1175 from Kotlin/api_renaimings
rename to valid camel case and remove deprecated URL()
2 parents b1ecefe + 3ad9726 commit c0c7b7f

File tree

28 files changed

+232
-137
lines changed

28 files changed

+232
-137
lines changed

‎core/api/core.api

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,6 +1535,8 @@ public final class org/jetbrains/kotlinx/dataframe/api/ConvertKt {
15351535
public static final fun convertToStringFromT (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)Lorg/jetbrains/kotlinx/dataframe/DataColumn;
15361536
public static final fun convertToURL (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)Lorg/jetbrains/kotlinx/dataframe/DataColumn;
15371537
public static final fun convertToURLFromStringNullable (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)Lorg/jetbrains/kotlinx/dataframe/DataColumn;
1538+
public static final fun convertToUrl (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)Lorg/jetbrains/kotlinx/dataframe/DataColumn;
1539+
public static final fun convertToUrlFromStringNullable (Lorg/jetbrains/kotlinx/dataframe/DataColumn;)Lorg/jetbrains/kotlinx/dataframe/DataColumn;
15381540
public static final fun to (Lorg/jetbrains/kotlinx/dataframe/api/Convert;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
15391541
public static final fun to (Lorg/jetbrains/kotlinx/dataframe/api/Convert;Lkotlin/reflect/KType;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
15401542
public static final fun toBigDecimal (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
@@ -1610,6 +1612,8 @@ public final class org/jetbrains/kotlinx/dataframe/api/ConvertKt {
16101612
public static final fun toLongTAny (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
16111613
public static final fun toStr (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
16121614
public static final fun toStrTAny (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
1615+
public static final fun toURLFromString (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
1616+
public static final fun toURLFromStringNullable (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
16131617
public static final fun toUrlFromString (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
16141618
public static final fun toUrlFromStringNullable (Lorg/jetbrains/kotlinx/dataframe/api/Convert;)Lorg/jetbrains/kotlinx/dataframe/DataFrame;
16151619
}
@@ -2221,10 +2225,10 @@ public final class org/jetbrains/kotlinx/dataframe/api/FormattedFrame {
22212225
public fun <init> (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function3;)V
22222226
public synthetic fun <init> (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lkotlin/jvm/functions/Function3;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
22232227
public final fun getDisplayConfiguration (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;
2224-
public final fun toHTML (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2225-
public static synthetic fun toHTML$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2226-
public final fun toStandaloneHTML (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2227-
public static synthetic fun toStandaloneHTML$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2228+
public final fun toHtml (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2229+
public static synthetic fun toHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2230+
public final fun toStandaloneHtml (Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
2231+
public static synthetic fun toStandaloneHtml$default (Lorg/jetbrains/kotlinx/dataframe/api/FormattedFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
22282232
}
22292233

22302234
public final class org/jetbrains/kotlinx/dataframe/api/FormattingDSL {
@@ -6091,6 +6095,9 @@ public final class org/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData {
60916095
public final fun writeHTML (Ljava/io/File;)V
60926096
public final fun writeHTML (Ljava/lang/String;)V
60936097
public final fun writeHTML (Ljava/nio/file/Path;)V
6098+
public final fun writeHtml (Ljava/io/File;)V
6099+
public final fun writeHtml (Ljava/lang/String;)V
6100+
public final fun writeHtml (Ljava/nio/file/Path;)V
60946101
}
60956102

60966103
public final class org/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData$Companion {
@@ -6167,8 +6174,12 @@ public final class org/jetbrains/kotlinx/dataframe/io/GuessKt {
61676174
public final class org/jetbrains/kotlinx/dataframe/io/HtmlKt {
61686175
public static final fun toHTML (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
61696176
public static synthetic fun toHTML$default (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
6177+
public static final fun toHtml (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
6178+
public static synthetic fun toHtml$default (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
61706179
public static final fun toStandaloneHTML (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
61716180
public static synthetic fun toStandaloneHTML$default (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
6181+
public static final fun toStandaloneHtml (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
6182+
public static synthetic fun toStandaloneHtml$default (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
61726183
public static final fun toStaticHtml (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;ZZ)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
61736184
public static synthetic fun toStaticHtml$default (Lorg/jetbrains/kotlinx/dataframe/DataFrame;Lorg/jetbrains/kotlinx/dataframe/io/DisplayConfiguration;Lorg/jetbrains/kotlinx/dataframe/jupyter/CellRenderer;ZZILjava/lang/Object;)Lorg/jetbrains/kotlinx/dataframe/io/DataFrameHtmlData;
61746185
}

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

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,13 @@ import org.jetbrains.kotlinx.dataframe.impl.io.FastDoubleParser
5050
import org.jetbrains.kotlinx.dataframe.io.toDataFrame
5151
import org.jetbrains.kotlinx.dataframe.util.CONVERT_TO
5252
import org.jetbrains.kotlinx.dataframe.util.CONVERT_TO_REPLACE
53+
import org.jetbrains.kotlinx.dataframe.util.CONVERT_TO_URL
54+
import org.jetbrains.kotlinx.dataframe.util.CONVERT_TO_URL_REPLACE
55+
import org.jetbrains.kotlinx.dataframe.util.TO_URL
56+
import org.jetbrains.kotlinx.dataframe.util.TO_URL_REPLACE
5357
import java.math.BigDecimal
5458
import java.math.BigInteger
59+
import java.net.URI
5560
import java.net.URL
5661
import java.util.Locale
5762
import kotlin.reflect.KProperty
@@ -180,7 +185,7 @@ internal interface ConvertDocs {
180185
* `| `__`.`__[**`toInstant`**][Convert.toInstant]`()`
181186
*
182187
* {@include [Indent]}
183-
* `| `__`.`__[**`toURL`**][Convert.toURL]`()`
188+
* `| `__`.`__[**`toUrl`**][Convert.toUrl]`()`
184189
*
185190
* {@include [Indent]}
186191
* `| `__`.`__[**`toIFrame`**][Convert.toIFrame]`()`
@@ -325,7 +330,7 @@ public inline fun <T, C, reified R> Convert<T, C?>.notNull(
325330
* - [toStr], [toInt], [toLong], [toDouble], [toFloat], [toBigDecimal],
326331
* [toBigInteger], [toBoolean] – convert to standard types.
327332
* - [toLocalDateTime], [toLocalDate], [toLocalTime], [toInstant] – convert to kotlinx.datetime types.
328-
* - [toURL], [toIFrame], [toImg] – convert to special types.
333+
* - [toUrl], [toIFrame], [toImg] – convert to special types.
329334
* - [toDataFrames] – converts a column of lists into separate DataFrames.
330335
*
331336
* See [Grammar][ConvertDocs.Grammar] for more details.
@@ -956,20 +961,34 @@ public fun <T, R : URL?> Convert<T, URL>.toImg(width: Int? = null, height: Int?
956961

957962
// region toURL
958963

964+
@Deprecated(CONVERT_TO_URL, ReplaceWith(CONVERT_TO_URL_REPLACE), DeprecationLevel.ERROR)
965+
public fun DataColumn<String>.convertToURL(): DataColumn<URL> = convertToUrl()
966+
959967
/**
960968
* Converts values in this [String] column to an [URL].
961969
*
962970
* @return A new [DataColumn] with an [URL] values.
963971
*/
964-
public fun DataColumn<String>.convertToURL(): DataColumn<URL> = map { URL(it) }
972+
public fun DataColumn<String>.convertToUrl(): DataColumn<URL> = map { URI(it).toURL() }
973+
974+
@Deprecated(CONVERT_TO_URL, ReplaceWith(CONVERT_TO_URL_REPLACE), DeprecationLevel.ERROR)
975+
@JvmName("convertToURLFromStringNullable")
976+
public fun DataColumn<String?>.convertToURL(): DataColumn<URL?> = convertToUrl()
965977

966978
/**
967979
* Converts values in this [String] column to an [URL]. Preserves null values.
968980
*
969981
* @return A new [DataColumn] with an [URL] nullable values.
970982
*/
971-
@JvmName("convertToURLFromStringNullable")
972-
public fun DataColumn<String?>.convertToURL(): DataColumn<URL?> = map { it?.let { URL(it) } }
983+
@JvmName("convertToUrlFromStringNullable")
984+
public fun DataColumn<String?>.convertToUrl(): DataColumn<URL?> = map { it?.let { URI(it).toURL() } }
985+
986+
@Deprecated(TO_URL, ReplaceWith(TO_URL_REPLACE), DeprecationLevel.ERROR)
987+
@JvmName("toURLFromStringNullable")
988+
@Refine
989+
@Converter(URL::class, nullable = true)
990+
@Interpretable("ToSpecificType")
991+
public fun <T> Convert<T, String?>.toURL(): DataFrame<T> = asColumn { it.convertToUrl() }
973992

974993
/**
975994
* Converts values in the [String] columns previously selected with [convert] to an [URL],
@@ -980,7 +999,7 @@ public fun DataColumn<String?>.convertToURL(): DataColumn<URL?> = map { it?.let
980999
*
9811000
* ### Examples:
9821001
* ```kotlin
983-
* df.convert { webAddress }.toURL()
1002+
* df.convert { webAddress }.toUrl()
9841003
* ```
9851004
*
9861005
* @return A new [DataFrame] with the values converted to an [URL].
@@ -989,7 +1008,14 @@ public fun DataColumn<String?>.convertToURL(): DataColumn<URL?> = map { it?.let
9891008
@Refine
9901009
@Converter(URL::class, nullable = true)
9911010
@Interpretable("ToSpecificType")
992-
public fun <T> Convert<T, String?>.toURL(): DataFrame<T> = asColumn { it.convertToURL() }
1011+
public fun <T> Convert<T, String?>.toUrl(): DataFrame<T> = asColumn { it.convertToUrl() }
1012+
1013+
@Deprecated(TO_URL, ReplaceWith(TO_URL_REPLACE), DeprecationLevel.ERROR)
1014+
@JvmName("toURLFromString")
1015+
@Refine
1016+
@Converter(URL::class, nullable = false)
1017+
@Interpretable("ToSpecificType")
1018+
public fun <T> Convert<T, String>.toURL(): DataFrame<T> = toUrl()
9931019

9941020
/**
9951021
* Converts values in the [String] columns previously selected with [convert] to an [URL],
@@ -999,7 +1025,7 @@ public fun <T> Convert<T, String?>.toURL(): DataFrame<T> = asColumn { it.convert
9991025
*
10001026
* ### Examples:
10011027
* ```kotlin
1002-
* df.convert { webAddress }.toURL()
1028+
* df.convert { webAddress }.toUrl()
10031029
* ```
10041030
*
10051031
* @return A new [DataFrame] with the values converted to an [URL].
@@ -1008,7 +1034,7 @@ public fun <T> Convert<T, String?>.toURL(): DataFrame<T> = asColumn { it.convert
10081034
@Refine
10091035
@Converter(URL::class, nullable = false)
10101036
@Interpretable("ToSpecificType")
1011-
public fun <T> Convert<T, String>.toURL(): DataFrame<T> = asColumn { it.convertToURL() }
1037+
public fun <T> Convert<T, String>.toUrl(): DataFrame<T> = asColumn { it.convertToUrl() }
10121038

10131039
// endregion
10141040

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ import org.jetbrains.kotlinx.dataframe.impl.api.formatImpl
1515
import org.jetbrains.kotlinx.dataframe.impl.api.linearGradient
1616
import org.jetbrains.kotlinx.dataframe.io.DataFrameHtmlData
1717
import org.jetbrains.kotlinx.dataframe.io.DisplayConfiguration
18-
import org.jetbrains.kotlinx.dataframe.io.toHTML
19-
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHTML
18+
import org.jetbrains.kotlinx.dataframe.io.toHtml
19+
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHtml
2020
import kotlin.reflect.KProperty
2121

2222
// region DataFrame
@@ -126,14 +126,14 @@ public class FormattedFrame<T>(internal val df: DataFrame<T>, internal val forma
126126
/**
127127
* @return DataFrameHtmlData without additional definitions. Can be rendered in Jupyter kernel environments
128128
*/
129-
public fun toHTML(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT): DataFrameHtmlData =
130-
df.toHTML(getDisplayConfiguration(configuration))
129+
public fun toHtml(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT): DataFrameHtmlData =
130+
df.toHtml(getDisplayConfiguration(configuration))
131131

132132
/**
133133
* @return DataFrameHtmlData with table script and css definitions. Can be saved as an *.html file and displayed in the browser
134134
*/
135-
public fun toStandaloneHTML(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT): DataFrameHtmlData =
136-
df.toStandaloneHTML(getDisplayConfiguration(configuration))
135+
public fun toStandaloneHtml(configuration: DisplayConfiguration = DisplayConfiguration.DEFAULT): DataFrameHtmlData =
136+
df.toStandaloneHtml(getDisplayConfiguration(configuration))
137137

138138
public fun getDisplayConfiguration(configuration: DisplayConfiguration): DisplayConfiguration =
139139
configuration.copy(cellFormatter = formatter as RowColFormatter<*, *>?)

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import org.jetbrains.kotlinx.dataframe.io.isUrl
4141
import org.jetbrains.kotlinx.dataframe.values
4242
import java.math.BigDecimal
4343
import java.math.BigInteger
44+
import java.net.URI
4445
import java.net.URL
4546
import java.text.ParsePosition
4647
import java.time.format.DateTimeFormatter
@@ -240,7 +241,7 @@ internal object Parsers : GlobalParserOptions {
240241
toJavaLocalDateTimeOrNull(formatter) // since we accept a Java DateTimeFormatter
241242
?.toKotlinLocalDateTime()
242243

243-
private fun String.toUrlOrNull(): URL? = if (isUrl(this)) catchSilent { URL(this) } else null
244+
private fun String.toUrlOrNull(): URL? = if (isUrl(this)) catchSilent { URI(this).toURL() } else null
244245

245246
private fun String.toBooleanOrNull() =
246247
when (uppercase(Locale.getDefault())) {

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import org.jetbrains.kotlinx.dataframe.util.IS_URL_REPLACE
1111
import java.io.File
1212
import java.io.InputStream
1313
import java.net.HttpURLConnection
14+
import java.net.URI
1415
import java.net.URL
1516

1617
/**
@@ -110,7 +111,7 @@ public fun isProtocolSupported(url: URL): Boolean = url.protocol in setOf("http"
110111
*/
111112
public fun asUrl(fileOrUrl: String): URL =
112113
if (isUrl(fileOrUrl)) {
113-
URL(fileOrUrl).toURI()
114+
URI(fileOrUrl)
114115
} else {
115116
File(fileOrUrl).also {
116117
require(it.exists()) { "File not found: \"$fileOrUrl\"" }

0 commit comments

Comments
 (0)