ipckit 0.1.6

A cross-platform IPC (Inter-Process Communication) library for Rust and Python
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
//! Python bindings for EventStream (Event Bus)

use crate::bindings::json_utils::{json_value_to_py, py_to_json_value};
use crate::event_stream::{
    Event, EventBus, EventBusConfig, EventFilter, EventPublisher, EventSubscriber,
    SlowConsumerPolicy,
};
use pyo3::exceptions::PyRuntimeError;
use pyo3::prelude::*;
use std::time::{Duration, UNIX_EPOCH};

/// Python wrapper for Event.
#[pyclass(name = "Event")]
#[derive(Clone)]
pub struct PyEvent {
    inner: Event,
}

#[pymethods]
impl PyEvent {
    /// Create a new event with the given type and data.
    #[new]
    #[pyo3(signature = (event_type, data=None))]
    fn new(py: Python<'_>, event_type: &str, data: Option<Py<PyAny>>) -> PyResult<Self> {
        let json_data = match data {
            Some(obj) => py_to_json_value(&obj.bind(py).clone())?,
            None => serde_json::json!({}),
        };
        Ok(Self {
            inner: Event::new(event_type, json_data),
        })
    }

    /// Create an event with a resource ID.
    #[staticmethod]
    #[pyo3(signature = (event_type, resource_id, data=None))]
    fn with_resource(
        py: Python<'_>,
        event_type: &str,
        resource_id: &str,
        data: Option<Py<PyAny>>,
    ) -> PyResult<Self> {
        let json_data = match data {
            Some(obj) => py_to_json_value(&obj.bind(py).clone())?,
            None => serde_json::json!({}),
        };
        Ok(Self {
            inner: Event::with_resource(event_type, resource_id, json_data),
        })
    }

    /// Create a progress event.
    #[staticmethod]
    fn progress(resource_id: &str, current: u64, total: u64, message: &str) -> Self {
        Self {
            inner: Event::progress(resource_id, current, total, message),
        }
    }

    /// Create a log event.
    #[staticmethod]
    fn log(resource_id: &str, level: &str, message: &str) -> Self {
        Self {
            inner: Event::log(resource_id, level, message),
        }
    }

    /// Create a stdout log event.
    #[staticmethod]
    fn stdout(resource_id: &str, line: &str) -> Self {
        Self {
            inner: Event::stdout(resource_id, line),
        }
    }

    /// Create a stderr log event.
    #[staticmethod]
    fn stderr(resource_id: &str, line: &str) -> Self {
        Self {
            inner: Event::stderr(resource_id, line),
        }
    }

    /// Get the event ID.
    #[getter]
    fn id(&self) -> u64 {
        self.inner.id
    }

    /// Get the event timestamp as Unix timestamp (seconds).
    #[getter]
    fn timestamp(&self) -> f64 {
        self.inner
            .timestamp
            .duration_since(UNIX_EPOCH)
            .unwrap_or(Duration::ZERO)
            .as_secs_f64()
    }

    /// Get the event type.
    #[getter]
    fn event_type(&self) -> &str {
        &self.inner.event_type
    }

    /// Get the resource ID.
    #[getter]
    fn resource_id(&self) -> Option<&str> {
        self.inner.resource_id.as_deref()
    }

    /// Get the event data as a Python object.
    #[getter]
    fn data(&self, py: Python<'_>) -> PyResult<Py<PyAny>> {
        json_value_to_py(py, &self.inner.data)
    }

    /// Convert to JSON string.
    fn to_json(&self) -> PyResult<String> {
        serde_json::to_string(&self.inner).map_err(|e| PyRuntimeError::new_err(e.to_string()))
    }

    fn __repr__(&self) -> String {
        format!(
            "Event(id={}, type='{}', resource_id={:?})",
            self.inner.id, self.inner.event_type, self.inner.resource_id
        )
    }
}

/// Python wrapper for EventFilter.
#[pyclass(name = "EventFilter")]
#[derive(Clone)]
pub struct PyEventFilter {
    inner: EventFilter,
}

#[pymethods]
impl PyEventFilter {
    /// Create a new empty filter that matches all events.
    #[new]
    fn new() -> Self {
        Self {
            inner: EventFilter::new(),
        }
    }

