fix missing dep in docs build (#557)

2025-07-29 05:04:05 +08:00 · 2021-06-30 12:49:45 -07:00
parent de93b2ad28
commit 5b43a5993d
14 changed files with 221 additions and 203 deletions
--- a/docs-requirements.txt
+++ b/docs-requirements.txt
@ -8,6 +8,7 @@ sphinx-autodoc-typehints
 -e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-semantic-conventions&subdirectory=opentelemetry-semantic-conventions"
 -e "git+https://github.com/open-telemetry/opentelemetry-python-contrib.git#egg=opentelemetry-instrumentation&subdirectory=opentelemetry-instrumentation"
 -e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-sdk&subdirectory=opentelemetry-sdk"
+-e "git+https://github.com/open-telemetry/opentelemetry-python-contrib.git#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http"

 # Required by opentelemetry-instrumentation
 fastapi>=0.65.2
--- a/instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/aiopg_integration.py
+++ b/instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/aiopg_integration.py
@ -1,7 +1,10 @@
 import typing

 import wrapt
-from aiopg.utils import _ContextManager, _PoolAcquireContextManager
+from aiopg.utils import (  # pylint: disable=no-name-in-module
+    _ContextManager,
+    _PoolAcquireContextManager,
+)

 from opentelemetry.instrumentation.dbapi import (
    CursorTracer,
@ -61,7 +64,9 @@ def get_traced_connection_proxy(

        def cursor(self, *args, **kwargs):
            coro = self._cursor(*args, **kwargs)
-            return _ContextManager(coro)
+            return _ContextManager(  # pylint: disable=no-value-for-parameter
+                coro
+            )

        async def _cursor(self, *args, **kwargs):
            # pylint: disable=protected-access
--- a/instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/wrappers.py
+++ b/instrumentation/opentelemetry-instrumentation-aiopg/src/opentelemetry/instrumentation/aiopg/wrappers.py
@ -34,7 +34,10 @@ import typing

 import aiopg
 import wrapt
-from aiopg.utils import _ContextManager, _PoolContextManager
+from aiopg.utils import (  # pylint: disable=no-name-in-module
+    _ContextManager,
+    _PoolContextManager,
+)

 from opentelemetry.instrumentation.aiopg.aiopg_integration import (
    AiopgIntegration,
@ -108,7 +111,7 @@ def wrap_connect(
            version=version,
            tracer_provider=tracer_provider,
        )
-        return _ContextManager(
+        return _ContextManager(  # pylint: disable=no-value-for-parameter
            db_integration.wrapped_connection(wrapped, args, kwargs)
        )

--- a/instrumentation/opentelemetry-instrumentation-aiopg/tests/test_aiopg_integration.py
+++ b/instrumentation/opentelemetry-instrumentation-aiopg/tests/test_aiopg_integration.py
@ -17,7 +17,10 @@ from unittest import mock
 from unittest.mock import MagicMock

 import aiopg
-from aiopg.utils import _ContextManager, _PoolAcquireContextManager
+from aiopg.utils import (  # pylint: disable=no-name-in-module
+    _ContextManager,
+    _PoolAcquireContextManager,
+)

 import opentelemetry.instrumentation.aiopg
 from opentelemetry import trace as trace_api
@ -525,7 +528,7 @@ class MockConnection:
    # pylint: disable=no-self-use
    def cursor(self):
        coro = self._cursor()
-        return _ContextManager(coro)
+        return _ContextManager(coro)  # pylint: disable=no-value-for-parameter

    async def _cursor(self):
        return MockCursor()
--- a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py
+++ b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py
@ -14,7 +14,7 @@

 import sys
 import unittest
-import unittest.mock as mock
+from unittest import mock

 import opentelemetry.instrumentation.asgi as otel_asgi
 from opentelemetry import trace as trace_api
--- a/instrumentation/opentelemetry-instrumentation-grpc/tests/_server.py
+++ b/instrumentation/opentelemetry-instrumentation-grpc/tests/_server.py
@ -79,6 +79,7 @@ class TestServer(test_server_pb2_grpc.GRPCTestServerServicer):


 def create_test_server(port):
+    # pylint: disable=consider-using-with
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=1))

    test_server_pb2_grpc.add_GRPCTestServerServicer_to_server(
--- a/instrumentation/opentelemetry-instrumentation-grpc/tests/test_server_interceptor.py
+++ b/instrumentation/opentelemetry-instrumentation-grpc/tests/test_server_interceptor.py
@ -82,9 +82,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):

        grpc_server_instrumentor = GrpcInstrumentorServer()
        grpc_server_instrumentor.instrument()
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
-            options=(("grpc.so_reuseport", 0),),
+                executor, options=(("grpc.so_reuseport", 0),),
            )

            server.add_generic_rpc_handlers((UnaryUnaryRpcHandler(handler),))
@ -134,9 +134,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
        grpc_server_instrumentor = GrpcInstrumentorServer()
        grpc_server_instrumentor.instrument()
        grpc_server_instrumentor.uninstrument()
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
-            options=(("grpc.so_reuseport", 0),),
+                executor, options=(("grpc.so_reuseport", 0),),
            )

            server.add_generic_rpc_handlers((UnaryUnaryRpcHandler(handler),))
@ -160,8 +160,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
        # Intercept gRPC calls...
        interceptor = server_interceptor()

+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -227,8 +228,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
        interceptor = server_interceptor()

        # setup the server
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -287,9 +289,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
        # Intercept gRPC calls...
        interceptor = server_interceptor()

-        # setup the server
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -355,9 +357,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
        # Intercept gRPC calls...
        interceptor = server_interceptor()

-        # setup the server
+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -422,8 +424,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
            active_span_in_handler = trace.get_current_span()
            return b""

+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -457,8 +460,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
            active_spans_in_handler.append(trace.get_current_span())
            return b""

+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -520,8 +524,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
            active_spans_in_handler.append(trace.get_current_span())
            return b""

+        with futures.ThreadPoolExecutor(max_workers=2) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=2),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
@ -584,8 +589,9 @@ class TestOpenTelemetryServerInterceptor(TestBase):
        def handler(request, context):
            context.abort(grpc.StatusCode.FAILED_PRECONDITION, failure_message)

