Address DeprecationWarning

[jenstroeger]

Describe your environment

Python 3.10.10 on macOS Ventura 13.2

Steps to reproduce

• ensure that setuptools v67.3.0 or later is installed (see their deprecation warning change)
• turn warnings filter to error
• run

   from opentelemetry.instrumentation.grpc import GrpcInstrumentorClient, GrpcInstrumentorServer

What is the expected behavior?

The import succeeds.

What is the actual behavior?

The import fails:

.venv/lib/python3.10/site-packages/opentelemetry/instrumentation/grpc/__init__.py:282: in <module>
    from opentelemetry import trace
.venv/lib/python3.10/site-packages/opentelemetry/trace/__init__.py:87: in <module>
    from opentelemetry import context as context_api
.venv/lib/python3.10/site-packages/opentelemetry/context/__init__.py:22: in <module>
    from pkg_resources import iter_entry_points
.venv/lib/python3.10/site-packages/pkg_resources/__init__.py:3257: in <module>
    def _initialize_master_working_set():
.venv/lib/python3.10/site-packages/pkg_resources/__init__.py:3231: in _call_aside
    f(*args, **kwargs)
.venv/lib/python3.10/site-packages/pkg_resources/__init__.py:3282: in _initialize_master_working_set
    tuple(dist.activate(replace=False) for dist in working_set)
.venv/lib/python3.10/site-packages/pkg_resources/__init__.py:3282: in <genexpr>
    tuple(dist.activate(replace=False) for dist in working_set)
.venv/lib/python3.10/site-packages/pkg_resources/__init__.py:2803: in activate
    declare_namespace(pkg)
.venv/lib/python3.10/site-packages/pkg_resources/__init__.py:2297: in declare_namespace
    warnings.warn(msg, DeprecationWarning, stacklevel=2)
E   DeprecationWarning: Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages

Additional context

For the time being I filter that warning with

PYTHONWARNINGS="always::DeprecationWarning:pkg_resources"

but it should probably be addressed.

[jenshnielsen]

Opentelemetry dropped the use of pkg_resources in #3047 so I think this is already fixed in the main branch.

As far as I understand the problem with pkg_resources is that is scans all installed packages so the namespace package could be any package in your environment. See the note in the setuptools docs

[jenshnielsen]

The actual origin of the warning is likely googleapis-common-protos if you have that installed https://github.com/googleapis/python-api-common-protos/blob/main/google/rpc/__init__.py

Also see googleapis/python-api-common-protos#140

[jenstroeger]

Thanks @jenshnielsen! Indeed the googleapis-common-protos is installed, nice catch!

Feel free to close this issue then.

[sk-]

But that's a dependency of opentelemetry-exporter-otlp-proto-grpc. See

opentelemetry-python/exporter/opentelemetry-exporter-otlp-proto-grpc/pyproject.toml

Line 31 in e003062

"googleapis-common-protos ~= 1.52",

Not sure if it's possible for OpenTelemetry to silence that warning somehow. Or maybe a better option could be to stop depending on that package and instead just bring the protos used to the opentelemetry repo. The only used proto from google that I found is RetryInfo

opentelemetry-python/exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/exporter.py

Line 34 in e003062

from google.rpc.error_details_pb2 import RetryInfo

[2zqa]

Can reproduce, please re-open this issue. As mentioned above this project uses v1.52 which is a 4 year old version and could use updating anyway. Updating to v1.62.0 will close this issue.

EDIT: this might be solved automatically once a new version is released that uses v1.62.0, since the ~= version identifier is used

[sk-]

If anyone is still having this issue, you can fix it by forcing an update of googleapis-common-protos. We bumped it to version 1.63.0 and the warnings are gone.