open-telemetry / open-telemetry/opentelemetry-python
Add runtime type checking (e.g. typeguard) during test runs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
There are currently some type mismatches that are not caught by mypy and static typing.
There was a previously pull request #316 that attempted to address this by adding typeguard. However, adding such a tool comes with significant work on massaging the types to be correct, and so had to be abandoned due to other priorities.
It would be fantastic work to re-integrate this type checking into the repo.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing pull request #316 and the repository's current test-run configuration to understand the abandoned typeguard integration. Identify the type mismatches that prevented adoption, then verify that runtime checks are enabled during test runs and the existing tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100