lib.rs 44.1 KB
Newer Older
1
// SPDX-FileCopyrightText: Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
3
// SPDX-License-Identifier: Apache-2.0

4
use dynamo_llm::local_model::LocalModel;
5
use dynamo_runtime::distributed::{DiscoveryBackend, DistributedConfig, RequestPlaneMode};
6
use dynamo_runtime::storage::kv;
7
8
use futures::StreamExt;
use once_cell::sync::OnceCell;
9
use pyo3::IntoPyObjectExt;
10
use pyo3::exceptions::PyStopAsyncIteration;
Richard Huo's avatar
Richard Huo committed
11
use pyo3::types::PyCapsule;
12
use pyo3::types::{PyDict, PyString};
13
14
use pyo3::{exceptions::PyException, prelude::*};
use rs::pipeline::network::Ingress;
Richard Huo's avatar
Richard Huo committed
15
use std::ffi::CString;
16
use std::fs;
17
use std::path::PathBuf;
Richard Huo's avatar
Richard Huo committed
18
19
20
21
use std::{
    fmt::Display,
    sync::{Arc, Weak},
};
22
use tokio::sync::Mutex;
23
use tracing::Instrument;
24

25
use dynamo_runtime::config;
26
use dynamo_runtime::config::environment_names::logging::otlp as env_otlp;
Neelay Shah's avatar
Neelay Shah committed
27
use dynamo_runtime::{
Ryan Olson's avatar
Ryan Olson committed
28
    self as rs, logging,
29
    pipeline::{
30
        AsyncEngineContextProvider, EngineStream, ManyOut, SingleIn, context::Context as RsContext,
31
        network::egress::push_router::RouterMode as RsRouterMode,
32
    },
33
    protocols::annotated::Annotated as RsAnnotated,
34
    traits::DistributedRuntimeProvider,
35
36
};

37
38
use dynamo_kv_router::config::KvRouterConfig;
use dynamo_llm::entrypoint::RouterConfig;
Neelay Shah's avatar
Neelay Shah committed
39
use dynamo_llm::{self as llm_rs};
40

41
use crate::llm::local_model::ModelRuntimeConfig;
42
use crate::llm::preprocessor::{MediaDecoder, MediaFetcher};
43

44
45
46
47
48
#[pyclass(eq, eq_int)]
#[derive(Clone, Debug, PartialEq)]
pub enum RouterMode {
    RoundRobin,
    Random,
49
    PowerOfTwoChoices,
50
    KV,
51
52
53
    /// Direct routing - reads worker ID from each request's routing hints.
    /// Used when an external orchestrator (e.g., EPP) handles worker selection.
    Direct,
54
    LeastLoaded,
55
    DeviceAwareWeighted,
56
57
58
59
60
61
62
}

impl From<RouterMode> for RsRouterMode {
    fn from(mode: RouterMode) -> Self {
        match mode {
            RouterMode::RoundRobin => Self::RoundRobin,
            RouterMode::Random => Self::Random,
63
            RouterMode::PowerOfTwoChoices => Self::PowerOfTwoChoices,
64
            RouterMode::KV => Self::KV,
65
            RouterMode::Direct => Self::Direct,
66
            RouterMode::LeastLoaded => Self::LeastLoaded,
67
            RouterMode::DeviceAwareWeighted => Self::DeviceAwareWeighted,
68
69
70
        }
    }
}
71

72
mod context;
73
mod engine;
74
pub mod errors;
75
mod http;
76
mod kserve_grpc;
77
mod llm;
78
mod parsers;
79
mod planner;
80
mod prometheus_metrics;
81
82
83
84
85
86
87

type JsonServerStreamingIngress =
    Ingress<SingleIn<serde_json::Value>, ManyOut<RsAnnotated<serde_json::Value>>>;

static INIT: OnceCell<()> = OnceCell::new();

const DEFAULT_ANNOTATED_SETTING: Option<bool> = Some(true);
88
89
const SKIP_PYTHON_LOG_INIT_ENV: &str = "DYNAMO_SKIP_PYTHON_LOG_INIT";

90
91
// Helper to get appropriate span for instrumentation - always emit spans
fn get_span_for_context(context: &context::Context, operation: &str) -> tracing::Span {
92
93
94
95
96
97
    logging::make_client_request_span(
        operation,
        context.inner().id(),
        context.trace_context(),
        None,
    )
98
99
100
101
102
103
104
105
}

// Helper to create span for direct method with instance_id
fn get_span_for_direct_context(
    context: &context::Context,
    operation: &str,
    instance_id: &str,
) -> tracing::Span {
106
107
108
109
110
111
    logging::make_client_request_span(
        operation,
        context.inner().id(),
        context.trace_context(),
        Some(instance_id),
    )
112
113
}

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Helper to create request context with proper linking and cancellation handling
fn create_request_context(
    request: serde_json::Value,
    parent_ctx: &Option<context::Context>,
) -> RsContext<serde_json::Value> {
    match parent_ctx {
        // If there is a parent context, link the request as a child context of it
        Some(parent_ctx) => {
            let child_ctx = RsContext::with_id(request, parent_ctx.inner().id().to_string());
            parent_ctx.inner().link_child(child_ctx.context());
            if parent_ctx.inner().is_stopped() || parent_ctx.inner().is_killed() {
                // Let the server handle the cancellation for now since not all backends are
                // properly handling request exceptions
                // TODO: (DIS-830) Return an error if context is cancelled
                child_ctx.context().stop_generating();
            }
            child_ctx
        }
        // Otherwise if there is no parent context, use the request as-is
        _ => request.into(),
    }
}

