Skip to content

Commit f7251dd

Browse files
committed
Hide internals of intermediate objects and data class attribute to remove irrelevant suggestions from completion
1 parent bb55f83 commit f7251dd

File tree

11 files changed

+51
-25
lines changed

11 files changed

+51
-25
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,13 @@ public inline fun <T, C, reified R> Convert<T, C?>.notNull(
9191
}
9292

9393
@HasSchema(schemaArg = 0)
94-
public data class Convert<T, out C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C>) {
94+
public class Convert<T, out C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>) {
9595
public fun <R> cast(): Convert<T, R> = Convert(df, columns as ColumnsSelector<T, R>)
9696

9797
@Interpretable("To0")
9898
public inline fun <reified D> to(): DataFrame<T> = to(typeOf<D>())
99+
100+
override fun toString(): String = "Convert(df=$df, columns=$columns)"
99101
}
100102

101103
public fun <T> Convert<T, *>.to(type: KType): DataFrame<T> = to { it.convertTo(type) }

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ public fun <T, C> FormatClause<T, C>.perRowCol(formatter: RowColFormatter<T, C>)
4242
public fun <T, C> FormatClause<T, C>.with(formatter: CellFormatter<C>): FormattedFrame<T> =
4343
formatImpl { row, col -> formatter(row[col]) }
4444

45-
public fun <T, C> FormatClause<T, C>.where(filter: RowValueFilter<T, C>): FormatClause<T, C> = copy(filter = filter)
45+
public fun <T, C> FormatClause<T, C>.where(filter: RowValueFilter<T, C>): FormatClause<T, C> =
46+
FormatClause(filter = filter, df = df, columns = columns, oldFormatter = oldFormatter)
4647

4748
public fun <T> FormattedFrame<T>.format(): FormatClause<T, Any?> = FormatClause(df, null, formatter)
4849

@@ -129,12 +130,15 @@ public class FormattedFrame<T>(internal val df: DataFrame<T>, internal val forma
129130
configuration.copy(cellFormatter = formatter as RowColFormatter<*, *>?)
130131
}
131132

132-
public data class FormatClause<T, C>(
133-
val df: DataFrame<T>,
134-
val columns: ColumnsSelector<T, C>? = null,
135-
val oldFormatter: RowColFormatter<T, C>? = null,
136-
val filter: RowValueFilter<T, C> = { true },
137-
)
133+
public class FormatClause<T, C>(
134+
internal val df: DataFrame<T>,
135+
internal val columns: ColumnsSelector<T, C>? = null,
136+
internal val oldFormatter: RowColFormatter<T, C>? = null,
137+
internal val filter: RowValueFilter<T, C> = { true },
138+
) {
139+
override fun toString(): String =
140+
"FormatClause(df=$df, columns=$columns, oldFormatter=$oldFormatter, filter=$filter)"
141+
}
138142

139143
public fun <T, C> FormattedFrame<T>.format(columns: ColumnsSelector<T, C>): FormatClause<T, C> =
140144
FormatClause(df, columns, formatter)

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ public fun <T> DataFrame<T>.group(vararg columns: KProperty<*>): GroupClause<T,
2828

2929
// region GroupClause
3030

31-
public data class GroupClause<T, C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C>)
31+
public class GroupClause<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>) {
32+
override fun toString(): String = "GroupClause(df=$df, columns=$columns)"
33+
}
3234

3335
// region into
3436

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,11 @@ internal fun <T, G> GroupBy<T, G>.internal(): GroupByImpl<T, G> = this as GroupB
104104

105105
public interface Grouped<out T> : Aggregatable<T>
106106

107-
public data class ReducedGroupBy<T, G>(
107+
public class ReducedGroupBy<T, G>(
108108
@PublishedApi internal val groupBy: GroupBy<T, G>,
109109
@PublishedApi internal val reducer: Selector<DataFrame<G>, DataRow<G>?>,
110-
)
110+
) {
111+
override fun toString(): String = "ReducedGroupBy(groupBy=$groupBy, reducer=$reducer)"
112+
}
111113

112114
internal fun <T, G> GroupBy<T, G>.reduce(reducer: Selector<DataFrame<G>, DataRow<G>?>) = ReducedGroupBy(this, reducer)

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ public inline fun <T, reified R> DataFrame<T>.insert(
4343

4444
// endregion
4545

46-
public data class InsertClause<T>(val df: DataFrame<T>, val column: AnyCol)
46+
public class InsertClause<T>(internal val df: DataFrame<T>, internal val column: AnyCol) {
47+
override fun toString(): String = "InsertClause(df=$df, column=$column)"
48+
}
4749

4850
// region under
4951

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@ public fun <T, C> MoveClause<T, C>.toLeft(): DataFrame<T> = to(0)
150150

151151
public fun <T, C> MoveClause<T, C>.toRight(): DataFrame<T> = to(df.ncol)
152152

153-
public class MoveClause<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>)
153+
public class MoveClause<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>) {
154+
override fun toString(): String = "MoveClause(df=$df, columns=$columns)"
155+
}
154156

