You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2022/04/15 07:38:54 UTC
[GitHub] [flink] HuangXingBo commented on a diff in pull request #19453: [FLINK-26477][python] Support side output in PyFlink DataStream API
HuangXingBo commented on code in PR #19453:
URL: https://github.com/apache/flink/pull/19453#discussion_r851041415
##########
flink-python/pyflink/datastream/output_tag.py:
##########
@@ -0,0 +1,50 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.common.typeinfo import TypeInformation, Types, RowTypeInfo
+from pyflink.java_gateway import get_gateway
+
+
+class OutputTag(object):
+ """
+ An :class:`OutputTag` is a typed and named tag to use for tagging side outputs of an operator.
+
+ Example:
+ ::
+
+ >>> info = OutputTag("late-data", Types.TUPLE([Types.STRING(), Types.LONG()]))
Review Comment:
Add more examples that no argument `type_info` or the input argument `type_info` is list
##########
flink-python/pyflink/datastream/output_tag.py:
##########
@@ -0,0 +1,50 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.common.typeinfo import TypeInformation, Types, RowTypeInfo
+from pyflink.java_gateway import get_gateway
+
+
+class OutputTag(object):
+ """
+ An :class:`OutputTag` is a typed and named tag to use for tagging side outputs of an operator.
+
+ Example:
+ ::
+
+ >>> info = OutputTag("late-data", Types.TUPLE([Types.STRING(), Types.LONG()]))
+
+ """
+
+ def __init__(self, tag_id: str, type_info: TypeInformation = None):
+ if tag_id == "":
+ raise ValueError("tag_id cannot be empty string")
+ self.tag_id = tag_id
+ if type_info is None:
+ self.type_info = Types.PICKLED_BYTE_ARRAY()
+ elif isinstance(type_info, list):
+ self.type_info = RowTypeInfo(type_info)
+ else:
Review Comment:
check type_info is instance of TypeInformation
##########
flink-python/src/main/java/org/apache/flink/streaming/api/runners/python/beam/BeamPythonFunctionRunner.java:
##########
@@ -131,6 +133,7 @@ public abstract class BeamPythonFunctionRunner implements PythonFunctionRunner {
protected final FlinkFnApi.CoderInfoDescriptor inputCoderDescriptor;
protected final FlinkFnApi.CoderInfoDescriptor outputCoderDescriptor;
+ protected final Map<String, FlinkFnApi.CoderInfoDescriptor> sideOutputCoderDescriptors;
Review Comment:
It is confusing that SideOutput appears in `BeamPythonFunctionRunner`
##########
flink-python/pyflink/datastream/tests/test_data_stream.py:
##########
@@ -755,6 +756,134 @@ def process_element(self, value, ctx):
expected = ['(1,hi)', '(2,hello)', '(4,hi)', '(6,hello)', '(9,hi)', '(12,hello)']
self.assert_equals_sorted(expected, results)
+ def test_process_side_output(self):
Review Comment:
Do we need to add a test that use multiple OutputTags？
##########
flink-python/pyflink/datastream/output_tag.py:
##########
@@ -0,0 +1,50 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.common.typeinfo import TypeInformation, Types, RowTypeInfo
+from pyflink.java_gateway import get_gateway
+
+
+class OutputTag(object):
+ """
+ An :class:`OutputTag` is a typed and named tag to use for tagging side outputs of an operator.
+
+ Example:
+ ::
+
+ >>> info = OutputTag("late-data", Types.TUPLE([Types.STRING(), Types.LONG()]))
+
+ """
+
+ def __init__(self, tag_id: str, type_info: TypeInformation = None):
+ if tag_id == "":
+ raise ValueError("tag_id cannot be empty string")
Review Comment:
```suggestion
raise ValueError("OutputTag tag_id cannot be None or empty string")
```
##########
flink-python/pyflink/datastream/output_tag.py:
##########
@@ -0,0 +1,50 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.common.typeinfo import TypeInformation, Types, RowTypeInfo
+from pyflink.java_gateway import get_gateway
+
+
+class OutputTag(object):
+ """
+ An :class:`OutputTag` is a typed and named tag to use for tagging side outputs of an operator.
+
+ Example:
+ ::
+
+ >>> info = OutputTag("late-data", Types.TUPLE([Types.STRING(), Types.LONG()]))
+
+ """
+
+ def __init__(self, tag_id: str, type_info: TypeInformation = None):
+ if tag_id == "":
+ raise ValueError("tag_id cannot be empty string")
+ self.tag_id = tag_id
+ if type_info is None:
+ self.type_info = Types.PICKLED_BYTE_ARRAY()
+ elif isinstance(type_info, list):
+ self.type_info = RowTypeInfo(type_info)
+ else:
+ self.type_info = type_info
+
+ def get_java_output_tag(self):
+ gateway = get_gateway()
+ j_obj = gateway.jvm.org.apache.flink.util.OutputTag(self.tag_id,
+ self.type_info.get_java_type_info())
+ # deal with serializability
+ self.type_info._j_typeinfo = None
Review Comment:
What's the reason for doing this？
##########
flink-python/src/main/java/org/apache/flink/streaming/api/runners/python/beam/BeamPythonFunctionRunner.java:
##########
@@ -444,6 +450,21 @@ private ExecutableStage createExecutableStage(RunnerApi.Environment environment)
.putCoders(OUTPUT_CODER_ID, createCoderProto(outputCoderDescriptor))
.putCoders(WINDOW_CODER_ID, getWindowCoderProto());
+ if (sideOutputCoderDescriptors != null) {
Review Comment:
Is it a better choice to put this part of the logic in `BeamDataStreamFunctionRunner`?
##########
flink-python/pyflink/datastream/output_tag.py:
##########
@@ -0,0 +1,50 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.common.typeinfo import TypeInformation, Types, RowTypeInfo
+from pyflink.java_gateway import get_gateway
+
+
+class OutputTag(object):
+ """
+ An :class:`OutputTag` is a typed and named tag to use for tagging side outputs of an operator.
+
+ Example:
+ ::
+
+ >>> info = OutputTag("late-data", Types.TUPLE([Types.STRING(), Types.LONG()]))
Review Comment:
Add example about wrong usage that input argument tag_id is None or empty string
##########
flink-python/src/main/java/org/apache/flink/streaming/api/runners/python/beam/BeamPythonFunctionRunner.java:
##########
@@ -165,10 +168,10 @@ public abstract class BeamPythonFunctionRunner implements PythonFunctionRunner {
private transient RemoteBundle remoteBundle;
/** The Python function execution result tuple: (raw bytes, length). */
Review Comment:
change the notes.
##########
flink-python/pyflink/datastream/output_tag.py:
##########
@@ -0,0 +1,50 @@
+################################################################################
+# 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.
+################################################################################
+from pyflink.common.typeinfo import TypeInformation, Types, RowTypeInfo
+from pyflink.java_gateway import get_gateway
+
+
+class OutputTag(object):
+ """
+ An :class:`OutputTag` is a typed and named tag to use for tagging side outputs of an operator.
+
+ Example:
+ ::
+
+ >>> info = OutputTag("late-data", Types.TUPLE([Types.STRING(), Types.LONG()]))
+
+ """
+
+ def __init__(self, tag_id: str, type_info: TypeInformation = None):
+ if tag_id == "":
Review Comment:
```suggestion
if not tag_id:
```
--
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.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org