137
138
139
140
141
/// A Python module implemented in Rust. The name of this function must match
/// the `lib.name` setting in the `Cargo.toml`, else Python will not be able to
/// import the module.
#[pymodule]
fn _core(m: &Bound<'_, PyModule>) -> PyResult<()> {
142
    // Initialize logging early unless OTEL export is enabled (which requires tokio runtime)
143
    if config::env_is_truthy(env_otlp::OTEL_EXPORT_ENABLED) {
144
        eprintln!(
145
            "Warning: OTEL_EXPORT_ENABLED detected. Logging initialization deferred until runtime is available. Early logs may be dropped."
146
        );
147
    } else if std::env::var_os(SKIP_PYTHON_LOG_INIT_ENV).is_none() {
148
149
150
        rs::logging::init();
    }

Yan Ru Pei's avatar
Yan Ru Pei committed
151
    m.add_function(wrap_pyfunction!(llm::kv::compute_block_hash_for_seq_py, m)?)?;
152
    m.add_function(wrap_pyfunction!(lora_name_to_id, m)?)?;
Ryan Olson's avatar
Ryan Olson committed
153
    m.add_function(wrap_pyfunction!(log_message, m)?)?;
154
155
156
    m.add_function(wrap_pyfunction!(register_model, m)?)?;
    m.add_function(wrap_pyfunction!(unregister_model, m)?)?;
    m.add_function(wrap_pyfunction!(fetch_model, m)?)?;
157
    m.add_function(wrap_pyfunction!(run_kv_indexer, m)?)?;
158
    m.add_function(wrap_pyfunction!(llm::entrypoint::make_engine, m)?)?;
159
    m.add_function(wrap_pyfunction!(llm::replay::run_mocker_trace_replay, m)?)?;
160
    m.add_function(wrap_pyfunction!(
161
        llm::replay::run_mocker_synthetic_trace_replay,
162
163
        m
    )?)?;
164
    m.add_function(wrap_pyfunction!(llm::entrypoint::run_input, m)?)?;
165

166
167
    m.add_class::<DistributedRuntime>()?;
    m.add_class::<Endpoint>()?;
168
    m.add_class::<ModelCardInstanceId>()?;
169
170
    m.add_class::<Client>()?;
    m.add_class::<AsyncResponseStream>()?;
171
172
173
    m.add_class::<llm::entrypoint::EntrypointArgs>()?;
    m.add_class::<llm::entrypoint::EngineConfig>()?;
    m.add_class::<llm::entrypoint::EngineType>()?;
174
    m.add_class::<llm::entrypoint::AicPerfConfig>()?;
175
176
    m.add_class::<llm::entrypoint::RouterConfig>()?;
    m.add_class::<llm::entrypoint::KvRouterConfig>()?;
177
178
179
    m.add_class::<llm::replay::ReasoningConfig>()?;
    m.add_class::<llm::replay::SglangArgs>()?;
    m.add_class::<llm::replay::MockEngineArgs>()?;
180
    m.add_class::<llm::replay::PlannerReplayBridge>()?;
181
    m.add_class::<llm::kv::WorkerMetricsPublisher>()?;
182
    m.add_class::<llm::model_card::ModelDeploymentCard>()?; // Internal: only in _internal, not public API
183
    m.add_class::<llm::local_model::ModelRuntimeConfig>()?;
184
185
    m.add_class::<llm::preprocessor::MediaDecoder>()?;
    m.add_class::<llm::preprocessor::MediaFetcher>()?;
186
    m.add_class::<llm::kv::OverlapScores>()?;
187
    m.add_class::<llm::kv::KvEventPublisher>()?;
Yan Ru Pei's avatar
Yan Ru Pei committed
188
    m.add_class::<llm::kv::RadixTree>()?;
189
190
    m.add_class::<llm::fpm::FpmEventRelay>()?;
    m.add_class::<llm::fpm::FpmEventSubscriber>()?;
191
    m.add_class::<llm::lora::LoRADownloader>()?;
192
193
    m.add_class::<http::HttpService>()?;
    m.add_class::<http::HttpAsyncEngine>()?;
194
    m.add_class::<context::Context>()?;
195
    m.add_class::<ModelType>()?;
196
    m.add_class::<ModelInput>()?;
197
    m.add_class::<llm::kv::KvRouter>()?;
198
    m.add_class::<RouterMode>()?;
199
    m.add_class::<kserve_grpc::KserveGrpcService>()?;
200
    m.add("__version__", env!("CARGO_PKG_VERSION"))?;
201
202
203
    m.add_class::<planner::VirtualConnectorCoordinator>()?;
    m.add_class::<planner::VirtualConnectorClient>()?;
    m.add_class::<planner::PlannerDecision>()?;
204
205

    engine::add_to_module(m)?;
206
    errors::register_exceptions(m)?;
207
    parsers::add_to_module(m)?;
208

209
    m.add_class::<prometheus_metrics::RuntimeMetrics>()?;
210
211
212
213
    let prometheus_metrics = PyModule::new(m.py(), "prometheus_metrics")?;
    prometheus_metrics::add_to_module(&prometheus_metrics)?;
    m.add_submodule(&prometheus_metrics)?;

214
215
216
217
218
219
220
221
222
223
    Ok(())
}

pub fn to_pyerr<E>(err: E) -> PyErr
where
    E: Display,
{
    PyException::new_err(format!("{}", err))
}

224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
fn kv_indexer_to_pyerr(err: anyhow::Error) -> PyErr {
    #[cfg(feature = "kv-indexer")]
    if let Some(clap_error) = err.downcast_ref::<clap::Error>() {
        let _ = clap_error.print();
        return pyo3::exceptions::PySystemExit::new_err(clap_error.exit_code());
    }

    to_pyerr(err)
}

#[pyfunction(name = "run_kv_indexer")]
#[pyo3(signature = (argv=None))]
fn run_kv_indexer(py: Python<'_>, argv: Option<Vec<String>>) -> PyResult<()> {
    let argv = argv.unwrap_or_default();
    py.allow_threads(move || llm::kv::run_kv_indexer_cli(argv))
        .map_err(kv_indexer_to_pyerr)
}

Ryan Olson's avatar
Ryan Olson committed
242
243
244
245
246
247
248
/// Log a message from Python with file and line info
#[pyfunction]
#[pyo3(text_signature = "(level, message, module, file, line)")]
fn log_message(level: &str, message: &str, module: &str, file: &str, line: u32) {
    logging::log_message(level, message, module, file, line);
}

