Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve type hints in opentelemetry.instrumentation.utils #3128

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve type hints in opentelemetry.instrumentation.utils #3128

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00e5008
Improve type hints in `opentelemetry.instrumentation.utils`
Kludex Dec 20, 2024
75aa318
add future annotations
Kludex Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

import urllib.parse
from contextlib import contextmanager
from importlib import import_module
from re import escape, sub
from typing import Dict, Iterable, Sequence, Union
from typing import Any, Dict, Generator, Sequence

from wrapt import ObjectProxy

Expand Down Expand Up @@ -44,9 +46,9 @@


def extract_attributes_from_object(
obj: any, attributes: Sequence[str], existing: Dict[str, str] = None
obj: Any, attributes: Sequence[str], existing: Dict[str, str] | None = None
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the most important change. any cannot be used as Any.

) -> Dict[str, str]:
extracted = {}
extracted: dict[str, str] = {}
if existing:
extracted.update(existing)
for attr in attributes:
Expand Down Expand Up @@ -81,7 +83,7 @@ def http_status_to_status_code(
return StatusCode.ERROR


def unwrap(obj: Union[object, str], attr: str):
def unwrap(obj: object, attr: str):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a type of redundancy here, since str is an object.

But on the first line of this function, the type checker is able to infer if it's a str or not.

"""Given a function that was wrapped by wrapt.wrap_function_wrapper, unwrap it

The object containing the function to unwrap may be passed as dotted module path string.
Expand Down Expand Up @@ -152,7 +154,7 @@ def _start_internal_or_server_span(
return span, token


def _url_quote(s) -> str: # pylint: disable=invalid-name
def _url_quote(s: Any) -> str: # pylint: disable=invalid-name
if not isinstance(s, (str, bytes)):
return s
quoted = urllib.parse.quote(s)
Expand All @@ -163,13 +165,13 @@ def _url_quote(s) -> str: # pylint: disable=invalid-name
return quoted.replace("%", "%%")


def _get_opentelemetry_values() -> dict:
def _get_opentelemetry_values() -> dict[str, Any]:
"""
Return the OpenTelemetry Trace and Span IDs if Span ID is set in the
OpenTelemetry execution context.
"""
# Insert the W3C TraceContext generated
_headers = {}
_headers: dict[str, Any] = {}
propagator.inject(_headers)
return _headers

Expand All @@ -196,7 +198,7 @@ def is_http_instrumentation_enabled() -> bool:


@contextmanager
def _suppress_instrumentation(*keys: str) -> Iterable[None]:
def _suppress_instrumentation(*keys: str) -> Generator[None]:
"""Suppress instrumentation within the context."""
ctx = context.get_current()
for key in keys:
Expand All @@ -209,7 +211,7 @@ def _suppress_instrumentation(*keys: str) -> Iterable[None]:


@contextmanager
def suppress_instrumentation() -> Iterable[None]:
def suppress_instrumentation() -> Generator[None]:
"""Suppress instrumentation within the context."""
with _suppress_instrumentation(
_SUPPRESS_INSTRUMENTATION_KEY, _SUPPRESS_INSTRUMENTATION_KEY_PLAIN
Expand All @@ -218,7 +220,7 @@ def suppress_instrumentation() -> Iterable[None]:


@contextmanager
def suppress_http_instrumentation() -> Iterable[None]:
def suppress_http_instrumentation() -> Generator[None]:
"""Suppress instrumentation within the context."""
with _suppress_instrumentation(_SUPPRESS_HTTP_INSTRUMENTATION_KEY):
yield
Loading