155157
// endregion

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,12 @@ public interface Pivot<T> : Aggregatable<T>
212212

213213
public typealias PivotColumnsSelector<T, C> = Selector<PivotDsl<T>, ColumnsResolver<C>>
214214

215-
public data class ReducedPivot<T>(
215+
public class ReducedPivot<T>(
216216
@PublishedApi internal val pivot: Pivot<T>,
217217
@PublishedApi internal val reducer: Selector<DataFrame<T>, DataRow<T>?>,
218-
)
218+
) {
219+
override fun toString(): String = "ReducedPivot(pivot=$pivot, reducer=$reducer)"
220+
}
219221

220222
internal fun <T> Pivot<T>.reduce(reducer: Selector<DataFrame<T>, DataRow<T>?>) = ReducedPivot(this, reducer)
221223

@@ -230,10 +232,12 @@ public interface PivotGroupBy<out T> : Aggregatable<T> {
230232
public fun default(value: Any?): PivotGroupBy<T>
231233
}
232234

233-
public data class ReducedPivotGroupBy<T>(
235+
public class ReducedPivotGroupBy<T>(
234236
@PublishedApi internal val pivot: PivotGroupBy<T>,
235237
@PublishedApi internal val reducer: Selector<DataFrame<T>, DataRow<T>?>,
236-
)
238+
) {
239+
override fun toString(): String = "ReducedPivotGroupBy(pivot=$pivot, reducer=$reducer)"
240+
}
237241

238242
@PublishedApi
239243
internal fun <T> PivotGroupBy<T>.reduce(reducer: Selector<DataFrame<T>, DataRow<T>?>): ReducedPivotGroupBy<T> =

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ public fun <T, C> DataFrame<T>.rename(vararg cols: KProperty<C>): RenameClause<T
4545
public fun <T> DataFrame<T>.rename(vararg cols: String): RenameClause<T, Any?> = rename { cols.toColumnSet() }
4646

4747
@HasSchema(schemaArg = 0)
48-
public data class RenameClause<T, C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C>)
48+
public class RenameClause<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>) {
49+
override fun toString(): String = "RenameClause(df=$df, columns=$columns)"
50+
}
4951

5052
/**
5153
* ## Rename to camelCase

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ public fun <T> DataFrame<T>.replaceAll(
3333
return update(columns).with { map[it] ?: it }
3434
}
3535

36-
public data class ReplaceClause<T, C>(val df: DataFrame<T>, val columns: ColumnsSelector<T, C>)
36+
public class ReplaceClause<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C>) {
37+
override fun toString(): String = "ReplaceClause(df=$df, columns=$columns)"
38+
}
3739

3840
public fun <T, C> ReplaceClause<T, C>.with(vararg columns: AnyCol): DataFrame<T> = with(columns.toList())
3941

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@ public fun <T, C> DataFrame<T>.split(vararg columns: ColumnReference<C?>): Split
2828

2929
public fun <T, C> DataFrame<T>.split(vararg columns: KProperty<C?>): Split<T, C> = split { columns.toColumnSet() }
3030

31-
public data class Split<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C?>) {
31+
public class Split<T, C>(internal val df: DataFrame<T>, internal val columns: ColumnsSelector<T, C?>) {
3232
public fun <P> cast(): Split<T, P> = this as Split<T, P>
33+
34+
override fun toString(): String = "Split(df=$df, columns=$columns)"
3335
}
3436

3537
public data class SplitWithTransform<T, C, R>(

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,16 @@ import kotlin.reflect.KProperty
4040
*
4141
* For more information: {@include [DocumentationUrls.Update]}
4242
*/
43-
public data class Update<T, C>(
44-
val df: DataFrame<T>,
45-
val filter: RowValueFilter<T, C>?,
46-
val columns: ColumnsSelector<T, C>,
43+
public class Update<T, C>(
44+
internal val df: DataFrame<T>,
45+
internal val filter: RowValueFilter<T, C>?,
46+
internal val columns: ColumnsSelector<T, C>,
4747
) {
4848
public fun <R : C> cast(): Update<T, R> =
4949
Update(df, filter as RowValueFilter<T, R>?, columns as ColumnsSelector<T, R>)
5050

51+
override fun toString(): String = "Update(df=$df, filter=$filter, columns=$columns)"
52+
5153
/*
5254
* This argument providing the (clickable) name of the update-like function.
5355
* Note: If clickable, make sure to [alias][your type].
@@ -188,7 +190,7 @@ public fun <T, C> DataFrame<T>.update(vararg columns: ColumnReference<C>): Updat
188190
* @param [predicate] The [row value filter][RowValueFilter] to select the rows to update.
189191
*/
190192
public fun <T, C> Update<T, C>.where(predicate: RowValueFilter<T, C>): Update<T, C> =
191-
copy(filter = filter and predicate)
193+
Update(df = df, filter = filter and predicate, columns = columns)
192194

193195
/** ## At
194196
* Only update the columns at certain given [row indices][CommonUpdateAtFunctionDoc.RowIndicesParam]:

0 commit comments

Comments
 (0)