249
250
251
252
253
254
255
/// Generate a deterministic signed int32 ID from a LoRA name using blake3 hash.
#[pyfunction]
#[pyo3(text_signature = "(lora_name)")]
fn lora_name_to_id(lora_name: &str) -> i32 {
    llm_rs::utils::lora_name_to_id(lora_name)
}

256
257
/// Create an engine and attach it to an endpoint to make it visible to the frontend.
/// This is the main way you create a Dynamo worker / backend.
258
259
260
261
262
263
264
///
/// If `lora_name` is provided, this function will publish a LoRA adapter instead of a base model:
/// - LoRA path: v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}/{lora_slug}
/// - Base model path: v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}
///
/// For LoRA mode, both `lora_name` and `base_model_path` must be provided together.
/// Providing only one of them will result in an error.
265
#[pyfunction]
266
#[pyo3(signature = (model_input, model_type, endpoint, model_path, model_name=None, context_length=None, kv_cache_block_size=None, router_mode=None, runtime_config=None, user_data=None, custom_template_path=None, media_decoder=None, media_fetcher=None, lora_name=None, base_model_path=None))]
267
#[allow(clippy::too_many_arguments)]
268
fn register_model<'p>(
269
    py: Python<'p>,
270
    model_input: ModelInput,
271
    model_type: ModelType,
272
273
274
    endpoint: Endpoint,
    model_path: &str,
    model_name: Option<&str>,
275
276
    context_length: Option<u32>,
    kv_cache_block_size: Option<u32>,
277
    router_mode: Option<RouterMode>,
278
    runtime_config: Option<ModelRuntimeConfig>,
279
    user_data: Option<&Bound<'p, PyDict>>,
280
    custom_template_path: Option<&str>,
281
282
    media_decoder: Option<MediaDecoder>,
    media_fetcher: Option<MediaFetcher>,
283
284
    lora_name: Option<&str>,
    base_model_path: Option<&str>,
285
) -> PyResult<Bound<'p, PyAny>> {
286
    // Validate Prefill model type requirements
287
288
289
290
291
292
    if model_type.inner == llm_rs::model_type::ModelType::Prefill
        && !matches!(model_input, ModelInput::Tokens)
    {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "ModelType::Prefill requires model_input to be ModelInput::Tokens",
        ));
293
294
    }

295
296
297
    let model_input = match model_input {
        ModelInput::Text => llm_rs::model_type::ModelInput::Text,
        ModelInput::Tokens => llm_rs::model_type::ModelInput::Tokens,
298
        ModelInput::Tensor => llm_rs::model_type::ModelInput::Tensor,
299
300
    };

301
    let is_tensor_based = model_type.inner.supports_tensor();
302
    let is_images = model_type.inner.supports_images();
303
    let is_videos = model_type.inner.supports_videos();
304

305
306
    let model_type_obj = model_type.inner;

307
    let inner_path = model_path.to_string();
308
    let model_name = model_name.map(|n| n.to_string());
309
310
311
    let router_mode = router_mode.unwrap_or(RouterMode::RoundRobin);
    let router_config = RouterConfig::new(router_mode.into(), KvRouterConfig::default());

312
313
314
315
316
317
318
319
320
321
322
323
324
    // Early validation of custom template path
    let custom_template_path_owned = custom_template_path
        .map(|s| {
            let path = PathBuf::from(s);
            if !path.exists() {
                return Err(PyErr::new::<pyo3::exceptions::PyFileNotFoundError, _>(
                    format!("Custom template file does not exist: {}", path.display()),
                ));
            }
            Ok(path)
        })
        .transpose()?;

325
326
327
328
329
330
331
    let user_data_json = user_data
        .map(|dict| pythonize::depythonize(dict))
        .transpose()
        .map_err(|err| {
            PyErr::new::<PyException, _>(format!("Failed to convert user_data: {}", err))
        })?;

332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
    // Validate LoRA parameters: both or neither must be provided
    if lora_name.is_some() ^ base_model_path.is_some() {
        return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(
            "lora_name and base_model_path must both be provided together, or neither",
        ));
    }

    // Determine source_path and lora_identifier based on registration mode
    let (source_path, lora_identifier) = match (lora_name, base_model_path) {
        (Some(lora), Some(base)) => (base.to_string(), Some(lora.to_string())),
        _ => (inner_path, None),
    };

    // Model name: use lora name if present, otherwise provided name or default to source path
    let model_name = lora_identifier
        .clone()
        .or(model_name)
        .or_else(|| Some(source_path.clone()));

351
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
352
353
354
        // For TensorBased, Images, and Videos models, skip HuggingFace downloads and register directly
        // These model types handle model loading internally, no tokenizer extraction needed
        if is_tensor_based || is_images || is_videos {
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
            let model_name = model_name.unwrap_or_else(|| source_path.clone());
            let mut card = llm_rs::model_card::ModelDeploymentCard::with_name_only(&model_name);
            card.model_type = model_type_obj;
            card.model_input = model_input;
            card.user_data = user_data_json;

            if let Some(cfg) = runtime_config {
                card.runtime_config = cfg.inner;
            }

            // Register the Model Deployment Card via discovery interface
            let discovery = endpoint.inner.drt().discovery();
            let spec = rs::discovery::DiscoverySpec::from_model(
                endpoint.inner.component().namespace().name().to_string(),
                endpoint.inner.component().name().to_string(),
                endpoint.inner.name().to_string(),
                &card,
            )
            .map_err(to_pyerr)?;
            discovery.register(spec).await.map_err(to_pyerr)?;

            return Ok(());
        }

        // For non-TensorBased models, resolve the model path (local or fetch from HuggingFace)
380
381
        let model_path = if fs::exists(&source_path)? {
            PathBuf::from(&source_path)
382
        } else {
383
            LocalModel::fetch(&source_path, false)
384
385
386
387
                .await
                .map_err(to_pyerr)?
        };

