Fix the py.typed marker file usage (open-telemetry#4172)

* Fix the py.typed marker file usage As defined in PEP 561, the py.typed marker files for namespace packages should be placed "in the submodules of the namespace". In commit 732ea8a, the markers were added to the subpackage roots, which serves no purpose. This changeset addresses all marker-related issues in this repository. A summary of the changes: - Removed the unnecessary py.typed markers from the subpackage roots. - Added the missing marker to the prometheus exporter. Fixes open-telemetry#4113. - Added the missing marker to opentelemetry._events. - Removed the accidentally reintroduced jaeger exporters, which were originally removed in commit 1625b35. * Add missing py.typed * Add pyright and fix the reported issues * Update the generated workflow --------- Co-authored-by: Riccardo Magliocchetti <riccardo.magliocchetti@gmail.com> Co-authored-by: Emídio Neto <9735060+emdneto@users.noreply.github.com> Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
ocelotl · Sep 30, 2024 · fd169a7 · fd169a7
1 parent cafd7f2
commit fd169a7
Show file tree

Hide file tree

Showing 33 changed files with 46 additions and 0 deletions.
diff --git a/.github/workflows/misc_0.yml b/.github/workflows/misc_0.yml
@@ -88,6 +88,24 @@ jobs:
       - name: Run tests
         run: tox -e mypyinstalled
 
+  pyright:
+    name: pyright
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests
+        run: tox -e pyright
+
   docs:
     name: docs
     runs-on: ubuntu-latest

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Removed superfluous py.typed markers and added them where they were missing
+  ([#4172](https://github.com/open-telemetry/opentelemetry-python/pull/4172))
 - Include metric info in encoding exceptions
   ([#4154](https://github.com/open-telemetry/opentelemetry-python/pull/4154))
 - sdk: Add support for log formatting

diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/py.typed b/exporter/opentelemetry-exporter-otlp-proto-http/py.typed
diff --git a/exporter/opentelemetry-exporter-otlp/py.typed b/exporter/opentelemetry-exporter-otlp/py.typed
diff --git a/exporter/opentelemetry-exporter-prometheus/py.typed b/exporter/opentelemetry-exporter-prometheus/py.typed
diff --git a/...metry-exporter-jaeger-proto-grpc/py.typed → ...pentelemetry/exporter/prometheus/py.typed b/...metry-exporter-jaeger-proto-grpc/py.typed → ...pentelemetry/exporter/prometheus/py.typed
diff --git a/exporter/opentelemetry-exporter-zipkin-json/py.typed b/exporter/opentelemetry-exporter-zipkin-json/py.typed
diff --git a/exporter/opentelemetry-exporter-zipkin-proto-http/py.typed b/exporter/opentelemetry-exporter-zipkin-proto-http/py.typed
diff --git a/exporter/opentelemetry-exporter-zipkin/py.typed b/exporter/opentelemetry-exporter-zipkin/py.typed
diff --git a/opentelemetry-api/py.typed b/opentelemetry-api/py.typed
diff --git a/...telemetry-exporter-jaeger-thrift/py.typed → ...ry-api/src/opentelemetry/_events/py.typed b/...telemetry-exporter-jaeger-thrift/py.typed → ...ry-api/src/opentelemetry/_events/py.typed
diff --git a/opentelemetry-proto/py.typed b/opentelemetry-proto/py.typed
diff --git a/...er/opentelemetry-exporter-jaeger/py.typed → ...ry-proto/src/opentelemetry/proto/py.typed b/...er/opentelemetry-exporter-jaeger/py.typed → ...ry-proto/src/opentelemetry/proto/py.typed
diff --git a/opentelemetry-sdk/py.typed b/opentelemetry-sdk/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/error_handler/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/error_handler/py.typed
diff --git a/...pentelemetry-exporter-opencensus/py.typed → ...nternal/exponential_histogram/__init__.py b/...pentelemetry-exporter-opencensus/py.typed → ...nternal/exponential_histogram/__init__.py
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/resources/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/resources/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/trace/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/util/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/util/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/version/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/version/py.typed
diff --git a/opentelemetry-semantic-conventions/py.typed b/opentelemetry-semantic-conventions/py.typed
diff --git a/...metry-exporter-otlp-proto-common/py.typed → ...ntelemetry/semconv/attributes/__init__.py b/...metry-exporter-otlp-proto-common/py.typed → ...ntelemetry/semconv/attributes/__init__.py
diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/metrics/py.typed b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/metrics/py.typed
diff --git a/...lemetry-exporter-otlp-proto-grpc/py.typed → ...ntions/src/opentelemetry/semconv/py.typed b/...lemetry-exporter-otlp-proto-grpc/py.typed → ...ntions/src/opentelemetry/semconv/py.typed
diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/resource/py.typed b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/resource/py.typed
diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/trace/py.typed b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/trace/py.typed
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,3 +18,12 @@ exclude = '''
 [tool.pytest.ini_options]
 addopts = "-rs -v"
 log_cli = true
+
+[tool.pyright]
+typeCheckingMode = "off"
+reportMissingTypeStubs = "error"
+include = [
+    "opentelemetry-api/src",
+    "opentelemetry-sdk/src",
+    "opentelemetry-semantic-conventions/src",
+]
diff --git a/pyright-requirements.txt b/pyright-requirements.txt
@@ -0,0 +1 @@
+pyright==1.1.381
diff --git a/tox.ini b/tox.ini
@@ -105,6 +105,7 @@ envlist =
     spellcheck
     tracecontext
     mypy,mypyinstalled
+    pyright
     docs
     docker-tests-proto{3,4}
     public-symbols-check
@@ -445,3 +446,18 @@ commands_pre =
 
 commands =
   sh -c "find {toxinidir} -name \*.sh | xargs shellcheck --severity=warning"
+
+[testenv:pyright]
+basepython: python3
+
+allowlist_externals = pyright
+
+commands_pre =
+  pip install -r {toxinidir}/pyright-requirements.txt \
+              -e {toxinidir}/opentelemetry-api \
+              -e {toxinidir}/opentelemetry-semantic-conventions \
+              -e {toxinidir}/opentelemetry-sdk
+
+commands =
+  pyright --version
+  pyright