Running mypy on sdk resources #773

[prabhakarjuzgar]

Description

Addressing running mypy on opentelemetry-sdk iteratively so we don't have to make one big change addressing all mypy issues at once.

Fixes # (issue)

Type of change

Run mypy against SDK resources

How Has This Been Tested?

I executed the following tox commands:

• tox -e mypy
• tox -e test-opentelemetry-sdk
• tox -e test-opentelemetry-api

Checklist:

• Followed the style guidelines of this project
• Changelogs have been updated
• Unit tests have been added
• Documentation has been updated

[xrmx]

Are these changes need to type check sdk resources? We are already checking it AFAICS, per mypy: mypy --install-types --non-interactive --namespace-packages --explicit-package-bases opentelemetry-sdk/src/opentelemetry/sdk/resources in tox.ini.

[xrmx]

This can be typed, https://github.com/python/importlib_metadata/blob/main/importlib_metadata/__init__.py#L1039C42-L1039C43
Need to check if we are exporting it from our util module

[prabhakarjuzgar]

It is - https://github.com/open-telemetry/opentelemetry-python/blob/main/opentelemetry-api/src/opentelemetry/util/_importlib_metadata.py#L28

[prabhakarjuzgar]

basedpyright: Import "opentelemetry.util._importlib_metadata" could not be resolved. This results in following errors when mypy is executed -

opentelemetry-sdk/src/opentelemetry/sdk/error_handler/init.py:119: error: Type of variable becomes "Any" due to an unfollowed import [no-any-unimported]
opentelemetry-sdk/src/opentelemetry/sdk/error_handler/init.py:119: error: Expression has type "Any" [misc]

[prabhakarjuzgar]

@xrmx Please let me know if the above errors can be handled differently.

[xrmx]

I mean something like this error_handler_entry_points : Entrypoints = entry_points(

[Kludex]

Yeah, so my point is that it should have been found, but it's not.

[prabhakarjuzgar]

When I changed
from importlib_metadata import (
to
from importlib.metadata import (
in https://github.com/open-telemetry/opentelemetry-python/blob/main/opentelemetry-api/src/opentelemetry/util/_importlib_metadata.py
mypy is able to find the imports. importlib_metadata is valid for python < 3.8.

[prabhakarjuzgar]

Will update the PR to change importlib_metadata to imortlib.metadata and will remove ignore in the files -
opentelemetry-api/src/opentelemetry/context/__init__. opentelemetry-api/src/opentelemetry/propagate/__init__.py opentelemetry-api/src/opentelemetry/util/_importlib_metadata.py opentelemetry-api/src/opentelemetry/util/_providers.py

[prabhakarjuzgar]

@xrmx / @Kludex, Can this be suppressed with # type: ignore for the time.

[Kludex]

I don't think type: ignore should be used in any situation. It's usually a sign that something is wrong. At least the reason to ignore should be mentioned in the brackets. That's why I suggested this: #4360 (review)

I think the PR I opened should help you: #4368 (?)

[prabhakarjuzgar]

Are these changes need to type check sdk resources? We are already checking it AFAICS, per mypy: mypy --install-types --non-interactive --namespace-packages --explicit-package-bases opentelemetry-sdk/src/opentelemetry/sdk/resources in tox.ini.

This does not execute mypy on sdk/src folder. Will add mypy: mypy --install-types --non-interactive --namespace-packages --explicit-package-bases opentelemetry-sdk/src to tox.ini after fixing all the files.

[Kludex]

It may be nice to enable https://docs.astral.sh/ruff/rules/blanket-type-ignore/#blanket-type-ignore-pgh003 to make it easier to understand on review what's the purpose of the ignores @xrmx