388
389
        let mut builder = dynamo_llm::local_model::LocalModelBuilder::default();
        builder
390
            // model path is the physical path on disk of the downloaded model
391
            .model_path(model_path)
392
393
394
395
            // source path is what the user gave as `--model-path`, either a real path (in which
            // case it matches model_path above), or an HF repo.
            .source_path(source_path.clone().into())
            // --served_model_name
396
            .model_name(model_name.clone())
397
            .context_length(context_length)
398
            .kv_cache_block_size(kv_cache_block_size)
399
            .router_config(Some(router_config))
400
            .runtime_config(runtime_config.unwrap_or_default().inner)
401
            .user_data(user_data_json)
402
403
404
            .custom_template_path(custom_template_path_owned)
            .media_decoder(media_decoder.map(|m| m.inner))
            .media_fetcher(media_fetcher.map(|m| m.inner));
405

406
        let mut local_model = builder.build().await.map_err(to_pyerr)?;
407
408
409
410
411
412
413
414
415

        // Convert lora_identifier (Option<String>) to Option<LoraInfo>
        let lora_info = lora_identifier
            .as_ref()
            .map(|name| llm_rs::model_card::LoraInfo {
                name: name.clone(),
                max_gpu_lora_count: None,
            });

416
        local_model
417
            .attach(&endpoint.inner, model_type_obj, model_input, lora_info)
418
419
420
            .await
            .map_err(to_pyerr)?;

421
422
423
        if let Some(lora_name) = lora_identifier {
            tracing::info!("Registered LoRA '{}' MDC", lora_name);
        } else {
424
425
426
427
            tracing::info!(
                "Registered base model '{}' MDC",
                model_name.unwrap_or(source_path)
            );
428
429
        }

430
431
432
433
        Ok(())
    })
}

434
435
436
437
438
439
440
441
442
443
444
445
446
/// Unregister a Model Deployment Card (MDC) from the service registry
///
/// This removes an LLM deployment from the discovery system.
///
/// # Arguments
///
/// * `endpoint` - The endpoint where the model is registered
/// * `lora_name` - Optional LoRA adapter name (if unregistering a LoRA deployment)
///
/// # MDC Path Format
///
/// - Base model: `v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}`
/// - LoRA model: `v1/mdc/{namespace}/{component}/{endpoint}/{instance_id}/{lora_slug}`
447
#[pyfunction]
448
#[pyo3(signature = (endpoint, lora_name=None))]
449
fn unregister_model<'p>(
450
451
452
453
454
455
    py: Python<'p>,
    endpoint: Endpoint,
    lora_name: Option<&str>,
) -> PyResult<Bound<'p, PyAny>> {
    let lora_name_owned = lora_name.map(|s| s.to_string());

456
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
457
458
        // Unified detach method handles both base models and LoRA adapters
        LocalModel::detach_from_endpoint(&endpoint.inner, lora_name_owned.as_deref())
459
460
461
462
463
464
            .await
            .map_err(to_pyerr)?;
        Ok(())
    })
}

465
466
/// Download a model from Hugging Face, returning its local path
/// Example: `model_path = await fetch_model("Qwen/Qwen3-0.6B")`
467
#[pyfunction]
468
#[pyo3(signature = (remote_name, ignore_weights=false))]
469
fn fetch_model<'p>(
470
471
472
473
    py: Python<'p>,
    remote_name: &str,
    ignore_weights: bool,
) -> PyResult<Bound<'p, PyAny>> {
474
475
    let repo = remote_name.to_string();
    pyo3_async_runtimes::tokio::future_into_py(py, async move {
476
477
478
        LocalModel::fetch(&repo, ignore_weights)
            .await
            .map_err(to_pyerr)
479
480
481
    })
}

482
483
#[pyclass]
#[derive(Clone)]
Ryan Olson's avatar
Ryan Olson committed
484
pub struct DistributedRuntime {
485
486
487
488
    inner: rs::DistributedRuntime,
    event_loop: PyObject,
}

Ryan Olson's avatar
Ryan Olson committed
489
490
impl DistributedRuntime {
    #[allow(dead_code)]
491
    pub(crate) fn inner(&self) -> &rs::DistributedRuntime {
Ryan Olson's avatar
Ryan Olson committed
492
493
494
495
        &self.inner
    }
}

496
#[pyclass]
497
#[derive(Clone)]
498
499
500
501
502
struct CancellationToken {
    inner: rs::CancellationToken,
}

#[pyclass]
503
#[derive(Clone)]
504
505
506
507
508
struct Endpoint {
    inner: rs::component::Endpoint,
    event_loop: PyObject,
}

509
510
511
512
513
514
#[pyclass]
#[derive(Clone)]
struct ModelCardInstanceId {
    inner: rs::discovery::ModelCardInstanceId,
}

515
#[pyclass]
516
#[derive(Clone)]
517
struct Client {
518
    router: rs::pipeline::PushRouter<serde_json::Value, RsAnnotated<serde_json::Value>>,
519
520
}

521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
#[pyclass]
#[derive(Clone, PartialEq)]
struct ModelType {
    inner: llm_rs::model_type::ModelType,
}

#[pymethods]
#[allow(non_upper_case_globals)]
impl ModelType {
    #[classattr]
    const Chat: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Chat,
    };
    #[classattr]
    const Completions: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Completions,
    };
    #[classattr]
    const Embedding: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Embedding,
    };
542
543
544
545
    #[classattr]
    const TensorBased: Self = ModelType {
        inner: llm_rs::model_type::ModelType::TensorBased,
    };
546
547
548
549
    #[classattr]
    const Prefill: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Prefill,
    };
550
551
552
553
    #[classattr]
    const Images: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Images,
    };
554
    #[classattr]
555
556
557
558
    const Audios: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Audios,
    };
    #[classattr]
559
560
561
    const Videos: Self = ModelType {
        inner: llm_rs::model_type::ModelType::Videos,
    };
562