    /// Add an event type pattern to the filter.
    /// Supports wildcards like "task.*" to match all task events.
    fn event_type(&self, pattern: &str) -> Self {
        Self {
            inner: self.inner.clone().event_type(pattern),
        }
    }

    /// Add a resource ID to the filter.
    fn resource(&self, id: &str) -> Self {
        Self {
            inner: self.inner.clone().resource(id),
        }
    }

    /// Set the start time filter (Unix timestamp in seconds).
    fn since(&self, timestamp: f64) -> Self {
        let time = UNIX_EPOCH + Duration::from_secs_f64(timestamp);
        Self {
            inner: self.inner.clone().since(time),
        }
    }

    /// Set the end time filter (Unix timestamp in seconds).
    fn until(&self, timestamp: f64) -> Self {
        let time = UNIX_EPOCH + Duration::from_secs_f64(timestamp);
        Self {
            inner: self.inner.clone().until(time),
        }
    }

    /// Check if an event matches this filter.
    fn matches(&self, event: &PyEvent) -> bool {
        self.inner.matches(&event.inner)
    }

    fn __repr__(&self) -> String {
        format!(
            "EventFilter(event_types={:?}, resource_ids={:?})",
            self.inner.event_types, self.inner.resource_ids
        )
    }
}

/// Python wrapper for EventBusConfig.
#[pyclass(name = "EventBusConfig")]
#[derive(Clone)]
pub struct PyEventBusConfig {
    inner: EventBusConfig,
}

#[pymethods]
impl PyEventBusConfig {
    /// Create a new event bus configuration.
    #[new]
    #[pyo3(signature = (history_size=1000, subscriber_buffer=256, slow_consumer="drop_oldest"))]
    fn new(history_size: usize, subscriber_buffer: usize, slow_consumer: &str) -> PyResult<Self> {
        let policy =
            match slow_consumer {
                "drop_oldest" => SlowConsumerPolicy::DropOldest,
                "drop_newest" => SlowConsumerPolicy::DropNewest,
                "block" => SlowConsumerPolicy::Block,
                _ => return Err(PyRuntimeError::new_err(
                    "Invalid slow_consumer policy. Use 'drop_oldest', 'drop_newest', or 'block'",
                )),
            };

        Ok(Self {
            inner: EventBusConfig {
                history_size,
                subscriber_buffer,
                slow_consumer: policy,
            },
        })
    }

    /// Get the history size.
    #[getter]
    fn history_size(&self) -> usize {
        self.inner.history_size
    }

    /// Get the subscriber buffer size.
    #[getter]
    fn subscriber_buffer(&self) -> usize {
        self.inner.subscriber_buffer
    }

    fn __repr__(&self) -> String {
        format!(
            "EventBusConfig(history_size={}, subscriber_buffer={})",
            self.inner.history_size, self.inner.subscriber_buffer
        )
    }
}

/// Python wrapper for EventPublisher.
#[pyclass(name = "EventPublisher")]
pub struct PyEventPublisher {
    inner: EventPublisher,
}

#[pymethods]
impl PyEventPublisher {
    /// Publish an event to the bus.
    fn publish(&self, event: &PyEvent) {
        self.inner.publish(event.inner.clone());
    }

    /// Publish a progress event.
    fn progress(&self, resource_id: &str, current: u64, total: u64, message: &str) {
        self.inner.progress(resource_id, current, total, message);
    }

    /// Publish a log event.
    fn log(&self, resource_id: &str, level: &str, message: &str) {
        self.inner.log(resource_id, level, message);
    }

    /// Publish a stdout log event.
    fn stdout(&self, resource_id: &str, line: &str) {
        self.inner.stdout(resource_id, line);
    }

    /// Publish a stderr log event.
    fn stderr(&self, resource_id: &str, line: &str) {
        self.inner.stderr(resource_id, line);
    }

    /// Publish a task started event.
    fn task_started(&self, py: Python<'_>, task_id: &str, data: Option<Py<PyAny>>) -> PyResult<()> {
        let json_data = match data {
            Some(obj) => py_to_json_value(&obj.bind(py).clone())?,
            None => serde_json::json!({}),
        };
        self.inner.task_started(task_id, json_data);
        Ok(())
    }

