Add literal type to union literal

[pingsutw]

Signed-off-by: Kevin Su [email protected]

TL;DR

flyteorg/flyte#2817

class Color(Enum):
    RED = "red"
    GREEN = "green"
    BLUE = "blue"


@task
def coalesce(a:  Union[List[str], str, Color]) -> str:
    if type(a) == Color:
        print(a.name)
        return a.name
    print(a)
    return a


@workflow
def wf(a:  Union[List[str], str, Color]) -> str:
    coalesced = coalesce(a=a)
    return coalesced


if __name__ == "__main__":
    wf(a=Color("red"))

Take the above code as an example. If we run pyflyte run --remote example_union.py wf --a "flyte", we'll get the below error.

Request failed with status code 400 invalid a input wrong type, expected union_type:<variants:<collection_type:
<simple:STRING > structure:<tag:"Typed List" > > variants:<simple:STRING structure:<tag:"str" > > variants:<enum_type:
<values:"red" values:"green" values:"blue" > structure:<tag:"DefaultEnumTransformer" > > > , got simple:STRING instead

That's because literal(string) can be converted to str or enum, which is ambiguous. To address this, we should add literal type in Union type, and it can force validator to cast "flyte" to string

Type

• Bug Fix
• Feature
• Plugin

Are all requirements met?

• Code completed
• Smoke tested
• Unit tests added
• Code documentation added
• Any pending items have an associated Issue

Complete description

How did you fix the bug, make the feature etc. Link to any design docs etc

Tracking Issue

https://github.com/flyteorg/flyte/issues/

Follow-up issue

NA
OR
https://github.com/flyteorg/flyte/issues/

[codecov]

Codecov Report

Merging #1144 (304dd94) into master (3cf0639) will increase coverage by 0.07%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1144      +/-   ##
==========================================
+ Coverage   68.36%   68.43%   +0.07%     
==========================================
  Files         287      288       +1     
  Lines       25931    25998      +67     
  Branches     2898     2900       +2     
==========================================
+ Hits        17728    17793      +65     
- Misses       7725     7727       +2     
  Partials      478      478              

Impacted Files	Coverage Δ
flytekit/clis/sdk_in_container/run.py	84.19% <100.00%> (+0.59%)	⬆️
tests/flytekit/unit/cli/pyflyte/test_run.py	99.20% <100.00%> (+0.39%)	⬆️
flytekit/remote/remote.py	41.11% <0.00%> (ø)
flytekit/clis/sdk_in_container/constants.py	100.00% <0.00%> (ø)
tests/flytekit/unit/cli/pyflyte/imperative_wf.py	86.36% <0.00%> (ø)
flytekit/core/tracker.py	48.67% <0.00%> (+0.04%)	⬆️
flytekit/tools/script_mode.py	49.25% <0.00%> (+0.72%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[eapolinario]

Can you add a unit test?

[wild-endeavor]

this is dependent on the propeller pr going out first right?

[pingsutw]

yes, let's merge this after propeller pr.