+        with futures.ThreadPoolExecutor(max_workers=1) as executor:
            server = grpc.server(
-            futures.ThreadPoolExecutor(max_workers=1),
+                executor,
                options=(("grpc.so_reuseport", 0),),
                interceptors=[interceptor],
            )
--- a/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/init.py
+++ b/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/init.py
@ -22,11 +22,10 @@ Usage
 .. code-block:: python

    import requests
-    import opentelemetry.instrumentation.requests
+    from opentelemetry.instrumentation.requests import RequestsInstrumentor

    # You can optionally pass a custom TracerProvider to
-    # RequestsInstrumentor.instrument()
-    opentelemetry.instrumentation.requests.RequestsInstrumentor().instrument()
+    RequestsInstrumentor.instrument()
    response = requests.get(url="https://www.example.org/")

 API
--- a/instrumentation/opentelemetry-instrumentation-tornado/tests/test_instrumentation.py
+++ b/instrumentation/opentelemetry-instrumentation-tornado/tests/test_instrumentation.py
@ -42,6 +42,7 @@ from .tornado_test_app import (


 class TornadoTest(AsyncHTTPTestCase, TestBase):
+    # pylint:disable=no-self-use
    def get_app(self):
        tracer = trace.get_tracer(__name__)
        app = make_app(tracer)
--- a/instrumentation/opentelemetry-instrumentation-wsgi/tests/test_wsgi_middleware.py
+++ b/instrumentation/opentelemetry-instrumentation-wsgi/tests/test_wsgi_middleware.py
@ -14,8 +14,8 @@

 import sys
 import unittest
-import unittest.mock as mock
 import wsgiref.util as wsgiref_util
+from unittest import mock
 from urllib.parse import urlsplit

 import opentelemetry.instrumentation.wsgi as otel_wsgi
--- a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/propagators.py
+++ b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/propagators.py
@ -26,7 +26,7 @@ https://w3c.github.io/trace-context/#trace-context-http-response-headers-format
 import typing
 from abc import ABC, abstractmethod

-import opentelemetry.trace as trace
+from opentelemetry import trace
 from opentelemetry.context.context import Context
 from opentelemetry.propagators import textmap
 from opentelemetry.trace import format_span_id, format_trace_id
--- a/scripts/eachdist.py
+++ b/scripts/eachdist.py
@ -631,9 +631,9 @@ def update_dependencies(targets, version, packages):
        if str(pkg) == "all":
            continue
        print(pkg)
-        package_name = str(pkg).split("/")[-1]
+        package_name = str(pkg).split("/", maxsplit=1)[-1]
        # Windows uses backslashes
-        package_name = str(pkg).split("\\")[-1]
+        package_name = str(pkg).split("\\", maxsplit=1)[-1]
        print(package_name)

        update_files(
--- a/scripts/generate_setup.py
+++ b/scripts/generate_setup.py
@ -35,11 +35,10 @@ _prefix = "opentelemetry-instrumentation-"

 def main():
    root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-    setuppy_tmpl = Template(
-        open(
+    with open(
        os.path.join(root_path, _template_dir, _template_name), "r"
-        ).read()
-    )
+    ) as template:
+        setuppy_tmpl = Template(template.read())
    base_instrumentation_path = os.path.join(root_path, "instrumentation")

    for instrumentation in os.listdir(base_instrumentation_path):
--- a/sdk-extension/opentelemetry-sdk-extension-aws/src/opentelemetry/sdk/extension/aws/trace/propagation/aws_xray_format.py
+++ b/sdk-extension/opentelemetry-sdk-extension-aws/src/opentelemetry/sdk/extension/aws/trace/propagation/aws_xray_format.py
@ -51,7 +51,7 @@ API
 import logging
 import typing

-import opentelemetry.trace as trace
+from opentelemetry import trace
 from opentelemetry.context import Context
 from opentelemetry.propagators.textmap import (
    CarrierT,