Skip to content

Case class for BindingCollection/Map #263

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

Merged
honnix merged 3 commits into from
Oct 19, 2023
Merged

Case class for BindingCollection/Map #263

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
7bb1271
Make BindingCollection and BindingMap case class
honnix Oct 18, 2023
80a90a9
Minor cleanup
honnix Oct 18, 2023
a32679d
Revise package doc a bit
honnix Oct 19, 2023
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
3 changes: 1 addition & 2 deletions flytekit-scala_2.13/src/main/scala/org/flyte/flytekit/BindingCollection.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,12 @@
package org.flyte.flytekit
Copy link
Member Author

@honnix honnix Oct 19, 2023

Choose a reason for hiding this comment

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

BTW why these classes are not under flytekitscala package?

Copy link
Member Author

@honnix honnix Oct 19, 2023

Choose a reason for hiding this comment

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

OK explained here https://github.com/flyteorg/flytekit-java/blob/master/flytekit-scala_2.13/src/main/scala/org/flyte/flytekit/package.scala

Copy link
Member Author

@honnix honnix Oct 19, 2023

Choose a reason for hiding this comment

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

We cannot make it protected either as it would
  * be good for the own object but both implementations deal with list or maps
  * of [[SdkBindingData]] and therefore cannot call this method because it is in
  * a different class.

Not sure I understand what this refers to.

Copy link
Member Author

@honnix honnix Oct 19, 2023

Choose a reason for hiding this comment

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

I think I understand what this means.

Copy link
Member Author

@honnix honnix Oct 19, 2023

Choose a reason for hiding this comment

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

I tried revising it a bit in a latter commit.


import org.flyte.api.v1.BindingData
import org.flyte.flytekit.SdkBindingData.Literal
import org.flyte.flytekitscala.SdkLiteralTypes.collections

import java.util.function
import scala.collection.JavaConverters._

private[flyte] class BindingCollection[T](
private[flyte] case class BindingCollection[T](
elementType: SdkLiteralType[T],
bindingCollection: List[SdkBindingData[T]]
) extends SdkBindingData[List[T]] {
Expand Down
3 changes: 1 addition & 2 deletions flytekit-scala_2.13/src/main/scala/org/flyte/flytekit/BindingMap.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,12 @@
package org.flyte.flytekit

import org.flyte.api.v1.BindingData
import org.flyte.flytekit.SdkBindingData.Literal
import org.flyte.flytekitscala.SdkLiteralTypes.maps

import java.util.function
import scala.collection.JavaConverters._

private[flyte] class BindingMap[T](
private[flyte] case class BindingMap[T](
valuesType: SdkLiteralType[T],
bindingMap: Map[String, SdkBindingData[T]]
) extends SdkBindingData[Map[String, T]] {
Expand Down
7 changes: 3 additions & 4 deletions flytekit-scala_2.13/src/main/scala/org/flyte/flytekit/package.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@ package org.flyte

/** Contains subclasses for [[SdkBindingData]]. We are forced to define this
* package here because [[SdkBindingData#idl()]] is package private (we don´t
* want to expose it to users). We cannot make it protected either as it would
* be good for the own object but both implementations deal with list or maps
* of [[SdkBindingData]] and therefore cannot call this method because it is in
* a different class.
* want to expose it to users). Making it protected doesn't help either because
* list or map needs to call this method of elements so that requires it to be
* public.
*
* This is not ideal because we are splitting the flytekit package in two maven
* modules. This would create problems when we decide to add java 9 style
Expand Down
4 changes: 2 additions & 2 deletions flytekit-scala_2.13/src/main/scala/org/flyte/flytekitscala/SdkBindingDataFactory.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ object SdkBindingDataFactory {
elementType: SdkLiteralType[T],
elements: List[SdkBindingData[T]]
): SdkBindingData[List[T]] = {
new BindingCollection(elementType, elements)
BindingCollection(elementType, elements)
}

/** Creates a [[SdkBindingData]] for a flyte map given a java
Expand All @@ -372,7 +372,7 @@ object SdkBindingDataFactory {
valuesType: SdkLiteralType[T],
valueMap: Map[String, SdkBindingData[T]]
): SdkBindingData[Map[String, T]] =
new BindingMap(valuesType, valueMap)
BindingMap(valuesType, valueMap)

private def toSdkLiteralType(
value: Any,
Expand Down