563
564
565
566
    fn supports_chat(&self) -> bool {
        self.inner.supports_chat()
    }

567
568
569
570
571
572
573
574
575
576
577
    fn __or__(&self, other: &Self) -> Self {
        ModelType {
            inner: self.inner | other.inner,
        }
    }

    fn __str__(&self) -> String {
        self.inner.to_string()
    }
}

578
579
#[pyclass(eq, eq_int)]
#[derive(Clone, PartialEq)]
580
581
582
enum ModelInput {
    Text = 1,
    Tokens = 2,
583
    Tensor = 3,
584
585
}

586
587
588
#[pymethods]
impl DistributedRuntime {
    #[new]
589
    #[pyo3(signature = (event_loop, discovery_backend, request_plane, enable_nats=None))]
590
591
    fn new(
        event_loop: PyObject,
592
        discovery_backend: String,
593
594
595
        request_plane: String,
        enable_nats: Option<bool>,
    ) -> PyResult<Self> {
596
597
598
599
600
601
602
603
604
605
606
607
608
609
        if enable_nats.is_some() {
            Python::with_gil(|py| {
                let warnings = py.import("warnings")?;
                warnings.call_method1(
                    "warn",
                    (
                        "The 'enable_nats' parameter is deprecated and will be removed in a future release. NATS enablement is now determined automatically from the event-plane configuration.",
                        py.import("builtins")?.getattr("DeprecationWarning")?,
                        2i32, // stacklevel
                    ),
                )?;
                Ok::<(), PyErr>(())
            })?;
        }
610
611
612
613
614
615
616
        let discovery_backend_config = match discovery_backend.as_str() {
            "kubernetes" => DiscoveryBackend::Kubernetes,
            other => {
                let selector: kv::Selector = other.parse().map_err(to_pyerr)?;
                DiscoveryBackend::KvStore(selector)
            }
        };
617
        let request_plane: RequestPlaneMode = request_plane.parse().map_err(to_pyerr)?;
618

619
620
621
        // Try to get existing runtime first, create new Worker only if needed
        // This allows multiple DistributedRuntime instances to share the same tokio runtime
        let runtime = rs::Worker::runtime_from_existing()
622
            .or_else(|_| -> anyhow::Result<rs::Runtime> {
623
624
625
626
                // No existing Worker, create new one
                let worker = rs::Worker::from_settings()?;

                // Initialize pyo3 bridge (only happens once per process)
627
                INIT.get_or_try_init(|| -> anyhow::Result<()> {
628
629
                    let primary = worker.tokio_runtime()?;
                    pyo3_async_runtimes::tokio::init_with_runtime(primary).map_err(|e| {
630
                        anyhow::anyhow!("failed to initialize pyo3 static runtime: {:?}", e)
631
                    })?;
632
                    Ok(())
633
634
                })?;

635
                Ok(worker.runtime().clone())
636
637
            })
            .map_err(to_pyerr)?;
638

639
640
        // Initialize logging in context where tokio runtime is available
        // otel exporter requires it
641
        if config::env_is_truthy(env_otlp::OTEL_EXPORT_ENABLED) {
642
643
644
645
            runtime.secondary().block_on(async {
                rs::logging::init();
            });
        }
646

647
648
649
650
651
652
653
654
        let event_plane_is_nats =
            std::env::var(config::environment_names::event_plane::DYN_EVENT_PLANE)
                .map(|v| v.eq_ignore_ascii_case("nats"))
                .unwrap_or(true);

        let nats_enabled = request_plane.is_nats()
            || std::env::var(config::environment_names::nats::NATS_SERVER).is_ok()
            || event_plane_is_nats;
655

656
        let runtime_config = DistributedConfig {
657
            discovery_backend: discovery_backend_config,
658
            nats_config: if nats_enabled {
659
660
661
662
                Some(dynamo_runtime::transports::nats::ClientOptions::default())
            } else {
                None
            },
663
            request_plane,
664
665
666
667
668
        };
        let inner = runtime
            .secondary()
            .block_on(rs::DistributedRuntime::new(runtime, runtime_config))
            .map_err(to_pyerr)?;
669
670
671
672

        Ok(DistributedRuntime { inner, event_loop })
    }

Ryan Olson's avatar
Ryan Olson committed
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
    #[staticmethod]
    fn detached(py: Python) -> PyResult<Self> {
        let rt = rs::Worker::runtime_from_existing().map_err(to_pyerr)?;
        let handle = rt.primary();

        let inner = handle
            .block_on(rs::DistributedRuntime::from_settings(rt))
            .map_err(to_pyerr)?;

        Ok(DistributedRuntime {
            inner,
            event_loop: py.None(),
        })
    }

688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
    /// Get an endpoint directly by path (e.g., "namespace.component.endpoint" or "dyn://...").
    fn endpoint(&self, path: String) -> PyResult<Endpoint> {
        let trimmed_path = path.trim_start_matches("dyn://");
        let parts: Vec<&str> = trimmed_path.split('.').collect();

        if parts.len() != 3 {
            return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(format!(
                "Invalid endpoint path '{}'. Expected format: 'namespace.component.endpoint' or 'dyn://namespace.component.endpoint'",
                path
            )));
        }

        let namespace_name = parts[0];
        let component_name = parts[1];
        let endpoint_name = parts[2];

        // Get endpoint using existing chain
        let namespace = self
            .inner
            .namespace(namespace_name.to_string())
            .map_err(to_pyerr)?;
        let component = namespace
            .component(component_name.to_string())
            .map_err(to_pyerr)?;
        let endpoint = component.endpoint(endpoint_name.to_string());

        Ok(Endpoint {
            inner: endpoint,
716
717
718
719
720
            event_loop: self.event_loop.clone(),
        })
    }

    fn shutdown(&self) {
721
        self.inner.shutdown();
722
723
724
725
726
    }

    fn event_loop(&self) -> PyObject {
        self.event_loop.clone()
    }
727

