OpenTelemetry symbols marked private to pyright

Open Beginner friendly
#2,455 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
backend

Research direction

Start with the documented imports from sentry_sdk.integrations.opentelemetry and reproduce the pyright errors for SentryPropagator and SentrySpanProcessor. Compare the package-level paths with the propagator and span_processor paths shown in the report. Done means the documented imports work without pyright export errors.

Written by the indexing model from the issue text.

Description

Component: Typing Errors Improvement Python Quality Improvement
How do you use Sentry?

Sentry Saas (sentry.io)

Version

1.32.0

Steps to Reproduce
  • Use pyright
  • Import from opentelemetry package:
from sentry_sdk.integrations.opentelemetry import SentryPropagator, SentrySpanProcessor
  • pyright error:
error: "SentryPropagator" is not exported from module "sentry_sdk.integrations.opentelemetry"
    Import from "sentry_sdk.integrations.opentelemetry.propagator" instead (reportPrivateImportUsage)
error: "SentrySpanProcessor" is not exported from module "sentry_sdk.integrations.opentelemetry"
    Import from "sentry_sdk.integrations.opentelemetry.span_processor" instead (reportPrivateImportUsage)
Expected Result

Import without pyright errors

Actual Result

Errors as above.

By changing the imports to be more specific pyright would pass but this is not in the documentation:

from sentry_sdk.integrations.opentelemetry.propagator import SentryPropagator
from sentry_sdk.integrations.opentelemetry.span_processor import SentrySpanProcessor
Dominant language
Python
Stars
2.2k
Forks
672
Avg merge
1d 13m
Merged PRs (30d)
212

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-python

All issues in getsentry/sentry-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.