[BEAM-1353] Beam should comply with PTransform style guide

• Type: Task
• Status: Resolved
• Priority: P2
• Resolution: Fixed
• Fix Version/s: 2.0.0
• Component/s: io-java-gcp, sdk-java-core, sdk-py-core
• Labels: Done backward-incompatible easy starter
• Assignee: Eugene Kirpichov
• Reporter: Eugene Kirpichov
• Created: 31/Jan/17 01:41
• Updated: 06/Oct/20 21:53
• Resolved: 03/May/17 06:39

Description

https://beam.apache.org/contribute/ptransform-style-guide/ is a collection of best practices for developing PTransform's.

Some of these practices shaped up relatively recently, and some Beam transforms violate them, introducing inconsistency into Beam APIs and tempting new library writers and users into mimicking code that's best not mimicked.

This is an umbrella bug for cleanups bringing individual Beam transforms in accordance with the style guide.

Please file 1 bug per transform that needs to be fixed (e.g. "Bring KafkaIO in accordance with style guide"); in the bug, describe which aspects need to be fixed (e.g. "should use AutoValue; should explicitly specify type parameters; should not use Coders for serialization") and link it with the current bug.

Issue Links

• incorporates: BEAM-1354 TextIO should comply with PTransform style guide
• incorporates: BEAM-1355 HDFS IO should comply with PTransform style guide
• incorporates: BEAM-1402 Make TextIO and AvroIO use best-practice types.
• incorporates: BEAM-1414 CountingInput should comply with PTransform style guide
• incorporates: BEAM-1415 PubsubIO should comply with PTransform style guide
• incorporates: BEAM-1416 Write transform should comply with PTransform style guide
• incorporates: BEAM-1417 Count should comply with PTransform style guide
• incorporates: BEAM-1418 MapElements and FlatMapElements should comply with PTransform style guide
• incorporates: BEAM-1419 Flatten should comply with PTransform style guide
• incorporates: BEAM-1420 GroupByKey should comply with PTransform style guide
• incorporates: BEAM-1421 Latest should comply with PTransform style guide
• incorporates: BEAM-1422 ParDo should comply with PTransform style guide
• incorporates: BEAM-1423 Sample should comply with PTransform style guide
• incorporates: BEAM-1424 ToString should comply with PTransform style guide
• incorporates: BEAM-1425 Window should comply with PTransform style guide
• incorporates: BEAM-1426 SortValues should comply with PTransform style guide
• incorporates: BEAM-1427 BigQueryIO should comply with PTransform style guide
• incorporates: BEAM-1428 KinesisIO should comply with PTransform style guide
• incorporates: BEAM-1913 TFRecordIO should comply with PTransform style guide
• incorporates: BEAM-1914 XML IO should comply with PTransform style guide
• incorporates: BEAM-447 Stop referring to types with Bound/Unbound
• incorporates: BEAM-717 Change KafkaIO API to be consistent with style guide
• incorporates: BEAM-1573 KafkaIO does not allow using Kafka serializers and deserializers
• is duplicated by: BEAM-1341 Rectify any egregious violations of PTransform style guide in the SDK
• is related to: BEAM-73 IO design pattern: Decouple Parsers and Coders
• links to: GitHub Pull Request #1943
• links to: GitHub Pull Request #2615