more little fixes

sdk/core/azure-core/azure/core/tracing/abstract_span.py

@@ -10,11 +10,19 @@
 except AttributeError:  # Python 2.7, abc exists, but not ABC
     ABC = abc.ABCMeta("ABC", (object,), {"__slots__": ()})  # type: ignore
 
+try:
+    from typing import TYPE_CHECKING
+except ImportError:
+    TYPE_CHECKING = False
+
+if TYPE_CHECKING:
+    from typing import Any, Dict, Optional
+
 
 class AbstractSpan(ABC):
     @abstractmethod
     def __init__(self, span=None, name=None):
-        # type: (Any, str) -> None
+        # type: (Optional[Any], Optional[str]) -> None
         """
         If a span is given wraps the span. Else a new span is created.
         The optional arguement name is given to the new span.
@@ -23,11 +31,11 @@ def __init__(self, span=None, name=None):
 
     @abstractmethod
     def span(self, name="child_span"):
-        # type: (str) -> AbstractSpan
+        # type: (Optional[str]) -> AbstractSpan
         """
         Create a child span for the current span and append it to the child spans list.
         The child span must be wrapped by an implementation of AbstractSpan
-         """
+        """
         pass
 
     @abstractmethod
@@ -44,7 +52,7 @@ def finish(self):
 
     @abstractmethod
     def to_header(self):
-        # type: (Dict[str, str]) -> Dict[str, str]
+        # type: () -> Dict[str, str]
         """
         Returns a dictionary with the header labels and values.
         """
@@ -66,6 +74,9 @@ def from_header(cls, headers):
         """
         Given a dictionary returns a new tracer with the span context
         extracted from that dictionary.
+
+        :param headers: A dictionary of the request header as key value pairs.
+        :type headers: Dict[str, str]
         """
         pass
 

sdk/core/azure-core/azure/core/tracing/ext/opencensus_wrapper.py

@@ -2,42 +2,35 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-import os
-
 from azure.core.tracing import AbstractSpan
 from opencensus.trace import execution_context
 from opencensus.trace import tracer as tracer_module, Span
 from opencensus.trace.propagation import trace_context_http_header_format
-from opencensus.trace.samplers import ProbabilitySampler
-from opencensus.trace.tracers.noop_tracer import NoopTracer
-
-try:
-    from opencensus.ext.azure.trace_exporter import AzureExporter
-except:
-    AzureExporter = False
 
 try:
     from typing import TYPE_CHECKING
 except ImportError:
     TYPE_CHECKING = False
 
 if TYPE_CHECKING:
-    from typing import Any, Dict, Union
+    from typing import Any, Dict, Optional
 
 
-class OpencensusSpanWrapper(AbstractSpan):
-    """Wraps a given Opencensus Span so that it implements azure.core.tracing.AbstractSpan"""
+class OpenCensusSpan(AbstractSpan):
+    """Wraps a given OpenCensus Span so that it implements azure.core.tracing.AbstractSpan"""
 
     def __init__(self, span=None, name="parent_span"):
-        # type: (Span, str) -> None
+        # type: (Optional[Span], Optional[str]) -> None
         """
         If a span is not passed in, creates a new tracer. If the instrumentation key for Azure Exporter is given, will
         configure the azure exporter else will just create a new tracer.
 
-        :param span: The opencensus span to wrap
-        :param name: The name of the opencensus span to create if a new span is needed
+        :param span: The OpenCensus span to wrap
+        :type span: Span
+        :param name: The name of the OpenCensus span to create if a new span is needed
+        :type name: str
         """
-        super(OpencensusSpanWrapper, self).__init__(span, name)
+        super(OpenCensusSpan, self).__init__(span, name)
         tracer = self.get_current_tracer()
         span = span or tracer.span(name=name)
         self._span_instance = span
@@ -51,11 +44,12 @@ def span_instance(self):
         return self._span_instance
 
     def span(self, name="child_span"):
-        # type: (str) -> OpencensusSpanWrapper
+        # type: (Optional[str]) -> OpenCensusSpan
         """
         Create a child span for the current span and append it to the child spans list in the span instance.
         :param name: Name of the child span
-        :return: The OpencensusWrapper that is wrapping the child span instance
+        :type name: str
+        :return: The OpenCensusWrapper that is wrapping the child span instance
         """
         return self.__class__(self.span_instance.span(name=name))
 
@@ -70,7 +64,7 @@ def finish(self):
         self.span_instance.finish()
 
     def to_header(self):
-        # type: (Dict[str, str]) -> str
+        # type: () -> Dict[str, str]
         """
         Returns a dictionary with the header labels and values.
         :param headers: A key value pair dictionary
@@ -89,6 +83,7 @@ def from_header(cls, headers):
         """
         Given a dictionary returns a new tracer with the span context extracted from that dictionary.
         :param headers: A key value pair dictionary
+        :type headers: Dict[str, str]
         :return: A tracer initialized with the span context extraction from headers.
         """
         ctx = trace_context_http_header_format.TraceContextPropagator().from_headers(
@@ -117,6 +112,9 @@ def set_current_span(cls, span):
         # type: (Span) -> None
         """
         Set the given span as the current span in the execution context.
