Make pyright run in standard mode (#4425)

* first init

* found tox.ini updates, and searched for references of mypy.

* found tox.ini updates, and searched for references of mypy.

* implement suggustions

* fix based on feedback, rm and updates to misc_0 ci/cd.

* fix commits.

* fix commits.

* keep mypy and run pyright in standard using strict list

Signed-off-by: emdneto <[email protected]>

* pyright ignore

Signed-off-by: emdneto <[email protected]>

* enable reportPrivateUsage

Signed-off-by: emdneto <[email protected]>

* use type for ignore

Signed-off-by: emdneto <[email protected]>

* please mypy

Signed-off-by: emdneto <[email protected]>

---------

Signed-off-by: emdneto <[email protected]>
Co-authored-by: emdneto <[email protected]>

Author: pierceroberts

.github/workflows/misc_0.yml

@@ -88,8 +88,8 @@ jobs:
       - name: Run tests
         run: tox -e mypyinstalled
 
-  pyright:
-    name: pyright
+  typecheck:
+    name: typecheck
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo @ SHA - ${{ github.sha }}
@@ -104,7 +104,7 @@ jobs:
         run: pip install tox
 
       - name: Run tests
-        run: tox -e pyright
+        run: tox -e typecheck
 
   docs:
     name: docs

CONTRIBUTING.md

@@ -60,6 +60,10 @@ You can run `tox` with the following arguments:
 - `tox -e lint-some-package` to run lint checks on `some-package`
 - `tox -e generate-workflows` to run creation of new CI workflows if tox environments have been updated
 - `tox -e ruff` to run ruff linter and formatter checks against the entire codebase
+- `tox -e typecheck` to run pyright against entire code base.
+- `tox -e public-symbols-check` to run public_symbols_checker.py.
+- `tox -e docker-tests-{otlpexporter,opencensus}` to run tests in both or either one location.
+- `tox -e tracecontext` to run integration tests for tracecontext.
 - `tox -e precommit` to run all `pre-commit` actions
 
 `ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:

dev-requirements.txt

@@ -1,5 +1,6 @@
 pylint==3.2.1
 httpretty==1.1.4
+pyright==1.1.396
 mypy==1.9.0
 sphinx==7.1.2
 sphinx-rtd-theme==2.0.0rc4

mypy-requirements.txt

@@ -447,7 +447,7 @@ def create_gauge(  # type: ignore # pylint: disable=no-self-use
         name: str,
         unit: str = "",
         description: str = "",
-    ) -> Gauge:
+    ) -> Gauge:  # pyright: ignore[reportReturnType]
         """Creates a ``Gauge`` instrument
 
         Args:

opentelemetry-api/src/opentelemetry/metrics/_internal/__init__.py

@@ -62,11 +62,11 @@ def __enter__(self) -> R:
         except StopIteration:
             raise RuntimeError("generator didn't yield") from None
 
-    def __call__(self, func: V) -> V:
+    def __call__(self, func: V) -> V:  # pyright: ignore [reportIncompatibleMethodOverride]
         if asyncio.iscoroutinefunction(func):
 
             @functools.wraps(func)  # type: ignore
-            async def async_wrapper(*args: Pargs, **kwargs: Pkwargs) -> R:
+            async def async_wrapper(*args: Pargs, **kwargs: Pkwargs) -> R:  # pyright: ignore [reportInvalidTypeVarUse]
                 with self._recreate_cm():  # type: ignore
                     return await func(*args, **kwargs)  # type: ignore
 
@@ -78,8 +78,8 @@ def _agnosticcontextmanager(
     func: "Callable[P, Iterator[R]]",
 ) -> "Callable[P, _AgnosticContextManager[R]]":
     @functools.wraps(func)
-    def helper(*args: Pargs, **kwargs: Pkwargs) -> _AgnosticContextManager[R]:
-        return _AgnosticContextManager(func, args, kwargs)
+    def helper(*args: Pargs, **kwargs: Pkwargs) -> _AgnosticContextManager[R]:  # pyright: ignore [reportInvalidTypeVarUse]
+        return _AgnosticContextManager(func, args, kwargs)  # pyright: ignore [reportArgumentType]
 
     # Ignoring the type to keep the original signature of the function
     return helper  # type: ignore[return-value]

opentelemetry-api/src/opentelemetry/util/_decorator.py

@@ -155,9 +155,10 @@ class TestUseSpanException(Exception):
                 raise TestUseSpanException("test error")
 
         self.assertEqual(
-            test_span.recorded_status.status_code, StatusCode.ERROR
+            test_span.recorded_status.status_code,  # type: ignore[reportAttributeAccessIssue]
+            StatusCode.ERROR,
         )
         self.assertEqual(
-            test_span.recorded_status.description,
+            test_span.recorded_status.description,  # type: ignore[reportAttributeAccessIssue]
             "TestUseSpanException: test error",
         )

opentelemetry-api/tests/trace/test_globals.py

@@ -24,12 +24,12 @@ def test_once_single_thread(self):
         self.assertEqual(once_func.call_count, 0)
 
         # first call should run
-        called = once.do_once(once_func)
+        called = once.do_once(once_func)  # type: ignore[reportArgumentType]
         self.assertTrue(called)
         self.assertEqual(once_func.call_count, 1)
 
         # subsequent calls do nothing
-        called = once.do_once(once_func)
+        called = once.do_once(once_func)  # type: ignore[reportArgumentType]
         self.assertFalse(called)
         self.assertEqual(once_func.call_count, 1)
 
@@ -38,7 +38,7 @@ def test_once_many_threads(self):
         once = Once()
 
         def run_concurrently() -> bool:
-            return once.do_once(once_func)
+            return once.do_once(once_func)  # type: ignore[reportArgumentType]
 
         results = self.run_with_many_threads(run_concurrently, num_threads=100)
 

opentelemetry-api/tests/util/test_once.py

@@ -22,7 +22,7 @@
 and PeriodicExportingMetricReader concrete class. Those may freely be modified in a
 backward-compatible way for *callers*.
 
-Ideally, we could use mypy for this as well, but SDK is not type checked atm.
+Ideally, we could use pyright for this as well, but SDK is not type checked atm.
 """
 
 from typing import Iterable, Sequence

opentelemetry-sdk/tests/metrics/test_backward_compat.py

@@ -57,15 +57,6 @@ exclude = [
 addopts = "-rs -v"
 log_cli = true
 
-[tool.pyright]
-typeCheckingMode = "off"
-reportMissingTypeStubs = "error"
-include = [
-    "opentelemetry-api/src",
-    "opentelemetry-sdk/src",
-    "opentelemetry-semantic-conventions/src",
-]
-
 [tool.ruff]
 # https://docs.astral.sh/ruff/configuration/
 target-version = "py38"
@@ -104,3 +95,17 @@ known-third-party = [
   "opencensus",
 ]
 known-first-party = ["opentelemetry", "opentelemetry_example_app"]
+
+[tool.pyright]
+typeCheckingMode = "standard"
+pythonVersion = "3.8"
+
+include = [
+  "opentelemetry-semantic-conventions",
+  "opentelemetry-api",
+]
+
+# When packages are correct typed add them to the strict list
+strict = [
+  "opentelemetry-semantic-conventions",
+]

pyproject.toml

@@ -89,7 +89,7 @@ envlist =
     spellcheck
     tracecontext
     mypy,mypyinstalled
-    pyright
+    typecheck
     docs
     docker-tests-{otlpexporter,opencensus}
     public-symbols-check
@@ -103,7 +103,8 @@ deps =
   coverage: pytest
   coverage: pytest-cov
 
-  mypy,mypyinstalled: -r {toxinidir}/mypy-requirements.txt
+  mypy,mypyinstalled: -c {toxinidir}/dev-requirements.txt
+  mypy,mypyinstalled: mypy
 
   api: -r {toxinidir}/opentelemetry-api/test-requirements.txt
 
@@ -161,7 +162,6 @@ setenv =
   CONTRIB_REPO_SHA={env:CONTRIB_REPO_SHA:main}
   CONTRIB_REPO=git+https://github.com/open-telemetry/opentelemetry-python-contrib.git@{env:CONTRIB_REPO_SHA}
   mypy: MYPYPATH={toxinidir}/opentelemetry-api/src/:{toxinidir}/opentelemetry-semantic-conventions/src/:{toxinidir}/opentelemetry-sdk/src/:{toxinidir}/tests/opentelemetry-test-utils/src/
-
 commands_pre =
   ; In order to get a healthy coverage report,
   ; we have to install packages in editable mode.
@@ -235,11 +235,11 @@ commands =
   mypy: mypy --install-types --non-interactive --namespace-packages --explicit-package-bases opentelemetry-sdk/src/opentelemetry/sdk/resources
   mypy: mypy --install-types --non-interactive --namespace-packages --explicit-package-bases opentelemetry-semantic-conventions/src/opentelemetry/semconv/
 
-; For test code, we don't want to enforce the full mypy strictness
+  ; For test code, we don't want to enforce the full mypy strictness
   mypy: mypy --install-types --non-interactive --namespace-packages --config-file=mypy-relaxed.ini opentelemetry-api/tests/
 
-; Test that mypy can pick up typeinfo from an installed package (otherwise,
-; implicit Any due to unfollowed import would result).
+  ; Test that mypy can pick up typeinfo from an installed package (otherwise,
+  ; implicit Any due to unfollowed import would result).
   mypyinstalled: mypy --install-types --non-interactive --namespace-packages opentelemetry-api/tests/mypysmoke.py --strict
 
 [testenv:spellcheck]
@@ -347,13 +347,16 @@ commands_pre =
 commands =
   sh -c "find {toxinidir} -name \*.sh | xargs shellcheck --severity=warning"
 
-[testenv:pyright]
+[testenv:typecheck]
 basepython: python3
 deps =
-  -r {toxinidir}/pyright-requirements.txt
+  -c {toxinidir}/dev-requirements.txt
+  pyright
+  psutil
   -e {toxinidir}/opentelemetry-api
   -e {toxinidir}/opentelemetry-semantic-conventions
   -e {toxinidir}/opentelemetry-sdk
+  -e {toxinidir}/tests/opentelemetry-test-utils
 commands =
   pyright --version
   pyright