TheNeuralBit commented on code in PR #21844:
URL: https://github.com/apache/beam/pull/21844#discussion_r897112603
##########
sdks/python/apache_beam/transforms/core.py:
##########
@@ -770,16 +794,32 @@ def _get_element_type_from_return_annotation(method,
input_type):
f"{method!r}, did you mean Iterator[{return_type}]?")
def get_output_batch_type(
- self, input_element_type) -> typing.Optional[TypeConstraint]:
+ self, input_element_type
+ ) -> typing.Optional[typing.Union[TypeConstraint, type]]:
+ """Determine the batch type produced by this DoFn's ``process_batch``
+ implementation and/or it's ``process`` implementation with
+ ``@yields_batch``.
+
+ The default implementation of this method observes the return type
+ annotations on ``process_batch`` and/or ``process``. A Batched DoFn may
+ override this method if a dynamic approach is required.
+
+ Args:
+ input_element_type: The **element type** of the input PCollection this
+ DoFn is being applied to.
+
+ Returns:
+ ``None`` if this DoFn will never yield batches, a Beam typehint or
Review Comment:
I want "Beam typehint or native typehint" as a unit to be the "else" clause.
I updated the language to make that explicit instead of applying this. Thanks
for pointing it out
##########
sdks/python/apache_beam/transforms/core.py:
##########
@@ -737,7 +737,23 @@ def process_yields_batches(self) -> bool:
def process_batch_yields_elements(self) -> bool:
return getattr(self.process_batch, '_beam_yields_elements', False)
- def get_input_batch_type(self) -> typing.Optional[TypeConstraint]:
+ def get_input_batch_type(
+ self, input_element_type
+ ) -> typing.Optional[typing.Union[TypeConstraint, type]]:
+ """Determine the batch type expected as input to process_batch.
+
+ The default implementation of ``get_input_batch_type`` simply observes the
+ input typehint for the first parameter of ``process_batch``. A Batched DoFn
+ may override this method if a dynamic approach is required.
+
+ Args:
+ input_element_type: The **element type** of the input PCollection this
+ DoFn is being applied to.
+
+ Returns:
+ ``None`` if this DoFn cannot accept batches, a Beam typehint or a native
Review Comment:
Same here
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
