Ensure that type info is picked up from installed package. (#124)

* Ensure that type info is picked up from installed package. This required moving all top-level modules to a sub-package, to not create collisions with py.typed marker files. See https://www.python.org/dev/peps/pep-0561/#packaging-type-information * Add MANIFEST.in for SDK package.
open-telemetry · Sep 16, 2019 · 531d0b1 · 531d0b1
1 parent 46ae415
commit 531d0b1
Show file tree

Hide file tree

Showing 21 changed files with 47 additions and 14 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,9 +16,10 @@ abstract types for OpenTelemetry implementations.
    :caption: Contents:
 
    opentelemetry.context
-   opentelemetry.loader
+   opentelemetry.util.loader
    opentelemetry.metrics
    opentelemetry.trace
+   opentelemetry.util.loader
 
 
 Indices and tables

diff --git a/docs/opentelemetry.loader.rst b/docs/opentelemetry.loader.rst
diff --git a/docs/opentelemetry.util.loader.rst b/docs/opentelemetry.util.loader.rst
@@ -0,0 +1,4 @@
+opentelemetry.util.loader module
+================================
+
+.. automodule:: opentelemetry.util.loader
diff --git a/opentelemetry-api/MANIFEST.in b/opentelemetry-api/MANIFEST.in
@@ -0,0 +1,7 @@
+prune tests
+graft src
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__/*
+include MANIFEST.in
+include README.rst
diff --git a/opentelemetry-api/setup.py b/opentelemetry-api/setup.py
@@ -17,7 +17,9 @@
 import setuptools
 
 BASE_DIR = os.path.dirname(__file__)
-VERSION_FILENAME = os.path.join(BASE_DIR, "src", "opentelemetry", "version.py")
+VERSION_FILENAME = os.path.join(
+    BASE_DIR, "src", "opentelemetry", "util", "version.py"
+)
 PACKAGE_INFO = {}
 with open(VERSION_FILENAME) as f:
     exec(f.read(), PACKAGE_INFO)

diff --git a/opentelemetry-api/src/opentelemetry/context/py.typed b/opentelemetry-api/src/opentelemetry/context/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/distributedcontext/py.typed b/opentelemetry-api/src/opentelemetry/distributedcontext/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/logs/py.typed b/opentelemetry-api/src/opentelemetry/logs/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/metrics/py.typed b/opentelemetry-api/src/opentelemetry/metrics/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/resources/py.typed b/opentelemetry-api/src/opentelemetry/resources/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py
@@ -64,7 +64,7 @@
 import typing
 from contextlib import contextmanager
 
-from opentelemetry import loader, types
+from opentelemetry.util import loader, types
 
 # TODO: quarantine
 ParentSpan = typing.Optional[typing.Union["Span", "SpanContext"]]
@@ -445,7 +445,7 @@ def use_span(self, span: "Span") -> typing.Iterator[None]:
 
 # Once https://github.com/python/mypy/issues/7092 is resolved,
 # the following type definition should be replaced with
-# from opentelemetry.loader import ImplementationFactory
+# from opentelemetry.util.loader import ImplementationFactory
 ImplementationFactory = typing.Callable[
     [typing.Type[Tracer]], typing.Optional[Tracer]
 ]
@@ -474,7 +474,7 @@ def set_preferred_tracer_implementation(
 ) -> None:
     """Set the factory to be used to create the tracer.
 
-    See :mod:`opentelemetry.loader` for details.
+    See :mod:`opentelemetry.util.loader` for details.
 
     This function may not be called after a tracer is already loaded.
 

diff --git a/opentelemetry-api/src/opentelemetry/trace/py.typed b/opentelemetry-api/src/opentelemetry/trace/py.typed
diff --git a/...telemetry-api/src/opentelemetry/loader.py → ...etry-api/src/opentelemetry/util/loader.py b/...telemetry-api/src/opentelemetry/loader.py → ...etry-api/src/opentelemetry/util/loader.py
diff --git a/opentelemetry-api/src/opentelemetry/util/py.typed b/opentelemetry-api/src/opentelemetry/util/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/types.py → ...metry-api/src/opentelemetry/util/types.py b/opentelemetry-api/src/opentelemetry/types.py → ...metry-api/src/opentelemetry/util/types.py
diff --git a/...elemetry-api/src/opentelemetry/version.py → ...try-api/src/opentelemetry/util/version.py b/...elemetry-api/src/opentelemetry/version.py → ...try-api/src/opentelemetry/util/version.py
diff --git a/opentelemetry-api/tests/mypysmoke.py b/opentelemetry-api/tests/mypysmoke.py
@@ -0,0 +1,5 @@
+import opentelemetry.trace
+
+
+def dummy_check_mypy_returntype() -> opentelemetry.trace.Tracer:
+    return opentelemetry.trace.tracer()
diff --git a/opentelemetry-api/tests/test_loader.py b/opentelemetry-api/tests/test_loader.py
@@ -17,7 +17,8 @@
 import unittest
 from importlib import reload
 
-from opentelemetry import loader, trace
+from opentelemetry import trace
+from opentelemetry.util import loader
 
 DUMMY_TRACER = None
 

diff --git a/opentelemetry-sdk/MANIFEST.in b/opentelemetry-sdk/MANIFEST.in
@@ -0,0 +1,7 @@
+prune tests
+graft src
+global-exclude *.pyc
+global-exclude *.pyo
+global-exclude __pycache__/*
+include MANIFEST.in
+include README.rst
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py
@@ -21,9 +21,9 @@
 from contextlib import contextmanager
 
 from opentelemetry import trace as trace_api
-from opentelemetry import types
 from opentelemetry.context import Context
 from opentelemetry.sdk import util
+from opentelemetry.util import types
 
 logger = logging.getLogger(__name__)
 

diff --git a/tox.ini b/tox.ini
@@ -5,7 +5,7 @@ envlist =
     py3{4,5,6,7,8}-test-{api,sdk,example-app,ext-wsgi,ext-http-requests}
     pypy3-test-{api,sdk,example-app,ext-wsgi,ext-http-requests}
     lint
-    py37-mypy
+    py37-{mypy,mypyinstalled}
     docs
 
 [travis]
@@ -14,7 +14,7 @@ python =
 
 [testenv]
 deps =
-  mypy: mypy~=0.711
+  mypy,mypyinstalled: mypy~=0.711
 
 setenv =
   mypy: MYPYPATH={toxinidir}/opentelemetry-api/src/
@@ -39,11 +39,21 @@ commands_pre =
   wsgi: pip install {toxinidir}/ext/opentelemetry-ext-wsgi
   http-requests: pip install {toxinidir}/ext/opentelemetry-ext-http-requests
 
+; Using file:// here because otherwise tox invokes just "pip install
+; opentelemetry-api", leading to an error
+  mypyinstalled: pip install file://{toxinidir}/opentelemetry-api/
+
 commands =
+  test: python -m unittest discover
+
   mypy: mypy --namespace-packages opentelemetry-api/src/opentelemetry/
 ; For test code, we don't want to enforce the full mypy strictness
   mypy: mypy --namespace-packages --config-file=mypy-relaxed.ini opentelemetry-api/tests/
-  test: python -m unittest discover
+
+; Test that mypy can pick up typeinfo from an installed package (otherwise,
+; implicit Any due to unfollowed import would result).
+  mypyinstalled: mypy --namespace-packages opentelemetry-api/tests/mypysmoke.py --strict
+
 
 [testenv:lint]
 basepython: python3.7