+
+        :param span: The span to set the current span as
+        :type span: Span
         """
         return execution_context.set_current_span(span)
 
@@ -125,5 +123,7 @@ def set_current_tracer(cls, tracer):
         # type: (tracer_module.Tracer) -> None
         """
         Set the given tracer as the current tracer in the execution context.
+        :param tracer: The tracer to set the current tracer as
+        :type tracer: Tracer
         """
         return execution_context.set_opencensus_tracer(tracer)

sdk/core/azure-core/tests/test_tracing_implementations.py

@@ -9,7 +9,7 @@
 except ImportError:
     import mock
 
-from azure.core.tracing.ext.opencensus_wrapper import OpencensusSpanWrapper
+from azure.core.tracing.ext.opencensus_wrapper import OpenCensusSpan
 from opencensus.trace import tracer as tracer_module
 from opencensus.trace.samplers import AlwaysOnSampler
 from opencensus.ext.azure.trace_exporter import AzureExporter
@@ -18,19 +18,19 @@
 
 class ContextHelper(object):
     def __init__(self, environ={}):
-        self.orig_tracer = OpencensusSpanWrapper.get_current_tracer()
-        self.orig_current_span = OpencensusSpanWrapper.get_current_span()
+        self.orig_tracer = OpenCensusSpan.get_current_tracer()
+        self.orig_current_span = OpenCensusSpan.get_current_span()
         self.os_env = mock.patch.dict(os.environ, environ)
 
     def __enter__(self):
-        self.orig_tracer = OpencensusSpanWrapper.get_current_tracer()
-        self.orig_current_span = OpencensusSpanWrapper.get_current_span()
+        self.orig_tracer = OpenCensusSpan.get_current_tracer()
+        self.orig_current_span = OpenCensusSpan.get_current_span()
         self.os_env.start()
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        OpencensusSpanWrapper.set_current_tracer(self.orig_tracer)
-        OpencensusSpanWrapper.set_current_span(self.orig_current_span)
+        OpenCensusSpan.set_current_tracer(self.orig_tracer)
+        OpenCensusSpan.set_current_span(self.orig_current_span)
         self.os_env.stop()
 
 
@@ -39,7 +39,7 @@ def test_span_passed_in(self):
         with ContextHelper():
             tracer = tracer_module.Tracer(sampler=AlwaysOnSampler())
             with tracer.start_span(name="parent") as parent:
-                wrapped_span = OpencensusSpanWrapper(parent)
+                wrapped_span = OpenCensusSpan(parent)
             assert wrapped_span.span_instance.name == "parent"
             assert (
                 wrapped_span.span_instance.context_tracer.trace_id
@@ -50,8 +50,8 @@ def test_span_passed_in(self):
 
     def test_no_span_passed_in_with_no_environ(self):
         with ContextHelper() as ctx:
-            tracer = OpencensusSpanWrapper.get_current_tracer()
-            wrapped_span = OpencensusSpanWrapper()
+            tracer = OpenCensusSpan.get_current_tracer()
+            wrapped_span = OpenCensusSpan()
             assert wrapped_span.span_instance.name == "parent_span"
             assert (
                 wrapped_span.span_instance.context_tracer.span_context.trace_id
@@ -63,7 +63,7 @@ def test_no_span_passed_in_with_no_environ(self):
     def test_no_span_but_in_trace(self):
         with ContextHelper():
             tracer = tracer_module.Tracer(sampler=AlwaysOnSampler())
-            wrapped_span = OpencensusSpanWrapper()
+            wrapped_span = OpenCensusSpan()
             assert wrapped_span.span_instance.name == "parent_span"
             assert (
                 wrapped_span.span_instance.context_tracer.trace_id
@@ -75,7 +75,7 @@ def test_no_span_but_in_trace(self):
     def test_span(self):
         with ContextHelper() as ctx:
             tracer = tracer_module.Tracer(sampler=AlwaysOnSampler())
-            wrapped_class = OpencensusSpanWrapper()
+            wrapped_class = OpenCensusSpan()
             child = wrapped_class.span()
             assert child.span_instance.name == "child_span"
             assert (
@@ -88,7 +88,7 @@ def test_span(self):
     def test_start_finish(self):
         with ContextHelper() as ctx:
             tracer = tracer_module.Tracer(sampler=AlwaysOnSampler())
-            parent = OpencensusSpanWrapper()
+            parent = OpenCensusSpan()
             wrapped_class = parent.span()
             assert wrapped_class.span_instance.start_time is None
             assert wrapped_class.span_instance.end_time is None
@@ -103,17 +103,13 @@ def test_to_and_from_header(self):
             og_header = {
                 "traceparent": "00-2578531519ed94423ceae67588eff2c9-231ebdc614cb9ddd-01"
             }
-            tracer = OpencensusSpanWrapper.from_header(og_header)
+            tracer = OpenCensusSpan.from_header(og_header)
             assert tracer.span_context.trace_id == "2578531519ed94423ceae67588eff2c9"
-            wrapped_class = OpencensusSpanWrapper()
+            wrapped_class = OpenCensusSpan()
             headers = wrapped_class.to_header()
             new_header = {
                 "traceparent": "00-2578531519ed94423ceae67588eff2c9-{}-01".format(
                     wrapped_class.span_instance.span_id
                 )
             }
             assert headers == new_header
-
-
-if __name__ == "__main__":
-    unittest.main()