728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
    /// Register an async Python callback for /engine/{route_name}
    ///
    /// Args:
    ///     route_name: Route path (e.g., "start_profile" → /engine/start_profile)
    ///     callback: Async function with signature: async def(body: dict) -> dict
    ///
    /// Example:
    /// ```python
    /// async def start_profile(body: dict) -> dict:
    ///     await engine.start_profile(**body)
    ///     return {"status": "ok"}
    ///
    /// runtime.register_engine_route("start_profile", start_profile)
    /// ```
    #[pyo3(signature = (route_name, callback))]
    fn register_engine_route(
        &self,
        py: Python<'_>,
        route_name: String,
        callback: PyObject,
    ) -> PyResult<()> {
        // Capture TaskLocals at registration time when Python's event loop is running.
        // This is needed because later, when the callback is invoked from an HTTP request,
        // we'll be on a Rust thread without a running Python event loop.
        let locals =
            Arc::new(pyo3_async_runtimes::tokio::get_current_locals(py).map_err(to_pyerr)?);
        let callback = Arc::new(callback);

        // Wrap Python async callback in Rust async closure
        let rust_callback: rs::engine_routes::EngineRouteCallback =
            Arc::new(move |body: serde_json::Value| {
                let callback = callback.clone();
                let locals = locals.clone();

                // Return a boxed future
                Box::pin(async move {
                    // Acquire GIL to call Python callback and convert coroutine to future
                    let py_future = Python::with_gil(|py| {
                        // Convert body to Python dict
                        let py_body = pythonize::pythonize(py, &body).map_err(|e| {
                            anyhow::anyhow!("Failed to convert request body to Python: {}", e)
                        })?;

                        // Call Python async function to get a coroutine
                        let coroutine = callback.call1(py, (py_body,)).map_err(|e| {
                            anyhow::anyhow!("Failed to call Python callback: {}", e)
                        })?;

                        // Use the TaskLocals captured at registration time
                        pyo3_async_runtimes::into_future_with_locals(
                            &locals,
                            coroutine.into_bound(py),
                        )
                        .map_err(|e| {
                            anyhow::anyhow!("Failed to convert coroutine to future: {}", e)
                        })
                    })?;

                    // Await the Python coroutine (GIL is released during await)
                    let py_result = py_future
                        .await
                        .map_err(|e| anyhow::anyhow!("Python callback failed: {}", e))?;

                    // Convert result back to serde_json::Value
                    Python::with_gil(|py| {
                        pythonize::depythonize::<serde_json::Value>(py_result.bind(py))
                            .map_err(|e| anyhow::anyhow!("Failed to serialize response: {}", e))
                    })
                })
            });

        self.inner
            .engine_routes()
            .register(&route_name, rust_callback);
        tracing::debug!("Registered engine route: /engine/{}", route_name);
        Ok(())
    }

806
807
808
809
810
811
812
813
814
815
816
    /// Set the system-level health status (Ready / NotReady).
    fn set_health_status(&self, ready: bool) -> PyResult<()> {
        let status = if ready {
            config::HealthStatus::Ready
        } else {
            config::HealthStatus::NotReady
        };
        self.inner.system_health().lock().set_health_status(status);
        Ok(())
    }

Richard Huo's avatar
Richard Huo committed
817
818
819
820
821
822
823
824
825
826
827
828
829
830
    // This is used to pass the DistributedRuntime from the dynamo-runtime bindings
    // to the KVBM bindings, since KVBM cannot directly use the struct from this cdylib.
    // TODO: Create a separate crate "dynamo-python" so that all binding crates can import
    // from it and share the same crate path. This will allow PyO3 to automatically
    // recognize that both bindings use the same PyClass.
    #[pyo3(name = "to_capsule")]
    fn to_capsule<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyCapsule>> {
        let arc: Arc<rs::DistributedRuntime> = Arc::new(self.inner.clone());
        let weak: Weak<rs::DistributedRuntime> = Arc::downgrade(&arc);

        let name = CString::new("dynamo.runtime.weak").expect("valid capsule name");

        PyCapsule::new(py, weak, Some(name))
    }
831
832
833
834
}

#[pymethods]
impl Endpoint {
835
    #[pyo3(signature = (generator, graceful_shutdown = true, metrics_labels = None, health_check_payload = None))]
836
837
838
839
    fn serve_endpoint<'p>(
        &self,
        py: Python<'p>,
        generator: PyObject,
840
        graceful_shutdown: Option<bool>,
841
        metrics_labels: Option<Vec<(String, String)>>,
842
        health_check_payload: Option<&Bound<'p, PyDict>>,
843
844
845
846
847
    ) -> PyResult<Bound<'p, PyAny>> {
        let engine = Arc::new(engine::PythonAsyncEngine::new(
            generator,
            self.event_loop.clone(),
        )?);
848
        let ingress = JsonServerStreamingIngress::for_engine(engine.clone()).map_err(to_pyerr)?;
849
850
851
852
853
854
855
856
857
858
859
860
861

        // Convert Python dict to serde_json::Value if provided and validate it's an object
        let health_payload_json = health_check_payload
            .map(|dict| pythonize::depythonize::<serde_json::Value>(dict))
            .transpose()
            .map_err(|err| {
                pyo3::exceptions::PyTypeError::new_err(format!(
                    "Failed to convert health_check_payload: {}",
                    err
                ))
            })?;

        // Require an object/dict
862
863
864
865
866
867
        if let Some(ref payload) = health_payload_json
            && !payload.is_object()
        {
            return Err(pyo3::exceptions::PyTypeError::new_err(
                "health_check_payload must be a JSON object (dict)",
            ));
868
869
870
        }

        let mut builder = self
871
872
873
874
            .inner
            .endpoint_builder()
            .metrics_labels(metrics_labels)
            .handler(ingress);
875
876
877
878
879

        if let Some(payload) = health_payload_json {
            builder = builder.health_check_payload(payload);
        }

880
881
882
        // Register the engine in the local endpoint registry for in-process calls
        builder = builder.register_local_engine(engine).map_err(to_pyerr)?;

