keep mypy and run pyright in standard using strict list

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

Author: emdneto

.codespellrc

@@ -1,4 +1,4 @@
 [codespell]
 # skipping auto generated folders
-skip = ./.tox,./docs/_build,./target,*/LICENSE,./venv,.git,./opentelemetry-semantic-conventions,*-requirements*.txt
+skip = ./.tox,./.mypy_cache,./docs/_build,./target,*/LICENSE,./venv,.git,./opentelemetry-semantic-conventions,*-requirements*.txt
 ignore-words-list = ans,ue,ot,hist,ro

.github/workflows/misc_0.yml

@@ -52,8 +52,44 @@ jobs:
       - name: Run tests
         run: tox -e tracecontext
 
-  pyright:
-    name: pyright
+  mypy:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests
+        run: tox -e mypy
+
+  mypyinstalled:
+    name: mypyinstalled
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests
+        run: tox -e mypyinstalled
+
+  typecheck:
+    name: typecheck
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo @ SHA - ${{ github.sha }}

.gitignore

@@ -56,6 +56,8 @@ htmlcov
 # Sphinx
 _build/
 
+# mypy
+.mypy_cache/
 target
 
 # Django example

dev-requirements.txt

@@ -1,6 +1,7 @@
 pylint==3.2.1
 httpretty==1.1.4
-pyright==1.1.394
+pyright==1.1.396
+mypy==1.9.0
 sphinx==7.1.2
 sphinx-rtd-theme==2.0.0rc4
 sphinx-autodoc-typehints==1.25.2

mypy-relaxed.ini

@@ -0,0 +1,22 @@
+; This is mainly intended for unit tests and such. So probably going forward, we
+; will disable even more warnings here.
+[mypy]
+  disallow_any_unimported = True
+; disallow_any_expr = True
+  disallow_any_decorated = True
+; disallow_any_explicit = True
+  disallow_any_generics = True
+  disallow_subclassing_any = True
+  disallow_untyped_calls = True
+; disallow_untyped_defs = True
+  disallow_incomplete_defs = True
+  check_untyped_defs = True
+  disallow_untyped_decorators = True
+  allow_untyped_globals = True
+; Due to disabling some other warnings, unused ignores may occur.
+;  warn_unused_ignores = True
+  warn_return_any = True
+  strict_equality = True
+
+[mypy-setuptools]
+  ignore_missing_imports = True

mypy.ini

@@ -0,0 +1,22 @@
+[mypy]
+  disallow_any_unimported = True
+  disallow_any_expr = True
+  disallow_any_decorated = True
+; disallow_any_explicit = True
+  disallow_any_generics = True
+  disallow_subclassing_any = True
+  disallow_untyped_calls = True
+  disallow_untyped_defs = True
+  disallow_incomplete_defs = True
+  check_untyped_defs = True
+  disallow_untyped_decorators = True
+  warn_unused_configs = True
+  warn_unused_ignores = True
+  warn_return_any = True
+  warn_redundant_casts = True
+  strict_equality = True
+  strict_optional = True
+  no_implicit_optional =  True
+  no_implicit_reexport = True
+  # https://mypy.readthedocs.io/en/stable/running_mypy.html#follow-imports
+  follow_imports = silent

pyproject.toml

@@ -2,29 +2,6 @@
 addopts = "-rs -v"
 log_cli = true
 
-[tool.pyright]
-typeCheckingMode = "strict"
-include = [
-    "opentelemetry-api/src",
-    "opentelemetry-sdk/src",
-    "opentelemetry-semantic-conventions/src",
-    "opentelemetry-proto/src",
-    "scripts"
-]
-ignore = [
-  "docs/**",
-  "exporter/**",
-  "propagator/**",
-  "shim/**",
-]
-reportUnnecessaryTypeIgnoreComment = true
-pythonVersion = "3.9"
-reportPrivateUsage = false  # Ignore private attributes added by instrumentation packages.
-
-exclude = [
-  "tests/**",
-]
-
 [tool.ruff]
 # https://docs.astral.sh/ruff/configuration/
 target-version = "py38"
@@ -63,3 +40,18 @@ known-third-party = [
   "opencensus",
 ]
 known-first-party = ["opentelemetry", "opentelemetry_example_app"]
+
+[tool.pyright]
+typeCheckingMode = "standard"
+pythonVersion = "3.8"
+reportPrivateUsage = false
+
+include = [
+  "opentelemetry-semantic-conventions",
+  "opentelemetry-api",
+]
+
+# When packages are correct typed add them to the strict list
+strict = [
+  "opentelemetry-semantic-conventions",
+]

pyright-requirements.txt

@@ -88,7 +88,8 @@ envlist =
 
     spellcheck
     tracecontext
-    pyright
+    mypy,mypyinstalled
+    typecheck
     docs
     docker-tests-{otlpexporter,opencensus}
     public-symbols-check
@@ -102,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
 
@@ -143,6 +145,7 @@ deps =
 
   propagator-jaeger: -r {toxinidir}/propagator/opentelemetry-propagator-jaeger/test-requirements.txt
 
+  mypyinstalled: -e {toxinidir}/opentelemetry-api
 
   getting-started: -r {toxinidir}/docs/getting_started/tests/requirements.txt
   getting-started: {env:CONTRIB_REPO}\#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http
@@ -158,7 +161,7 @@ setenv =
   ; i.e: CONTRIB_REPO_SHA=dde62cebffe519c35875af6d06fae053b3be65ec tox -e <env to test>
   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.
@@ -227,7 +230,18 @@ commands =
 
   coverage: {toxinidir}/scripts/coverage.sh
 
-  
+  mypy: mypy --version
+  mypy: mypy --install-types --non-interactive --namespace-packages --explicit-package-bases opentelemetry-api/src/opentelemetry/
+  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
+  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).
+  mypyinstalled: mypy --install-types --non-interactive --namespace-packages opentelemetry-api/tests/mypysmoke.py --strict
+
 [testenv:spellcheck]
 basepython: python3
 recreate = True
@@ -335,10 +349,13 @@ commands =
 [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