Make propagators a namespace (#1591)

Author: ocelotl

.github/workflows/test.yml

@@ -10,7 +10,7 @@ env:
   # Otherwise, set variable to the commit of your branch on
   # opentelemetry-python-contrib which is compatible with these Core repo
   # changes.
-  CONTRIB_REPO_SHA: 370afa618c30a9773b0594c2ea469518c8b2c274
+  CONTRIB_REPO_SHA: 8e1dd27be3a2101c9034e480560fd5ceb6712d51
 
 jobs:
   build:

docs/examples/auto-instrumentation/server_instrumented.py

@@ -14,8 +14,9 @@
 
 from flask import Flask, request
 
-from opentelemetry import propagators, trace
+from opentelemetry import trace
 from opentelemetry.instrumentation.wsgi import collect_request_attributes
+from opentelemetry.propagate import extract
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import (
     ConsoleSpanExporter,
@@ -37,7 +38,7 @@
 def server_request():
     with tracer.start_as_current_span(
         "server_request",
-        context=propagators.extract(DictGetter(), request.headers),
+        context=extract(DictGetter(), request.headers),
         kind=trace.SpanKind.SERVER,
         attributes=collect_request_attributes(request.environ),
     ):

docs/examples/datadog_exporter/client.py

@@ -16,11 +16,12 @@
 
 from requests import get
 
-from opentelemetry import propagators, trace
+from opentelemetry import trace
 from opentelemetry.exporter.datadog import (
     DatadogExportSpanProcessor,
     DatadogSpanExporter,
 )
+from opentelemetry.propagate import inject
 from opentelemetry.sdk import resources
 from opentelemetry.sdk.trace import TracerProvider
 
@@ -46,7 +47,7 @@
 
     with tracer.start_as_current_span("client-server"):
         headers = {}
-        propagators.inject(dict.__setitem__, headers)
+        inject(dict.__setitem__, headers)
         requested = get(
             "http://localhost:8082/server_request",
             params={"param": argv[1]},

docs/examples/datadog_exporter/server.py

@@ -14,12 +14,14 @@
 
 from flask import Flask, request
 
-from opentelemetry import propagators, trace
+from opentelemetry import trace
 from opentelemetry.exporter.datadog import (
     DatadogExportSpanProcessor,
     DatadogSpanExporter,
 )
 from opentelemetry.exporter.datadog.propagator import DatadogFormat
+from opentelemetry.propagate import get_global_textmap, set_global_textmap
+from opentelemetry.propagators.composite import CompositeHTTPPropagator
 from opentelemetry.sdk.trace import TracerProvider
 
 app = Flask(__name__)
@@ -35,19 +37,17 @@
 )
 
 # append Datadog format for propagation to and from Datadog instrumented services
-global_textmap = propagators.get_global_textmap()
-if isinstance(
-    global_textmap, propagators.composite.CompositeHTTPPropagator
-) and not any(
+global_textmap = get_global_textmap()
+if isinstance(global_textmap, CompositeHTTPPropagator) and not any(
     isinstance(p, DatadogFormat) for p in global_textmap._propagators
 ):
-    propagators.set_global_textmap(
-        propagators.composite.CompositeHTTPPropagator(
+    set_global_textmap(
+        CompositeHTTPPropagator(
             global_textmap._propagators + [DatadogFormat()]
         )
     )
 else:
-    propagators.set_global_textmap(DatadogFormat())
+    set_global_textmap(DatadogFormat())
 
 tracer = trace.get_tracer(__name__)
 

docs/examples/django/client.py

@@ -16,7 +16,8 @@
 
 from requests import get
 
-from opentelemetry import propagators, trace
+from opentelemetry import trace
+from opentelemetry.propagate import inject
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import (
     ConsoleSpanExporter,
@@ -35,7 +36,7 @@
 
     with tracer.start_as_current_span("client-server"):
         headers = {}
-        propagators.inject(dict.__setitem__, headers)
+        inject(dict.__setitem__, headers)
         requested = get(
             "http://localhost:8000",
             params={"param": argv[1]},

docs/getting-started.rst

@@ -195,10 +195,10 @@ Following the installation of the package containing the b3 propagator, configur
 
 .. code-block:: python
 
-    from opentelemetry import propagators
+    from opentelemetry.propagate import set_global_textmap
     from opentelemetry.propagators.b3 import B3Format
 
-    propagators.set_global_textmap(B3Format())
+    set_global_textmap(B3Format())
 
 Use the OpenTelemetry Collector for traces
 ------------------------------------------

opentelemetry-api/src/opentelemetry/propagators/__init__.py renamed to opentelemetry-api/src/opentelemetry/propagate/__init__.py

@@ -12,11 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import typing
 import unittest
 
 from opentelemetry import baggage, trace
-from opentelemetry.propagators import extract, inject
+from opentelemetry.propagate import extract, inject
 from opentelemetry.trace import get_current_span, set_span_in_context
 from opentelemetry.trace.propagation.textmap import DictGetter
 

opentelemetry-api/tests/propagators/test_global_httptextformat.py

@@ -40,9 +40,9 @@ def test_propagators(propagators):
             **{"side_effect": test_propagators}
         )
 
-        import opentelemetry.propagators
+        import opentelemetry.propagate
 
-        reload(opentelemetry.propagators)
+        reload(opentelemetry.propagate)
 
     @patch.dict(environ, {OTEL_PROPAGATORS: "a,b,c"})
     @patch("opentelemetry.propagators.composite.CompositeHTTPPropagator")
@@ -75,6 +75,6 @@ def test_propagators(propagators):
             **{"side_effect": test_propagators}
         )
 
-        import opentelemetry.propagators
+        import opentelemetry.propagate
 
-        reload(opentelemetry.propagators)
+        reload(opentelemetry.propagate)

opentelemetry-api/tests/propagators/test_propagators.py

@@ -99,9 +99,9 @@
     UnsupportedFormatException,
 )
 
-from opentelemetry import propagators
 from opentelemetry.baggage import get_baggage, set_baggage
 from opentelemetry.context import Context, attach, detach, get_value, set_value
+from opentelemetry.propagate import get_global_textmap
 from opentelemetry.shim.opentracing_shim import util
 from opentelemetry.shim.opentracing_shim.version import __version__
 from opentelemetry.trace import INVALID_SPAN_CONTEXT, DefaultSpan, Link
@@ -682,7 +682,7 @@ def inject(self, span_context, format: object, carrier: object):
         if format not in self._supported_formats:
             raise UnsupportedFormatException
 
-        propagator = propagators.get_global_textmap()
+        propagator = get_global_textmap()
 
         ctx = set_span_in_context(DefaultSpan(span_context.unwrap()))
         propagator.inject(type(carrier).__setitem__, carrier, context=ctx)
@@ -712,7 +712,7 @@ def extract(self, format: object, carrier: object):
         if format not in self._supported_formats:
             raise UnsupportedFormatException
 
-        propagator = propagators.get_global_textmap()
+        propagator = get_global_textmap()
         ctx = propagator.extract(self._carrier_getter, carrier)
         span = get_current_span(ctx)
         if span is not None: