apache/beam

python typehints: reduce the number of runtime-type-check wrappers

Open

#20,226 opened on Jun 4, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (4,097 forks)batch import
P3bugcoregood first issuepythontypes

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 30d)

Description

The --runtime_type_check flag is considered to be a performance penalty. One of the possible slowdowns is the wrapper around DoFn.process(), which adds an extra call to the wrapped process() method. Currently, there are 2 wrappers applied: OutputCheckWrapperDoFn and TypeCheckWrapperDoFn. These could be merged into one to possibly save on overhead.

Imported from Jira BEAM-9489. Original Jira may contain additional context. Reported by: udim.

Contributor guide

Research direction
Examine the existing OutputCheckWrapperDoFn and TypeCheckWrapperDoFn classes, identify their responsibilities, and design a unified wrapper that combines both functionalities while minimizing overhead.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonApache Beam
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55