orionis.support.system.contracts.workers.IWorkers

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class IWorkers(ABC): (source)

Undocumented

Class Method	`calculate`	Calculate the recommended maximum number of worker processes.
Class Method	`setRamPerWorker`	Update the RAM allocation per worker.

overridden in orionis.support.system.Workers

Calculate the recommended maximum number of worker processes.

Notes

The calculation considers both CPU core count and available RAM. Ensures resources are not overcommitted. No instantiation is required.

Parameters
None

Returns
`int`	The maximum number of worker processes that can be safely run in parallel, determined by the lesser of available CPU cores and memory capacity. Always returns at least 1.

def setRamPerWorker(cls, ram_per_worker: float): (source) ¶

overridden in orionis.support.system.Workers

Update the RAM allocation per worker.

Notes

Changing the RAM allocation per worker affects every subsequent call to calculate(). No instantiation is required.

Parameters
ram_per_worker:`float`	New amount of RAM in GB to allocate for each worker.

Returns
`None`	This method updates the class-level RAM allocation and returns nothing.

Raises
`ValueError`	If the budget is not finite, positive, or at least one byte.