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/10/13 17:30:45 UTC
[GitHub] [beam] robertwb commented on a change in pull request #13069: [BEAM-10475] Add a well-known coder for ShardedKey in Java/Python SDK
robertwb commented on a change in pull request #13069:
URL: https://github.com/apache/beam/pull/13069#discussion_r504132029
##########
File path: sdks/python/apache_beam/coders/coders_test_common.py
##########
@@ -570,6 +571,37 @@ def test_map_coder(self):
}, {}, {i: str(i)
for i in range(5000)})
+ def test_sharded_key_coder(self):
+ coder = coders.ShardedKeyCoder(coders.BytesCoder())
+ # Verify cloud object representation
+ self.assertEqual({
+ '@type': 'kind:sharded_key',
+ 'component_encodings': [coders.BytesCoder().as_cloud_object()]
+ },
+ coder.as_cloud_object())
+
+ # Test binary representation
+ self.assertEqual(b'\x00\x00', coder.encode(ShardedKey(b'')))
Review comment:
Maybe move these to the yaml file so they can be shared among all languages.
##########
File path: sdks/python/apache_beam/coders/coders_test_common.py
##########
@@ -570,6 +571,37 @@ def test_map_coder(self):
}, {}, {i: str(i)
for i in range(5000)})
+ def test_sharded_key_coder(self):
+ coder = coders.ShardedKeyCoder(coders.BytesCoder())
+ # Verify cloud object representation
+ self.assertEqual({
+ '@type': 'kind:sharded_key',
+ 'component_encodings': [coders.BytesCoder().as_cloud_object()]
+ },
+ coder.as_cloud_object())
+
+ # Test binary representation
+ self.assertEqual(b'\x00\x00', coder.encode(ShardedKey(b'')))
+ self.assertEqual(b'\x00\x03key', coder.encode(ShardedKey(b'key')))
+ self.assertEqual(b'\x00\x00', coder.encode(ShardedKey(b'', b'')))
+ self.assertEqual(b'\x03123\00', coder.encode(ShardedKey(b'', b'123')))
+ self.assertEqual(b'\x03123\03key', coder.encode(ShardedKey(b'key', b'123')))
+
+ test_values = [
+ ShardedKey(b''),
Review comment:
Have at least one example with a non-bytes key type?
##########
File path: sdks/python/apache_beam/utils/sharded_key.py
##########
@@ -0,0 +1,65 @@
+#
+# 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
+
+
+class ShardedKey(object):
+ """A sharded key consisting of a user key and a shard id.
+
+ Attributes:
+ key: The user key.
+ shard_id: An opaque byte string that uniquely represents a shard of the key.
+ """
+ def __init__(
+ self,
+ key,
+ shard_id=b'', # type: bytes
+ ):
+ # type: (...) -> None
+ assert shard_id is not None
+ self._key = key
+ self._shard_id = shard_id
+
+ @property
+ def key(self):
+ return self._key
+
+ @property
+ def shard_id(self):
+ return self._shard_id
+
+ def __repr__(self):
+ return '(%s, %s)' % (repr(self.key), self.shard_id)
+
+ def __eq__(self, other):
+ return (
+ type(self) == type(other) and self.key == other.key and
+ self.shard_id == other.shard_id)
+
+ def __ne__(self, other):
+ # TODO(BEAM-5949): Needed for Python 2 compatibility.
+ return not self == other
+
+ def __hash__(self):
+ return ((hash(self.key) & 0xFFFFFFFFFFFFFFF) + 3 *
Review comment:
You can drop the anding with 0xFFFF. You could also just return `hash((self.key, self.shard_key))` (i.e. has the tuple).
##########
File path: sdks/python/apache_beam/utils/sharded_key.py
##########
@@ -0,0 +1,65 @@
+#
+# 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
+
+
+class ShardedKey(object):
+ """A sharded key consisting of a user key and a shard id.
+
+ Attributes:
+ key: The user key.
+ shard_id: An opaque byte string that uniquely represents a shard of the key.
+ """
+ def __init__(
+ self,
+ key,
+ shard_id=b'', # type: bytes
+ ):
+ # type: (...) -> None
+ assert shard_id is not None
+ self._key = key
+ self._shard_id = shard_id
+
+ @property
+ def key(self):
+ return self._key
+
+ @property
+ def shard_id(self):
Review comment:
Do we intend this to be public? IMHO, it'd be better to not have it part of the public API (and we can always add it later if needed).
##########
File path: sdks/python/apache_beam/utils/sharded_key.py
##########
@@ -0,0 +1,65 @@
+#
+# 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
+
+
+class ShardedKey(object):
+ """A sharded key consisting of a user key and a shard id.
+
+ Attributes:
+ key: The user key.
+ shard_id: An opaque byte string that uniquely represents a shard of the key.
+ """
+ def __init__(
+ self,
+ key,
+ shard_id=b'', # type: bytes
+ ):
+ # type: (...) -> None
+ assert shard_id is not None
+ self._key = key
+ self._shard_id = shard_id
+
+ @property
+ def key(self):
+ return self._key
+
+ @property
+ def shard_id(self):
Review comment:
Same for Java.
----------------------------------------------------------------
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