Add pyright and fix the reported issues

open-telemetry · Sep 21, 2024 · 90f4eca · 90f4eca
1 parent b103078
commit 90f4eca
Show file tree

Hide file tree

Showing 17 changed files with 44 additions and 0 deletions.
diff --git a/.github/workflows/misc_0.yml b/.github/workflows/misc_0.yml
@@ -70,6 +70,24 @@ jobs:
       - name: Run tests
         run: tox -e mypy
 
+  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
+
   mypyinstalled:
     name: mypyinstalled
     runs-on: ubuntu-latest

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/...opentelemetry/sdk/_configuration/py.typed → ...nternal/exponential_histogram/__init__.py b/...opentelemetry/sdk/_configuration/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/...dk/src/opentelemetry/sdk/_events/py.typed → ...ntelemetry/semconv/attributes/__init__.py b/...dk/src/opentelemetry/sdk/_events/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/...-sdk/src/opentelemetry/sdk/_logs/py.typed → ...ntions/src/opentelemetry/semconv/py.typed b/...-sdk/src/opentelemetry/sdk/_logs/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