You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2020/12/03 17:48:41 UTC
[GitHub] [beam] nehsyc opened a new pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
nehsyc opened a new pull request #13474:
URL: https://github.com/apache/beam/pull/13474
Implement `to_type_hint` and `from_type_hint` for `ShardedKeyCoder` and add a `TypeConstraint` for `ShardedKey` so during the runner API translation the corresponding coder can be added.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [ ] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Dataflow | Flink | Samza | Spark | Twister2
--- | --- | --- | --- | --- | --- | ---
Go | [](https://ci-beam.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Spark/lastCompletedBuild/) | ---
Java | [](https://ci-beam.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Java11/lastCompletedBuild/) | [](https://ci-beam
.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Java11/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Spark_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_SparkStructuredStreaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Twister2/lastCompletedBuild/)
Python | [](https://ci-beam.apache.org/job/beam_PostCommit_Python36/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python37/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python38/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_PVR_Flink_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Spark/lastCompletedBuild/) | ---
XLang | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Direct/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Dataflow/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Spark/lastCompletedBuild/) | ---
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website | Whitespace | Typescript
--- | --- | --- | --- | --- | --- | ---
Non-portable | [](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonLint_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocker_Cron/lastCompletedBuild/) <br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocs_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Whitespace_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Typescript_Cron/lastCompletedBuild/)
Portable | --- | [](https://ci-beam.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/) | --- | --- | --- | ---
See [.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md) for trigger phrase, status and link of all Jenkins jobs.
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] nehsyc commented on pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
nehsyc commented on pull request #13474:
URL: https://github.com/apache/beam/pull/13474#issuecomment-739057556
> LGTM, thanks for the thorough tests!
>
> LMK if I can merge this or if you have more changes to make
Thanks for the review! This is good to go.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] udim commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
udim commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r536407936
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type.py
##########
@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.coders import typecoders
+from apache_beam.coders.coders import ShardedKeyCoder
+from apache_beam.typehints import typehints
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraint(typehints.TypeConstraint):
Review comment:
If you do want to allow something like a `ShardedKey` type hint annotation in code, add it here:
https://github.com/apache/beam/blob/edc087efc7bb78e4f06bf9b73fbbdc85c76fb10d/sdks/python/apache_beam/typehints/typehints.py#L1117
(doesn't have to be in this PR)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] nehsyc commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
nehsyc commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r535706100
##########
File path: sdks/python/apache_beam/coders/coders.py
##########
@@ -1485,6 +1486,21 @@ def as_cloud_object(self, coders_context=None):
],
}
+ def to_type_hint(self):
+ from apache_beam.typehints import sharded_key_type
+ return sharded_key_type.ShardedKeyTypeConstraint(
+ self._key_coder.to_type_hint())
+
+ @staticmethod
+ def from_type_hint(typehint, registry):
+ from apache_beam.typehints import sharded_key_type
+ if isinstance(typehint, sharded_key_type.ShardedKeyTypeConstraint):
+ return ShardedKeyCoder(registry.get_coder(typehint.key_type))
+ else:
+ raise ValueError((
Review comment:
Done.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] nehsyc commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
nehsyc commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r535705683
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type.py
##########
@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.coders import typecoders
+from apache_beam.coders.coders import ShardedKeyCoder
+from apache_beam.typehints import typehints
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraint(typehints.TypeConstraint):
Review comment:
Users or dev may use it for specifying the output type of a transform to provide type hints.
##########
File path: sdks/python/apache_beam/coders/coders.py
##########
@@ -1485,6 +1486,21 @@ def as_cloud_object(self, coders_context=None):
],
}
+ def to_type_hint(self):
+ from apache_beam.typehints import sharded_key_type
Review comment:
To avoid circular import.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] udim merged pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
udim merged pull request #13474:
URL: https://github.com/apache/beam/pull/13474
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] udim commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
udim commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r535526012
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type.py
##########
@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.coders import typecoders
+from apache_beam.coders.coders import ShardedKeyCoder
+from apache_beam.typehints import typehints
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraint(typehints.TypeConstraint):
+ def __init__(self, key_type):
+ self.key_type = typehints.normalize(key_type)
+
+ def _inner_types(self):
+ yield self.key_type
+
+ def _consistent_with_check_(self, sub):
+ return (
+ isinstance(sub, self.__class__) and
+ typehints.is_consistent_with(sub.key_type, self.key_type))
+
+ def type_check(self, instance):
Review comment:
The 2 exceptions raised here should have test coverage.
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type.py
##########
@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.coders import typecoders
+from apache_beam.coders.coders import ShardedKeyCoder
+from apache_beam.typehints import typehints
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraint(typehints.TypeConstraint):
Review comment:
To verify: this type constraint is for Beam internal use only and users are not expected specify it?
##########
File path: sdks/python/apache_beam/coders/coders.py
##########
@@ -1485,6 +1486,21 @@ def as_cloud_object(self, coders_context=None):
],
}
+ def to_type_hint(self):
+ from apache_beam.typehints import sharded_key_type
+ return sharded_key_type.ShardedKeyTypeConstraint(
+ self._key_coder.to_type_hint())
+
+ @staticmethod
+ def from_type_hint(typehint, registry):
+ from apache_beam.typehints import sharded_key_type
+ if isinstance(typehint, sharded_key_type.ShardedKeyTypeConstraint):
+ return ShardedKeyCoder(registry.get_coder(typehint.key_type))
+ else:
+ raise ValueError((
Review comment:
This branch should have test coverage.
##########
File path: sdks/python/apache_beam/coders/coders.py
##########
@@ -1485,6 +1486,21 @@ def as_cloud_object(self, coders_context=None):
],
}
+ def to_type_hint(self):
+ from apache_beam.typehints import sharded_key_type
Review comment:
Why isn't this import at the top of the file?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] nehsyc commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
nehsyc commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r535706027
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type.py
##########
@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.coders import typecoders
+from apache_beam.coders.coders import ShardedKeyCoder
+from apache_beam.typehints import typehints
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraint(typehints.TypeConstraint):
+ def __init__(self, key_type):
+ self.key_type = typehints.normalize(key_type)
+
+ def _inner_types(self):
+ yield self.key_type
+
+ def _consistent_with_check_(self, sub):
+ return (
+ isinstance(sub, self.__class__) and
+ typehints.is_consistent_with(sub.key_type, self.key_type))
+
+ def type_check(self, instance):
Review comment:
Done. Added test coverage and some minor fixes in the latest commit.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] nehsyc commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
nehsyc commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r536421140
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type.py
##########
@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.coders import typecoders
+from apache_beam.coders.coders import ShardedKeyCoder
+from apache_beam.typehints import typehints
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraint(typehints.TypeConstraint):
Review comment:
I see. Thanks for pointing it out. I will change that in a follow-up PR.
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type_test.py
##########
@@ -0,0 +1,80 @@
+#
+# 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 the ShardedKeyTypeConstraint."""
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.typehints import Tuple
+from apache_beam.typehints import typehints
+from apache_beam.typehints.sharded_key_type import ShardedKeyTypeConstraint
+from apache_beam.typehints.typehints_test import TypeHintTestCase
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraintTest(TypeHintTestCase):
+ def test_compatibility(self):
+ constraint1 = ShardedKeyTypeConstraint(int)
+ constraint2 = ShardedKeyTypeConstraint(str)
+
+ self.assertCompatible(constraint1, constraint1)
+ self.assertCompatible(constraint2, constraint2)
+ self.assertNotCompatible(constraint1, constraint2)
+
+ def test_repr(self):
+ constraint = ShardedKeyTypeConstraint(int)
+ self.assertEqual('ShardedKey(int)', repr(constraint))
+
+ def test_type_check_not_sharded_key(self):
+ constraint = ShardedKeyTypeConstraint(int)
+ obj = 5
+ with self.assertRaises(TypeError) as e:
Review comment:
Good to know!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [beam] udim commented on a change in pull request #13474: [BEAM-10475] Add typehints for ShardedKeyCoder
Posted by GitBox <gi...@apache.org>.
udim commented on a change in pull request #13474:
URL: https://github.com/apache/beam/pull/13474#discussion_r536410630
##########
File path: sdks/python/apache_beam/typehints/sharded_key_type_test.py
##########
@@ -0,0 +1,80 @@
+#
+# 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 the ShardedKeyTypeConstraint."""
+
+# pytype: skip-file
+
+from __future__ import absolute_import
+
+from apache_beam.typehints import Tuple
+from apache_beam.typehints import typehints
+from apache_beam.typehints.sharded_key_type import ShardedKeyTypeConstraint
+from apache_beam.typehints.typehints_test import TypeHintTestCase
+from apache_beam.utils.sharded_key import ShardedKey
+
+
+class ShardedKeyTypeConstraintTest(TypeHintTestCase):
+ def test_compatibility(self):
+ constraint1 = ShardedKeyTypeConstraint(int)
+ constraint2 = ShardedKeyTypeConstraint(str)
+
+ self.assertCompatible(constraint1, constraint1)
+ self.assertCompatible(constraint2, constraint2)
+ self.assertNotCompatible(constraint1, constraint2)
+
+ def test_repr(self):
+ constraint = ShardedKeyTypeConstraint(int)
+ self.assertEqual('ShardedKey(int)', repr(constraint))
+
+ def test_type_check_not_sharded_key(self):
+ constraint = ShardedKeyTypeConstraint(int)
+ obj = 5
+ with self.assertRaises(TypeError) as e:
Review comment:
Note: `self.assertRaisesRegex` can also check exception messages.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org