883
        let graceful_shutdown = graceful_shutdown.unwrap_or(true);
884
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
885
886
887
888
889
            builder
                .graceful_shutdown(graceful_shutdown)
                .start()
                .await
                .map_err(to_pyerr)?;
890
891
892
893
            Ok(())
        })
    }

894
895
896
897
898
899
900
    #[pyo3(signature = (router_mode = None))]
    fn client<'p>(
        &self,
        py: Python<'p>,
        router_mode: Option<RouterMode>,
    ) -> PyResult<Bound<'p, PyAny>> {
        let router_mode = router_mode.unwrap_or(RouterMode::RoundRobin);
901
902
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
903
            let client = inner.client().await.map_err(to_pyerr)?;
904
905
906
            let push_router = rs::pipeline::PushRouter::<
                serde_json::Value,
                RsAnnotated<serde_json::Value>,
907
            >::from_client(client, router_mode.into())
908
909
            .await
            .map_err(to_pyerr)?;
910
911
912
            Ok(Client {
                router: push_router,
            })
913
914
        })
    }
915

916
917
918
    // Opaque unique ID for this worker. May change over worker lifetime.
    fn connection_id(&self) -> u64 {
        self.inner.drt().connection_id()
919
    }
920
921
922

    /// Get a RuntimeMetrics helper for creating Prometheus metrics
    #[getter]
923
924
    fn metrics(&self) -> prometheus_metrics::RuntimeMetrics {
        prometheus_metrics::RuntimeMetrics::from_endpoint(self.inner.clone())
925
    }
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954

    /// Unregister this endpoint instance from discovery.
    ///
    /// This removes the endpoint from the instances bucket, preventing the router
    /// from sending requests to this worker. Use this when a worker is sleeping
    /// and should not receive any requests.
    fn unregister_endpoint_instance<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            inner
                .unregister_endpoint_instance()
                .await
                .map_err(to_pyerr)?;
            Ok(())
        })
    }

    /// Re-register this endpoint instance to discovery.
    ///
    /// This adds the endpoint back to the instances bucket, allowing the router
    /// to send requests to this worker again. Use this when a worker wakes up
    /// and should start receiving requests.
    fn register_endpoint_instance<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let inner = self.inner.clone();
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            inner.register_endpoint_instance().await.map_err(to_pyerr)?;
            Ok(())
        })
    }
955
956
}

957
958
959
960
961
962
963
964
965
966
967
968
969
#[pymethods]
impl ModelCardInstanceId {
    // (namespace, component, endpoint)
    // TODO: Can these be borrowed as &str?
    fn triple(&self) -> (String, String, String) {
        (
            self.inner.namespace.clone(),
            self.inner.component.clone(),
            self.inner.endpoint.clone(),
        )
    }
}

970
971
#[pymethods]
impl Client {
972
973
    /// Get list of current instances.
    /// Replaces endpoint_ids.
974
    fn instance_ids(&self) -> Vec<u64> {
975
        self.router.client.instance_ids()
976
977
    }

978
979
980
    /// Wait for an instance to be available for work.
    /// Replaces wait_for_endpoints.
    fn wait_for_instances<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
981
        let inner = self.router.client.clone();
982
        pyo3_async_runtimes::tokio::future_into_py(py, async move {
983
            inner
984
                .wait_for_instances()
985
                .await
986
                .map(|v| v.into_iter().map(|cei| cei.id()).collect::<Vec<u64>>())
987
                .map_err(to_pyerr)
988
989
990
991
        })
    }

    /// Issue a request to the endpoint using the default routing strategy.
992
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
993
994
995
996
997
    fn generate<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
998
        context: Option<context::Context>,
999
    ) -> PyResult<Bound<'p, PyAny>> {
1000
        self.random(py, request, annotated, context)
1001
1002
1003
    }

    /// Send a request to the next endpoint in a round-robin fashion.
1004
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
1005
1006
1007
1008
1009
    fn round_robin<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
1010
        context: Option<context::Context>,
1011
1012
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
1013
        let request_ctx = create_request_context(request, &context);
1014
1015
1016
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
1017
        let client = self.router.clone();
1018
1019

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
1020
1021
            let stream = match context {
                Some(context) => {
1022
1023
                    // Always instrument with appropriate span (none if no trace context)
                    let span = get_span_for_context(&context, "round_robin");
1024
1025
1026
1027
1028
                    client
                        .round_robin(request_ctx)
                        .instrument(span)
                        .await
                        .map_err(to_pyerr)?
1029
                }
1030
                _ => client.round_robin(request_ctx).await.map_err(to_pyerr)?,
1031
            };
1032
            tokio::spawn(process_stream(stream, tx));
1033
            Ok(AsyncResponseStream::new(rx, annotated))
1034
1035
1036
1037
        })
    }

    /// Send a request to a random endpoint.
1038
    #[pyo3(signature = (request, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
1039
1040
1041
1042
1043
    fn random<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
        annotated: Option<bool>,
1044
        context: Option<context::Context>,
1045
1046
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
1047
        let request_ctx = create_request_context(request, &context);
1048
1049
1050
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
1051
        let client = self.router.clone();
1052
1053

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
1054
1055
            let stream = match context {
                Some(context) => {
1056
                    // Always instrument with appropriate span (none if no trace context)
1057
                    let span = get_span_for_context(&context, "random");
1058
1059
1060
1061
1062
                    client
                        .random(request_ctx)
                        .instrument(span)
                        .await
                        .map_err(to_pyerr)?
1063
                }
1064
                _ => client.random(request_ctx).await.map_err(to_pyerr)?,
1065
            };
1066
            tokio::spawn(process_stream(stream, tx));
1067
            Ok(AsyncResponseStream::new(rx, annotated))
1068
1069
1070
1071
        })
    }

    /// Directly send a request to a specific endpoint.
1072
    #[pyo3(signature = (request, instance_id, annotated=DEFAULT_ANNOTATED_SETTING, context=None))]
