Fix ruff check issues.

Author: michaelsafyan

instrumentation-genai/opentelemetry-instrumentation-google-genai/examples/manual/main.py

@@ -12,33 +12,36 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+
 import google.genai
 
 # NOTE: OpenTelemetry Python Logs and Events APIs are in beta
 from opentelemetry import _events as otel_events
 from opentelemetry import _logs as otel_logs
-from opentelemetry import trace as otel_trace
 from opentelemetry import metrics as otel_metrics
+from opentelemetry import trace as otel_trace
 from opentelemetry.exporter.otlp.proto.grpc._log_exporter import (
     OTLPLogExporter,
 )
+from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import (
+    OTLPMetricExporter,
+)
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
     OTLPSpanExporter,
 )
-from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import (
-    OTLPMetricExporter,
+from opentelemetry.instrumentation.google_genai import (
+    GoogleGenAiSdkInstrumentor,
 )
-from opentelemetry.instrumentation.google_genai import GoogleGenAiSdkInstrumentor
 from opentelemetry.instrumentation.requests import RequestsInstrumentor
 from opentelemetry.sdk._events import EventLoggerProvider
 from opentelemetry.sdk._logs import LoggerProvider
 from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
-from opentelemetry.sdk.metrics import MeterProvider
-from opentelemetry.sdk.metrics.export import (
-    PeriodicExportingMetricReader,
-)
+
 
 def setup_otel_tracing():
     otel_trace.set_tracer_provider(TracerProvider())
@@ -82,8 +85,8 @@ def main():
     instrument_google_genai()
     client = google.genai.Client()
     response = client.models.generate_content(
-        model = os.getenv('MODEL', 'gemini-2.0-flash-001'),
-        contents = os.getenv('PROMPT', 'Why is the sky blue?'),
+        model = os.getenv("MODEL", "gemini-2.0-flash-001"),
+        contents = os.getenv("PROMPT", "Why is the sky blue?"),
     )
     print(response.text)
 

instrumentation-genai/opentelemetry-instrumentation-google-genai/examples/zero-code/main.py

@@ -13,13 +13,15 @@
 # limitations under the License.
 
 import os
+
 import google.genai
 
+
 def main():
     client = google.genai.Client()
     response = client.models.generate_content(
-        model = os.getenv('MODEL', 'gemini-2.0-flash-001'),
-        contents = os.getenv('PROMPT', 'Why is the sky blue?'),
+        model = os.getenv("MODEL", "gemini-2.0-flash-001"),
+        contents = os.getenv("PROMPT", "Why is the sky blue?"),
     )
     print(response.text)
 

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/__init__.py

@@ -25,7 +25,7 @@
 .. code:: python
 
     import os
-    import google.genai 
+    import google.genai
     from opentelemetry.instrumentation.google_genai import GoogleGenAiSdkInstrumentor
 
     GoogleGenAiSdkInstrumentor().instrument()
@@ -44,4 +44,7 @@
 from .instrumentor import GoogleGenAiSdkInstrumentor
 from .version import __version__
 
-__all__ = ['GoogleGenAiSdkInstrumentor']
+__all__ = [
+    "GoogleGenAiSdkInstrumentor",
+    "__version__"
+]

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/flags.py

@@ -14,11 +14,11 @@
 
 import os
 
-_CONTENT_RECORDING_ENV_VAR = 'OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT'
+_CONTENT_RECORDING_ENV_VAR = "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT"
 
 
 def is_content_recording_enabled():
     return os.getenv(
         _CONTENT_RECORDING_ENV_VAR,
-        'false'
-    ).lower() in ['1', 'true', 'yes', 'on']
+        "false"
+    ).lower() in ["1", "true", "yes", "on"]

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py

@@ -12,28 +12,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Union, Optional, Iterator, AsyncIterator, Awaitable
-
+import functools
 import logging
-import time
 import os
-import functools
-
+import time
+from typing import AsyncIterator, Awaitable, Iterator, Optional, Union
 
-from google.genai.models import Models, AsyncModels
+from google.genai.models import AsyncModels, Models
 from google.genai.types import (
+    BlockedReason,
     ContentListUnion,
     ContentListUnionDict,
     GenerateContentConfigOrDict,
     GenerateContentResponse,
 )
