Rename HTTPInjector HTTPExtractor to Injector Extractor

Signed-off-by: Alex Boten <aboten@lightstep.com>

ext/opentelemetry-ext-opentracing-shim/tests/test_shim.py

@@ -21,8 +21,8 @@
 from opentelemetry import propagation, trace
 from opentelemetry.context.propagation import get_as_list, set_in_dict
 from opentelemetry.context.propagation.httptextformat import (
-    HTTPExtractor,
-    HTTPInjector,
+    Extractor,
+    Injector,
 )
 from opentelemetry.ext.opentracing_shim import util
 from opentelemetry.sdk.trace import TracerSource
@@ -547,7 +547,7 @@ def test_extract_binary(self):
 _SPAN_ID_KEY = "mock-spanid"
 
 
-class MockHTTPExtractor(HTTPExtractor):
+class MockHTTPExtractor(Extractor):
     """Mock extractor for testing purposes."""
 
     @classmethod
@@ -565,7 +565,7 @@ def extract(cls, carrier, context=None, get_from_carrier=get_as_list):
         )
 
 
-class MockHTTPInjector(HTTPInjector):
+class MockHTTPInjector(Injector):
     """Mock injector for testing purposes."""
 
     @classmethod

opentelemetry-api/src/opentelemetry/context/propagation/__init__.py

@@ -18,25 +18,14 @@
 from .binaryformat import BinaryFormat
 from .httptextformat import (
     ContextT,
-    DefaultHTTPExtractor,
-    DefaultHTTPInjector,
+    DefaultExtractor,
+    DefaultInjector,
+    Extractor,
     Getter,
-    HTTPExtractor,
-    HTTPInjector,
+    Injector,
     Setter,
 )
 
