Merge branch 'main' into protobuf5

emdneto · Oct 2, 2024 · ba9314e · ba9314e
2 parents 3e428f7 + 01a670e
commit ba9314e
Show file tree

Hide file tree

Showing 41 changed files with 74 additions and 8 deletions.
diff --git a/.github/workflows/misc_0.yml b/.github/workflows/misc_0.yml
@@ -88,6 +88,24 @@ jobs:
       - name: Run tests
         run: tox -e mypyinstalled
 
+  pyright:
+    name: pyright
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests
+        run: tox -e pyright
+
   docs:
     name: docs
     runs-on: ubuntu-latest

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Removed superfluous py.typed markers and added them where they were missing
+  ([#4172](https://github.com/open-telemetry/opentelemetry-python/pull/4172))
 - Include metric info in encoding exceptions
   ([#4154](https://github.com/open-telemetry/opentelemetry-python/pull/4154))
 - sdk: Add support for log formatting

diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1,4 +1,4 @@
-pylint==3.0.2
+pylint==3.2.1
 flake8==6.1.0
 isort==5.12.0
 black==24.3.0

diff --git a/exporter/opentelemetry-exporter-otlp-proto-http/py.typed b/exporter/opentelemetry-exporter-otlp-proto-http/py.typed
diff --git a/exporter/opentelemetry-exporter-otlp/py.typed b/exporter/opentelemetry-exporter-otlp/py.typed
diff --git a/exporter/opentelemetry-exporter-prometheus/py.typed b/exporter/opentelemetry-exporter-prometheus/py.typed
diff --git a/exporter/opentelemetry-exporter-prometheus/src/opentelemetry/exporter/prometheus/__init__.py b/exporter/opentelemetry-exporter-prometheus/src/opentelemetry/exporter/prometheus/__init__.py
@@ -209,8 +209,7 @@ def collect(self) -> Iterable[PrometheusMetric]:
             )
 
             if metric_family_id_metric_family:
-                for metric_family in metric_family_id_metric_family.values():
-                    yield metric_family
+                yield from metric_family_id_metric_family.values()
 
     # pylint: disable=too-many-locals,too-many-branches
     def _translate_to_prometheus(

diff --git a/...metry-exporter-jaeger-proto-grpc/py.typed → ...pentelemetry/exporter/prometheus/py.typed b/...metry-exporter-jaeger-proto-grpc/py.typed → ...pentelemetry/exporter/prometheus/py.typed
diff --git a/exporter/opentelemetry-exporter-zipkin-json/py.typed b/exporter/opentelemetry-exporter-zipkin-json/py.typed
diff --git a/exporter/opentelemetry-exporter-zipkin-proto-http/py.typed b/exporter/opentelemetry-exporter-zipkin-proto-http/py.typed
diff --git a/exporter/opentelemetry-exporter-zipkin/py.typed b/exporter/opentelemetry-exporter-zipkin/py.typed
diff --git a/opentelemetry-api/py.typed b/opentelemetry-api/py.typed
diff --git a/...telemetry-exporter-jaeger-thrift/py.typed → ...ry-api/src/opentelemetry/_events/py.typed b/...telemetry-exporter-jaeger-thrift/py.typed → ...ry-api/src/opentelemetry/_events/py.typed
diff --git a/opentelemetry-api/src/opentelemetry/util/types.py b/opentelemetry-api/src/opentelemetry/util/types.py
@@ -15,6 +15,20 @@
 
 from typing import Mapping, Optional, Sequence, Tuple, Union
 
+# This is the implementation of the "Any" type as specified by the specifications of OpenTelemetry data model for logs.
+# For more details, refer to the OTel specification:
+# https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#type-any
+AnyValue = Union[
+    str,
+    bool,
+    int,
+    float,
+    bytes,
+    Sequence["AnyValue"],
+    Mapping[str, "AnyValue"],
+    None,
+]
+
 AttributeValue = Union[
     str,
     bool,

diff --git a/opentelemetry-proto/py.typed b/opentelemetry-proto/py.typed
diff --git a/...er/opentelemetry-exporter-jaeger/py.typed → ...ry-proto/src/opentelemetry/proto/py.typed b/...er/opentelemetry-exporter-jaeger/py.typed → ...ry-proto/src/opentelemetry/proto/py.typed
diff --git a/opentelemetry-sdk/py.typed b/opentelemetry-sdk/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/_configuration/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py
@@ -50,7 +50,7 @@
     get_current_span,
 )
 from opentelemetry.trace.span import TraceFlags
-from opentelemetry.util.types import Attributes
+from opentelemetry.util.types import AnyValue, Attributes
 
 _logger = logging.getLogger(__name__)
 
@@ -179,7 +179,7 @@ def __init__(
         trace_flags: Optional[TraceFlags] = None,
         severity_text: Optional[str] = None,
         severity_number: Optional[SeverityNumber] = None,
-        body: Optional[Any] = None,
+        body: Optional[AnyValue] = None,
         resource: Optional[Resource] = None,
         attributes: Optional[Attributes] = None,
         limits: Optional[LogLimits] = _UnsetLogLimits,

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/error_handler/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/error_handler/py.typed
diff --git a/...pentelemetry-exporter-opencensus/py.typed → ...nternal/exponential_histogram/__init__.py b/...pentelemetry-exporter-opencensus/py.typed → ...nternal/exponential_histogram/__init__.py
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/metric_reader_storage.py b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/metric_reader_storage.py
@@ -210,6 +210,7 @@ def collect(self) -> Optional[MetricsData]:
                     metrics.append(
                         Metric(
                             # pylint: disable=protected-access
+                            # pylint: disable=possibly-used-before-assignment
                             name=view_instrument_match._name,
                             description=view_instrument_match._description,
                             unit=view_instrument_match._instrument.unit,

diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/metrics/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/metrics/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/resources/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/resources/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/trace/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/trace/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/util/__init__.pyi b/opentelemetry-sdk/src/opentelemetry/sdk/util/__init__.pyi
@@ -33,6 +33,7 @@ def get_dict_as_key(
     labels: Mapping[str, AttributeValue]
 ) -> AttributesAsKey: ...
 
+# pylint: disable=no-self-use
 class BoundedList(Sequence[_T]):
     """An append only list with a fixed max size.
 
@@ -51,7 +52,9 @@ class BoundedList(Sequence[_T]):
     def append(self, item: _T): ...
     def extend(self, seq: Sequence[_T]): ...
     @classmethod
-    def from_seq(cls, maxlen: int, seq: Iterable[_T]) -> BoundedList[_T]: ...
+    def from_seq(
+        cls, maxlen: int, seq: Iterable[_T]
+    ) -> BoundedList[_T]: ...  # pylint: disable=undefined-variable
 
 class BoundedDict(MutableMapping[_KT, _VT]):
     """An ordered dict with a fixed max capacity.
@@ -70,4 +73,4 @@ class BoundedDict(MutableMapping[_KT, _VT]):
     @classmethod
     def from_map(
         cls, maxlen: int, mapping: Mapping[_KT, _VT]
-    ) -> BoundedDict[_KT, _VT]: ...
+    ) -> BoundedDict[_KT, _VT]: ...  # pylint: disable=undefined-variable
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/util/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/util/py.typed
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/version/py.typed b/opentelemetry-sdk/src/opentelemetry/sdk/version/py.typed
diff --git a/opentelemetry-sdk/tests/metrics/exponential_histogram/test_exponent_mapping.py b/opentelemetry-sdk/tests/metrics/exponential_histogram/test_exponent_mapping.py
@@ -389,7 +389,9 @@ def test_exponent_index_min(self):
 
             self.assertEqual(
                 exponent_mapping.map_to_index(
-                    nextafter(MIN_NORMAL_VALUE, inf)
+                    nextafter(  # pylint: disable=possibly-used-before-assignment
+                        MIN_NORMAL_VALUE, inf
+                    )
                 ),
                 MIN_NORMAL_EXPONENT >> -scale,
             )
diff --git a/opentelemetry-sdk/tests/test_util.py b/opentelemetry-sdk/tests/test_util.py
@@ -17,6 +17,7 @@
 from opentelemetry.sdk.util import BoundedList
 
 
+# pylint: disable=unsubscriptable-object
 class TestBoundedList(unittest.TestCase):
     base = [52, 36, 53, 29, 54, 99, 56, 48, 22, 35, 21, 65, 10, 95, 42, 60]
 

diff --git a/opentelemetry-semantic-conventions/py.typed b/opentelemetry-semantic-conventions/py.typed
diff --git a/...metry-exporter-otlp-proto-common/py.typed → ...ntelemetry/semconv/attributes/__init__.py b/...metry-exporter-otlp-proto-common/py.typed → ...ntelemetry/semconv/attributes/__init__.py
diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/metrics/py.typed b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/metrics/py.typed
diff --git a/...lemetry-exporter-otlp-proto-grpc/py.typed → ...ntions/src/opentelemetry/semconv/py.typed b/...lemetry-exporter-otlp-proto-grpc/py.typed → ...ntions/src/opentelemetry/semconv/py.typed
diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/resource/py.typed b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/resource/py.typed
diff --git a/opentelemetry-semantic-conventions/src/opentelemetry/semconv/trace/py.typed b/opentelemetry-semantic-conventions/src/opentelemetry/semconv/trace/py.typed
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,3 +18,12 @@ exclude = '''
 [tool.pytest.ini_options]
 addopts = "-rs -v"
 log_cli = true
+
+[tool.pyright]
+typeCheckingMode = "off"
+reportMissingTypeStubs = "error"
+include = [
+    "opentelemetry-api/src",
+    "opentelemetry-sdk/src",
+    "opentelemetry-semantic-conventions/src",
+]
diff --git a/pyright-requirements.txt b/pyright-requirements.txt
@@ -0,0 +1 @@
+pyright==1.1.381
diff --git a/tox.ini b/tox.ini
@@ -105,6 +105,7 @@ envlist =
     spellcheck
     tracecontext
     mypy,mypyinstalled
+    pyright
     docs
     docker-tests-proto
     public-symbols-check
@@ -434,3 +435,18 @@ commands_pre =
 
 commands =
   sh -c "find {toxinidir} -name \*.sh | xargs shellcheck --severity=warning"
+
+[testenv:pyright]
+basepython: python3
+
+allowlist_externals = pyright
+
+commands_pre =
+  pip install -r {toxinidir}/pyright-requirements.txt \
+              -e {toxinidir}/opentelemetry-api \
+              -e {toxinidir}/opentelemetry-semantic-conventions \
+              -e {toxinidir}/opentelemetry-sdk
+
+commands =
+  pyright --version
+  pyright