-from .flags import is_content_recording_enabled
-from .otel_wrapper import OTelWrapper
 
 from opentelemetry import trace
 from opentelemetry.semconv._incubating.attributes import gen_ai_attributes
 from opentelemetry.semconv.attributes import error_attributes
 
+from .flags import is_content_recording_enabled
+from .otel_wrapper import OTelWrapper
 
 _logger = logging.getLogger(__name__)
 
@@ -84,20 +83,20 @@ def _get_gemini_system_name():
 
 
 def _guess_genai_system_from_env():
-    if os.environ.get('GOOGLE_GENAI_USE_VERTEXAI', '0').lower() in [
-          'true',
-          '1',
+    if os.environ.get("GOOGLE_GENAI_USE_VERTEXAI", "0").lower() in [
+          "true",
+          "1",
       ]:
       return _get_vertexai_system_name()
     return _get_gemini_system_name()
 
 
 
 def _determine_genai_system(models_object: Union[Models, AsyncModels]):
-    client = getattr(models_object, '_api_client')
+    client = getattr(models_object, "_api_client")
     if not client:
         return _guess_genai_system_from_env()
-    vertexai_attr = getattr(client, 'vertexai')
+    vertexai_attr = getattr(client, "vertexai")
     if vertexai_attr is None:
         return _guess_genai_system_from_env()
     if vertexai_attr:
@@ -111,7 +110,7 @@ def _get_config_property(
     path: str):
     if config is None:
         return None
-    path_segments = path.split('.')
+    path_segments = path.split(".")
     current_context = config
     for path_segment in path_segments:
         if current_context is None:
@@ -126,7 +125,7 @@ def _get_config_property(
 def _get_response_property(
     response: GenerateContentResponse,
     path: str):
-    path_segments = path.split('.')
+    path_segments = path.split(".")
     current_context = response
     for path_segment in path_segments:
         if current_context is None:
@@ -139,15 +138,15 @@ def _get_response_property(
 
 
 def _get_temperature(config: Optional[GenerateContentConfigOrDict]):
-    return _get_config_property(config, 'temperature')
+    return _get_config_property(config, "temperature")
 
 
 def _get_top_k(config: Optional[GenerateContentConfigOrDict]):
-    return _get_config_property(config, 'top_k')
+    return _get_config_property(config, "top_k")
 
 
 def _get_top_p(config: Optional[GenerateContentConfigOrDict]):
-    return _get_config_property(config, 'top_p')
+    return _get_config_property(config, "top_p")
 
 
 _SPAN_ATTRIBUTE_TO_CONFIG_EXTRACTOR = {
@@ -181,7 +180,7 @@ def start_span_as_current_span(self, name):
             attributes={
                 gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
                 gen_ai_attributes.GEN_AI_REQUEST_MODEL: self._genai_request_model,
-                gen_ai_attributes.GEN_AI_OPERATION_NAME: 'GenerateContent',
+                gen_ai_attributes.GEN_AI_OPERATION_NAME: "GenerateContent",
             }
         )
 
@@ -196,7 +195,7 @@ def process_request(
                 span.set_attribute(attribute_key, attribute_value)
         self._maybe_log_system_instruction(config=config)
         self._maybe_log_user_prompt(contents)
-        
+
 
     def process_response(self, response: GenerateContentResponse):
         self._maybe_update_token_counts(response)
@@ -216,8 +215,8 @@ def finalize_processing(self):
         self._otel_wrapper.done()
 
     def _maybe_update_token_counts(self, response: GenerateContentResponse):
-        input_tokens = _get_response_property(response, 'usage_metadata.prompt_token_count')
-        output_tokens = _get_response_property(response, 'usage_metadata.candidates_token_count')
+        input_tokens = _get_response_property(response, "usage_metadata.prompt_token_count")
+        output_tokens = _get_response_property(response, "usage_metadata.candidates_token_count")
         if input_tokens:
             self._input_tokens += input_tokens
         if output_tokens:
@@ -228,26 +227,26 @@ def _maybe_update_error_type(self, response: GenerateContentResponse):
             return
         if ((not response.prompt_feedback) or
             (not response.prompt_feedback.block_reason) or
-            (block_reason == genai_types.BlockedReason.BLOCKED_REASON_UNSPECIFIED)):
-            self._error_type = 'NO_CANDIDATES'
+            (response.prompt_feedback.block_reason == BlockedReason.BLOCKED_REASON_UNSPECIFIED)):
+            self._error_type = "NO_CANDIDATES"
             return
         block_reason = response.prompt_feedback.block_reason
-        self._error_type = 'BLOCKED_{}'.format(block_reason.name)
+        self._error_type = "BLOCKED_{}".format(block_reason.name)
 
     def _maybe_log_system_instruction(self, config: Optional[GenerateContentConfigOrDict]=None):
         if not self._content_recording_enabled:
             return
-        system_instruction = _get_config_property(config, 'system_instruction')
+        system_instruction = _get_config_property(config, "system_instruction")
         if not system_instruction:
             return
         self._otel_wrapper.log_system_prompt(
             attributes={
                 gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
             },
             body={
-                'content': system_instruction,
+                "content": system_instruction,
             })
-    
+
     def _maybe_log_user_prompt(self, contents: Union[ContentListUnion, ContentListUnionDict]):
         if not self._content_recording_enabled:
             return
@@ -256,7 +255,7 @@ def _maybe_log_user_prompt(self, contents: Union[ContentListUnion, ContentListUn
                 gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
             },
             body={
-                'content': contents,
+                "content": contents,
             })
 
     def _maybe_log_response(self, response: GenerateContentResponse):
@@ -267,34 +266,34 @@ def _maybe_log_response(self, response: GenerateContentResponse):
                 gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
             },
             body={
-                'content': response.model_dump(),
+                "content": response.model_dump(),
             })
 
     def _record_token_usage_metric(self):
         self._otel_wrapper.token_usage_metric.record(
             self._input_tokens,
             attributes={
-                gen_ai_attributes.GEN_AI_TOKEN_TYPE: 'input',
+                gen_ai_attributes.GEN_AI_TOKEN_TYPE: "input",
                 gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
                 gen_ai_attributes.GEN_AI_REQUEST_MODEL: self._genai_request_model,
-                gen_ai_attributes.GEN_AI_OPERATION_NAME: 'GenerateContent',
+                gen_ai_attributes.GEN_AI_OPERATION_NAME: "GenerateContent",
             }
         )
         self._otel_wrapper.token_usage_metric.record(
             self._output_tokens,
             attributes={
-                gen_ai_attributes.GEN_AI_TOKEN_TYPE: 'output',
+                gen_ai_attributes.GEN_AI_TOKEN_TYPE: "output",
                 gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
                 gen_ai_attributes.GEN_AI_REQUEST_MODEL: self._genai_request_model,
-                gen_ai_attributes.GEN_AI_OPERATION_NAME: 'GenerateContent',
+                gen_ai_attributes.GEN_AI_OPERATION_NAME: "GenerateContent",
             }
         )
-    
+
     def _record_duration_metric(self):
         attributes = {
             gen_ai_attributes.GEN_AI_SYSTEM: self._genai_system,
             gen_ai_attributes.GEN_AI_REQUEST_MODEL: self._genai_request_model,
-            gen_ai_attributes.GEN_AI_OPERATION_NAME: 'GenerateContent',
+            gen_ai_attributes.GEN_AI_OPERATION_NAME: "GenerateContent",
         }
         if self._error_type is not None:
             attributes[error_attributes.ERROR_TYPE] = self._error_type
@@ -319,7 +318,7 @@ def instrumented_generate_content(
         contents: Union[ContentListUnion, ContentListUnionDict],
         config: Optional[GenerateContentConfigOrDict] = None) -> GenerateContentResponse:
         helper = _GenerateContentInstrumentationHelper(self, otel_wrapper, model)
-        with helper.start_span_as_current_span('google.genai.Models.generate_content'):
+        with helper.start_span_as_current_span("google.genai.Models.generate_content"):
             helper.process_request(contents, config)
             try:
                 response = wrapped_func(self, model=model, contents=contents, config=config)
@@ -348,7 +347,7 @@ def instrumented_generate_content_stream(
         contents: Union[ContentListUnion, ContentListUnionDict],
         config: Optional[GenerateContentConfigOrDict] = None) -> Iterator[GenerateContentResponse]:
         helper = _GenerateContentInstrumentationHelper(self, otel_wrapper, model)
-        with helper.start_span_as_current_span('google.genai.Models.generate_content_stream'):
+        with helper.start_span_as_current_span("google.genai.Models.generate_content_stream"):
             helper.process_request(contents, config)
             try:
                 for response in wrapped_func(self, model=model, contents=contents, config=config):
@@ -377,7 +376,7 @@ async def instrumented_generate_content(
         contents: Union[ContentListUnion, ContentListUnionDict],
         config: Optional[GenerateContentConfigOrDict] = None) -> GenerateContentResponse:
         helper = _GenerateContentInstrumentationHelper(self, otel_wrapper, model)
-        with helper.start_span_as_current_span('google.genai.AsyncModels.generate_content'):
+        with helper.start_span_as_current_span("google.genai.AsyncModels.generate_content"):
             helper.process_request(contents, config)
             try:
                 response = await wrapped_func(self, model=model, contents=contents, config=config)
@@ -406,7 +405,7 @@ async def instrumented_generate_content_stream(
         contents: Union[ContentListUnion, ContentListUnionDict],
         config: Optional[GenerateContentConfigOrDict] = None) -> Awaitable[AsyncIterator[GenerateContentResponse]]:
         helper = _GenerateContentInstrumentationHelper(self, otel_wrapper, model)
-        with helper.start_span_as_current_span('google.genai.AsyncModels.generate_content_stream'):
+        with helper.start_span_as_current_span("google.genai.AsyncModels.generate_content_stream"):
             helper.process_request(contents, config)
             try:
                 async for response in wrapped_func(self, model=model, contents=contents, config=config):
@@ -431,4 +430,4 @@ def instrument_generate_content(otel_wrapper: OTelWrapper) -> object:
     Models.generate_content_stream = _create_instrumented_generate_content_stream(snapshot, otel_wrapper)
     AsyncModels.generate_content = _create_instrumented_async_generate_content(snapshot, otel_wrapper)
     AsyncModels.generate_content_stream = _create_instrumented_async_generate_content_stream(snapshot, otel_wrapper)
-    return snapshot
+    return snapshot

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/instrumentor.py

@@ -14,12 +14,15 @@
 
 from typing import Any, Collection
 
-from opentelemetry.trace import get_tracer_provider
-from opentelemetry.metrics import get_meter_provider
-from opentelemetry._events import get_event_logger_provider 
+from opentelemetry._events import get_event_logger_provider
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.metrics import get_meter_provider
+from opentelemetry.trace import get_tracer_provider
 
-from .generate_content import instrument_generate_content, uninstrument_generate_content
+from .generate_content import (
+    instrument_generate_content,
+    uninstrument_generate_content,
+)
 from .otel_wrapper import OTelWrapper
 
 
@@ -29,12 +32,12 @@ def __init__(self):
         self._generate_content_snapshot = None
 
     def instrumentation_dependencies(self) -> Collection[str]:
-        return ['google-genai>=1.0.0,<2']
+        return ["google-genai>=1.0.0,<2"]
 
     def _instrument(self, **kwargs: Any):
-        tracer_provider = kwargs.get('tracer_provider') or get_tracer_provider()
-        event_logger_provider = kwargs.get('event_logger_provider') or get_event_logger_provider()
-        meter_provider = kwargs.get('meter_provider') or get_meter_provider()
+        tracer_provider = kwargs.get("tracer_provider") or get_tracer_provider()
+        event_logger_provider = kwargs.get("event_logger_provider") or get_event_logger_provider()
+        meter_provider = kwargs.get("meter_provider") or get_meter_provider()
         otel_wrapper = OTelWrapper.from_providers(
             tracer_provider=tracer_provider,
             event_logger_provider=event_logger_provider,