aiq.utils.optional_imports

Attributes

logger

Exceptions

OptionalImportError	Raised when an optional import fails.
TelemetryOptionalImportError	Raised when an optional import of telemetry dependencies fails.

Classes

DummySpan	Dummy span class that does nothing when OpenTelemetry is not available.
DummyTracer	Dummy tracer class that returns dummy spans.
DummyTracerProvider	Dummy tracer provider that returns dummy tracers.
DummyTrace	Dummy trace module that returns dummy tracer providers.
DummySpanExporter	Dummy span exporter that does nothing.
DummyBatchSpanProcessor	Dummy implementation of BatchSpanProcessor for when OpenTelemetry is not available.

Functions

optional_import(→ types.ModuleType)	Attempt to import a module, raising OptionalImportError if it fails.
telemetry_optional_import(→ types.ModuleType)	Attempt to import a module, raising TelemetryOptionalImportError if it fails.
try_import_opentelemetry(→ types.ModuleType)	Get the opentelemetry module if available.
try_import_phoenix(→ types.ModuleType)	Get the phoenix module if available.
dummy_set_span_in_context(→ None)	Dummy function that does nothing.

Module Contents

logger

exception OptionalImportError(module_name: str, additional_message: str = '')

Bases: Exception

Raised when an optional import fails.

Initialize self. See help(type(self)) for accurate signature.

exception TelemetryOptionalImportError(module_name: str)

Bases: OptionalImportError

Raised when an optional import of telemetry dependencies fails.

Initialize self. See help(type(self)) for accurate signature.

optional_import(module_name: str) → types.ModuleType

Attempt to import a module, raising OptionalImportError if it fails.

telemetry_optional_import(module_name: str) → types.ModuleType

Attempt to import a module, raising TelemetryOptionalImportError if it fails.

try_import_opentelemetry() → types.ModuleType

Get the opentelemetry module if available.

try_import_phoenix() → types.ModuleType

Get the phoenix module if available.

class DummySpan(*args, **kwargs)

Dummy span class that does nothing when OpenTelemetry is not available.

end(*args, **kwargs)

set_attribute(*args, **kwargs)

class DummyTracer

Dummy tracer class that returns dummy spans.

start_span(*args, **kwargs)

class DummyTracerProvider

Dummy tracer provider that returns dummy tracers.

static get_tracer(*args, **kwargs)

static add_span_processor(*args, **kwargs)

class DummyTrace

Dummy trace module that returns dummy tracer providers.

static get_tracer_provider()

static set_tracer_provider(*args, **kwargs)

static get_tracer(*args, **kwargs)

class DummySpanExporter

Dummy span exporter that does nothing.

static export(*args, **kwargs)

static shutdown(*args, **kwargs)

class DummyBatchSpanProcessor(*args, **kwargs)

Dummy implementation of BatchSpanProcessor for when OpenTelemetry is not available.

static shutdown(*args, **kwargs)

dummy_set_span_in_context(*args, **kwargs) → None

Dummy function that does nothing.