    /// Publish a task completed event.
    fn task_completed(
        &self,
        py: Python<'_>,
        task_id: &str,
        result: Option<Py<PyAny>>,
    ) -> PyResult<()> {
        let json_result = match result {
            Some(obj) => py_to_json_value(&obj.bind(py).clone())?,
            None => serde_json::json!({}),
        };
        self.inner.task_completed(task_id, json_result);
        Ok(())
    }

    /// Publish a task failed event.
    fn task_failed(&self, task_id: &str, error: &str) {
        self.inner.task_failed(task_id, error);
    }

    /// Publish a task cancelled event.
    fn task_cancelled(&self, task_id: &str) {
        self.inner.task_cancelled(task_id);
    }

    fn __repr__(&self) -> String {
        "EventPublisher()".to_string()
    }
}

/// Python wrapper for EventSubscriber.
#[pyclass(name = "EventSubscriber")]
pub struct PyEventSubscriber {
    inner: EventSubscriber,
}

#[pymethods]
impl PyEventSubscriber {
    /// Receive the next event (blocking).
    /// Returns None if the bus is closed.
    fn recv(&self, py: Python<'_>) -> Option<PyEvent> {
        let inner = &self.inner;
        py.detach(|| inner.recv().map(|e| PyEvent { inner: e }))
    }

    /// Try to receive an event without blocking.
    /// Returns None if no event is available.
    fn try_recv(&self) -> Option<PyEvent> {
        self.inner.try_recv().map(|e| PyEvent { inner: e })
    }

    /// Receive an event with a timeout in milliseconds.
    /// Raises RuntimeError on timeout.
    fn recv_timeout(&self, py: Python<'_>, timeout_ms: u64) -> PyResult<PyEvent> {
        let timeout = Duration::from_millis(timeout_ms);
        let inner = &self.inner;
        py.detach(|| {
            inner
                .recv_timeout(timeout)
                .map(|e| PyEvent { inner: e })
                .map_err(|e| PyRuntimeError::new_err(e.to_string()))
        })
    }

    /// Get all currently available events without blocking.
    fn drain(&self) -> Vec<PyEvent> {
        self.inner
            .try_iter()
            .map(|e| PyEvent { inner: e })
            .collect()
    }

    fn __repr__(&self) -> String {
        format!("EventSubscriber(filter={:?})", self.inner.filter())
    }
}

/// Python wrapper for EventBus.
#[pyclass(name = "EventBus")]
pub struct PyEventBus {
    inner: EventBus,
}

#[pymethods]
impl PyEventBus {
    /// Create a new event bus with optional configuration.
    #[new]
    #[pyo3(signature = (config=None))]
    fn new(config: Option<PyEventBusConfig>) -> Self {
        let cfg = config.map(|c| c.inner).unwrap_or_default();
        Self {
            inner: EventBus::new(cfg),
        }
    }

    /// Create a new publisher for this bus.
    fn publisher(&self) -> PyEventPublisher {
        PyEventPublisher {
            inner: self.inner.publisher(),
        }
    }

    /// Subscribe to events matching the given filter.
    #[pyo3(signature = (filter=None))]
    fn subscribe(&self, filter: Option<PyEventFilter>) -> PyEventSubscriber {
        let f = filter.map(|f| f.inner).unwrap_or_default();
        PyEventSubscriber {
            inner: self.inner.subscribe(f),
        }
    }

    /// Get historical events matching the given filter.
    #[pyo3(signature = (filter=None))]
    fn history(&self, filter: Option<PyEventFilter>) -> Vec<PyEvent> {
        let f = filter.map(|f| f.inner).unwrap_or_default();
        self.inner
            .history(&f)
            .into_iter()
            .map(|e| PyEvent { inner: e })
            .collect()
    }

    /// Clear all event history.
    fn clear_history(&self) {
        self.inner.clear_history();
    }

    /// Publish an event directly.
    fn publish(&self, event: &PyEvent) {
        self.inner.publish(event.inner.clone());
    }

    fn __repr__(&self) -> String {
        "EventBus()".to_string()
    }
}