1073
1074
1075
1076
    fn direct<'p>(
        &self,
        py: Python<'p>,
        request: PyObject,
1077
        instance_id: u64,
1078
        annotated: Option<bool>,
1079
        context: Option<context::Context>,
1080
1081
    ) -> PyResult<Bound<'p, PyAny>> {
        let request: serde_json::Value = pythonize::depythonize(&request.into_bound(py))?;
1082
        let request_ctx = create_request_context(request, &context);
1083
1084
1085
        let annotated = annotated.unwrap_or(false);

        let (tx, rx) = tokio::sync::mpsc::channel(32);
1086
        let client = self.router.clone();
1087
1088

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
1089
1090
            let stream = match context {
                Some(context) => {
1091
                    // Always instrument with appropriate span (none if no trace context)
1092
1093
                    let span =
                        get_span_for_direct_context(&context, "direct", &instance_id.to_string());
1094
1095
1096
1097
1098
                    client
                        .direct(request_ctx, instance_id)
                        .instrument(span)
                        .await
                        .map_err(to_pyerr)?
1099
1100
                }
                _ => client
1101
                    .direct(request_ctx, instance_id)
1102
1103
1104
                    .await
                    .map_err(to_pyerr)?,
            };
1105
1106
1107

            tokio::spawn(process_stream(stream, tx));

1108
            Ok(AsyncResponseStream::new(rx, annotated))
1109
1110
1111
1112
1113
        })
    }
}

async fn process_stream(
1114
    stream: EngineStream<RsAnnotated<serde_json::Value>>,
1115
1116
1117
1118
1119
    tx: tokio::sync::mpsc::Sender<RsAnnotated<PyObject>>,
) {
    let mut stream = stream;
    while let Some(response) = stream.next().await {
        // Convert the response to a PyObject using Python's GIL
1120
        let annotated: RsAnnotated<serde_json::Value> = response;
1121
        let annotated: RsAnnotated<PyObject> = annotated.map_data(|data| {
1122
            Python::with_gil(|py| match pythonize::pythonize(py, &data) {
1123
1124
                Ok(pyobj) => Ok(pyobj.into()),
                Err(e) => Err(e.to_string()),
1125
            })
1126
1127
1128
1129
1130
1131
        });

        let is_error = annotated.is_error();

        // Send the PyObject through the channel or log an error
        if let Err(e) = tx.send(annotated).await {
1132
            tracing::error!("Failed to send response: {:?}", e);
1133
            break;
1134
1135
1136
1137
1138
1139
1140
1141
1142
        }

        if is_error {
            break;
        }
    }
}

#[pyclass]
1143
pub(crate) struct AsyncResponseStream {
1144
1145
1146
    rx: Arc<Mutex<tokio::sync::mpsc::Receiver<RsAnnotated<PyObject>>>>,
    annotated: bool,
}
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158

impl AsyncResponseStream {
    pub(crate) fn new(
        rx: tokio::sync::mpsc::Receiver<RsAnnotated<PyObject>>,
        annotated: bool,
    ) -> Self {
        Self {
            rx: Arc::new(Mutex::new(rx)),
            annotated,
        }
    }
}
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255

#[pymethods]
impl AsyncResponseStream {
    /// This method is required to implement the `AsyncIterator` protocol.
    #[pyo3(name = "__aiter__")]
    fn aiter(slf: PyRef<Self>, py: Python) -> PyResult<Py<PyAny>> {
        slf.into_py_any(py)
    }
    /// This method is required to implement the `AsyncIterator` protocol.
    #[pyo3(name = "__anext__")]
    fn next<'p>(&self, py: Python<'p>) -> PyResult<Bound<'p, PyAny>> {
        let rx = self.rx.clone();
        let annotated = self.annotated;

        pyo3_async_runtimes::tokio::future_into_py(py, async move {
            loop {
                let value = rx.lock().await.recv().await;
                match value {
                    Some(pyobj) => {
                        let pyobj = match pyobj.ok() {
                            Ok(pyobj) => pyobj,
                            Err(e) => {
                                return Err(PyErr::new::<pyo3::exceptions::PyValueError, _>(e));
                            }
                        };

                        if annotated {
                            let object = Annotated { inner: pyobj };
                            #[allow(deprecated)]
                            let object = Python::with_gil(|py| object.into_py(py));
                            return Ok(object);
                        } else {
                            match pyobj.data {
                                Some(data) => return Ok(data),
                                None => continue,
                            }
                        }
                    }
                    None => return Err(PyStopAsyncIteration::new_err("Stream exhausted")),
                }
            }
        })
    }
}

#[pyclass]
struct Annotated {
    inner: RsAnnotated<PyObject>,
}

#[pymethods]
impl Annotated {
    #[new]
    fn new(data: PyObject) -> Self {
        Annotated {
            inner: RsAnnotated::from_data(data),
        }
    }

    fn is_error(&self) -> bool {
        self.inner.is_error()
    }

    fn data(&self) -> Option<PyObject> {
        self.inner.data.clone()
    }

    fn event(&self) -> Option<String> {
        self.inner.event.clone()
    }

    fn comments(&self) -> Option<Vec<String>> {
        self.inner.comment.clone()
    }

    fn id(&self) -> Option<String> {
        self.inner.id.clone()
    }

    #[pyo3(name = "__repr__")]
    fn _repr(&self, py: Python) -> String {
        let data = self.inner.data.clone().map(|obj| {
            obj.call_method0(py, "__repr__")
                .and_then(|repr_obj| repr_obj.extract::<Py<PyString>>(py))
                .map(|py_str| py_str.to_string_lossy(py).into_owned())
                .unwrap_or_else(|_| "<failed_repr>".to_string())
        });

        format!(
            "Annotated(data={}, event={}, comment={:?}, id={})",
            data.unwrap_or_else(|| "<no_data>".to_string()),
            self.inner.event.as_deref().unwrap_or("None"),
            self.inner.comment.as_deref().unwrap_or(&[]),
            self.inner.id.as_deref().unwrap_or("None")
        )
    }
}