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

Jump to bottom

fix: add support for PEP 585 type hinting for 3.9+ #199

Open
wants to merge 14 commits into
base: dev
Choose a base branch
from
Open

fix: add support for PEP 585 type hinting for 3.9+ #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
53ccfab
support standard collection types in type hint for 3.9+
YunchuWang Dec 20, 2023
414cb0a
fix
YunchuWang Dec 21, 2023
87e06b8
fix
YunchuWang Dec 21, 2023
6583719
fix
YunchuWang Dec 21, 2023
1b8c295
fix
YunchuWang Dec 21, 2023
e1ba535
fix
YunchuWang Dec 21, 2023
0648666
change tests
YunchuWang Dec 21, 2023
5c02cba
fix
YunchuWang Dec 21, 2023
862f0ca
fix
YunchuWang Dec 22, 2023
45e853d
fix eh tests
YunchuWang Dec 22, 2023
94739ae
fix
YunchuWang Dec 22, 2023
e0b550c
Merge branch 'dev' into wangbill/native-type-hint
hallvictoria Aug 12, 2024
7cbabd6
Merge branch 'dev' into wangbill/native-type-hint
hallvictoria Aug 20, 2024
3095502
docs
Aug 21, 2024
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
30 changes: 24 additions & 6 deletions azure/functions/meta.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@
import datetime
import json
import re
import sys

from typing import Dict, Optional, Union, Tuple, Mapping, Any
if sys.version_info >= (3, 9):
from typing import get_origin, get_args
else:
from ._thirdparty.typing_inspect import get_origin, get_args

from ._thirdparty import typing_inspect
from ._utils import (
Expand All @@ -16,16 +22,28 @@


def is_iterable_type_annotation(annotation: object, pytype: object) -> bool:
is_iterable_anno = (
typing_inspect.is_generic_type(annotation)
and issubclass(typing_inspect.get_origin(annotation),
collections.abc.Iterable)
)
"""Since python 3.9, standard collection types are supported in type hint.
origin is the unsubscripted version of a type (eg. list, union, etc.).

If origin is not None, then the type annotation is a builtin or part of
the collections class.
"""
origin = get_origin(annotation)
if sys.version_info >= (3, 9):
is_iterable_anno = (origin is not None
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is typing_inspect.is_generic_type(annotation) not included in >3.9?

Copy link
Contributor

Choose a reason for hiding this comment

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

is_generic_type will fail for the list type -- this is a method we defined. get_origin expands on our definition of is_generic_type but includes the built-in collection types. get_origin supports the generic types and returns a non-None value where is_generic_type would return true

and issubclass(origin, collections.abc.Iterable))
else:
is_iterable_anno = (
typing_inspect.is_generic_type(annotation)
and origin is not None
and issubclass(origin, collections.abc.Iterable)
)

if not is_iterable_anno:
return False

args = typing_inspect.get_args(annotation)
args = get_args(annotation)

if not args:
return False

Expand Down
6 changes: 6 additions & 0 deletions tests/test_eventgrid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Licensed under the MIT License.

from datetime import datetime
import sys
import unittest
from typing import List

Expand All @@ -21,6 +22,11 @@ def test_eventgrid_input_type(self):
def test_eventgrid_output_type(self):
check_output_type = azf_event_grid.EventGridEventOutConverter.\
check_output_type_annotation

if sys.version_info >= (3, 9):
self.assertTrue(check_output_type(list[func.EventGridOutputEvent]))
self.assertTrue(check_output_type(list[str]))

self.assertTrue(check_output_type(func.EventGridOutputEvent))
self.assertTrue(check_output_type(List[func.EventGridOutputEvent]))
self.assertTrue(check_output_type(str))
Expand Down
8 changes: 8 additions & 0 deletions tests/test_eventhub.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

import sys
from typing import List, Mapping
import unittest
import json
Expand All @@ -21,6 +22,9 @@ def test_eventhub_input_type(self):
check_input_type = (
azf_eh.EventHubConverter.check_input_type_annotation
)
if sys.version_info >= (3, 9):
self.assertTrue(check_input_type(list[func.EventHubEvent]))

self.assertTrue(check_input_type(func.EventHubEvent))
self.assertTrue(check_input_type(List[func.EventHubEvent]))
self.assertFalse(check_input_type(str))
Expand All @@ -31,6 +35,10 @@ def test_eventhub_output_type(self):
check_output_type = (
azf_eh.EventHubTriggerConverter.check_output_type_annotation
)

if sys.version_info >= (3, 9):
self.assertTrue(check_output_type(list[str]))

self.assertTrue(check_output_type(bytes))
self.assertTrue(check_output_type(str))
self.assertTrue(check_output_type(List[str]))
Expand Down
9 changes: 9 additions & 0 deletions tests/test_kafka.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

import sys
from typing import List
import unittest
import json
Expand Down Expand Up @@ -34,6 +35,10 @@ def test_kafka_input_type(self):
check_input_type = (
azf_ka.KafkaConverter.check_input_type_annotation
)

if sys.version_info >= (3, 9):
self.assertTrue(check_input_type(list[func.KafkaEvent]))

self.assertTrue(check_input_type(func.KafkaEvent))
self.assertTrue(check_input_type(List[func.KafkaEvent]))
self.assertFalse(check_input_type(str))
Expand All @@ -44,6 +49,10 @@ def test_kafka_output_type(self):
check_output_type = (
azf_ka.KafkaTriggerConverter.check_output_type_annotation
)

if sys.version_info >= (3, 9):
self.assertTrue(check_output_type(list[str]))

self.assertTrue(check_output_type(bytes))
self.assertTrue(check_output_type(str))
self.assertTrue(check_output_type(List[str]))
Expand Down