| # |
| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You under the Apache License, Version 2.0 |
| # (the "License"); you may not use this file except in compliance with |
| # the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| |
| """Unit tests for type-hint objects and decorators - Python 3 syntax specific. |
| """ |
| |
| # pytype: skip-file |
| |
| from __future__ import absolute_import |
| |
| import typing |
| import unittest |
| |
| import apache_beam as beam |
| from apache_beam import typehints |
| |
| |
| class MainInputTest(unittest.TestCase): |
| def test_typed_dofn_method(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int) -> typehints.Tuple[str]: |
| return tuple(str(element)) |
| |
| result = [1, 2, 3] | beam.ParDo(MyDoFn()) |
| self.assertEqual(['1', '2', '3'], sorted(result)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*int.*got.*str'): |
| _ = ['a', 'b', 'c'] | beam.ParDo(MyDoFn()) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*int.*got.*str'): |
| _ = [1, 2, 3] | (beam.ParDo(MyDoFn()) | 'again' >> beam.ParDo(MyDoFn())) |
| |
| def test_typed_dofn_method_with_class_decorators(self): |
| # Class decorators take precedence over PEP 484 hints. |
| @typehints.with_input_types(typehints.Tuple[int, int]) |
| @typehints.with_output_types(int) |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int) -> typehints.Tuple[str]: |
| yield element[0] |
| |
| result = [(1, 2)] | beam.ParDo(MyDoFn()) |
| self.assertEqual([1], sorted(result)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*Tuple\[int, int\].*got.*str'): |
| _ = ['a', 'b', 'c'] | beam.ParDo(MyDoFn()) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*Tuple\[int, int\].*got.*int'): |
| _ = [1, 2, 3] | (beam.ParDo(MyDoFn()) | 'again' >> beam.ParDo(MyDoFn())) |
| |
| def test_typed_dofn_instance(self): |
| # Type hints applied to DoFn instance take precedence over decorators and |
| # process annotations. |
| @typehints.with_input_types(typehints.Tuple[int, int]) |
| @typehints.with_output_types(int) |
| class MyDoFn(beam.DoFn): |
| def process(self, element: typehints.Tuple[int, int]) -> \ |
| typehints.List[int]: |
| return [str(element)] |
| |
| my_do_fn = MyDoFn().with_input_types(int).with_output_types(str) |
| |
| result = [1, 2, 3] | beam.ParDo(my_do_fn) |
| self.assertEqual(['1', '2', '3'], sorted(result)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*int.*got.*str'): |
| _ = ['a', 'b', 'c'] | beam.ParDo(my_do_fn) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*int.*got.*str'): |
| _ = [1, 2, 3] | (beam.ParDo(my_do_fn) | 'again' >> beam.ParDo(my_do_fn)) |
| |
| def test_typed_callable_instance(self): |
| # Type hints applied to ParDo instance take precedence over callable |
| # decorators and annotations. |
| @typehints.with_input_types(typehints.Tuple[int, int]) |
| @typehints.with_output_types(typehints.Generator[int]) |
| def do_fn(element: typehints.Tuple[int, int]) -> typehints.Generator[str]: |
| yield str(element) |
| |
| pardo = beam.ParDo(do_fn).with_input_types(int).with_output_types(str) |
| |
| result = [1, 2, 3] | pardo |
| self.assertEqual(['1', '2', '3'], sorted(result)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*int.*got.*str'): |
| _ = ['a', 'b', 'c'] | pardo |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*int.*got.*str'): |
| _ = [1, 2, 3] | (pardo | 'again' >> pardo) |
| |
| def test_typed_callable_iterable_output(self): |
| # Only the outer Iterable should be stripped. |
| def do_fn(element: int) -> typehints.Iterable[typehints.Iterable[str]]: |
| return [[str(element)] * 2] |
| |
| result = [1, 2] | beam.ParDo(do_fn) |
| self.assertEqual([['1', '1'], ['2', '2']], sorted(result)) |
| |
| def test_typed_dofn_method_not_iterable(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int) -> str: |
| return str(element) |
| |
| with self.assertRaisesRegex(ValueError, r'str.*is not iterable'): |
| _ = [1, 2, 3] | beam.ParDo(MyDoFn()) |
| |
| def test_typed_dofn_method_return_none(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, unused_element: int) -> None: |
| pass |
| |
| result = [1, 2, 3] | beam.ParDo(MyDoFn()) |
| self.assertListEqual([], result) |
| |
| def test_typed_dofn_method_return_optional(self): |
| class MyDoFn(beam.DoFn): |
| def process( |
| self, |
| unused_element: int) -> typehints.Optional[typehints.Iterable[int]]: |
| pass |
| |
| result = [1, 2, 3] | beam.ParDo(MyDoFn()) |
| self.assertListEqual([], result) |
| |
| def test_typed_dofn_method_return_optional_not_iterable(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, unused_element: int) -> typehints.Optional[int]: |
| pass |
| |
| with self.assertRaisesRegex(ValueError, r'int.*is not iterable'): |
| _ = [1, 2, 3] | beam.ParDo(MyDoFn()) |
| |
| def test_typed_callable_not_iterable(self): |
| def do_fn(element: int) -> int: |
| return element |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'int.*is not iterable'): |
| _ = [1, 2, 3] | beam.ParDo(do_fn) |
| |
| def test_typed_dofn_kwonly(self): |
| class MyDoFn(beam.DoFn): |
| # TODO(BEAM-5878): A kwonly argument like |
| # timestamp=beam.DoFn.TimestampParam would not work here. |
| def process(self, element: int, *, side_input: str) -> \ |
| typehints.Generator[typehints.Optional[int]]: |
| yield str(element) if side_input else None |
| |
| my_do_fn = MyDoFn() |
| |
| result = [1, 2, 3] | beam.ParDo(my_do_fn, side_input='abc') |
| self.assertEqual(['1', '2', '3'], sorted(result)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*str.*got.*int.*side_input'): |
| _ = [1, 2, 3] | beam.ParDo(my_do_fn, side_input=1) |
| |
| def test_typed_dofn_var_kwargs(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int, **side_inputs: typehints.Dict[str, str]) \ |
| -> typehints.Generator[typehints.Optional[int]]: |
| yield str(element) if side_inputs else None |
| |
| my_do_fn = MyDoFn() |
| |
| result = [1, 2, 3] | beam.ParDo(my_do_fn, foo='abc', bar='def') |
| self.assertEqual(['1', '2', '3'], sorted(result)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'requires.*str.*got.*int.*side_inputs'): |
| _ = [1, 2, 3] | beam.ParDo(my_do_fn, a=1) |
| |
| def test_typed_callable_string_literals(self): |
| def do_fn(element: 'int') -> 'typehints.List[str]': |
| return [[str(element)] * 2] |
| |
| result = [1, 2] | beam.ParDo(do_fn) |
| self.assertEqual([['1', '1'], ['2', '2']], sorted(result)) |
| |
| def test_typed_dofn_string_literals(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: 'int') -> 'typehints.List[str]': |
| return [[str(element)] * 2] |
| |
| result = [1, 2] | beam.ParDo(MyDoFn()) |
| self.assertEqual([['1', '1'], ['2', '2']], sorted(result)) |
| |
| def test_typed_map(self): |
| def fn(element: int) -> int: |
| return element * 2 |
| |
| result = [1, 2, 3] | beam.Map(fn) |
| self.assertEqual([2, 4, 6], sorted(result)) |
| |
| def test_typed_map_return_optional(self): |
| # None is a valid element value for Map. |
| def fn(element: int) -> typehints.Optional[int]: |
| if element > 1: |
| return element |
| |
| result = [1, 2, 3] | beam.Map(fn) |
| self.assertCountEqual([None, 2, 3], result) |
| |
| def test_typed_flatmap(self): |
| def fn(element: int) -> typehints.Iterable[int]: |
| yield element * 2 |
| |
| result = [1, 2, 3] | beam.FlatMap(fn) |
| self.assertCountEqual([2, 4, 6], result) |
| |
| def test_typed_flatmap_output_hint_not_iterable(self): |
| def fn(element: int) -> int: |
| return element * 2 |
| |
| # This is raised (originally) in strip_iterable. |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'int.*is not iterable'): |
| _ = [1, 2, 3] | beam.FlatMap(fn) |
| |
| def test_typed_flatmap_output_value_not_iterable(self): |
| def fn(element: int) -> typehints.Iterable[int]: |
| return element * 2 |
| |
| # This is raised in runners/common.py (process_outputs). |
| with self.assertRaisesRegex(TypeError, r'int.*is not iterable'): |
| _ = [1, 2, 3] | beam.FlatMap(fn) |
| |
| def test_typed_flatmap_optional(self): |
| def fn(element: int) -> typehints.Optional[typehints.Iterable[int]]: |
| if element > 1: |
| yield element * 2 |
| |
| # Verify that the output type of fn is int and not Optional[int]. |
| def fn2(element: int) -> int: |
| return element |
| |
| result = [1, 2, 3] | beam.FlatMap(fn) | beam.Map(fn2) |
| self.assertCountEqual([4, 6], result) |
| |
| def test_typed_ptransform_with_no_error(self): |
| class StrToInt(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[str]) -> beam.pvalue.PCollection[int]: |
| return pcoll | beam.Map(lambda x: int(x)) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[int]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| _ = ['1', '2', '3'] | StrToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_bad_typehints(self): |
| class StrToInt(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[str]) -> beam.pvalue.PCollection[int]: |
| return pcoll | beam.Map(lambda x: int(x)) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[str]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| "Input type hint violation at IntToStr: " |
| "expected <class 'str'>, got <class 'int'>"): |
| _ = ['1', '2', '3'] | StrToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_bad_input(self): |
| class StrToInt(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[str]) -> beam.pvalue.PCollection[int]: |
| return pcoll | beam.Map(lambda x: int(x)) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[int]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| "Input type hint violation at StrToInt: " |
| "expected <class 'str'>, got <class 'int'>"): |
| # Feed integers to a PTransform that expects strings |
| _ = [1, 2, 3] | StrToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_partial_typehints(self): |
| class StrToInt(beam.PTransform): |
| def expand(self, pcoll) -> beam.pvalue.PCollection[int]: |
| return pcoll | beam.Map(lambda x: int(x)) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[int]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| # Feed integers to a PTransform that should expect strings |
| # but has no typehints so it expects any |
| _ = [1, 2, 3] | StrToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_bare_wrappers(self): |
| class StrToInt(beam.PTransform): |
| def expand( |
| self, pcoll: beam.pvalue.PCollection) -> beam.pvalue.PCollection: |
| return pcoll | beam.Map(lambda x: int(x)) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[int]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| _ = [1, 2, 3] | StrToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_no_typehints(self): |
| class StrToInt(beam.PTransform): |
| def expand(self, pcoll): |
| return pcoll | beam.Map(lambda x: int(x)) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[int]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| # Feed integers to a PTransform that should expect strings |
| # but has no typehints so it expects any |
| _ = [1, 2, 3] | StrToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_generic_annotations(self): |
| T = typing.TypeVar('T') |
| |
| class IntToInt(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[T]) -> beam.pvalue.PCollection[T]: |
| return pcoll | beam.Map(lambda x: x) |
| |
| class IntToStr(beam.PTransform): |
| def expand( |
| self, |
| pcoll: beam.pvalue.PCollection[T]) -> beam.pvalue.PCollection[str]: |
| return pcoll | beam.Map(lambda x: str(x)) |
| |
| _ = [1, 2, 3] | IntToInt() | IntToStr() |
| |
| def test_typed_ptransform_with_do_outputs_tuple_compiles(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int, *args, **kwargs): |
| if element % 2: |
| yield beam.pvalue.TaggedOutput('odd', 1) |
| else: |
| yield beam.pvalue.TaggedOutput('even', 1) |
| |
| class MyPTransform(beam.PTransform): |
| def expand(self, pcoll: beam.pvalue.PCollection[int]): |
| return pcoll | beam.ParDo(MyDoFn()).with_outputs('odd', 'even') |
| |
| # This test fails if you remove the following line from ptransform.py |
| # if isinstance(pvalue_, DoOutputsTuple): continue |
| _ = [1, 2, 3] | MyPTransform() |
| |
| |
| class AnnotationsTest(unittest.TestCase): |
| def test_pardo_dofn(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int) -> typehints.Generator[str]: |
| yield str(element) |
| |
| th = beam.ParDo(MyDoFn()).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((str, ), {})) |
| |
| def test_pardo_dofn_not_iterable(self): |
| class MyDoFn(beam.DoFn): |
| def process(self, element: int) -> str: |
| return str(element) |
| |
| with self.assertRaisesRegex(ValueError, r'str.*is not iterable'): |
| _ = beam.ParDo(MyDoFn()).get_type_hints() |
| |
| def test_pardo_wrapper(self): |
| def do_fn(element: int) -> typehints.Iterable[str]: |
| return [str(element)] |
| |
| th = beam.ParDo(do_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((str, ), {})) |
| |
| def test_pardo_wrapper_tuple(self): |
| # Test case for callables that return key-value pairs for GBK. The outer |
| # Iterable should be stripped but the inner Tuple left intact. |
| def do_fn(element: int) -> typehints.Iterable[typehints.Tuple[str, int]]: |
| return [(str(element), element)] |
| |
| th = beam.ParDo(do_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((typehints.Tuple[str, int], ), {})) |
| |
| def test_pardo_wrapper_not_iterable(self): |
| def do_fn(element: int) -> str: |
| return str(element) |
| |
| with self.assertRaisesRegex(typehints.TypeCheckError, |
| r'str.*is not iterable'): |
| _ = beam.ParDo(do_fn).get_type_hints() |
| |
| def test_flat_map_wrapper(self): |
| def map_fn(element: int) -> typehints.Iterable[int]: |
| return [element, element + 1] |
| |
| th = beam.FlatMap(map_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((int, ), {})) |
| |
| def test_flat_map_wrapper_optional_output(self): |
| # Optional should not affect output type (Nones are ignored). |
| def map_fn(element: int) -> typehints.Optional[typehints.Iterable[int]]: |
| return [element, element + 1] |
| |
| th = beam.FlatMap(map_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((int, ), {})) |
| |
| @unittest.skip('BEAM-8662: Py3 annotations not yet supported for MapTuple') |
| def test_flat_map_tuple_wrapper(self): |
| # TODO(BEAM-8662): Also test with a fn that accepts default arguments. |
| def tuple_map_fn(a: str, b: str, c: str) -> typehints.Iterable[str]: |
| return [a, b, c] |
| |
| th = beam.FlatMapTuple(tuple_map_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((str, str, str), {})) |
| self.assertEqual(th.output_types, ((str, ), {})) |
| |
| def test_map_wrapper(self): |
| def map_fn(unused_element: int) -> int: |
| return 1 |
| |
| th = beam.Map(map_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((int, ), {})) |
| |
| def test_map_wrapper_optional_output(self): |
| # Optional does affect output type (Nones are NOT ignored). |
| def map_fn(unused_element: int) -> typehints.Optional[int]: |
| return 1 |
| |
| th = beam.Map(map_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((typehints.Optional[int], ), {})) |
| |
| @unittest.skip('BEAM-8662: Py3 annotations not yet supported for MapTuple') |
| def test_map_tuple(self): |
| # TODO(BEAM-8662): Also test with a fn that accepts default arguments. |
| def tuple_map_fn(a: str, b: str, c: str) -> str: |
| return a + b + c |
| |
| th = beam.MapTuple(tuple_map_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((str, str, str), {})) |
| self.assertEqual(th.output_types, ((str, ), {})) |
| |
| def test_filter_wrapper(self): |
| def filter_fn(element: int) -> bool: |
| return bool(element % 2) |
| |
| th = beam.Filter(filter_fn).get_type_hints() |
| self.assertEqual(th.input_types, ((int, ), {})) |
| self.assertEqual(th.output_types, ((int, ), {})) |
| |
| |
| if __name__ == '__main__': |
| unittest.main() |
