Struct RiPythonServiceModule 

pub struct RiPythonServiceModule { /* private fields */ }

Python wrapper for synchronous ServiceModule trait.

This structure provides a Python-accessible representation of synchronous service modules. It enables Python code to define synchronous modules that integrate with Ri’s module lifecycle system. Unlike asynchronous modules, synchronous modules execute their operations in a blocking manner.

Synchronous vs Asynchronous

Synchronous modules use blocking I/O and execute their callbacks on the same thread as the module lifecycle manager. For non-blocking operations, use RiPythonAsyncServiceModule instead.

Threading Model

Synchronous modules are executed in the context of the module management thread. Long-running operations will block the entire module system. Consider using tokio::task::spawn_blocking for CPU-intensive work.

Default Behavior

All lifecycle methods return Ok(()) by default, allowing Python modules to override only the methods they need to customize.

Python Usage

 

class MySyncModule:
    def name(&self):
        return "sync_module"

    def start(&self, ctx):
        print("Starting sync module")
        return None

module = dms.RiPythonServiceModule(name="my_sync")
module.priority = 50
module.dependencies = ["config"]

Implementations

impl RiPythonServiceModule

pub fn name(&self) -> String

pub fn set_name(&mut self, name: String)

pub fn is_critical(&self) -> bool

pub fn set_is_critical(&mut self, is_critical: bool)

pub fn priority(&self) -> i32

pub fn set_priority(&mut self, priority: i32)

pub fn dependencies(&self) -> Vec<String>

pub fn set_dependencies(&mut self, dependencies: Vec<String>)

Trait Implementations

impl Clone for RiPythonServiceModule

fn clone(&self) -> RiPythonServiceModule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for RiPythonServiceModule

type Target = RiPythonServiceModule

The Python output type

type Output = Bound<'py, <RiPythonServiceModule as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiPythonServiceModule

type Frozen = False

Whether the pyclass is frozen.

impl PyClassBaseType for RiPythonServiceModule

type LayoutAsBase = PyClassObject<RiPythonServiceModule>

type BaseNativeType = <RiPythonServiceModule as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<RiPythonServiceModule>

type PyClassMutability = <RiPythonServiceModule as PyClassImpl>::PyClassMutability

impl PyClassImpl for RiPythonServiceModule

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// ```

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiPythonServiceModule>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for RiPythonServiceModule

const TEXT_SIGNATURE: &'static str = "(name)"

impl PyMethods<RiPythonServiceModule> for PyClassImplCollector<RiPythonServiceModule>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for RiPythonServiceModule

const NAME: &'static str = "RiPythonServiceModule"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl ServiceModule for RiPythonServiceModule

Available on crate feature pyo3 only.

fn name(&self) -> &str

Returns the name of the service module.

fn is_critical(&self) -> bool

Indicates if the module is critical to the operation of the system.

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn init(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Initializes the service module.

fn before_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for startup.

fn start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Starts the service module.

fn after_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-startup operations.

fn before_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for shutdown.

fn shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Shuts down the service module.

fn after_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-shutdown cleanup.

impl DerefToPyAny for RiPythonServiceModule

impl ExtractPyClassWithClone for RiPythonServiceModule