-__all__ = [
-    "BinaryFormat",
-    "ContextT",
-    "Getter",
-    "DefaultHTTPExtractor",
-    "DefaultHTTPInjector",
-    "HTTPExtractor",
-    "HTTPInjector",
-    "Setter",
-]
-
 
 def get_as_list(
     dict_object: typing.Dict[str, str], key: str

opentelemetry-api/src/opentelemetry/context/propagation/httptextformat.py

@@ -23,7 +23,7 @@
 Getter = typing.Callable[[ContextT, str], typing.List[str]]
 
 
-class HTTPExtractor(abc.ABC):
+class Extractor(abc.ABC):
     """API for propagation of span context via headers.
 
     TODO: update docs to reflect split into extractor/injector
@@ -38,7 +38,7 @@ class HTTPExtractor(abc.ABC):
 
         import flask
         import requests
-        from opentelemetry.context.propagation import HTTPExtractor
+        from opentelemetry.context.propagation import Extractor
 
         PROPAGATOR = HTTPTextFormat()
 
@@ -80,27 +80,27 @@ def extract(
         context: typing.Optional[Context] = None,
         get_from_carrier: typing.Optional[Getter[ContextT]] = None,
     ) -> Context:
-        """Create a SpanContext from values in the carrier.
+        """Create a Context from values in the carrier.
 
         The extract function should retrieve values from the carrier
-        object using get_from_carrier, and use values to populate a
-        SpanContext value and return it.
+        object using get_from_carrier, use values to populate a
+        Context value and return it.
 
         Args:
-            get_from_carrier: a function that can retrieve zero
-                or more values from the carrier. In the case that
-                the value does not exist, return an empty list.
             carrier: and object which contains values that are
-                used to construct a SpanContext. This object
+                used to construct a Context. This object
                 must be paired with an appropriate get_from_carrier
                 which understands how to extract a value from it.
+            context: The Context to read values from.
+            get_from_carrier: a function that can retrieve zero
+                or more values from the carrier. In the case that
+                the value does not exist, return an empty list.
         Returns:
-            A SpanContext with configuration found in the carrier.
-
+            A Context with configuration found in the carrier.
         """
 
 
-class HTTPInjector(abc.ABC):
+class Injector(abc.ABC):
     @classmethod
     @abc.abstractmethod
     def inject(
@@ -109,71 +109,27 @@ def inject(
         context: typing.Optional[Context] = None,
         set_in_carrier: typing.Optional[Setter[ContextT]] = None,
     ) -> None:
-        """Inject values from a SpanContext into a carrier.
+        """Inject values from a Context into a carrier.
 
         inject enables the propagation of values into HTTP clients or
         other objects which perform an HTTP request. Implementations
         should use the set_in_carrier method to set values on the
         carrier.
 
         Args:
-            context: The SpanContext to read values from.
-            set_in_carrier: A setter function that can set values
-                on the carrier.
             carrier: An object that a place to define HTTP headers.
                 Should be paired with set_in_carrier, which should
                 know how to set header values on the carrier.
-
+            context: The Context to read values from.
+            set_in_carrier: A setter function that can set values
+                on the carrier.
         """
 
 
-class DefaultHTTPExtractor(HTTPExtractor):
-    """API for propagation of span context via headers.
-
-    TODO: update docs to reflect split into extractor/injector
-
-    This class provides an interface that enables extracting and injecting
-    span context into headers of HTTP requests. HTTP frameworks and clients
-    can integrate with HTTPTextFormat by providing the object containing the
-    headers, and a getter and setter function for the extraction and
-    injection of values, respectively.
-
-    Example::
-
-        import flask
-        import requests
-        from opentelemetry.context.propagation import HTTPExtractor
-
-        PROPAGATOR = HTTPTextFormat()
-
-
-
-        def get_header_from_flask_request(request, key):
-            return request.headers.get_all(key)
-
-        def set_header_into_requests_request(request: requests.Request,
-                                             key: str, value: str):
-            request.headers[key] = value
-
-        def example_route():
-            span_context = PROPAGATOR.extract(
-                get_header_from_flask_request,
-                flask.request
-            )
-            request_to_downstream = requests.Request(
-                "GET", "http://httpbin.org/get"
-            )
-            PROPAGATOR.inject(
-                span_context,
-                set_header_into_requests_request,
-                request_to_downstream
-            )
-            session = requests.Session()
-            session.send(request_to_downstream.prepare())
-
+class DefaultExtractor(Extractor):
+    """The default Extractor that is used when no Extractor implementation is configured.
 
-    .. _Propagation API Specification:
-       https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/api-propagators.md
+    All operations are no-ops.
     """
 
     @classmethod
@@ -183,51 +139,22 @@ def extract(
         context: typing.Optional[Context] = None,
         get_from_carrier: typing.Optional[Getter[ContextT]] = None,
     ) -> Context:
-        """Create a SpanContext from values in the carrier.
-
-        The extract function should retrieve values from the carrier
-        object using get_from_carrier, and use values to populate a
-        SpanContext value and return it.
-
-        Args:
-            get_from_carrier: a function that can retrieve zero
-                or more values from the carrier. In the case that
-                the value does not exist, return an empty list.
-            carrier: and object which contains values that are
-                used to construct a SpanContext. This object
-                must be paired with an appropriate get_from_carrier
-                which understands how to extract a value from it.
-        Returns:
-            A SpanContext with configuration found in the carrier.
-
-        """
         if context:
             return context
         return Context.current()
 
 
-class DefaultHTTPInjector(HTTPInjector):
+class DefaultInjector(Injector):
+    """The default Injector that is used when no Injector implementation is configured.
+
+    All operations are no-ops.
+    """
+
     @classmethod
     def inject(
         cls,
         carrier: ContextT,
         context: typing.Optional[Context] = None,
         set_in_carrier: typing.Optional[Setter[ContextT]] = None,
     ) -> None:
-        """Inject values from a SpanContext into a carrier.
-
-        inject enables the propagation of values into HTTP clients or
-        other objects which perform an HTTP request. Implementations
-        should use the set_in_carrier method to set values on the
-        carrier.
-
-        Args:
-            context: The SpanContext to read values from.
-            set_in_carrier: A setter function that can set values
-                on the carrier.
-            carrier: An object that a place to define HTTP headers.
-                Should be paired with set_in_carrier, which should
-                know how to set header values on the carrier.
-
-        """
         return None

opentelemetry-api/src/opentelemetry/correlationcontext/__init__.py

@@ -18,7 +18,7 @@
 from typing import Optional
 
 from opentelemetry.context import Context
-from opentelemetry.context.propagation import HTTPExtractor, HTTPInjector
+from opentelemetry.context.propagation import Extractor, Injector
 
 PRINTABLE = frozenset(
     itertools.chain(

opentelemetry-api/src/opentelemetry/propagation/__init__.py

@@ -19,8 +19,8 @@
 from opentelemetry.context import Context
 from opentelemetry.context.propagation import (
     ContextT,
-    DefaultHTTPExtractor,
-    DefaultHTTPInjector,
+    DefaultExtractor,
+    DefaultInjector,
     Getter,
     Setter,
 )
@@ -29,14 +29,12 @@
 def extract(
     carrier: ContextT,
     context: typing.Optional[Context] = None,
-    extractors: typing.Optional[
-        typing.List[httptextformat.HTTPExtractor]
-    ] = None,
+    extractors: typing.Optional[typing.List[httptextformat.Extractor]] = None,
     get_from_carrier: typing.Optional[Getter[ContextT]] = None,
 ) -> typing.Optional[Context]:
     """Load the parent SpanContext from values in the carrier.
 
-    Using the specified HTTPExtractor, the propagator will
+    Using the specified Extractor, the propagator will
     extract a SpanContext from the carrier. If one is found,
     it will be set as the parent context of the current span.
 
@@ -69,9 +67,7 @@ def extract(
 
 def inject(
     carrier: ContextT,
-    injectors: typing.Optional[
-        typing.List[httptextformat.HTTPInjector]
-    ] = None,
+    injectors: typing.Optional[typing.List[httptextformat.Injector]] = None,
     context: typing.Optional[Context] = None,
 ) -> None:
     """Inject values from the current context into the carrier.
@@ -98,16 +94,16 @@ def inject(
 
 
 _HTTP_TEXT_INJECTORS = [
-    DefaultHTTPInjector
-]  # typing.List[httptextformat.HTTPInjector]
+    DefaultInjector
+]  # typing.List[httptextformat.Injector]
 
 _HTTP_TEXT_EXTRACTORS = [
-    DefaultHTTPExtractor
-]  # typing.List[httptextformat.HTTPExtractor]
+    DefaultExtractor
+]  # typing.List[httptextformat.Extractor]
 
 
 def set_http_extractors(
-    extractor_list: typing.List[httptextformat.HTTPExtractor],
+    extractor_list: typing.List[httptextformat.Extractor],
 ) -> None:
     """
     To update the global extractor, the Propagation API provides a
@@ -118,7 +114,7 @@ def set_http_extractors(
 
 
 def set_http_injectors(
-    injector_list: typing.List[httptextformat.HTTPInjector],
+    injector_list: typing.List[httptextformat.Injector],
 ) -> None:
     """
     To update the global injector, the Propagation API provides a
@@ -128,15 +124,15 @@ def set_http_injectors(
     _HTTP_TEXT_INJECTORS = injector_list  # type: ignore
 
 
-def get_http_extractors() -> typing.List[httptextformat.HTTPExtractor]:
+def get_http_extractors() -> typing.List[httptextformat.Extractor]:
     """
     To access the global extractor, the Propagation API provides
     a function which returns an extractor.
     """
     return _HTTP_TEXT_EXTRACTORS  # type: ignore
 
 
-def get_http_injectors() -> typing.List[httptextformat.HTTPInjector]:
+def get_http_injectors() -> typing.List[httptextformat.Injector]:
     """
     To access the global injector, the Propagation API provides a
     function which returns an injector.

opentelemetry-sdk/src/opentelemetry/sdk/context/propagation/b3_format.py

@@ -16,9 +16,9 @@
 
 import opentelemetry.trace as trace
 from opentelemetry.context.propagation import (
+    Extractor,
     Getter,
-    HTTPExtractor,
-    HTTPInjector,
+    Injector,
     Setter,
     get_as_list,
     set_in_dict,
@@ -36,12 +36,12 @@
 SAMPLED_KEY = "x-b3-sampled"
 
 
-def http_propagator() -> typing.Tuple[HTTPExtractor, HTTPInjector]:
+def http_propagator() -> typing.Tuple[Extractor, Injector]:
     """ TODO """
     return B3Extractor, B3Injector
 
 
-class B3Extractor(HTTPExtractor):
+class B3Extractor(Extractor):
     """Propagator for the B3 HTTP header format.
 
     See: https://github.com/openzipkin/b3-propagation
@@ -123,7 +123,7 @@ def extract(
         )
 
 
-class B3Injector(HTTPInjector):
+class B3Injector(Injector):
     @classmethod
     def inject(
         cls,