Skip to content
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

Correctly fetch typing.Annotated metadata in typing.NamedTuple #1096

Merged
merged 4 commits into from
Jul 11, 2022
Merged

Correctly fetch typing.Annotated metadata in typing.NamedTuple #1096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
86780e4
Correctly fetch metadata in
samhita-alla Jul 8, 2022
80a39f1
fix import issue
samhita-alla Jul 8, 2022
edcefef
add unit test
samhita-alla Jul 8, 2022
096b8ef
fix low codecov
samhita-alla Jul 11, 2022
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
11 changes: 4 additions & 7 deletions flytekit/core/interface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from collections import OrderedDict
from typing import Any, Dict, Generator, List, Optional, Tuple, Type, TypeVar, Union

from typing_extensions import get_args, get_origin
from typing_extensions import get_args, get_origin, get_type_hints
Copy link
Contributor

Choose a reason for hiding this comment

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

so in python 3.7 and 3.8, it just doesn't do anything?

Copy link
Collaborator

Choose a reason for hiding this comment

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

no, the annotations are returned regardless in python < 3.9.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I guess that's what you meant by "doing nothing".


from flytekit.core import context_manager
from flytekit.core.docstring import Docstring
Expand Down Expand Up @@ -283,11 +283,8 @@ def transform_function_to_interface(fn: typing.Callable, docstring: Optional[Doc
For now the fancy object, maybe in the future a dumb object.

"""
try:
# include_extras can only be used in python >= 3.9
type_hints = typing.get_type_hints(fn, include_extras=True)
except TypeError:
type_hints = typing.get_type_hints(fn)

type_hints = get_type_hints(fn, include_extras=True)
signature = inspect.signature(fn)
return_annotation = type_hints.get("return", None)

Expand Down Expand Up @@ -395,7 +392,7 @@ def t(a: int, b: str) -> Dict[str, int]: ...
bases = return_annotation.__bases__ # type: ignore
if len(bases) == 1 and bases[0] == tuple and hasattr(return_annotation, "_fields"):
logger.debug(f"Task returns named tuple {return_annotation}")
return dict(typing.get_type_hints(return_annotation))
return dict(get_type_hints(return_annotation, include_extras=True))

if hasattr(return_annotation, "__origin__") and return_annotation.__origin__ is tuple: # type: ignore
# Handle option 3
Expand Down
11 changes: 10 additions & 1 deletion tests/flytekit/unit/core/test_type_hints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
from dataclasses_json import dataclass_json
from google.protobuf.struct_pb2 import Struct
from pandas._testing import assert_frame_equal
from typing_extensions import Annotated
from typing_extensions import Annotated, get_origin

import flytekit
import flytekit.configuration
Expand Down Expand Up @@ -89,6 +89,15 @@ def my_task(a: int) -> typing.NamedTuple("OutputsBC", b=typing.ForwardRef("int")
assert context_manager.FlyteContextManager.size() == 1


def test_annotated_namedtuple_output():
@task
def my_task(a: int) -> typing.NamedTuple("OutputA", a=Annotated[int, "metadata-a"]):
return a + 2

assert my_task(a=9) == (11,)
assert get_origin(my_task.python_interface.outputs["a"]) is Annotated


def test_simple_input_no_output():
@task
def my_task(a: int):
Expand Down